#include <vtkNetCDFCFReader.h>

Inheritance diagram for vtkNetCDFCFReader:

Collaboration diagram for vtkNetCDFCFReader:

Classes
class	vtkDependentDimensionInfo
class	vtkDimensionInfo
Public Types
typedef vtkNetCDFReader	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkNetCDFCFReader *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	GetSphericalCoordinates ()
virtual void	SetSphericalCoordinates (int)
virtual void	SphericalCoordinatesOn ()
virtual void	SphericalCoordinatesOff ()

virtual double	GetVerticalScale ()
virtual void	SetVerticalScale (double)
virtual double	GetVerticalBias ()
virtual void	SetVerticalBias (double)

virtual int	GetOutputType ()
virtual void	SetOutputType (int type)
void	SetOutputTypeToAutomatic ()
void	SetOutputTypeToImage ()
void	SetOutputTypeToRectilinear ()
void	SetOutputTypeToStructured ()
void	SetOutputTypeToUnstructured ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkNetCDFCFReader *	SafeDownCast (vtkObjectBase *o)
static vtkNetCDFCFReader *	New ()
static int	CanReadFile (const char *filename)
Protected Types
enum	CoordinateTypesEnum { COORDS_UNIFORM_RECTILINEAR, COORDS_NONUNIFORM_RECTILINEAR, COORDS_REGULAR_SPHERICAL, COORDS_2D_EUCLIDEAN, COORDS_2D_SPHERICAL, COORDS_EUCLIDEAN_4SIDED_CELLS, COORDS_SPHERICAL_4SIDED_CELLS, COORDS_EUCLIDEAN_PSIDED_CELLS, COORDS_SPHERICAL_PSIDED_CELLS }
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkNetCDFCFReader ()
	~vtkNetCDFCFReader ()
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)
vtkDimensionInfo *	GetDimensionInfo (int dimension)
vtkDependentDimensionInfo *	FindDependentDimensionInfo (vtkIntArray *dims)
CoordinateTypesEnum	CoordinateType (vtkIntArray *dimensions)
virtual bool	DimensionsAreForPointData (vtkIntArray *dimensions)
virtual void	GetUpdateExtentForOutput (vtkDataSet *output, int extent[6])

virtual int	ReadMetaData (int ncFD)
virtual int	IsTimeDimension (int ncFD, int dimId)
virtual vtkSmartPointer < vtkDoubleArray >	GetTimeValues (int ncFD, int dimId)

virtual void	IdentifySphericalCoordinates (vtkIntArray *dimensions, int &longitudeDim, int &latitudeDim, int &verticalDim)

void	ExtentForDimensionsAndPiece (int pieceNumber, int numberOfPieces, int ghostLevels, int extent[6])

void	AddRectilinearCoordinates (vtkImageData *imageOutput)
void	AddRectilinearCoordinates (vtkRectilinearGrid *rectilinearOutput)
void	Add1DRectilinearCoordinates (vtkPoints *points, const int extent[6])
void	Add2DRectilinearCoordinates (vtkPoints *points, const int extent[6])
void	Add1DRectilinearCoordinates (vtkStructuredGrid *structuredOutput)
void	Add2DRectilinearCoordinates (vtkStructuredGrid *structuredOutput)
void	Add1DRectilinearCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
void	Add2DRectilinearCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])

void	Add1DSphericalCoordinates (vtkPoints *points, const int extent[6])
void	Add2DSphericalCoordinates (vtkPoints *points, const int extent[6])
void	Add1DSphericalCoordinates (vtkStructuredGrid *structuredOutput)
void	Add2DSphericalCoordinates (vtkStructuredGrid *structuredOutput)
void	Add1DSphericalCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
void	Add2DSphericalCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])

void	AddStructuredCells (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])

void	AddUnstructuredRectilinearCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
void	AddUnstructuredSphericalCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
Protected Attributes
int	SphericalCoordinates
double	VerticalScale
double	VerticalBias
int	OutputType
vtkDimensionInfoVector *	DimensionInfo
vtkDependentDimensionInfoVector *	DependentDimensionInfo
Friends
class	vtkDimensionInfoVector
class	vtkDependentDimensionInfo
class	vtkDependentDimensionInfoVector

Detailed Description

Reads netCDF files that follow the CF convention. Details on this convention can be found at http://cf-pcmdi.llnl.gov/.

Tests:: vtkNetCDFCFReader (Tests)

Definition at line 49 of file vtkNetCDFCFReader.h.

Member Typedef Documentation

typedef vtkNetCDFReader vtkNetCDFCFReader::Superclass

Reimplemented from vtkNetCDFReader.

Definition at line 52 of file vtkNetCDFCFReader.h.

Member Enumeration Documentation

enum vtkNetCDFCFReader::CoordinateTypesEnum [protected]

Enumerator:

COORDS_UNIFORM_RECTILINEAR
COORDS_NONUNIFORM_RECTILINEAR
COORDS_REGULAR_SPHERICAL
COORDS_2D_EUCLIDEAN
COORDS_2D_SPHERICAL
COORDS_EUCLIDEAN_4SIDED_CELLS
COORDS_SPHERICAL_4SIDED_CELLS
COORDS_EUCLIDEAN_PSIDED_CELLS
COORDS_SPHERICAL_PSIDED_CELLS

Definition at line 226 of file vtkNetCDFCFReader.h.

Constructor & Destructor Documentation

vtkNetCDFCFReader::vtkNetCDFCFReader ( ) [protected]

vtkNetCDFCFReader::~vtkNetCDFCFReader ( ) [protected]

Member Function Documentation

static int vtkNetCDFCFReader::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 vtkNetCDFReader.

virtual int vtkNetCDFCFReader::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 vtkNetCDFReader.

static vtkNetCDFCFReader* vtkNetCDFCFReader::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkNetCDFReader.

virtual vtkObjectBase* vtkNetCDFCFReader::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkNetCDFReader.

vtkNetCDFCFReader* vtkNetCDFCFReader::NewInstance ( ) const

Reimplemented from vtkNetCDFReader.

static vtkNetCDFCFReader* vtkNetCDFCFReader::New ( ) [static]

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

Reimplemented from vtkNetCDFReader.

virtual void vtkNetCDFCFReader::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 vtkNetCDFReader.

virtual int vtkNetCDFCFReader::GetSphericalCoordinates ( ) [virtual]

If on (the default), then 3D data with latitude/longitude dimensions will be read in as curvilinear data shaped like spherical coordinates. If false, then the data will always be read in Cartesian coordinates.

virtual void vtkNetCDFCFReader::SetSphericalCoordinates ( int ) [virtual]

If on (the default), then 3D data with latitude/longitude dimensions will be read in as curvilinear data shaped like spherical coordinates. If false, then the data will always be read in Cartesian coordinates.

virtual void vtkNetCDFCFReader::SphericalCoordinatesOn ( ) [virtual]

If on (the default), then 3D data with latitude/longitude dimensions will be read in as curvilinear data shaped like spherical coordinates. If false, then the data will always be read in Cartesian coordinates.

virtual void vtkNetCDFCFReader::SphericalCoordinatesOff ( ) [virtual]

If on (the default), then 3D data with latitude/longitude dimensions will be read in as curvilinear data shaped like spherical coordinates. If false, then the data will always be read in Cartesian coordinates.

virtual double vtkNetCDFCFReader::GetVerticalScale ( ) [virtual]

The scale and bias of the vertical component of spherical coordinates. It is common to write the vertical component with respect to something other than the center of the sphere (for example, the surface). In this case, it might be necessary to scale and/or bias the vertical height. The height will become height*scale

bias. Keep in mind that if the positive attribute of the vertical dimension is down, then the height is negated. By default the scale is 1 and the bias is 0 (that is, no change). The scaling will be adjusted if it results in invalid (negative) vertical values.

virtual void vtkNetCDFCFReader::SetVerticalScale ( double ) [virtual]

The scale and bias of the vertical component of spherical coordinates. It is common to write the vertical component with respect to something other than the center of the sphere (for example, the surface). In this case, it might be necessary to scale and/or bias the vertical height. The height will become height*scale

bias. Keep in mind that if the positive attribute of the vertical dimension is down, then the height is negated. By default the scale is 1 and the bias is 0 (that is, no change). The scaling will be adjusted if it results in invalid (negative) vertical values.

virtual double vtkNetCDFCFReader::GetVerticalBias ( ) [virtual]

The scale and bias of the vertical component of spherical coordinates. It is common to write the vertical component with respect to something other than the center of the sphere (for example, the surface). In this case, it might be necessary to scale and/or bias the vertical height. The height will become height*scale

bias. Keep in mind that if the positive attribute of the vertical dimension is down, then the height is negated. By default the scale is 1 and the bias is 0 (that is, no change). The scaling will be adjusted if it results in invalid (negative) vertical values.

virtual void vtkNetCDFCFReader::SetVerticalBias ( double ) [virtual]

The scale and bias of the vertical component of spherical coordinates. It is common to write the vertical component with respect to something other than the center of the sphere (for example, the surface). In this case, it might be necessary to scale and/or bias the vertical height. The height will become height*scale

bias. Keep in mind that if the positive attribute of the vertical dimension is down, then the height is negated. By default the scale is 1 and the bias is 0 (that is, no change). The scaling will be adjusted if it results in invalid (negative) vertical values.

virtual int vtkNetCDFCFReader::GetOutputType ( ) [virtual]

Set/get the data type of the output. The index used is taken from the list of VTK data types in vtkType.h. Valid types are VTK_IMAGE_DATA, VTK_RECTILINEAR_GRID, VTK_STRUCTURED_GRID, and VTK_UNSTRUCTURED_GRID. In addition you can set the type to -1 (the default), and this reader will pick the data type best suited for the dimensions being read.

virtual void vtkNetCDFCFReader::SetOutputType ( int type ) [virtual]

Set/get the data type of the output. The index used is taken from the list of VTK data types in vtkType.h. Valid types are VTK_IMAGE_DATA, VTK_RECTILINEAR_GRID, VTK_STRUCTURED_GRID, and VTK_UNSTRUCTURED_GRID. In addition you can set the type to -1 (the default), and this reader will pick the data type best suited for the dimensions being read.

void vtkNetCDFCFReader::SetOutputTypeToAutomatic ( ) [inline]

Set/get the data type of the output. The index used is taken from the list of VTK data types in vtkType.h. Valid types are VTK_IMAGE_DATA, VTK_RECTILINEAR_GRID, VTK_STRUCTURED_GRID, and VTK_UNSTRUCTURED_GRID. In addition you can set the type to -1 (the default), and this reader will pick the data type best suited for the dimensions being read.

Definition at line 91 of file vtkNetCDFCFReader.h.

void vtkNetCDFCFReader::SetOutputTypeToImage ( ) [inline]

Set/get the data type of the output. The index used is taken from the list of VTK data types in vtkType.h. Valid types are VTK_IMAGE_DATA, VTK_RECTILINEAR_GRID, VTK_STRUCTURED_GRID, and VTK_UNSTRUCTURED_GRID. In addition you can set the type to -1 (the default), and this reader will pick the data type best suited for the dimensions being read.

Definition at line 92 of file vtkNetCDFCFReader.h.

void vtkNetCDFCFReader::SetOutputTypeToRectilinear ( ) [inline]

Set/get the data type of the output. The index used is taken from the list of VTK data types in vtkType.h. Valid types are VTK_IMAGE_DATA, VTK_RECTILINEAR_GRID, VTK_STRUCTURED_GRID, and VTK_UNSTRUCTURED_GRID. In addition you can set the type to -1 (the default), and this reader will pick the data type best suited for the dimensions being read.

Definition at line 93 of file vtkNetCDFCFReader.h.

void vtkNetCDFCFReader::SetOutputTypeToStructured ( ) [inline]

Set/get the data type of the output. The index used is taken from the list of VTK data types in vtkType.h. Valid types are VTK_IMAGE_DATA, VTK_RECTILINEAR_GRID, VTK_STRUCTURED_GRID, and VTK_UNSTRUCTURED_GRID. In addition you can set the type to -1 (the default), and this reader will pick the data type best suited for the dimensions being read.

Definition at line 94 of file vtkNetCDFCFReader.h.

void vtkNetCDFCFReader::SetOutputTypeToUnstructured ( ) [inline]

Set/get the data type of the output. The index used is taken from the list of VTK data types in vtkType.h. Valid types are VTK_IMAGE_DATA, VTK_RECTILINEAR_GRID, VTK_STRUCTURED_GRID, and VTK_UNSTRUCTURED_GRID. In addition you can set the type to -1 (the default), and this reader will pick the data type best suited for the dimensions being read.

Definition at line 95 of file vtkNetCDFCFReader.h.

static int vtkNetCDFCFReader::CanReadFile ( const char * filename ) [static]

Returns true if the given file can be read.

virtual int vtkNetCDFCFReader::RequestDataObject	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)		`[protected, virtual]`

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

Reimplemented from vtkNetCDFReader.

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

Reimplemented from vtkNetCDFReader.

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

Reimplemented from vtkNetCDFReader.

virtual int vtkNetCDFCFReader::ReadMetaData ( int ncFD ) [protected, virtual]

Interprets the special conventions of COARDS.

Reimplemented from vtkNetCDFReader.

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

Interprets the special conventions of COARDS.

Reimplemented from vtkNetCDFReader.

virtual vtkSmartPointer<vtkDoubleArray> vtkNetCDFCFReader::GetTimeValues	(	int	ncFD,
		int	dimId
	)		`[protected, virtual]`

Interprets the special conventions of COARDS.

Reimplemented from vtkNetCDFReader.

vtkDimensionInfo* vtkNetCDFCFReader::GetDimensionInfo ( int dimension ) [protected]

vtkDependentDimensionInfo* vtkNetCDFCFReader::FindDependentDimensionInfo ( vtkIntArray * dims ) [protected]

virtual void vtkNetCDFCFReader::IdentifySphericalCoordinates	(	vtkIntArray *	dimensions,
		int &	longitudeDim,
		int &	latitudeDim,
		int &	verticalDim
	)		`[protected, virtual]`

Given the list of dimensions, identify the longitude, latitude, and vertical dimensions. -1 is returned for any not found. The results depend on the values in this->DimensionInfo.

CoordinateTypesEnum vtkNetCDFCFReader::CoordinateType ( vtkIntArray * dimensions ) [protected]

Based on the given dimensions and the current state of the reader, returns how the coordinates should be interpreted. The returned value is one of the CoordinateTypesEnum identifiers.

virtual bool vtkNetCDFCFReader::DimensionsAreForPointData ( vtkIntArray * dimensions ) [protected, virtual]

Returns false for spherical dimensions, which should use cell data.

void vtkNetCDFCFReader::ExtentForDimensionsAndPiece	(	int	pieceNumber,
		int	numberOfPieces,
		int	ghostLevels,
		int	extent[6]
	)		`[protected]`

Convenience function that takes piece information and then returns a set of extents to load based on this->WholeExtent. The result is returned in extent.

virtual void vtkNetCDFCFReader::GetUpdateExtentForOutput	(	vtkDataSet *	output,
		int	extent[6]
	)		`[protected, virtual]`

Overridden to retrieve stored extent for unstructured data.

Reimplemented from vtkNetCDFReader.

void vtkNetCDFCFReader::AddRectilinearCoordinates ( vtkImageData * imageOutput ) [protected]