vtkNetCDFCFReader Class Reference
#include <vtkNetCDFCFReader.h>
Detailed Description
Reads netCDF files that follow the CF convention. Details on this convention can be found at <http://cf-pcmdi.llnl.gov/>.
Definition at line 44 of file vtkNetCDFCFReader.h.
Public Types | |
| typedef vtkNetCDFReader | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| 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) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkNetCDFCFReader * | SafeDownCast (vtkObject *o) |
| static vtkNetCDFCFReader * | New () |
| static int | CanReadFile (const char *filename) |
Protected Member Functions | |
| vtkNetCDFCFReader () | |
| ~vtkNetCDFCFReader () | |
| virtual int | RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
| virtual int | RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
| vtkDimensionInfo * | GetDimensionInfo (int dimension) |
| vtkDependentDimensionInfo * | FindDependentDimensionInfo (vtkIntArray *dims) |
| vtkDependentDimensionInfo * | FindDependentDimensionInfo (const int *dims, int numDims) |
| virtual int | ReadMetaData (int ncFD) |
| virtual int | IsTimeDimension (int ncFD, int dimId) |
| virtual vtkSmartPointer < vtkDoubleArray > | GetTimeValues (int ncFD, int dimId) |
| virtual void | IdentifySphericalCoordinates (const int *dimensions, int numDimensions, int &longitudeDim, int &latitudeDim, int &verticalDim) |
| bool | CoordinatesAreSpherical (const int *dimensions, int numDimensions) |
| virtual bool | DimensionsAreForPointData (const int *dimensions, int numDimensions) |
| void | Add1DSphericalCoordinates (vtkStructuredGrid *structOutput) |
| void | Add2DSphericalCoordinates (vtkStructuredGrid *structOutput) |
Protected Attributes | |
| int | SphericalCoordinates |
| double | VerticalScale |
| double | VerticalBias |
| vtkDimensionInfoVector * | DimensionInfo |
| vtkDependentDimensionInfoVector * | DependentDimensionInfo |
Friends | |
| class | vtkDimensionInfoVector |
| class | vtkDependentDimensionInfo |
| class | vtkDependentDimensionInfoVector |
Classes | |
| class | vtkDependentDimensionInfo |
| class | vtkDimensionInfo |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkNetCDFCFReader::vtkNetCDFCFReader | ( | ) | [protected] |
| vtkNetCDFCFReader::~vtkNetCDFCFReader | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkNetCDFCFReader::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkNetCDFReader.
| 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 | ( | vtkObject * | o | ) | [static] |
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.
| 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::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] |
| vtkDependentDimensionInfo* vtkNetCDFCFReader::FindDependentDimensionInfo | ( | const int * | dims, | |
| int | numDims | |||
| ) | [protected] |
| virtual void vtkNetCDFCFReader::IdentifySphericalCoordinates | ( | const int * | dimensions, | |
| int | numDimensions, | |||
| 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.
| bool vtkNetCDFCFReader::CoordinatesAreSpherical | ( | const int * | dimensions, | |
| int | numDimensions | |||
| ) | [inline, protected] |
Convienience function that returns true if the given dimensions can be used as spherical coordinates, false otherwise.
Definition at line 199 of file vtkNetCDFCFReader.h.
| virtual bool vtkNetCDFCFReader::DimensionsAreForPointData | ( | const int * | dimensions, | |
| int | numDimensions | |||
| ) | [inline, protected, virtual] |
Returns false for spherical dimensions, which should use cell data.
Definition at line 223 of file vtkNetCDFCFReader.h.
| void vtkNetCDFCFReader::Add1DSphericalCoordinates | ( | vtkStructuredGrid * | structOutput | ) | [protected] |
Internal methods for setting spherical coordiantes.
| void vtkNetCDFCFReader::Add2DSphericalCoordinates | ( | vtkStructuredGrid * | structOutput | ) | [protected] |
Convienience function that returns true if the given dimensions can be used as spherical coordinates, false otherwise.
Friends And Related Function Documentation
friend class vtkDimensionInfoVector [friend] |
Definition at line 139 of file vtkNetCDFCFReader.h.
friend class vtkDependentDimensionInfo [friend] |
Definition at line 173 of file vtkNetCDFCFReader.h.
friend class vtkDependentDimensionInfoVector [friend] |
Definition at line 174 of file vtkNetCDFCFReader.h.
Member Data Documentation
int vtkNetCDFCFReader::SphericalCoordinates [protected] |
Definition at line 84 of file vtkNetCDFCFReader.h.
double vtkNetCDFCFReader::VerticalScale [protected] |
Definition at line 86 of file vtkNetCDFCFReader.h.
double vtkNetCDFCFReader::VerticalBias [protected] |
Definition at line 87 of file vtkNetCDFCFReader.h.
vtkDimensionInfoVector* vtkNetCDFCFReader::DimensionInfo [protected] |
Definition at line 141 of file vtkNetCDFCFReader.h.
vtkDependentDimensionInfoVector* vtkNetCDFCFReader::DependentDimensionInfo [protected] |
Definition at line 176 of file vtkNetCDFCFReader.h.
The documentation for this class was generated from the following file:
- dox/IO/vtkNetCDFCFReader.h
