VTK
Public Types | Public Member Functions | Static Public Member Functions | 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
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetFileName (const char *filename)
virtual char * GetFileName ()
int UpdateMetaData ()
virtual vtkStringArrayGetAllVariableArrayNames ()
virtual void SetDimensions (const char *dimensions)
virtual int GetNumberOfVariableArrays ()
virtual const char * GetVariableArrayName (int idx)
virtual int GetVariableArrayStatus (const char *name)
virtual void SetVariableArrayStatus (const char *name, int status)
virtual vtkStringArrayGetVariableDimensions ()
virtual vtkStringArrayGetAllDimensions ()
virtual int GetReplaceFillValueWithNan ()
virtual void SetReplaceFillValueWithNan (int)
virtual void ReplaceFillValueWithNanOn ()
virtual void ReplaceFillValueWithNanOff ()
- Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkDataObjectGetOutput ()
vtkDataObjectGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
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)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkNetCDFReaderSafeDownCast (vtkObject *o)
static vtkNetCDFReaderNew ()

Protected Member Functions

 vtkNetCDFReader ()
 ~vtkNetCDFReader ()
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkStdString DescribeDimensions (int ncFD, const int *dimIds, int numDims)
virtual int ReadMetaData (int ncFD)
virtual int FillVariableDimensions (int ncFD)
virtual int IsTimeDimension (int ncFD, int dimId)
virtual void GetUpdateExtentForOutput (vtkDataSet *output, int extent[6])
virtual vtkSmartPointer
< vtkDoubleArray
GetTimeValues (int ncFD, int dimId)
virtual bool DimensionsAreForPointData (vtkIntArray *vtkNotUsed(dimensions))
virtual int LoadVariable (int ncFD, const char *varName, double time, vtkDataSet *output)
- Protected Member Functions inherited from vtkDataObjectAlgorithm
 vtkDataObjectAlgorithm ()
 ~vtkDataObjectAlgorithm ()
int UpdateExtentIsEmpty (vtkDataObject *output)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
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)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
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)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Static Protected Member Functions

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

Protected Attributes

char * FileName
vtkTimeStamp FileNameMTime
vtkTimeStamp MetaDataMTime
vtkSmartPointer< vtkIntArrayLoadingDimensions
vtkSmartPointer
< vtkDataArraySelection
VariableArraySelection
vtkSmartPointer< vtkStringArrayAllVariableArrayNames
vtkStringArrayVariableDimensions
int ReplaceFillValueWithNan
int WholeExtent [6]
vtkStringArrayAllDimensions

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

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 48 of file vtkNetCDFReader.h.

Member Typedef Documentation

Definition at line 51 of file vtkNetCDFReader.h.

Constructor & Destructor Documentation

vtkNetCDFReader::vtkNetCDFReader ( )
protected
vtkNetCDFReader::~vtkNetCDFReader ( )
protected

Member Function Documentation

virtual const char* vtkNetCDFReader::GetClassName ( )
virtual

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

static int vtkNetCDFReader::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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.

virtual int 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.

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

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

static vtkNetCDFReader* vtkNetCDFReader::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

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

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.

Reimplemented in vtkNetCDFCFReader.

virtual void vtkNetCDFReader::SetFileName ( const char *  filename)
virtual
virtual char* vtkNetCDFReader::GetFileName ( )
virtual
int vtkNetCDFReader::UpdateMetaData ( )

Update the meta data from the current file. Automatically called during the RequestInformation pipeline update stage.

virtual int vtkNetCDFReader::GetNumberOfVariableArrays ( )
virtual

Variable array selection.

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

Variable array selection.

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

Variable array selection.

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

Variable array selection.

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).

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.

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.

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.

virtual int 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.

virtual void vtkNetCDFReader::SetReplaceFillValueWithNan ( int  )
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.

virtual void vtkNetCDFReader::ReplaceFillValueWithNanOn ( )
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.

virtual void vtkNetCDFReader::ReplaceFillValueWithNanOff ( )
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.

virtual int vtkNetCDFReader::RequestDataObject ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

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

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

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

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

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

Callback registered with the VariableArraySelection.

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

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

virtual int vtkNetCDFReader::ReadMetaData ( int  ncFD)
protectedvirtual

Reads meta data and populates ivars. Returns 1 on success, 0 on failure.

Reimplemented in vtkNetCDFCFReader.

virtual int vtkNetCDFReader::FillVariableDimensions ( int  ncFD)
protectedvirtual

Fills the VariableDimensions array.

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.

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 tiem 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.

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 204 of file vtkNetCDFReader.h.

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.

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

char* vtkNetCDFReader::FileName
protected

Definition at line 125 of file vtkNetCDFReader.h.

vtkTimeStamp vtkNetCDFReader::FileNameMTime
protected

Definition at line 126 of file vtkNetCDFReader.h.

vtkTimeStamp vtkNetCDFReader::MetaDataMTime
protected

Definition at line 127 of file vtkNetCDFReader.h.

vtkSmartPointer<vtkIntArray> vtkNetCDFReader::LoadingDimensions
protected

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

Definition at line 131 of file vtkNetCDFReader.h.

vtkSmartPointer<vtkDataArraySelection> vtkNetCDFReader::VariableArraySelection
protected

Definition at line 133 of file vtkNetCDFReader.h.

vtkSmartPointer<vtkStringArray> vtkNetCDFReader::AllVariableArrayNames
protected

Definition at line 135 of file vtkNetCDFReader.h.

vtkStringArray* vtkNetCDFReader::VariableDimensions
protected

Placeholder for structure returned from GetVariableDimensions().

Definition at line 138 of file vtkNetCDFReader.h.

vtkStringArray* vtkNetCDFReader::AllDimensions
protected

Placeholder for structure returned from GetAllDimensions().

Definition at line 142 of file vtkNetCDFReader.h.

int vtkNetCDFReader::ReplaceFillValueWithNan
protected

Definition at line 146 of file vtkNetCDFReader.h.

int vtkNetCDFReader::WholeExtent[6]
protected

Definition at line 148 of file vtkNetCDFReader.h.


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