vtkNetCDFReader Class Reference

#include <vtkNetCDFReader.h>

Inheritance diagram for vtkNetCDFReader:

[legend]

Collaboration diagram for vtkNetCDFReader:

[legend]

List of all members.

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.


Public Types
typedef vtkDataObjectAlgorithm	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 vtkStringArray *	GetAllVariableArrayNames ()
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 vtkStringArray *	GetVariableDimensions ()

virtual vtkStringArray *	GetAllDimensions ()

virtual int	GetReplaceFillValueWithNan ()
virtual void	SetReplaceFillValueWithNan (int)
virtual void	ReplaceFillValueWithNanOn ()
virtual void	ReplaceFillValueWithNanOff ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkNetCDFReader *	SafeDownCast (vtkObject *o)
static vtkNetCDFReader *	New ()
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)
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< vtkIntArray >	LoadingDimensions
vtkSmartPointer < vtkDataArraySelection >	VariableArraySelection
vtkSmartPointer< vtkStringArray >	AllVariableArrayNames
vtkStringArray *	VariableDimensions
int	ReplaceFillValueWithNan
int	WholeExtent [6]

vtkStringArray *	AllDimensions

Member Typedef Documentation

typedef vtkDataObjectAlgorithm vtkNetCDFReader::Superclass

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

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 *
	)			`[protected, virtual]`

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
	)			`[protected, virtual]`

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

virtual int vtkNetCDFReader::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkNetCDFCFReader.

static void vtkNetCDFReader::SelectionModifiedCallback	(	vtkObject *	caller,
		unsigned long	eid,
		void *	clientdata,
		void *	calldata
	)			`[static, protected]`

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 ) [protected, virtual]

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

Reimplemented in vtkNetCDFCFReader.

virtual int vtkNetCDFReader::FillVariableDimensions ( int ncFD ) [protected, virtual]

Fills the VariableDimensions array.

virtual int vtkNetCDFReader::IsTimeDimension	(	int	ncFD,
		int	dimId
	)			`[protected, virtual]`

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
	)			`[protected, virtual]`

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 ) [inline, protected, virtual]

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]
	)			`[protected, virtual]`

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.