Reads netCDF files that follow the CF convention. More...

#include <vtkNetCDFCFReader.h>

Inheritance diagram for vtkNetCDFCFReader:

Collaboration diagram for vtkNetCDFCFReader:

Classes
class	vtkDependentDimensionInfo

class	vtkDimensionInfo

Public Types
typedef vtkNetCDFReader	Superclass

Public Types inherited from vtkNetCDFReader
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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkNetCDFCFReader *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...


virtual int	GetSphericalCoordinates ()
	If on (the default), then 3D data with latitude/longitude dimensions will be read in as curvilinear data shaped like spherical coordinates. More...

virtual void	SetSphericalCoordinates (int)
	If on (the default), then 3D data with latitude/longitude dimensions will be read in as curvilinear data shaped like spherical coordinates. More...

virtual void	SphericalCoordinatesOn ()
	If on (the default), then 3D data with latitude/longitude dimensions will be read in as curvilinear data shaped like spherical coordinates. More...

virtual void	SphericalCoordinatesOff ()
	If on (the default), then 3D data with latitude/longitude dimensions will be read in as curvilinear data shaped like spherical coordinates. More...


virtual double	GetVerticalScale ()
	The scale and bias of the vertical component of spherical coordinates. More...

virtual void	SetVerticalScale (double)
	The scale and bias of the vertical component of spherical coordinates. More...

virtual double	GetVerticalBias ()
	The scale and bias of the vertical component of spherical coordinates. More...

virtual void	SetVerticalBias (double)
	The scale and bias of the vertical component of spherical coordinates. More...


virtual int	GetOutputType ()
	Set/get the data type of the output. More...

virtual void	SetOutputType (int type)
	Set/get the data type of the output. More...

void	SetOutputTypeToAutomatic ()
	Set/get the data type of the output. More...

void	SetOutputTypeToImage ()
	Set/get the data type of the output. More...

void	SetOutputTypeToRectilinear ()
	Set/get the data type of the output. More...

void	SetOutputTypeToStructured ()
	Set/get the data type of the output. More...

void	SetOutputTypeToUnstructured ()
	Set/get the data type of the output. More...

Public Member Functions inherited from vtkNetCDFReader
vtkNetCDFReader *	NewInstance () const

virtual void	SetFileName (const char *filename)

virtual char *	GetFileName ()

int	UpdateMetaData ()
	Update the meta data from the current file. More...

virtual vtkStringArray *	GetAllVariableArrayNames ()
	Convenience method to get a list of variable arrays. More...

virtual void	SetDimensions (const char *dimensions)
	Loads the grid with the given dimensions. More...

std::string	QueryArrayUnits (const char *ArrayName)
	Get units attached to a particular array in the netcdf file. More...

virtual int	GetNumberOfVariableArrays ()
	Variable array selection. More...

virtual const char *	GetVariableArrayName (int idx)
	Variable array selection. More...

virtual int	GetVariableArrayStatus (const char *name)
	Variable array selection. More...

virtual void	SetVariableArrayStatus (const char *name, int status)
	Variable array selection. More...

virtual vtkStringArray *	GetVariableDimensions ()
	Returns an array with string encodings for the dimensions used in each of the variables. More...

virtual vtkStringArray *	GetAllDimensions ()
	Returns an array with string encodings for the dimension combinations used in the variables. More...

virtual int	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 (int)
	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	ReplaceFillValueWithNanOn ()
	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	ReplaceFillValueWithNanOff ()
	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 char *	GetTimeUnits ()
	Access to the time dimensions units. More...

virtual char *	GetCalendar ()
	Access to the time dimensions units. More...

Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithm *	NewInstance () const

int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details More...

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetOutput ()
	Get the output data object for a port on this algorithm. More...

vtkDataObject *	GetOutput (int)
	Get the output data object for a port on this algorithm. More...

virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm. More...

void	SetInputData (vtkDataObject *)
	Assign a data object as input. More...

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input. More...

void	AddInputData (vtkDataObject *)
	Assign a data object as input. More...

void	AddInputData (int, vtkDataObject *)
	Assign a data object as input. More...

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

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

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

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	UpdateProgress (double amount)
	Update the progress of the process object. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

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)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

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

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual int	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 int	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]=0)
	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]=0)
	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...

int	SetUpdateExtentToWholeExtent (int port)
	If the whole output extent is required, this method can be called to set the output update extent to the whole extent. More...

int	SetUpdateExtentToWholeExtent ()
	Convenience function equivalent to SetUpdateExtentToWholeExtent(0) This method assumes that the whole extent is known (that UpdateInformation has been called). More...

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
	Set the output update extent in terms of piece and ghost levels. More...

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
	Convenience function equivalent to SetUpdateExtent(0, piece, numPieces, ghostLevel) More...

void	SetUpdateExtent (int port, int extent[6])
	Set the output update extent for data objects that use 3D extents. More...

void	SetUpdateExtent (int extent[6])
	Convenience function equivalent to SetUpdateExtent(0, extent) More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (int)
	Set/Get the AbortExecute flag for the process object. More...

virtual int	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

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)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

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)
	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 *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

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

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkNetCDFCFReader *	SafeDownCast (vtkObjectBase *o)

static vtkNetCDFCFReader *	New ()

static int	CanReadFile (const char *filename)
	Returns true if the given file can be read. More...

Static Public Member Functions inherited from vtkNetCDFReader
static int	IsTypeOf (const char *type)

static vtkNetCDFReader *	SafeDownCast (vtkObjectBase *o)

static vtkNetCDFReader *	New ()

Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObjectAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_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 vtkInformationIntegerKey *	CAN_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 vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

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)
	This is called by the superclass. More...

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)

virtual void	IdentifySphericalCoordinates (vtkIntArray *dimensions, int &longitudeDim, int &latitudeDim, int &verticalDim)
	Given the list of dimensions, identify the longitude, latitude, and vertical dimensions. More...

CoordinateTypesEnum	CoordinateType (vtkIntArray *dimensions)
	Based on the given dimensions and the current state of the reader, returns how the coordinates should be interpreted. More...

virtual bool	DimensionsAreForPointData (vtkIntArray *dimensions)
	Returns false for spherical dimensions, which should use cell data. More...

void	ExtentForDimensionsAndPiece (int pieceNumber, int numberOfPieces, int ghostLevels, int extent[6])
	Convenience function that takes piece information and then returns a set of extents to load based on this->WholeExtent. More...

virtual void	GetUpdateExtentForOutput (vtkDataSet *output, int extent[6])
	Overridden to retrieve stored extent for unstructured data. More...

void	AddStructuredCells (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
	Internal method for building unstructred cells that match structured cells. More...


virtual int	ReadMetaData (int ncFD)
	Interprets the special conventions of COARDS. More...

virtual int	IsTimeDimension (int ncFD, int dimId)
	Interprets the special conventions of COARDS. More...

virtual vtkSmartPointer< vtkDoubleArray >	GetTimeValues (int ncFD, int dimId)
	Interprets the special conventions of COARDS. More...


void	AddRectilinearCoordinates (vtkImageData *imageOutput)
	Internal methods for setting rectilinear coordinates. More...

void	AddRectilinearCoordinates (vtkRectilinearGrid *rectilinearOutput)
	Internal methods for setting rectilinear coordinates. More...

void	FakeRectilinearCoordinates (vtkRectilinearGrid *rectilinearOutput)
	Internal methods for setting rectilinear coordinates. More...

void	Add1DRectilinearCoordinates (vtkPoints *points, const int extent[6])
	Internal methods for setting rectilinear coordinates. More...

void	Add2DRectilinearCoordinates (vtkPoints *points, const int extent[6])
	Internal methods for setting rectilinear coordinates. More...

void	Add1DRectilinearCoordinates (vtkStructuredGrid *structuredOutput)
	Internal methods for setting rectilinear coordinates. More...

void	Add2DRectilinearCoordinates (vtkStructuredGrid *structuredOutput)
	Internal methods for setting rectilinear coordinates. More...

void	FakeStructuredCoordinates (vtkStructuredGrid *structuredOutput)
	Internal methods for setting rectilinear coordinates. More...

void	Add1DRectilinearCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
	Internal methods for setting rectilinear coordinates. More...

void	Add2DRectilinearCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
	Internal methods for setting rectilinear coordinates. More...


void	Add1DSphericalCoordinates (vtkPoints *points, const int extent[6])
	Internal methods for setting spherical coordinates. More...

void	Add2DSphericalCoordinates (vtkPoints *points, const int extent[6])
	Internal methods for setting spherical coordinates. More...

void	Add1DSphericalCoordinates (vtkStructuredGrid *structuredOutput)
	Internal methods for setting spherical coordinates. More...

void	Add2DSphericalCoordinates (vtkStructuredGrid *structuredOutput)
	Internal methods for setting spherical coordinates. More...

void	Add1DSphericalCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
	Internal methods for setting spherical coordinates. More...

void	Add2DSphericalCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
	Internal methods for setting spherical coordinates. More...


void	AddUnstructuredRectilinearCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
	Internal methods for creating unstructured cells. More...

void	AddUnstructuredSphericalCoordinates (vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
	Internal methods for creating unstructured cells. More...

Protected Member Functions inherited from vtkNetCDFReader
	vtkNetCDFReader ()

	~vtkNetCDFReader ()

vtkStdString	DescribeDimensions (int ncFD, const int *dimIds, int numDims)
	Convenience function for getting a string that describes a set of dimensions. More...

virtual int	FillVariableDimensions (int ncFD)
	Fills the VariableDimensions array. 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 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...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. 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)

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)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (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...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (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...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	SphericalCoordinates

double	VerticalScale

double	VerticalBias

int	OutputType

vtkDimensionInfoVector *	DimensionInfo

vtkDependentDimensionInfoVector *	DependentDimensionInfo

Protected Attributes inherited from vtkNetCDFReader
char *	FileName

vtkTimeStamp	FileNameMTime

vtkTimeStamp	MetaDataMTime

vtkSmartPointer< vtkIntArray >	LoadingDimensions
	The dimension ids of the arrays being loaded into the data. More...

vtkSmartPointer< vtkDataArraySelection >	VariableArraySelection

vtkSmartPointer< vtkStringArray >	AllVariableArrayNames

vtkStringArray *	VariableDimensions
	Placeholder for structure returned from GetVariableDimensions(). More...

vtkStringArray *	AllDimensions
	Placeholder for structure returned from GetAllDimensions(). More...

int	ReplaceFillValueWithNan

int	WholeExtent [6]

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkDimensionInfoVector

class	vtkDependentDimensionInfo

class	vtkDependentDimensionInfoVector

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkNetCDFReader
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 vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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 50 of file vtkNetCDFCFReader.h.

Member Typedef Documentation

typedef vtkNetCDFReader vtkNetCDFCFReader::Superclass

Definition at line 53 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 231 of file vtkNetCDFCFReader.h.

Constructor & Destructor Documentation

vtkNetCDFCFReader::vtkNetCDFCFReader ( )

protected

vtkNetCDFCFReader::~vtkNetCDFCFReader ( )

protected

Member Function Documentation

static int vtkNetCDFCFReader::IsTypeOf ( const char * type )

static

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

virtual vtkObjectBase* vtkNetCDFCFReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkNetCDFReader.

vtkNetCDFCFReader* vtkNetCDFCFReader::NewInstance ( ) const

static vtkNetCDFCFReader* vtkNetCDFCFReader::New ( )

static

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 96 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 97 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 98 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 99 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 100 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 *
	)

protectedvirtual

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
	)

protectedvirtual

Reimplemented from vtkNetCDFReader.

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

protectedvirtual

Reimplemented from vtkNetCDFReader.

virtual int vtkNetCDFCFReader::ReadMetaData ( int ncFD )

protectedvirtual

Interprets the special conventions of COARDS.

Reimplemented from vtkNetCDFReader.

virtual int vtkNetCDFCFReader::IsTimeDimension	(	int	ncFD,
		int	dimId
	)

protectedvirtual

Interprets the special conventions of COARDS.

Reimplemented from vtkNetCDFReader.

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

protectedvirtual

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
	)

protectedvirtual

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 )

protectedvirtual

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

protectedvirtual

Overridden to retrieve stored extent for unstructured data.

Reimplemented from vtkNetCDFReader.

void vtkNetCDFCFReader::AddRectilinearCoordinates ( vtkImageData * imageOutput )

protected