Read VTK HDF files. More...

#include <vtkHDFReader.h>

Inheritance diagram for vtkHDFReader:

Collaboration diagram for vtkHDFReader:

Classes
class	Implementation
	Implementation for the vtkHDFReader. More...

Public Types
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 vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkHDFReader *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual int	CanReadFile (VTK_FILEPATH const char *name)
	Test whether the file (type) with the given name can be read by this reader.

	vtkSetFilePathMacro (FileName)
	Get/Set the name of the input file.
	vtkGetFilePathMacro (FileName)
	Get/Set the name of the input file.

vtkDataSet *	GetOutputAsDataSet ()
	Get the output as a vtkDataSet pointer.
vtkDataSet *	GetOutputAsDataSet (int index)
	Get the output as a vtkDataSet pointer.

virtual vtkDataArraySelection *	GetPointDataArraySelection ()
	Get the data array selection tables used to configure which data arrays are loaded by the reader.
virtual vtkDataArraySelection *	GetCellDataArraySelection ()
	Get the data array selection tables used to configure which data arrays are loaded by the reader.
virtual vtkDataArraySelection *	GetFieldDataArraySelection ()
	Get the data array selection tables used to configure which data arrays are loaded by the reader.

int	GetNumberOfPointArrays ()
	Get the number of point or cell arrays available in the input.
int	GetNumberOfCellArrays ()
	Get the number of point or cell arrays available in the input.

const char *	GetPointArrayName (int index)
	Get the name of the point or cell array with the given index in the input.
const char *	GetCellArrayName (int index)
	Get the name of the point or cell array with the given index in the input.

virtual bool	GetHasTransientData ()
	Getters and setters for temporal data.
bool	GetHasTemporalData ()
	Getters and setters for temporal data.
virtual vtkIdType	GetNumberOfSteps ()
	Getters and setters for temporal data.
virtual vtkIdType	GetStep ()
	Getters and setters for temporal data.
virtual void	SetStep (vtkIdType)
	Getters and setters for temporal data.
virtual double	GetTimeValue ()
	Getters and setters for temporal data.
const std::array< double, 2 > &	GetTimeRange () const
	Getters and setters for temporal data.

virtual bool	GetUseCache ()
	Boolean property determining whether to use the internal cache or not (default is false).
virtual void	SetUseCache (bool)
	Boolean property determining whether to use the internal cache or not (default is false).
virtual void	UseCacheOn ()
	Boolean property determining whether to use the internal cache or not (default is false).
virtual void	UseCacheOff ()
	Boolean property determining whether to use the internal cache or not (default is false).

virtual bool	GetMergeParts ()
	/!
virtual void	SetMergeParts (bool)
	/!
virtual void	MergePartsOn ()
	/!
virtual void	MergePartsOff ()
	/!

virtual void	SetMaximumLevelsToReadByDefaultForAMR (unsigned int)
	Choose the maximum level to read for AMR structures.
virtual unsigned int	GetMaximumLevelsToReadByDefaultForAMR ()
	Choose the maximum level to read for AMR structures.

std::string	GetAttributeOriginalIdName (vtkIdType attribute)
	Get or Set the Original id name of an attribute (POINT, CELL, FIELD...).
void	SetAttributeOriginalIdName (vtkIdType attribute, const std::string &name)
	Get or Set the Original id name of an attribute (POINT, CELL, FIELD...).
Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithm *	NewInstance () const
vtkTypeBool	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkDataObject *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
void	AddInputData (vtkDataObject *)
	Assign a data object as input.
void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
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.
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.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.
void	UpdateProgress (double amount)
	Update the progress of the process object.
bool	CheckAbort ()
	Checks to see if this filter should abort.
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
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.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0).
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0).
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	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).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
bool	UsesGarbageCollector () const override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.
vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.
virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.
virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
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.
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.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
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.
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.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkHDFReader *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkHDFReader *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkDataObjectAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
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.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey *	ABORTED ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkHDFReader ()
	~vtkHDFReader () override
int	CanReadFileVersion (int major, int minor)
	Test if the reader can read a file with the given version number.
int	Read (const std::vector< vtkIdType > &numberOfPoints, const std::vector< vtkIdType > &numberOfCells, const std::vector< vtkIdType > &numberOfConnectivityIds, vtkIdType partOffset, vtkIdType startingPointOffset, vtkIdType startingCellOffset, vtkIdType startingConnectctivityIdOffset, int filePiece, vtkUnstructuredGrid *pieceData)
	Read 'pieceData' specified by 'filePiece' where number of points, cells and connectivity ids store those numbers for all pieces.
int	AddFieldArrays (vtkDataObject *data)
	Read the field arrays from the file and add them to the dataset.
void	PrintPieceInformation (vtkInformation *outInfo)
	Print update number of pieces, piece number and ghost levels.
int	SetupInformation (vtkInformation *outInfo)
	Setup the information pass in parameter based on current vtkHDF file loaded.

int	Read (vtkInformation outInfo, vtkImageData data)
	Reads the 'data' requested in 'outInfo' (through extents or pieces) for a specialized data type.
int	Read (vtkInformation outInfo, vtkUnstructuredGrid data, vtkPartitionedDataSet *pData)
	Reads the 'data' requested in 'outInfo' (through extents or pieces) for a specialized data type.
int	Read (vtkInformation outInfo, vtkPolyData data, vtkPartitionedDataSet *pData)
	Reads the 'data' requested in 'outInfo' (through extents or pieces) for a specialized data type.
int	Read (vtkInformation outInfo, vtkHyperTreeGrid data, vtkPartitionedDataSet *pData)
	Reads the 'data' requested in 'outInfo' (through extents or pieces) for a specialized data type.
int	Read (vtkInformation outInfo, vtkOverlappingAMR data)
	Reads the 'data' requested in 'outInfo' (through extents or pieces) for a specialized data type.
int	Read (vtkInformation outInfo, vtkPartitionedDataSetCollection data)
	Reads the 'data' requested in 'outInfo' (through extents or pieces) for a specialized data type.
int	Read (vtkInformation outInfo, vtkMultiBlockDataSet data)
	Reads the 'data' requested in 'outInfo' (through extents or pieces) for a specialized data type.
int	ReadRecursively (vtkInformation outInfo, vtkMultiBlockDataSet data, const std::string &path)
	Reads the 'data' requested in 'outInfo' (through extents or pieces) for a specialized data type.

int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	Standard functions to specify the type, information and read the data from the file.
int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	Standard functions to specify the type, information and read the data from the file.
int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	Standard functions to specify the type, information and read the data from the file.
Protected Member Functions inherited from vtkDataObjectAlgorithm
	vtkDataObjectAlgorithm ()
	~vtkDataObjectAlgorithm () override
virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.
virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )
int	FillOutputPortInformation (int port, vtkInformation *info) override
int	FillInputPortInformation (int port, vtkInformation *info) override
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=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	SelectionModifiedCallback (vtkObject caller, unsigned long eid, void clientdata, void *calldata)
	Modify this object when an array selection is changed.
Static Protected Member Functions inherited from vtkDataObjectAlgorithm
static bool	SetOutputDataObject (int dataType, vtkInformation *outputInformation, bool exact=false)
	A helper method that can be used by subclasses in RequestDataObject to create an output data object of the given type if not already present.
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
char *	FileName
	The input file's name.
vtkDataArraySelection *	DataArraySelection [3]
	The array selections.
vtkCallbackCommand *	SelectionObserver
	The observer to modify this object when the array selections are modified.
bool	MergeParts = false
	/!
unsigned int	MaximumLevelsToReadByDefaultForAMR = 0
bool	UseCache = false
std::shared_ptr< DataCache >	Cache

vtkSmartPointer< vtkDataAssembly >	Assembly
	Assembly used for PartitionedDataSetCollection.
bool	HasTransientData = false
	Temporal data properties.
vtkIdType	Step = 0
	Assembly used for PartitionedDataSetCollection.
vtkIdType	NumberOfSteps = 1
	Assembly used for PartitionedDataSetCollection.
double	TimeValue = 0.0
	Assembly used for PartitionedDataSetCollection.
std::array< double, 2 >	TimeRange
	Assembly used for PartitionedDataSetCollection.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
enum vtkAlgorithm::DesiredOutputPrecision	RemoveNoPriorTemporalAccessInformationKey
std::atomic< vtkTypeBool >	AbortExecute

Detailed Description

Read VTK HDF files.

Reader for data saved using the VTKHDF format, supporting image data, poly data, unstructured grid, overlapping AMR, hyper tree grid, partitioned dataset collection and multiblock.

Serial and parallel reading are supported, with the possibility of piece selection.

This reader provides an internal cache with the UseCache option, improving read performance for temporal datasets when the geometry is constant between time steps.

For non-composite datasets, constant geometry does not change the MeshMTime between time steps.

Major version of the specification should be incremented when older readers can no longer read files written for this reader. Minor versions are for added functionality that can be safely ignored by older readers.

Note: vtkHDF file format is defined here : https://docs.vtk.org/en/latest/design_documents/VTKFileFormats.html#hdf-file-formats

Tests:: vtkHDFReader (Tests)

Definition at line 69 of file vtkHDFReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObjectAlgorithm vtkHDFReader::Superclass

Definition at line 73 of file vtkHDFReader.h.

Constructor & Destructor Documentation

◆ vtkHDFReader()

vtkHDFReader::vtkHDFReader ( )

protected

◆ ~vtkHDFReader()

vtkHDFReader::~vtkHDFReader ( )

overrideprotected

Member Function Documentation

◆ New()

vtkHDFReader * vtkHDFReader::New ( )

static

◆ IsTypeOf()

vtkTypeBool vtkHDFReader::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkHDFReader::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.

◆ SafeDownCast()

vtkHDFReader * vtkHDFReader::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkHDFReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ NewInstance()

vtkHDFReader * vtkHDFReader::NewInstance ( ) const

◆ PrintSelf()

void vtkHDFReader::PrintSelf	(	ostream &	os,
		vtkIndent	indent )

overridevirtual

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.

◆ vtkSetFilePathMacro()

vtkHDFReader::vtkSetFilePathMacro ( FileName )

Get/Set the name of the input file.

◆ vtkGetFilePathMacro()

vtkHDFReader::vtkGetFilePathMacro ( FileName )

Get/Set the name of the input file.

◆ CanReadFile()

virtual int vtkHDFReader::CanReadFile ( VTK_FILEPATH const char * name )

virtual

Test whether the file (type) with the given name can be read by this reader.

If the file has a newer version than the reader, we still say we can read the file type and we fail later, when we try to read the file. This enables clients (ParaView) to distinguish between failures when we need to look for another reader and failures when we don't.

◆ GetOutputAsDataSet() [1/2]

vtkDataSet * vtkHDFReader::GetOutputAsDataSet ( )

Get the output as a vtkDataSet pointer.

◆ GetOutputAsDataSet() [2/2]

vtkDataSet * vtkHDFReader::GetOutputAsDataSet ( int index )

Get the output as a vtkDataSet pointer.

◆ GetPointDataArraySelection()

virtual vtkDataArraySelection * vtkHDFReader::GetPointDataArraySelection ( )

virtual

Get the data array selection tables used to configure which data arrays are loaded by the reader.

◆ GetCellDataArraySelection()

virtual vtkDataArraySelection * vtkHDFReader::GetCellDataArraySelection ( )

virtual

Get the data array selection tables used to configure which data arrays are loaded by the reader.

◆ GetFieldDataArraySelection()

virtual vtkDataArraySelection * vtkHDFReader::GetFieldDataArraySelection ( )

virtual

Get the data array selection tables used to configure which data arrays are loaded by the reader.

◆ GetNumberOfPointArrays()

int vtkHDFReader::GetNumberOfPointArrays ( )

Get the number of point or cell arrays available in the input.

◆ GetNumberOfCellArrays()

int vtkHDFReader::GetNumberOfCellArrays ( )

Get the number of point or cell arrays available in the input.

◆ GetPointArrayName()

const char * vtkHDFReader::GetPointArrayName ( int index )

Get the name of the point or cell array with the given index in the input.

◆ GetCellArrayName()

const char * vtkHDFReader::GetCellArrayName ( int index )

Get the name of the point or cell array with the given index in the input.

◆ GetHasTransientData()

virtual bool vtkHDFReader::GetHasTransientData ( )

virtual

Getters and setters for temporal data.

HasTemporalData is a boolean that flags whether the file has temporal data
NumberOfSteps is the number of time steps contained in the file
Step is the time step to be read or last read by the reader
TimeValue is the value corresponding to the Step property
TimeRange is an array with the {min, max} values of time for the data

◆ GetHasTemporalData()

bool vtkHDFReader::GetHasTemporalData ( )

Getters and setters for temporal data.

HasTemporalData is a boolean that flags whether the file has temporal data
NumberOfSteps is the number of time steps contained in the file
Step is the time step to be read or last read by the reader
TimeValue is the value corresponding to the Step property
TimeRange is an array with the {min, max} values of time for the data

◆ GetNumberOfSteps()

virtual vtkIdType vtkHDFReader::GetNumberOfSteps ( )

virtual

Getters and setters for temporal data.

HasTemporalData is a boolean that flags whether the file has temporal data
NumberOfSteps is the number of time steps contained in the file
Step is the time step to be read or last read by the reader
TimeValue is the value corresponding to the Step property
TimeRange is an array with the {min, max} values of time for the data

◆ GetStep()

virtual vtkIdType vtkHDFReader::GetStep ( )

virtual

Getters and setters for temporal data.

HasTemporalData is a boolean that flags whether the file has temporal data
NumberOfSteps is the number of time steps contained in the file
Step is the time step to be read or last read by the reader
TimeValue is the value corresponding to the Step property
TimeRange is an array with the {min, max} values of time for the data

◆ SetStep()

virtual void vtkHDFReader::SetStep ( vtkIdType )

virtual

Getters and setters for temporal data.

HasTemporalData is a boolean that flags whether the file has temporal data
NumberOfSteps is the number of time steps contained in the file
Step is the time step to be read or last read by the reader
TimeValue is the value corresponding to the Step property
TimeRange is an array with the {min, max} values of time for the data

◆ GetTimeValue()

virtual double vtkHDFReader::GetTimeValue ( )

virtual

Getters and setters for temporal data.

HasTemporalData is a boolean that flags whether the file has temporal data
NumberOfSteps is the number of time steps contained in the file
Step is the time step to be read or last read by the reader
TimeValue is the value corresponding to the Step property
TimeRange is an array with the {min, max} values of time for the data

◆ GetTimeRange()

const std::array< double, 2 > & vtkHDFReader::GetTimeRange ( ) const

inline

Getters and setters for temporal data.

HasTemporalData is a boolean that flags whether the file has temporal data
NumberOfSteps is the number of time steps contained in the file
Step is the time step to be read or last read by the reader
TimeValue is the value corresponding to the Step property
TimeRange is an array with the {min, max} values of time for the data

Definition at line 144 of file vtkHDFReader.h.

◆ GetUseCache()

virtual bool vtkHDFReader::GetUseCache ( )

virtual

Boolean property determining whether to use the internal cache or not (default is false).

Internal cache is useful when reading temporal data to never re-read something that has already been cached.

Note: Incompatible with MergeParts as vtkAppendDataSet which is used internally doesn't support static mesh.

◆ SetUseCache()

virtual void vtkHDFReader::SetUseCache ( bool )

virtual

Boolean property determining whether to use the internal cache or not (default is false).

Internal cache is useful when reading temporal data to never re-read something that has already been cached.

Note: Incompatible with MergeParts as vtkAppendDataSet which is used internally doesn't support static mesh.

◆ UseCacheOn()

virtual void vtkHDFReader::UseCacheOn ( )

virtual

Boolean property determining whether to use the internal cache or not (default is false).

Internal cache is useful when reading temporal data to never re-read something that has already been cached.

Note: Incompatible with MergeParts as vtkAppendDataSet which is used internally doesn't support static mesh.

◆ UseCacheOff()

virtual void vtkHDFReader::UseCacheOff ( )

virtual

Boolean property determining whether to use the internal cache or not (default is false).

Internal cache is useful when reading temporal data to never re-read something that has already been cached.

Note: Incompatible with MergeParts as vtkAppendDataSet which is used internally doesn't support static mesh.

◆ GetMergeParts()

virtual bool vtkHDFReader::GetMergeParts ( )

virtual

/!

\ Now deprecated due to its limitations regarding cache, please do not use! Settings this flag will have no effect. This option can be replaced by the vtkMergeBlocks filter.

Boolean property determining whether to merge partitions when reading unstructured data.

Merging partitions (true) allows the reader to return either vtkUnstructuredGrid or vtkPolyData directly while not merging (false) them returns a vtkPartitionedDataSet. It is advised to set this value to false when using the internal cache (UseCache == true) since the partitions are what are stored in the cache and merging them before outputting would effectively double the memory constraints.

Default is false

Note: Incompatible with UseCache as vtkAppendDataSet which is used internally doesn't support static mesh.

◆ SetMergeParts()

virtual void vtkHDFReader::SetMergeParts ( bool )

virtual

/!

\ Now deprecated due to its limitations regarding cache, please do not use! Settings this flag will have no effect. This option can be replaced by the vtkMergeBlocks filter.

Boolean property determining whether to merge partitions when reading unstructured data.

Merging partitions (true) allows the reader to return either vtkUnstructuredGrid or vtkPolyData directly while not merging (false) them returns a vtkPartitionedDataSet. It is advised to set this value to false when using the internal cache (UseCache == true) since the partitions are what are stored in the cache and merging them before outputting would effectively double the memory constraints.

Default is false

Note: Incompatible with UseCache as vtkAppendDataSet which is used internally doesn't support static mesh.

◆ MergePartsOn()

virtual void vtkHDFReader::MergePartsOn ( )

virtual

/!

\ Now deprecated due to its limitations regarding cache, please do not use! Settings this flag will have no effect. This option can be replaced by the vtkMergeBlocks filter.

Boolean property determining whether to merge partitions when reading unstructured data.

Merging partitions (true) allows the reader to return either vtkUnstructuredGrid or vtkPolyData directly while not merging (false) them returns a vtkPartitionedDataSet. It is advised to set this value to false when using the internal cache (UseCache == true) since the partitions are what are stored in the cache and merging them before outputting would effectively double the memory constraints.

Default is false

Note: Incompatible with UseCache as vtkAppendDataSet which is used internally doesn't support static mesh.

◆ MergePartsOff()

virtual void vtkHDFReader::MergePartsOff ( )

virtual

/!

\ Now deprecated due to its limitations regarding cache, please do not use! Settings this flag will have no effect. This option can be replaced by the vtkMergeBlocks filter.

Boolean property determining whether to merge partitions when reading unstructured data.

Merging partitions (true) allows the reader to return either vtkUnstructuredGrid or vtkPolyData directly while not merging (false) them returns a vtkPartitionedDataSet. It is advised to set this value to false when using the internal cache (UseCache == true) since the partitions are what are stored in the cache and merging them before outputting would effectively double the memory constraints.

Default is false

Note: Incompatible with UseCache as vtkAppendDataSet which is used internally doesn't support static mesh.

◆ SetMaximumLevelsToReadByDefaultForAMR()

virtual void vtkHDFReader::SetMaximumLevelsToReadByDefaultForAMR ( unsigned int )

virtual

Choose the maximum level to read for AMR structures.

This only applies if LimitAMRLevelsToRead is active. The value 0 indicates that the level read is not limited. Default is 0.

◆ GetMaximumLevelsToReadByDefaultForAMR()

virtual unsigned int vtkHDFReader::GetMaximumLevelsToReadByDefaultForAMR ( )

virtual

Choose the maximum level to read for AMR structures.

This only applies if LimitAMRLevelsToRead is active. The value 0 indicates that the level read is not limited. Default is 0.

◆ GetAttributeOriginalIdName()

std::string vtkHDFReader::GetAttributeOriginalIdName ( vtkIdType attribute )

Get or Set the Original id name of an attribute (POINT, CELL, FIELD...).

◆ SetAttributeOriginalIdName()

void vtkHDFReader::SetAttributeOriginalIdName	(	vtkIdType	attribute,
		const std::string &	name )

Get or Set the Original id name of an attribute (POINT, CELL, FIELD...).

◆ CanReadFileVersion()

int vtkHDFReader::CanReadFileVersion	(	int	major,
		int	minor )

protected

Test if the reader can read a file with the given version number.