VTK: vtkMetaImageReader Class Reference

| VTK 9.3.1

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkMetaImageReader Class Reference

read binary UNC meta image data More...

`#include <vtkMetaImageReader.h>`

Inheritance diagram for vtkMetaImageReader:
[legend]
Collaboration diagram for vtkMetaImageReader:
[legend]

## Public Types
typedef vtkImageReader2 | Superclass
Public Types inherited from vtkImageReader2
typedef vtkImageAlgorithm | Superclass
Public Types inherited from vtkImageAlgorithm
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...
vtkMetaImageReader * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
const char * | GetFileExtensions () override
| Get the file extensions for this format. More...
const char * | GetDescriptiveName () override
| Return a descriptive name for the file format that might be useful in a GUI. More...
double * | GetPixelSpacing ()
int | GetWidth ()
int | GetHeight ()
double * | GetImagePositionPatient ()
int | GetNumberOfComponents ()
int | GetPixelRepresentation ()
int | GetDataByteOrder () override
| These methods should be used instead of the SwapBytes methods. More...
virtual double | GetRescaleSlope ()
virtual double | GetRescaleOffset ()
virtual int | GetBitsAllocated ()
virtual char * | GetDistanceUnits ()
virtual char * | GetAnatomicalOrientation ()
virtual double | GetGantryAngle ()
virtual char * | GetPatientName ()
virtual char * | GetPatientID ()
virtual char * | GetDate ()
virtual char * | GetSeries ()
virtual char * | GetImageNumber ()
virtual char * | GetModality ()
virtual char * | GetStudyID ()
virtual char * | GetStudyUID ()
virtual char * | GetTransferSyntaxUID ()
int | CanReadFile (VTK_FILEPATH const char *name) override
| Test whether the file with the given name can be read by this reader. More...
Public Member Functions inherited from vtkImageReader2
vtkImageReader2 * | NewInstance () const
virtual void | SetMemoryBuffer (const void *)
| Specify the in memory image buffer. More...
virtual const void * | GetMemoryBuffer ()
virtual void | SetMemoryBufferLength (vtkIdType buflen)
| Specify the in memory image buffer length. More...
vtkIdType | GetMemoryBufferLength ()
virtual void | SetDataScalarType (int type)
| Set the data type of pixels in the file. More...
virtual void | SetDataScalarTypeToFloat ()
virtual void | SetDataScalarTypeToDouble ()
virtual void | SetDataScalarTypeToInt ()
virtual void | SetDataScalarTypeToUnsignedInt ()
virtual void | SetDataScalarTypeToShort ()
virtual void | SetDataScalarTypeToUnsignedShort ()
virtual void | SetDataScalarTypeToChar ()
virtual void | SetDataScalarTypeToSignedChar ()
virtual void | SetDataScalarTypeToUnsignedChar ()
virtual void | SetHeaderSize (unsigned long size)
| If there is a tail on the file, you want to explicitly set the header size. More...
istream * | GetFile ()
virtual unsigned long * | GetDataIncrements ()
virtual void | GetDataIncrements (unsigned long data[4])
virtual int | OpenFile ()
void | CloseFile ()
virtual void | SeekFile (int i, int j, int k)
virtual int | CanReadFile (VTK_FILEPATH const char *vtkNotUsed(fname))
| Return non zero if the reader can read the given file name. More...
virtual void | SetFileName (VTK_FILEPATH const char *)
| Specify file name for the image file. More...
| vtkGetFilePathMacro (FileName)
| Specify file name for the image file. More...
virtual void | SetFileNames (vtkStringArray *)
| Specify a list of file names. More...
virtual vtkStringArray * | GetFileNames ()
| Specify a list of file names. More...
virtual void | SetFilePrefix (VTK_FILEPATH const char *)
| Specify file prefix for the image file or files. More...
| vtkGetFilePathMacro (FilePrefix)
| Specify file prefix for the image file or files. More...
virtual void | SetFilePattern (VTK_FILEPATH const char *)
| The snprintf-style format string used to build filename from FilePrefix and slice number. More...
| vtkGetFilePathMacro (FilePattern)
| The snprintf-style format string used to build filename from FilePrefix and slice number. More...
virtual int | GetDataScalarType ()
| Get the file format. More...
virtual void | SetNumberOfScalarComponents (int)
| Set/Get the number of scalar components. More...
virtual int | GetNumberOfScalarComponents ()
| Set/Get the number of scalar components. More...
virtual void | SetDataExtent (int, int, int, int, int, int)
| Get/Set the extent of the data on disk. More...
virtual void | SetDataExtent (int[6])
| Get/Set the extent of the data on disk. More...
virtual int * | GetDataExtent ()
| Get/Set the extent of the data on disk. More...
virtual void | GetDataExtent (int &, int &, int &, int &, int &, int &)
| Get/Set the extent of the data on disk. More...
virtual void | GetDataExtent (int[6])
| Get/Set the extent of the data on disk. More...
virtual void | SetFileDimensionality (int)
| The number of dimensions stored in a file. More...
int | GetFileDimensionality ()
| The number of dimensions stored in a file. More...
virtual void | SetDataSpacing (double, double, double)
| Set/Get the spacing of the data in the file. More...
virtual void | SetDataSpacing (double[3])
| Set/Get the spacing of the data in the file. More...
virtual double * | GetDataSpacing ()
| Set/Get the spacing of the data in the file. More...
virtual void | GetDataSpacing (double &, double &, double &)
| Set/Get the spacing of the data in the file. More...
virtual void | GetDataSpacing (double[3])
| Set/Get the spacing of the data in the file. More...
virtual void | SetDataOrigin (double, double, double)
| Set/Get the origin of the data (location of first pixel in the file). More...
virtual void | SetDataOrigin (double[3])
| Set/Get the origin of the data (location of first pixel in the file). More...
virtual double * | GetDataOrigin ()
| Set/Get the origin of the data (location of first pixel in the file). More...
virtual void | GetDataOrigin (double &, double &, double &)
| Set/Get the origin of the data (location of first pixel in the file). More...
virtual void | GetDataOrigin (double[3])
| Set/Get the origin of the data (location of first pixel in the file). More...
virtual void | SetDataDirection (double data[])
| Set/Get the direction of the data (9 elements: 3x3 matrix). More...
virtual double * | GetDataDirection ()
| Set/Get the direction of the data (9 elements: 3x3 matrix). More...
virtual void | GetDataDirection (double data[9])
| Set/Get the direction of the data (9 elements: 3x3 matrix). More...
unsigned long | GetHeaderSize ()
| Get the size of the header computed by this object. More...
unsigned long | GetHeaderSize (unsigned long slice)
| Get the size of the header computed by this object. More...
virtual void | SetDataByteOrderToBigEndian ()
| These methods should be used instead of the SwapBytes methods. More...
virtual void | SetDataByteOrderToLittleEndian ()
| These methods should be used instead of the SwapBytes methods. More...
virtual void | SetDataByteOrder (int)
| These methods should be used instead of the SwapBytes methods. More...
virtual const char * | GetDataByteOrderAsString ()
| These methods should be used instead of the SwapBytes methods. More...
virtual void | SetFileNameSliceOffset (int)
| When reading files which start at an unusual index, this can be added to the slice number when generating the file name (default = 0) More...
virtual int | GetFileNameSliceOffset ()
| When reading files which start at an unusual index, this can be added to the slice number when generating the file name (default = 0) More...
virtual void | SetFileNameSliceSpacing (int)
| When reading files which have regular, but non contiguous slices (eg filename.1,filename.3,filename.5) a spacing can be specified to skip missing files (default = 1) More...
virtual int | GetFileNameSliceSpacing ()
| When reading files which have regular, but non contiguous slices (eg filename.1,filename.3,filename.5) a spacing can be specified to skip missing files (default = 1) More...
virtual void | SetSwapBytes (vtkTypeBool)
| Set/Get the byte swapping to explicitly swap the bytes of a file. More...
virtual vtkTypeBool | GetSwapBytes ()
| Set/Get the byte swapping to explicitly swap the bytes of a file. More...
virtual void | SwapBytesOn ()
| Set/Get the byte swapping to explicitly swap the bytes of a file. More...
virtual void | SwapBytesOff ()
| Set/Get the byte swapping to explicitly swap the bytes of a file. More...
virtual void | FileLowerLeftOn ()
| Set/Get whether the data comes from the file starting in the lower left corner or upper left corner. More...
virtual void | FileLowerLeftOff ()
| Set/Get whether the data comes from the file starting in the lower left corner or upper left corner. More...
virtual vtkTypeBool | GetFileLowerLeft ()
| Set/Get whether the data comes from the file starting in the lower left corner or upper left corner. More...
virtual void | SetFileLowerLeft (vtkTypeBool)
| Set/Get whether the data comes from the file starting in the lower left corner or upper left corner. More...
virtual void | ComputeInternalFileName (int slice)
| Set/Get the internal file name. More...
| vtkGetFilePathMacro (InternalFileName)
| Set/Get the internal file name. More...
Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm * | NewInstance () const
vtkTypeBool | ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
| Process a request from the executive. More...
vtkImageData * | GetOutput ()
| Get the output data object for a port on this algorithm. More...
vtkImageData * | 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...
vtkDataObject * | GetInput (int port)
| Get a data object for one of the input port connections. More...
vtkDataObject * | GetInput ()
| Get a data object for one of the input port connections. More...
vtkImageData * | GetImageDataInput (int port)
| Get a data object for one of the input port connections. More...
virtual void | AddInputData (vtkDataObject *)
| Assign a data object as input. More...
virtual void | AddInputData (int, vtkDataObject *)
| Assign a data object as input. More...
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm * | NewInstance () const
vtkTypeBool | 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...
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 | SetAbortExecuteAndUpdateTime ()
| Set AbortExecute Flag and update LastAbortTime. More...
void | UpdateProgress (double amount)
| Update the progress of the process object. More...
bool | CheckAbort ()
| Checks to see if this filter should abort. 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 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 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...
bool | UsesGarbageCollector () const override
| Participate in garbage collection. More...
virtual void | SetAbortExecute (vtkTypeBool)
| Set/Get the AbortExecute flag for the process object. More...
virtual vtkTypeBool | 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 double | GetProgress ()
| Get the execution progress of a process object. More...
void | SetContainerAlgorithm (vtkAlgorithm *containerAlg)
| Set/get a Container algorithm for this algorithm. More...
vtkAlgorithm * | GetContainerAlgorithm ()
| Set/get a Container algorithm for this algorithm. More...
virtual void | SetAbortOutput (bool)
| Set/Get an internal variable used to communicate between the algorithm and executive. More...
virtual bool | GetAbortOutput ()
| Set/Get an internal variable used to communicate between the algorithm and executive. 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 ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
virtual double | GetProgressScale ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. 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 (vtkTypeBool)
| Turn release data flag on or off for all output ports. More...
virtual vtkTypeBool | 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 ()
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. 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)
| 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...
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool | 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...
vtkTypeBool | InvokeEvent (unsigned long event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
vtkTypeBool | InvokeEvent (const char *event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
virtual void | SetObjectName (const std::string &objectName)
| Set/get the name of this object for reporting purposes. More...
virtual std::string | GetObjectName () const
| Set/get the name of this object for reporting purposes. More...
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 | Register (vtkObjectBase *o)
| Increase the reference count (mark as used by another object). More...
virtual void | UnRegister (vtkObjectBase *o)
| Decrease the reference count (release by another object). More...
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...
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 vtkTypeBool | IsTypeOf (const char *type)
static vtkMetaImageReader * | SafeDownCast (vtkObjectBase *o)
static vtkMetaImageReader * | New ()
| Construct object with FlipNormals turned off and Normals set to true. More...
Static Public Member Functions inherited from vtkImageReader2
static vtkImageReader2 * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkImageReader2 * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool | IsTypeOf (const char *type)
static vtkImageAlgorithm * | 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 vtkInformationIntegerKey * | ABORTED ()
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 (vtkTypeBool 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 vtkTypeBool | 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 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
| vtkMetaImageReader ()
| ~vtkMetaImageReader () override
void | ExecuteInformation () override
void | ExecuteDataWithInformation (vtkDataObject *out, vtkInformation *outInfo) override
| This is a convenience method that is implemented in many subclasses instead of RequestData. More...
int | RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
| Subclasses can reimplement this method to collect information from their inputs and set information for their outputs. More...
Protected Member Functions inherited from vtkImageReader2
virtual void | ComputeDataIncrements ()
| vtkImageReader2 ()
| Return a descriptive name for the file format that might be useful in a GUI. More...
| ~vtkImageReader2 () override
| Return a descriptive name for the file format that might be useful in a GUI. More...
Protected Member Functions inherited from vtkImageAlgorithm
| vtkImageAlgorithm ()
| ~vtkImageAlgorithm () override
virtual int | RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
| Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections. More...
virtual void | CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
| Convenience method to copy the scalar type and number of components from the input data to the output data. More...
virtual int | RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
| This is called in response to a REQUEST_DATA request from the executive. More...
virtual void | CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
| Copy the other point and cell data. More...
virtual void | ExecuteData (vtkDataObject *output)
| This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
virtual void | Execute ()
| This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
virtual void | AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
| Allocate the output data. More...
virtual vtkImageData * | AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
| Allocate the output data. More...
int | FillOutputPortInformation (int port, vtkInformation *info) override
| These method should be reimplemented by subclasses that have more than a single input or single output. More...
int | FillInputPortInformation (int port, vtkInformation *info) override
| These method should be reimplemented by subclasses that have more than a single input or single output. More...
Protected Member Functions inherited from vtkAlgorithm
| vtkAlgorithm ()
| ~vtkAlgorithm () override
bool | CheckUpstreamAbort ()
| Checks to see if an upstream filter has been aborted. 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 association 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=nullptr)
| 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 ()
| vtkObjectBase (const vtkObjectBase &)
void | operator= (const vtkObjectBase &)

## Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool > | AbortExecute
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 ()
Protected Attributes inherited from vtkImageReader2
vtkStringArray * | FileNames
char * | InternalFileName
char * | FileName
char * | FilePrefix
char * | FilePattern
int | NumberOfScalarComponents
vtkTypeBool | FileLowerLeft
const void * | MemoryBuffer
vtkIdType | MemoryBufferLength
istream * | File
unsigned long | DataIncrements [4]
int | DataExtent [6]
vtkTypeBool | SwapBytes
int | FileDimensionality
unsigned long | HeaderSize
int | DataScalarType
unsigned long | ManualHeaderSize
double | DataSpacing [3]
double | DataOrigin [3]
double | DataDirection [9]
int | FileNameSliceOffset
int | FileNameSliceSpacing
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp | LastAbortCheckTime
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
std::string | ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > | ReferenceCount
vtkWeakPointerBase ** | WeakPointers
Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp | LastAbortTime
static vtkExecutive * | DefaultExecutivePrototype

## Detailed Description

read binary UNC meta image data

One of the formats for which a reader is already available in the toolkit is the MetaImage file format. This is a fairly simple yet powerful format consisting of a text header and a binary data section. The following instructions describe how you can write a MetaImage header for the data that you download from the BrainWeb page.

The minimal structure of the MetaImage header is the following:

NDims = 3 DimSize = 181 217 181 ElementType = MET_UCHAR ElementSpacing = 1.0 1.0 1.0 ElementByteOrderMSB = False ElementDataFile = brainweb1.raw

- NDims indicate that this is a 3D image. ITK can handle images of arbitrary dimension.
- DimSize indicates the size of the volume in pixels along each direction.
- ElementType indicate the primitive type used for pixels. In this case is "unsigned char", implying that the data is digitized in 8 bits / pixel.
- ElementSpacing indicates the physical separation between the center of one pixel and the center of the next pixel along each direction in space. The units used are millimeters.
- ElementByteOrderMSB indicates is the data is encoded in little or big endian order. You might want to play with this value when moving data between different computer platforms.
- ElementDataFile is the name of the file containing the raw binary data of the image. This file must be in the same directory as the header.

MetaImage headers are expected to have extension: ".mha" or ".mhd"

Once you write this header text file, it should be possible to read the image into your ITK based application using the itk::FileIOToImageFilter class.

Examples:
  vtkMetaImageReader (Examples)

Online Examples:

Tests:
  vtkMetaImageReader (Tests)

Definition at line 76 of file vtkMetaImageReader.h.

## Member Typedef Documentation

## ◆ Superclass

typedef vtkImageReader2 vtkMetaImageReader::Superclass

Definition at line 79 of file vtkMetaImageReader.h.

## Constructor & Destructor Documentation

## ◆ vtkMetaImageReader()

vtkMetaImageReader::vtkMetaImageReader | ( |  | ) |
| protected

## ◆ ~vtkMetaImageReader()

vtkMetaImageReader::~vtkMetaImageReader | ( |  | ) |
| overrideprotected

## Member Function Documentation

## ◆ IsTypeOf()

static vtkTypeBool vtkMetaImageReader::IsTypeOf | ( | const char * | type | ) |
| static

## ◆ IsA()

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

## ◆ SafeDownCast()

static vtkMetaImageReader* vtkMetaImageReader::SafeDownCast | ( | vtkObjectBase * | o | ) |
| static

## ◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMetaImageReader::NewInstanceInternal | ( |  | ) | const
| protectedvirtual

Reimplemented from vtkImageReader2.

## ◆ NewInstance()

vtkMetaImageReader* vtkMetaImageReader::NewInstance | ( |  | ) | const

## ◆ PrintSelf()

void vtkMetaImageReader::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 vtkImageReader2.

## ◆ New()

static vtkMetaImageReader* vtkMetaImageReader::New | ( |  | ) |
| static

Construct object with FlipNormals turned off and Normals set to true.

## ◆ GetFileExtensions()

const char* vtkMetaImageReader::GetFileExtensions | ( |  | ) |
| inlineoverridevirtual

Get the file extensions for this format.

Returns a string with a space separated list of extensions in the format .extension

Reimplemented from vtkImageReader2.

Definition at line 87 of file vtkMetaImageReader.h.

## ◆ GetDescriptiveName()

const char* vtkMetaImageReader::GetDescriptiveName | ( |  | ) |
| inlineoverridevirtual

Return a descriptive name for the file format that might be useful in a GUI.

Reimplemented from vtkImageReader2.

Definition at line 89 of file vtkMetaImageReader.h.

## ◆ GetPixelSpacing()

double* vtkMetaImageReader::GetPixelSpacing | ( |  | ) |
| inline

Definition at line 92 of file vtkMetaImageReader.h.

## ◆ GetWidth()

int vtkMetaImageReader::GetWidth | ( |  | ) |
| inline

Definition at line 93 of file vtkMetaImageReader.h.

## ◆ GetHeight()

int vtkMetaImageReader::GetHeight | ( |  | ) |
| inline

Definition at line 94 of file vtkMetaImageReader.h.

## ◆ GetImagePositionPatient()

double* vtkMetaImageReader::GetImagePositionPatient | ( |  | ) |
| inline

Definition at line 95 of file vtkMetaImageReader.h.

## ◆ GetNumberOfComponents()

int vtkMetaImageReader::GetNumberOfComponents | ( |  | ) |
| inline

Definition at line 96 of file vtkMetaImageReader.h.

## ◆ GetPixelRepresentation()

int vtkMetaImageReader::GetPixelRepresentation | ( |  | ) |
| inline

Definition at line 97 of file vtkMetaImageReader.h.

## ◆ GetDataByteOrder()

int vtkMetaImageReader::GetDataByteOrder | ( |  | ) |
| overridevirtual

These methods should be used instead of the SwapBytes methods.

They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.

Reimplemented from vtkImageReader2.

## ◆ GetRescaleSlope()

virtual double vtkMetaImageReader::GetRescaleSlope | ( |  | ) |
| virtual

## ◆ GetRescaleOffset()

virtual double vtkMetaImageReader::GetRescaleOffset | ( |  | ) |
| virtual

## ◆ GetBitsAllocated()

virtual int vtkMetaImageReader::GetBitsAllocated | ( |  | ) |
| virtual

## ◆ GetDistanceUnits()

virtual char* vtkMetaImageReader::GetDistanceUnits | ( |  | ) |
| virtual

## ◆ GetAnatomicalOrientation()

virtual char* vtkMetaImageReader::GetAnatomicalOrientation | ( |  | ) |
| virtual

## ◆ GetGantryAngle()

virtual double vtkMetaImageReader::GetGantryAngle | ( |  | ) |
| virtual

## ◆ GetPatientName()

virtual char* vtkMetaImageReader::GetPatientName | ( |  | ) |
| virtual

## ◆ GetPatientID()

virtual char* vtkMetaImageReader::GetPatientID | ( |  | ) |
| virtual

## ◆ GetDate()

virtual char* vtkMetaImageReader::GetDate | ( |  | ) |
| virtual

## ◆ GetSeries()

virtual char* vtkMetaImageReader::GetSeries | ( |  | ) |
| virtual

## ◆ GetImageNumber()

virtual char* vtkMetaImageReader::GetImageNumber | ( |  | ) |
| virtual

## ◆ GetModality()

virtual char* vtkMetaImageReader::GetModality | ( |  | ) |
| virtual

## ◆ GetStudyID()

virtual char* vtkMetaImageReader::GetStudyID | ( |  | ) |
| virtual

## ◆ GetStudyUID()

virtual char* vtkMetaImageReader::GetStudyUID | ( |  | ) |
| virtual

## ◆ GetTransferSyntaxUID()

virtual char* vtkMetaImageReader::GetTransferSyntaxUID | ( |  | ) |
| virtual

## ◆ CanReadFile()

int vtkMetaImageReader::CanReadFile | ( | VTK_FILEPATH const char * | name | ) |
| override

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

## ◆ ExecuteInformation()

void vtkMetaImageReader::ExecuteInformation | ( |  | ) |
| overrideprotectedvirtual

Reimplemented from vtkImageReader2.

## ◆ ExecuteDataWithInformation()

void vtkMetaImageReader::ExecuteDataWithInformation | ( | vtkDataObject * | output,
|  | vtkInformation * | outInfo
| ) |  |
| overrideprotectedvirtual

This is a convenience method that is implemented in many subclasses instead of RequestData.

It is called by RequestData.

Reimplemented from vtkImageReader2.

## ◆ RequestInformation()

int vtkMetaImageReader::RequestInformation | ( | vtkInformation * | request,
|  | vtkInformationVector ** | inputVector,
|  | vtkInformationVector * | outputVector
| ) |  |
| overrideprotectedvirtual

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageReader2.

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

- IO/Image/vtkMetaImageReader.h