VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImageReader2 Class Reference

Superclass of binary file readers. More...

#include <vtkImageReader2.h>

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

List of all members.

Public Types

typedef vtkImageAlgorithm Superclass
- Public Types inherited from vtkImageAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetHeaderSize (unsigned long size)
ifstream * GetFile ()
virtual unsigned long * GetDataIncrements ()
virtual void GetDataIncrements (unsigned long data[4])
virtual int OpenFile ()
virtual void SeekFile (int i, int j, int k)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetFileNames (vtkStringArray *)
virtual vtkStringArrayGetFileNames ()
virtual void SetFilePrefix (const char *)
virtual char * GetFilePrefix ()
virtual void SetFilePattern (const char *)
virtual char * GetFilePattern ()
virtual void SetDataScalarType (int type)
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 int GetDataScalarType ()
virtual void SetNumberOfScalarComponents (int)
virtual int GetNumberOfScalarComponents ()
virtual void SetDataExtent (int, int, int, int, int, int)
virtual void SetDataExtent (int[6])
virtual int * GetDataExtent ()
virtual void GetDataExtent (int &, int &, int &, int &, int &, int &)
virtual void GetDataExtent (int[6])
virtual void SetFileDimensionality (int)
int GetFileDimensionality ()
virtual void SetDataSpacing (double, double, double)
virtual void SetDataSpacing (double[3])
virtual double * GetDataSpacing ()
virtual void GetDataSpacing (double &, double &, double &)
virtual void GetDataSpacing (double[3])
virtual void SetDataOrigin (double, double, double)
virtual void SetDataOrigin (double[3])
virtual double * GetDataOrigin ()
virtual void GetDataOrigin (double &, double &, double &)
virtual void GetDataOrigin (double[3])
unsigned long GetHeaderSize ()
unsigned long GetHeaderSize (unsigned long slice)
virtual void SetDataByteOrderToBigEndian ()
virtual void SetDataByteOrderToLittleEndian ()
virtual int GetDataByteOrder ()
virtual void SetDataByteOrder (int)
virtual const char * GetDataByteOrderAsString ()
virtual void SetFileNameSliceOffset (int)
virtual int GetFileNameSliceOffset ()
virtual void SetFileNameSliceSpacing (int)
virtual int GetFileNameSliceSpacing ()
virtual void SetSwapBytes (int)
virtual int GetSwapBytes ()
virtual void SwapBytesOn ()
virtual void SwapBytesOff ()
virtual void FileLowerLeftOn ()
virtual void FileLowerLeftOff ()
virtual int GetFileLowerLeft ()
virtual void SetFileLowerLeft (int)
virtual void ComputeInternalFileName (int slice)
virtual char * GetInternalFileName ()
virtual int CanReadFile (const char *vtkNotUsed(fname))
virtual const char * GetFileExtensions ()
- Public Member Functions inherited from vtkImageAlgorithm
vtkDataObjectGetInput (int port)
vtkDataObjectGetInput ()
vtkImageDataGetImageDataInput (int port)
vtkImageDataGetOutput ()
vtkImageDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
virtual void AddInput (vtkDataObject *)
virtual void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
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)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkImageReader2New ()
static int IsTypeOf (const char *type)
static vtkImageReader2SafeDownCast (vtkObject *o)

Protected Member Functions

virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void ExecuteInformation ()
virtual void ExecuteData (vtkDataObject *data)
virtual void ComputeDataIncrements ()
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 ~vtkImageAlgorithm ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void AllocateOutputData (vtkImageData *out, int *uExtent)
virtual vtkImageDataAllocateOutputData (vtkDataObject *out)
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkStringArrayFileNames
char * InternalFileName
char * FileName
char * FilePrefix
char * FilePattern
int NumberOfScalarComponents
int FileLowerLeft
ifstream * File
unsigned long DataIncrements [4]
int DataExtent [6]
int SwapBytes
int FileDimensionality
unsigned long HeaderSize
int DataScalarType
unsigned long ManualHeaderSize
double DataSpacing [3]
double DataOrigin [3]
int FileNameSliceOffset
int FileNameSliceSpacing
virtual const char * GetDescriptiveName ()
 vtkImageReader2 ()
 ~vtkImageReader2 ()

Detailed Description

Superclass of binary file readers.

vtkImageReader2 is the parent class for vtkImageReader. It is a good super class for streaming readers that do not require a mask or transform on the data. vtkImageReader was implemented before vtkImageReader2, vtkImageReader2 is intended to have a simpler interface.

See also:
vtkJPEGReader vtkPNGReader vtkImageReader vtkGESignaReader
Examples:
vtkImageReader2 (Examples)
Tests:
vtkImageReader2 (Tests)

Definition at line 44 of file vtkImageReader2.h.


Member Typedef Documentation


Constructor & Destructor Documentation

vtkImageReader2::vtkImageReader2 ( )
protected

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

vtkImageReader2::~vtkImageReader2 ( )
protected

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


Member Function Documentation

static vtkImageReader2* vtkImageReader2::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkMINCImageReader, vtkMetaImageReader, vtkMPIImageReader, vtkDICOMImageReader, vtkBMPReader, vtkPNrrdReader, vtkPNMReader, vtkImageReader, vtkTIFFReader, vtkGESignaReader, vtkJPEGReader, vtkPNGReader, vtkSLCReader, and vtkMedicalImageReader2.

virtual const char* vtkImageReader2::GetClassName ( )
virtual
static int vtkImageReader2::IsTypeOf ( const char *  name)
static

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMINCImageReader, vtkMetaImageReader, vtkDICOMImageReader, vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, vtkPNMReader, vtkImageReader, vtkTIFFReader, vtkGESignaReader, vtkJPEGReader, vtkPNGReader, vtkSLCReader, and vtkMedicalImageReader2.

virtual int vtkImageReader2::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 vtkImageAlgorithm.

Reimplemented in vtkMINCImageReader, vtkMetaImageReader, vtkDICOMImageReader, vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, vtkPNMReader, vtkImageReader, vtkTIFFReader, vtkGESignaReader, vtkJPEGReader, vtkPNGReader, vtkSLCReader, and vtkMedicalImageReader2.

static vtkImageReader2* vtkImageReader2::SafeDownCast ( vtkObject o)
static
void vtkImageReader2::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMINCImageReader, vtkMetaImageReader, vtkDICOMImageReader, vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, vtkPNMReader, vtkImageReader, vtkTIFFReader, vtkGESignaReader, vtkJPEGReader, vtkPNGReader, vtkSLCReader, and vtkMedicalImageReader2.

virtual void vtkImageReader2::SetFileName ( const char *  )
virtual

Specify file name for the image file. If the data is stored in multiple files, then use SetFileNames or SetFilePrefix instead.

Reimplemented in vtkMINCImageReader, vtkDICOMImageReader, and vtkSLCReader.

virtual char* vtkImageReader2::GetFileName ( )
virtual

Specify file name for the image file. If the data is stored in multiple files, then use SetFileNames or SetFilePrefix instead.

Reimplemented in vtkSLCReader.

virtual void vtkImageReader2::SetFileNames ( vtkStringArray )
virtual

Specify a list of file names. Each file must be a single slice, and each slice must be of the same size. The files must be in the correct order. Use SetFileName when reading a volume (multiple slice), since DataExtent will be modified after a SetFileNames call.

virtual vtkStringArray* vtkImageReader2::GetFileNames ( )
virtual

Specify a list of file names. Each file must be a single slice, and each slice must be of the same size. The files must be in the correct order. Use SetFileName when reading a volume (multiple slice), since DataExtent will be modified after a SetFileNames call.

virtual void vtkImageReader2::SetFilePrefix ( const char *  )
virtual

Specify file prefix for the image file or files. This can be used in place of SetFileName or SetFileNames if the filenames follow a specific naming pattern, but you must explicitly set the DataExtent so that the reader will know what range of slices to load.

virtual char* vtkImageReader2::GetFilePrefix ( )
virtual

Specify file prefix for the image file or files. This can be used in place of SetFileName or SetFileNames if the filenames follow a specific naming pattern, but you must explicitly set the DataExtent so that the reader will know what range of slices to load.

virtual void vtkImageReader2::SetFilePattern ( const char *  )
virtual

The sprintf-style format string used to build filename from FilePrefix and slice number.

virtual char* vtkImageReader2::GetFilePattern ( )
virtual

The sprintf-style format string used to build filename from FilePrefix and slice number.

virtual void vtkImageReader2::SetDataScalarType ( int  type)
virtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

virtual void vtkImageReader2::SetDataScalarTypeToFloat ( )
inlinevirtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Definition at line 88 of file vtkImageReader2.h.

virtual void vtkImageReader2::SetDataScalarTypeToDouble ( )
inlinevirtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Definition at line 89 of file vtkImageReader2.h.

virtual void vtkImageReader2::SetDataScalarTypeToInt ( )
inlinevirtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Definition at line 90 of file vtkImageReader2.h.

virtual void vtkImageReader2::SetDataScalarTypeToUnsignedInt ( )
inlinevirtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Definition at line 91 of file vtkImageReader2.h.

virtual void vtkImageReader2::SetDataScalarTypeToShort ( )
inlinevirtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Definition at line 92 of file vtkImageReader2.h.

virtual void vtkImageReader2::SetDataScalarTypeToUnsignedShort ( )
inlinevirtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Definition at line 93 of file vtkImageReader2.h.

virtual void vtkImageReader2::SetDataScalarTypeToChar ( )
inlinevirtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Definition at line 95 of file vtkImageReader2.h.

virtual void vtkImageReader2::SetDataScalarTypeToSignedChar ( )
inlinevirtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Definition at line 97 of file vtkImageReader2.h.

virtual void vtkImageReader2::SetDataScalarTypeToUnsignedChar ( )
inlinevirtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

Definition at line 99 of file vtkImageReader2.h.

virtual int vtkImageReader2::GetDataScalarType ( )
virtual

Get the file format. Pixels are this type in the file.

virtual void vtkImageReader2::SetNumberOfScalarComponents ( int  )
virtual

Set/Get the number of scalar components

virtual int vtkImageReader2::GetNumberOfScalarComponents ( )
virtual

Set/Get the number of scalar components

virtual void vtkImageReader2::SetDataExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
virtual

Get/Set the extent of the data on disk.

virtual void vtkImageReader2::SetDataExtent ( int  [6])
virtual

Get/Set the extent of the data on disk.

virtual int* vtkImageReader2::GetDataExtent ( )
virtual

Get/Set the extent of the data on disk.

virtual void vtkImageReader2::GetDataExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
)
virtual

Get/Set the extent of the data on disk.

virtual void vtkImageReader2::GetDataExtent ( int  [6])
virtual

Get/Set the extent of the data on disk.

virtual void vtkImageReader2::SetFileDimensionality ( int  )
virtual

The number of dimensions stored in a file. This defaults to two.

int vtkImageReader2::GetFileDimensionality ( )
inline

The number of dimensions stored in a file. This defaults to two.

Definition at line 123 of file vtkImageReader2.h.

virtual void vtkImageReader2::SetDataSpacing ( double  ,
double  ,
double   
)
virtual

Set/Get the spacing of the data in the file.

virtual void vtkImageReader2::SetDataSpacing ( double  [3])
virtual

Set/Get the spacing of the data in the file.

virtual double* vtkImageReader2::GetDataSpacing ( )
virtual

Set/Get the spacing of the data in the file.

virtual void vtkImageReader2::GetDataSpacing ( double &  ,
double &  ,
double &   
)
virtual

Set/Get the spacing of the data in the file.

virtual void vtkImageReader2::GetDataSpacing ( double  [3])
virtual

Set/Get the spacing of the data in the file.

virtual void vtkImageReader2::SetDataOrigin ( double  ,
double  ,
double   
)
virtual

Set/Get the origin of the data (location of first pixel in the file).

virtual void vtkImageReader2::SetDataOrigin ( double  [3])
virtual

Set/Get the origin of the data (location of first pixel in the file).

virtual double* vtkImageReader2::GetDataOrigin ( )
virtual

Set/Get the origin of the data (location of first pixel in the file).

virtual void vtkImageReader2::GetDataOrigin ( double &  ,
double &  ,
double &   
)
virtual

Set/Get the origin of the data (location of first pixel in the file).

virtual void vtkImageReader2::GetDataOrigin ( double  [3])
virtual

Set/Get the origin of the data (location of first pixel in the file).

unsigned long vtkImageReader2::GetHeaderSize ( )

Get the size of the header computed by this object.

unsigned long vtkImageReader2::GetHeaderSize ( unsigned long  slice)

Get the size of the header computed by this object.

virtual void vtkImageReader2::SetHeaderSize ( unsigned long  size)
virtual

If there is a tail on the file, you want to explicitly set the header size.

virtual void vtkImageReader2::SetDataByteOrderToBigEndian ( )
virtual

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.

virtual void vtkImageReader2::SetDataByteOrderToLittleEndian ( )
virtual

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.

virtual int vtkImageReader2::GetDataByteOrder ( )
virtual

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

virtual void vtkImageReader2::SetDataByteOrder ( int  )
virtual

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.

virtual const char* vtkImageReader2::GetDataByteOrderAsString ( )
virtual

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.

virtual void vtkImageReader2::SetFileNameSliceOffset ( int  )
virtual

When reading files which start at an unusual index, this can be added to the slice number when generating the file name (default = 0)

virtual int vtkImageReader2::GetFileNameSliceOffset ( )
virtual

When reading files which start at an unusual index, this can be added to the slice number when generating the file name (default = 0)

virtual void vtkImageReader2::SetFileNameSliceSpacing ( int  )
virtual

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)

virtual int vtkImageReader2::GetFileNameSliceSpacing ( )
virtual

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)

virtual void vtkImageReader2::SetSwapBytes ( int  )
virtual

Set/Get the byte swapping to explicitly swap the bytes of a file.

virtual int vtkImageReader2::GetSwapBytes ( )
inlinevirtual

Set/Get the byte swapping to explicitly swap the bytes of a file.

Definition at line 185 of file vtkImageReader2.h.

virtual void vtkImageReader2::SwapBytesOn ( )
virtual

Set/Get the byte swapping to explicitly swap the bytes of a file.

virtual void vtkImageReader2::SwapBytesOff ( )
virtual

Set/Get the byte swapping to explicitly swap the bytes of a file.

ifstream* vtkImageReader2::GetFile ( )
inline

Definition at line 190 of file vtkImageReader2.h.

virtual unsigned long* vtkImageReader2::GetDataIncrements ( )
virtual
virtual void vtkImageReader2::GetDataIncrements ( unsigned long  data[4])
virtual
virtual int vtkImageReader2::OpenFile ( )
virtual
virtual void vtkImageReader2::SeekFile ( int  i,
int  j,
int  k 
)
virtual
virtual void vtkImageReader2::FileLowerLeftOn ( )
virtual

Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.

virtual void vtkImageReader2::FileLowerLeftOff ( )
virtual

Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.

virtual int vtkImageReader2::GetFileLowerLeft ( )
virtual

Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.

virtual void vtkImageReader2::SetFileLowerLeft ( int  )
virtual

Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.

virtual void vtkImageReader2::ComputeInternalFileName ( int  slice)
virtual

Set/Get the internal file name

virtual char* vtkImageReader2::GetInternalFileName ( )
virtual

Set/Get the internal file name

virtual int vtkImageReader2::CanReadFile ( const char *  vtkNotUsedfname)
inlinevirtual

Return non zero if the reader can read the given file name. Should be implemented by all sub-classes of vtkImageReader2. For non zero return values the following values are to be used 1 - I think I can read the file but I cannot prove it 2 - I definitely can read the file 3 - I can read the file and I have validated that I am the correct reader for this file

Definition at line 218 of file vtkImageReader2.h.

virtual const char* vtkImageReader2::GetFileExtensions ( )
inlinevirtual

Get the file extensions for this format. Returns a string with a space separated list of extensions in the format .extension

Reimplemented in vtkDICOMImageReader, vtkMINCImageReader, vtkMetaImageReader, vtkBMPReader, vtkSLCReader, vtkPNMReader, vtkTIFFReader, vtkGESignaReader, vtkJPEGReader, and vtkPNGReader.

Definition at line 227 of file vtkImageReader2.h.

virtual const char* vtkImageReader2::GetDescriptiveName ( )
inlinevirtual

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

Reimplemented in vtkDICOMImageReader, vtkMINCImageReader, vtkMetaImageReader, vtkBMPReader, vtkSLCReader, vtkPNMReader, vtkTIFFReader, vtkGESignaReader, vtkJPEGReader, and vtkPNGReader.

Definition at line 236 of file vtkImageReader2.h.

virtual int vtkImageReader2::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMetaImageReader, vtkImageReader, vtkSLCReader, and vtkPNrrdReader.

virtual void vtkImageReader2::ExecuteInformation ( )
protectedvirtual
virtual void vtkImageReader2::ExecuteData ( vtkDataObject output)
protectedvirtual
virtual void vtkImageReader2::ComputeDataIncrements ( )
protectedvirtual

Reimplemented in vtkBMPReader.


Member Data Documentation

vtkStringArray* vtkImageReader2::FileNames
protected

Definition at line 245 of file vtkImageReader2.h.

char* vtkImageReader2::InternalFileName
protected

Definition at line 247 of file vtkImageReader2.h.

char* vtkImageReader2::FileName
protected

Definition at line 248 of file vtkImageReader2.h.

char* vtkImageReader2::FilePrefix
protected

Definition at line 249 of file vtkImageReader2.h.

char* vtkImageReader2::FilePattern
protected

Definition at line 250 of file vtkImageReader2.h.

int vtkImageReader2::NumberOfScalarComponents
protected

Definition at line 251 of file vtkImageReader2.h.

int vtkImageReader2::FileLowerLeft
protected

Definition at line 252 of file vtkImageReader2.h.

ifstream* vtkImageReader2::File
protected

Definition at line 254 of file vtkImageReader2.h.

unsigned long vtkImageReader2::DataIncrements[4]
protected

Definition at line 255 of file vtkImageReader2.h.

int vtkImageReader2::DataExtent[6]
protected

Definition at line 256 of file vtkImageReader2.h.

int vtkImageReader2::SwapBytes
protected

Definition at line 257 of file vtkImageReader2.h.

int vtkImageReader2::FileDimensionality
protected

Definition at line 259 of file vtkImageReader2.h.

unsigned long vtkImageReader2::HeaderSize
protected

Definition at line 260 of file vtkImageReader2.h.

int vtkImageReader2::DataScalarType
protected

Definition at line 261 of file vtkImageReader2.h.

unsigned long vtkImageReader2::ManualHeaderSize
protected

Definition at line 262 of file vtkImageReader2.h.

double vtkImageReader2::DataSpacing[3]
protected

Definition at line 264 of file vtkImageReader2.h.

double vtkImageReader2::DataOrigin[3]
protected

Definition at line 265 of file vtkImageReader2.h.

int vtkImageReader2::FileNameSliceOffset
protected

Definition at line 267 of file vtkImageReader2.h.

int vtkImageReader2::FileNameSliceSpacing
protected

Definition at line 268 of file vtkImageReader2.h.


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