vtkXMLImageDataReader Class Reference

Read VTK XML ImageData files. More...

#include <vtkXMLImageDataReader.h>

Inheritance diagram for vtkXMLImageDataReader:

Collaboration diagram for vtkXMLImageDataReader:

Public Types
typedef vtkXMLStructuredDataReader	Superclass
Public Types inherited from vtkXMLStructuredDataReader
typedef vtkXMLDataReader	Superclass
Public Types inherited from vtkXMLDataReader
typedef vtkXMLReader	Superclass
Public Types inherited from vtkXMLReader
enum	FieldType { POINT_DATA, CELL_DATA, OTHER }
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. More...
vtkXMLImageDataReader *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
vtkImageData *	GetOutput ()
	Get the reader's output. More...
vtkImageData *	GetOutput (int idx)
void	CopyOutputInformation (vtkInformation *outInfo, int port) override
	For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo. More...
Public Member Functions inherited from vtkXMLStructuredDataReader
vtkXMLStructuredDataReader *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
vtkIdType	GetNumberOfPoints () override
	Get the number of points in the output. More...
vtkIdType	GetNumberOfCells () override
	Get the number of cells in the output. More...
virtual void	SetWholeSlices (vtkTypeBool)
	Get/Set whether the reader gets a whole slice from disk when only a rectangle inside it is needed. More...
virtual vtkTypeBool	GetWholeSlices ()
virtual void	WholeSlicesOn ()
virtual void	WholeSlicesOff ()
void	CopyOutputInformation (vtkInformation *outInfo, int port) override
	For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo. More...
Public Member Functions inherited from vtkXMLDataReader
vtkXMLDataReader *	NewInstance () const
void	CopyOutputInformation (vtkInformation *outInfo, int port) override
Public Member Functions inherited from vtkXMLReader
vtkXMLReader *	NewInstance () const
virtual void	SetFileName (const char *)
	Get/Set the name of the input file. More...
virtual char *	GetFileName ()
virtual void	SetReadFromInputString (vtkTypeBool)
	Enable reading from an InputString instead of the default, a file. More...
virtual vtkTypeBool	GetReadFromInputString ()
virtual void	ReadFromInputStringOn ()
virtual void	ReadFromInputStringOff ()
void	SetInputString (const std::string &s)
virtual int	CanReadFile (const char *name)
	Test whether the file (type) with the given name can be read by this reader. More...
vtkDataSet *	GetOutputAsDataSet ()
	Get the output as a vtkDataSet pointer. More...
vtkDataSet *	GetOutputAsDataSet (int index)
virtual vtkDataArraySelection *	GetPointDataArraySelection ()
	Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
virtual vtkDataArraySelection *	GetCellDataArraySelection ()
virtual vtkDataArraySelection *	GetColumnArraySelection ()
int	GetNumberOfPointArrays ()
	Get the number of point, cell or column arrays available in the input. More...
int	GetNumberOfCellArrays ()
int	GetNumberOfColumnArrays ()
int	GetNumberOfTimeDataArrays () const
	Getters for time data array candidates. More...
const char *	GetTimeDataArray (int idx) const
virtual vtkStringArray *	GetTimeDataStringArray ()
virtual char *	GetActiveTimeDataArrayName ()
	Setter / Getter on ActiveTimeDataArrayName. More...
virtual void	SetActiveTimeDataArrayName (const char *)
const char *	GetPointArrayName (int index)
	Get the name of the point, cell, column or time array with the given index in the input. More...
const char *	GetCellArrayName (int index)
const char *	GetColumnArrayName (int index)
int	GetPointArrayStatus (const char *name)
	Get/Set whether the point, cell, column or time array with the given name is to be read. More...
int	GetCellArrayStatus (const char *name)
void	SetPointArrayStatus (const char *name, int status)
void	SetCellArrayStatus (const char *name, int status)
int	GetColumnArrayStatus (const char *name)
void	SetColumnArrayStatus (const char *name, int status)
virtual void	CopyOutputInformation (vtkInformation *vtkNotUsed(outInfo), int vtkNotUsed(port))
virtual void	SetTimeStep (int)
	Which TimeStep to read. More...
virtual int	GetTimeStep ()
virtual int	GetNumberOfTimeSteps ()
virtual int *	GetTimeStepRange ()
	Which TimeStepRange to read. More...
virtual void	GetTimeStepRange (int &, int &)
virtual void	GetTimeStepRange (int[2])
virtual void	SetTimeStepRange (int, int)
void	SetTimeStepRange (int[2])
vtkXMLDataParser *	GetXMLParser ()
	Returns the internal XML parser. More...
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
void	SetReaderErrorObserver (vtkCommand *)
	Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages. More...
virtual vtkCommand *	GetReaderErrorObserver ()
void	SetParserErrorObserver (vtkCommand *)
	Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages. More...
virtual vtkCommand *	GetParserErrorObserver ()
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...
vtkTypeBool	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...
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...
virtual void	SetInformation (vtkInformation *)
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	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...
void	UnRegister (vtkObjectBase *o) override
	Decrease the reference count (release by another object). More...
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...
virtual vtkTypeBool	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual double	GetProgress ()
	Get the execution progress of a process object. More...
void	SetProgress (double)
	SetProgress is deprecated. More...
void	UpdateProgress (double amount)
	Update the progress of the process object. More...
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
virtual double	GetProgressShift ()
virtual double	GetProgressScale ()
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...
virtual char *	GetProgressText ()
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)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
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	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
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 void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...
virtual void	Update ()
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). More...
virtual vtkTypeBool	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]=nullptr)
	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]=nullptr)
	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...
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
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)
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
virtual vtkProgressObserver *	GetProgressObserver ()
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...
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)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
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)
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)
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
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). 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...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkXMLImageDataReader *	SafeDownCast (vtkObjectBase *o)
static vtkXMLImageDataReader *	New ()
Static Public Member Functions inherited from vtkXMLStructuredDataReader
static vtkTypeBool	IsTypeOf (const char *type)
static vtkXMLStructuredDataReader *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkXMLDataReader
static vtkTypeBool	IsTypeOf (const char *type)
static vtkXMLDataReader *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkXMLReader
static vtkTypeBool	IsTypeOf (const char *type)
static vtkXMLReader *	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. 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 ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
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 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). More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
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. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkXMLImageDataReader ()
	~vtkXMLImageDataReader () override
const char *	GetDataSetName () override
void	SetOutputExtent (int *extent) override
int	ReadPrimaryElement (vtkXMLDataElement *ePrimary) override
void	SetupOutputInformation (vtkInformation *outInfo) override
int	FillOutputPortInformation (int, vtkInformation *) override
	Fill the output port information objects for this algorithm. More...
Protected Member Functions inherited from vtkXMLStructuredDataReader
	vtkXMLStructuredDataReader ()
	~vtkXMLStructuredDataReader () override
int	ReadPrimaryElement (vtkXMLDataElement *ePrimary) override
void	ReadXMLData () override
void	SetupOutputInformation (vtkInformation *outInfo) override
void	SetupEmptyOutput () override
void	SetupPieces (int numPieces) override
void	DestroyPieces () override
int	ReadArrayForPoints (vtkXMLDataElement *da, vtkAbstractArray *outArray) override
int	ReadArrayForCells (vtkXMLDataElement *da, vtkAbstractArray *outArray) override
int	ReadPiece (vtkXMLDataElement *ePiece) override
virtual int	ReadSubExtent (int *inExtent, int *inDimensions, vtkIdType *inIncrements, int *outExtent, int *outDimensions, vtkIdType *outIncrements, int *subExtent, int *subDimensions, vtkXMLDataElement *da, vtkAbstractArray *array, FieldType type)
Protected Member Functions inherited from vtkXMLDataReader
	vtkXMLDataReader ()
	~vtkXMLDataReader () override
void	CreateXMLParser () override
void	DestroyXMLParser () override
void	SetupOutputInformation (vtkInformation *outInfo) override
void	SetupOutputData () override
int	ReadPiece (vtkXMLDataElement *ePiece, int piece)
int	ReadPieceData (int piece)
virtual int	ReadPieceData ()
virtual void	DataProgressCallback ()
Protected Member Functions inherited from vtkXMLReader
	vtkXMLReader ()
	~vtkXMLReader () override
virtual int	ReadXMLInformation ()
virtual int	CanReadFileVersion (int major, int minor)
virtual void	SetupOutputInformation (vtkInformation *vtkNotUsed(outInfo))
virtual int	ReadVTKFile (vtkXMLDataElement *eVTKFile)
int	GetLocalDataType (vtkXMLDataElement *da, int datatype)
	If the IdType argument is present in the provided XMLDataElement and the provided dataType has the same size with VTK_ID_TYPE on this build of VTK, returns VTK_ID_TYPE. More...
vtkAbstractArray *	CreateArray (vtkXMLDataElement *da)
int	CreateInformationKey (vtkXMLDataElement *eInfoKey, vtkInformation *info)
bool	ReadInformation (vtkXMLDataElement *infoRoot, vtkInformation *info)
virtual int	OpenStream ()
virtual void	CloseStream ()
virtual int	OpenVTKFile ()
virtual void	CloseVTKFile ()
virtual int	OpenVTKString ()
virtual void	CloseVTKString ()
void	SetupCompressor (const char *type)
int	CanReadFileVersionString (const char *version)
virtual int	CanReadFileWithDataType (const char *dsname)
	This method is used by CanReadFile() to check if the reader can read an XML with the primary element with the given name. More...
virtual int	GetFileMajorVersion ()
virtual int	GetFileMinorVersion ()
int	IntersectExtents (int *extent1, int *extent2, int *result)
int	Min (int a, int b)
int	Max (int a, int b)
void	ComputePointDimensions (int *extent, int *dimensions)
void	ComputePointIncrements (int *extent, vtkIdType *increments)
void	ComputeCellDimensions (int *extent, int *dimensions)
void	ComputeCellIncrements (int *extent, vtkIdType *increments)
vtkIdType	GetStartTuple (int *extent, vtkIdType *increments, int i, int j, int k)
void	ReadAttributeIndices (vtkXMLDataElement *eDSA, vtkDataSetAttributes *dsa)
char **	CreateStringArray (int numStrings)
void	DestroyStringArray (int numStrings, char **strings)
virtual int	ReadArrayValues (vtkXMLDataElement *da, vtkIdType arrayIndex, vtkAbstractArray *array, vtkIdType startIndex, vtkIdType numValues, FieldType type=OTHER)
void	SetDataArraySelections (vtkXMLDataElement *eDSA, vtkDataArraySelection *sel)
int	SetFieldDataInfo (vtkXMLDataElement *eDSA, int association, vtkIdType numTuples, vtkInformationVector *(&infoVector))
int	PointDataArrayIsEnabled (vtkXMLDataElement *ePDA)
int	CellDataArrayIsEnabled (vtkXMLDataElement *eCDA)
virtual void	SqueezeOutputArrays (vtkDataObject *)
void	MarkIdTypeArrays (vtkXMLDataElement *da)
	XML files have not consistently saved out adequate meta-data in past to correctly create vtkIdTypeArray for global ids and pedigree ids. More...
virtual void	GetProgressRange (float *range)
virtual void	SetProgressRange (const float range[2], int curStep, int numSteps)
virtual void	SetProgressRange (const float range[2], int curStep, const float *fractions)
virtual void	UpdateProgressDiscrete (float progress)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestDataObject (vtkInformation *vtkNotUsed(request), vtkInformationVector **vtkNotUsed(inputVector), vtkInformationVector *vtkNotUsed(outputVector))
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void	SetNumberOfTimeSteps (int num)
vtkDataObject *	GetCurrentOutput ()
vtkInformation *	GetCurrentOutputInformation ()
void	ReadFieldData ()
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm () override
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm. More...
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...
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)
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)
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)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
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)
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)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
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...
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. 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)
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. More...
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	Origin [3]
double	Spacing [3]
double	Direction [9]
int	PieceExtent [6]
Protected Attributes inherited from vtkXMLStructuredDataReader
int *	PieceExtents
int *	PiecePointDimensions
vtkIdType *	PiecePointIncrements
int *	PieceCellDimensions
vtkIdType *	PieceCellIncrements
vtkTypeBool	WholeSlices
int	UpdateExtent [6]
int	PointDimensions [3]
int	CellDimensions [3]
vtkIdType	PointIncrements [3]
vtkIdType	CellIncrements [3]
int	WholeExtent [6]
int	SubExtent [6]
int	SubPointDimensions [3]
int	SubCellDimensions [3]
Protected Attributes inherited from vtkXMLDataReader
int	NumberOfPieces
vtkXMLDataElement **	PointDataElements
vtkXMLDataElement **	CellDataElements
vtkXMLDataElement **	TimeDataElements
int	Piece
int	NumberOfPointArrays
int	NumberOfCellArrays
vtkCallbackCommand *	DataProgressObserver
Protected Attributes inherited from vtkXMLReader
vtkXMLDataParser *	XMLParser
vtkXMLDataElement *	FieldDataElement
char *	FileName
istream *	Stream
vtkTypeBool	ReadFromInputString
std::string	InputString
vtkDataArraySelection *	PointDataArraySelection
vtkDataArraySelection *	CellDataArraySelection
vtkDataArraySelection *	ColumnArraySelection
vtkStringArray *	TimeDataStringArray
char *	ActiveTimeDataArrayName
	Name of the field-data array used to determine the time for the dataset being read. More...
vtkSmartPointer< vtkDataArray >	TimeDataArray
	Populated in ReadXMLInformation from the field data for the array chosen using ActiveTimeDataArrayName, if any. More...
vtkCallbackCommand *	SelectionObserver
int	InformationError
int	DataError
float	ProgressRange [2]
vtkTimeStamp	ReadMTime
int	ReadError
int	AxesEmpty [3]
int	TimeStep
int	CurrentTimeStep
int	NumberOfTimeSteps
int *	TimeSteps
int	TimeStepRange [2]
int	InReadData
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
unsigned long	ErrorCode
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute
Static Protected Member Functions inherited from vtkXMLDataReader
static void	DataProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)
Static Protected Member Functions inherited from vtkXMLReader
static void	SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
static int	IsTimeStepInArray (int timestep, int *timesteps, int length)
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Read VTK XML ImageData files.

vtkXMLImageDataReader reads the VTK XML ImageData file format. One image data file can be read to produce one output. Streaming is supported. The standard extension for this reader's file format is "vti". This reader is also used to read a single piece of the parallel file format.

See also

vtkXMLPImageDataReader

Definition at line 37 of file vtkXMLImageDataReader.h.

Member Typedef Documentation

Superclass

typedef vtkXMLStructuredDataReader vtkXMLImageDataReader::Superclass

Definition at line 40 of file vtkXMLImageDataReader.h.

Constructor & Destructor Documentation

vtkXMLImageDataReader()

vtkXMLImageDataReader::vtkXMLImageDataReader ( )

protected

~vtkXMLImageDataReader()

vtkXMLImageDataReader::~vtkXMLImageDataReader ( )

overrideprotected

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkXMLImageDataReader::IsTypeOf ( const char *  type )

static

IsA()

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

SafeDownCast()

static vtkXMLImageDataReader* vtkXMLImageDataReader::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase* vtkXMLImageDataReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkXMLStructuredDataReader.

NewInstance()

vtkXMLImageDataReader* vtkXMLImageDataReader::NewInstance

(

)

const

PrintSelf()

void vtkXMLImageDataReader::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 vtkXMLDataReader.

New()

static vtkXMLImageDataReader* vtkXMLImageDataReader::New ( )

static

GetOutput() [1/2]

vtkImageData* vtkXMLImageDataReader::GetOutput

(

)

Get the reader's output.

GetOutput() [2/2]

vtkImageData* vtkXMLImageDataReader::GetOutput

(

int

idx

)

CopyOutputInformation()

void vtkXMLImageDataReader::CopyOutputInformation ( vtkInformation *  outInfo, int  port  )

override

For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo.

GetDataSetName()

const char* vtkXMLImageDataReader::GetDataSetName ( )

overrideprotectedvirtual

Implements vtkXMLReader.

SetOutputExtent()

void vtkXMLImageDataReader::SetOutputExtent ( int *  extent )

overrideprotectedvirtual

Implements vtkXMLStructuredDataReader.

ReadPrimaryElement()

int vtkXMLImageDataReader::ReadPrimaryElement ( vtkXMLDataElement *  ePrimary )

overrideprotectedvirtual

Reimplemented from vtkXMLDataReader.

SetupOutputInformation()

void vtkXMLImageDataReader::SetupOutputInformation ( vtkInformation *  outInfo )

overrideprotected

FillOutputPortInformation()

int vtkXMLImageDataReader::FillOutputPortInformation ( int  port, vtkInformation *  info  )

overrideprotectedvirtual

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

Member Data Documentation

Origin

double vtkXMLImageDataReader::Origin[3]

protected

Definition at line 62 of file vtkXMLImageDataReader.h.

Spacing

double vtkXMLImageDataReader::Spacing[3]

protected

Definition at line 63 of file vtkXMLImageDataReader.h.

Direction

double vtkXMLImageDataReader::Direction[9]

protected

Definition at line 64 of file vtkXMLImageDataReader.h.

PieceExtent

int vtkXMLImageDataReader::PieceExtent[6]

protected

Definition at line 65 of file vtkXMLImageDataReader.h.

---

The documentation for this class was generated from the following file:

• IO/XML/vtkXMLImageDataReader.h