VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkNetCDFReader Class Reference

#include <vtkNetCDFReader.h>

Inheritance diagram for vtkNetCDFReader:
[legend]
Collaboration diagram for vtkNetCDFReader:
[legend]

Public Types

typedef vtkDataObjectAlgorithm Superclass
 
- Public Types inherited from vtkDataObjectAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkNetCDFReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetFileName (const char *filename)
 
virtual char * GetFileName ()
 
int UpdateMetaData ()
 Update the meta data from the current file. More...
 
virtual int GetNumberOfVariableArrays ()
 Variable array selection. More...
 
virtual const char * GetVariableArrayName (int idx)
 
virtual int GetVariableArrayStatus (const char *name)
 
virtual void SetVariableArrayStatus (const char *name, int status)
 
virtual vtkStringArrayGetAllVariableArrayNames ()
 Convenience method to get a list of variable arrays. More...
 
virtual vtkStringArrayGetVariableDimensions ()
 Returns an array with string encodings for the dimensions used in each of the variables. More...
 
virtual void SetDimensions (const char *dimensions)
 Loads the grid with the given dimensions. More...
 
virtual vtkStringArrayGetAllDimensions ()
 Returns an array with string encodings for the dimension combinations used in the variables. More...
 
virtual vtkTypeBool GetReplaceFillValueWithNan ()
 If on, any float or double variable read that has a _FillValue attribute will have that fill value replaced with a not-a-number (NaN) value. More...
 
virtual void SetReplaceFillValueWithNan (vtkTypeBool)
 
virtual void ReplaceFillValueWithNanOn ()
 
virtual void ReplaceFillValueWithNanOff ()
 
virtual char * GetTimeUnits ()
 Access to the time dimensions units. More...
 
virtual char * GetCalendar ()
 
std::string QueryArrayUnits (const char *ArrayName)
 Get units attached to a particular array in the netcdf file. More...
 
- Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithmNewInstance () const
 
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataObjectGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkNetCDFReaderSafeDownCast (vtkObjectBase *o)
 
static vtkNetCDFReaderNew ()
 
- Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkNetCDFReader ()
 
 ~vtkNetCDFReader () override
 
int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
vtkStdString DescribeDimensions (int ncFD, const int *dimIds, int numDims)
 Convenience function for getting a string that describes a set of dimensions. More...
 
virtual int ReadMetaData (int ncFD)
 Reads meta data and populates ivars. More...
 
virtual int FillVariableDimensions (int ncFD)
 Fills the VariableDimensions array. More...
 
virtual int IsTimeDimension (int ncFD, int dimId)
 Determines whether the given variable is a time dimension. More...
 
virtual vtkSmartPointer< vtkDoubleArrayGetTimeValues (int ncFD, int dimId)
 Given a dimension already determined to be a time dimension (via a call to IsTimeDimension) returns an array with time values. More...
 
virtual bool DimensionsAreForPointData (vtkIntArray *vtkNotUsed(dimensions))
 Called internally to determine whether a variable with the given set of dimensions should be loaded as point data (return true) or cell data (return false). More...
 
virtual void GetUpdateExtentForOutput (vtkDataSet *output, int extent[6])
 Retrieves the update extent for the output object. More...
 
virtual int LoadVariable (int ncFD, const char *varName, double time, vtkDataSet *output)
 Load the variable at the given time into the given data set. More...
 
- Protected Member Functions inherited from vtkDataObjectAlgorithm
 vtkDataObjectAlgorithm ()
 
 ~vtkDataObjectAlgorithm () override
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 Callback registered with the VariableArraySelection. More...
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

char * FileName
 
vtkTimeStamp FileNameMTime
 
vtkTimeStamp MetaDataMTime
 
vtkSmartPointer< vtkIntArrayLoadingDimensions
 The dimension ids of the arrays being loaded into the data. More...
 
vtkSmartPointer< vtkDataArraySelectionVariableArraySelection
 
vtkSmartPointer< vtkStringArrayAllVariableArrayNames
 
vtkStringArrayVariableDimensions
 Placeholder for structure returned from GetVariableDimensions(). More...
 
vtkStringArrayAllDimensions
 Placeholder for structure returned from GetAllDimensions(). More...
 
vtkTypeBool ReplaceFillValueWithNan
 
int WholeExtent [6]
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

A superclass for reading netCDF files. Subclass add conventions to the reader. This class just outputs data into a multi block data set with a vtkImageData at each block. A block is created for each variable except that variables with matching dimensions will be placed in the same block.

Definition at line 51 of file vtkNetCDFReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkNetCDFReader.h.

Constructor & Destructor Documentation

◆ vtkNetCDFReader()

vtkNetCDFReader::vtkNetCDFReader ( )
protected

◆ ~vtkNetCDFReader()

vtkNetCDFReader::~vtkNetCDFReader ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkNetCDFReader::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkNetCDFReader::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

◆ SafeDownCast()

static vtkNetCDFReader* vtkNetCDFReader::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkNetCDFReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

◆ NewInstance()

vtkNetCDFReader* vtkNetCDFReader::NewInstance ( ) const

◆ New()

static vtkNetCDFReader* vtkNetCDFReader::New ( )
static

◆ PrintSelf()

void vtkNetCDFReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataObjectAlgorithm.

◆ SetFileName()

virtual void vtkNetCDFReader::SetFileName ( const char *  filename)
virtual

◆ GetFileName()

virtual char* vtkNetCDFReader::GetFileName ( )
virtual

◆ UpdateMetaData()

int vtkNetCDFReader::UpdateMetaData ( )

Update the meta data from the current file.

Automatically called during the RequestInformation pipeline update stage.

◆ GetNumberOfVariableArrays()

virtual int vtkNetCDFReader::GetNumberOfVariableArrays ( )
virtual

Variable array selection.

◆ GetVariableArrayName()

virtual const char* vtkNetCDFReader::GetVariableArrayName ( int  idx)
virtual

◆ GetVariableArrayStatus()

virtual int vtkNetCDFReader::GetVariableArrayStatus ( const char *  name)
virtual

◆ SetVariableArrayStatus()

virtual void vtkNetCDFReader::SetVariableArrayStatus ( const char *  name,
int  status 
)
virtual

◆ GetAllVariableArrayNames()

virtual vtkStringArray* vtkNetCDFReader::GetAllVariableArrayNames ( )
virtual

Convenience method to get a list of variable arrays.

The length of the returned list is the same as GetNumberOfVariableArrays, and the string at each index i is the same as returned from GetVariableArrayname(i).

◆ GetVariableDimensions()

virtual vtkStringArray* vtkNetCDFReader::GetVariableDimensions ( )
virtual

Returns an array with string encodings for the dimensions used in each of the variables.

The indices in the returned array correspond to those used in the GetVariableArrayName method. Two arrays with the same dimensions will have the same encoded string returned by this method.

◆ SetDimensions()

virtual void vtkNetCDFReader::SetDimensions ( const char *  dimensions)
virtual

Loads the grid with the given dimensions.

The dimensions are encoded in a string that conforms to the same format as returned by GetVariableDimensions and GetAllDimensions. This method is really a convenience method for SetVariableArrayStatus. It turns on all variables that have the given dimensions and turns off all other variables.

◆ GetAllDimensions()

virtual vtkStringArray* vtkNetCDFReader::GetAllDimensions ( )
virtual

Returns an array with string encodings for the dimension combinations used in the variables.

The result is the same as GetVariableDimensions except that each entry in the array is unique (a set of dimensions is only given once even if it occurs for multiple variables) and the order is meaningless.

◆ GetReplaceFillValueWithNan()

virtual vtkTypeBool vtkNetCDFReader::GetReplaceFillValueWithNan ( )
virtual

If on, any float or double variable read that has a _FillValue attribute will have that fill value replaced with a not-a-number (NaN) value.

The advantage of setting these to NaN values is that, if implemented properly by the system and careful math operations are used, they can implicitly be ignored by calculations like finding the range of the values. That said, this option should be used with caution as VTK does not fully support NaN values and therefore odd calculations may occur. By default this is off.

◆ SetReplaceFillValueWithNan()

virtual void vtkNetCDFReader::SetReplaceFillValueWithNan ( vtkTypeBool  )
virtual

◆ ReplaceFillValueWithNanOn()

virtual void vtkNetCDFReader::ReplaceFillValueWithNanOn ( )
virtual

◆ ReplaceFillValueWithNanOff()

virtual void vtkNetCDFReader::ReplaceFillValueWithNanOff ( )
virtual

◆ GetTimeUnits()

virtual char* vtkNetCDFReader::GetTimeUnits ( )
virtual

Access to the time dimensions units.

Can be used by the udunits library to convert raw numerical time values into meaningful representations.

◆ GetCalendar()

virtual char* vtkNetCDFReader::GetCalendar ( )
virtual

◆ QueryArrayUnits()

std::string vtkNetCDFReader::QueryArrayUnits ( const char *  ArrayName)

Get units attached to a particular array in the netcdf file.

◆ RequestDataObject()

int vtkNetCDFReader::RequestDataObject ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestInformation()

int vtkNetCDFReader::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestData()

int vtkNetCDFReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ SelectionModifiedCallback()

static void vtkNetCDFReader::SelectionModifiedCallback ( vtkObject caller,
unsigned long  eid,
void *  clientdata,
void *  calldata 
)
staticprotected

Callback registered with the VariableArraySelection.

◆ DescribeDimensions()

vtkStdString vtkNetCDFReader::DescribeDimensions ( int  ncFD,
const int *  dimIds,
int  numDims 
)
protected

Convenience function for getting a string that describes a set of dimensions.

◆ ReadMetaData()

virtual int vtkNetCDFReader::ReadMetaData ( int  ncFD)
protectedvirtual

Reads meta data and populates ivars.

Returns 1 on success, 0 on failure.

Reimplemented in vtkNetCDFCFReader.

◆ FillVariableDimensions()

virtual int vtkNetCDFReader::FillVariableDimensions ( int  ncFD)
protectedvirtual

Fills the VariableDimensions array.

◆ IsTimeDimension()

virtual int vtkNetCDFReader::IsTimeDimension ( int  ncFD,
int  dimId 
)
protectedvirtual

Determines whether the given variable is a time dimension.

The default implementation bases the decision on the name of the variable. Subclasses should override this function if there is a more specific way to identify the time variable. This method is always called after ReadMetaData for a given file.

Reimplemented in vtkNetCDFCFReader.

◆ GetTimeValues()

virtual vtkSmartPointer<vtkDoubleArray> vtkNetCDFReader::GetTimeValues ( int  ncFD,
int  dimId 
)
protectedvirtual

Given a dimension already determined to be a time dimension (via a call to IsTimeDimension) returns an array with time values.

The default implementation just uses the time index for the time value. Subclasses should override this function if there is a convention that identifies time values. This method returns 0 on error, 1 otherwise.

Reimplemented in vtkNetCDFCFReader.

◆ DimensionsAreForPointData()

virtual bool vtkNetCDFReader::DimensionsAreForPointData ( vtkIntArray vtkNotUseddimensions)
inlineprotectedvirtual

Called internally to determine whether a variable with the given set of dimensions should be loaded as point data (return true) or cell data (return false).

The implementation in this class always returns true. Subclasses should override to load cell data for some or all variables.

Definition at line 235 of file vtkNetCDFReader.h.

◆ GetUpdateExtentForOutput()

virtual void vtkNetCDFReader::GetUpdateExtentForOutput ( vtkDataSet output,
int  extent[6] 
)
protectedvirtual

Retrieves the update extent for the output object.

The default implementation just gets the update extent from the object as you would expect. However, if a subclass is loading an unstructured data set, this gives it a chance to set the range of values to read.

Reimplemented in vtkNetCDFCFReader.

◆ LoadVariable()

virtual int vtkNetCDFReader::LoadVariable ( int  ncFD,
const char *  varName,
double  time,
vtkDataSet output 
)
protectedvirtual

Load the variable at the given time into the given data set.

Return 1 on success and 0 on failure.

Member Data Documentation

◆ FileName

char* vtkNetCDFReader::FileName
protected

Definition at line 153 of file vtkNetCDFReader.h.

◆ FileNameMTime

vtkTimeStamp vtkNetCDFReader::FileNameMTime
protected

Definition at line 154 of file vtkNetCDFReader.h.

◆ MetaDataMTime

vtkTimeStamp vtkNetCDFReader::MetaDataMTime
protected

Definition at line 155 of file vtkNetCDFReader.h.

◆ LoadingDimensions

vtkSmartPointer<vtkIntArray> vtkNetCDFReader::LoadingDimensions
protected

The dimension ids of the arrays being loaded into the data.

Definition at line 160 of file vtkNetCDFReader.h.

◆ VariableArraySelection

vtkSmartPointer<vtkDataArraySelection> vtkNetCDFReader::VariableArraySelection
protected

Definition at line 162 of file vtkNetCDFReader.h.

◆ AllVariableArrayNames

vtkSmartPointer<vtkStringArray> vtkNetCDFReader::AllVariableArrayNames
protected

Definition at line 164 of file vtkNetCDFReader.h.

◆ VariableDimensions

vtkStringArray* vtkNetCDFReader::VariableDimensions
protected

Placeholder for structure returned from GetVariableDimensions().

Definition at line 169 of file vtkNetCDFReader.h.

◆ AllDimensions

vtkStringArray* vtkNetCDFReader::AllDimensions
protected

Placeholder for structure returned from GetAllDimensions().

Definition at line 174 of file vtkNetCDFReader.h.

◆ ReplaceFillValueWithNan

vtkTypeBool vtkNetCDFReader::ReplaceFillValueWithNan
protected

Definition at line 176 of file vtkNetCDFReader.h.

◆ WholeExtent

int vtkNetCDFReader::WholeExtent[6]
protected

Definition at line 178 of file vtkNetCDFReader.h.


The documentation for this class was generated from the following file: