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

Superclass of transformable binary file readers. More...

#include <vtkImageReader.h>

Inheritance diagram for vtkImageReader:
Inheritance graph
[legend]
Collaboration diagram for vtkImageReader:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkImageReader2 Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkImageReaderNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
void ComputeInverseTransformedExtent (int inExtent[6], int outExtent[6])
void ComputeInverseTransformedIncrements (vtkIdType inIncr[3], vtkIdType outIncr[3])
int OpenAndSeekFile (int extent[6], int slice)
virtual void SetDataVOI (int, int, int, int, int, int)
virtual void SetDataVOI (int[6])
virtual intGetDataVOI ()
virtual void GetDataVOI (int &, int &, int &, int &, int &, int &)
virtual void GetDataVOI (int[6])
virtual vtkTypeUInt64 GetDataMask ()
virtual void SetDataMask (vtkTypeUInt64)
virtual void SetTransform (vtkTransform *)
virtual vtkTransformGetTransform ()
virtual void SetScalarArrayName (const char *)
virtual char * GetScalarArrayName ()

Static Public Member Functions

static vtkImageReaderNew ()
static int IsTypeOf (const char *type)
static vtkImageReaderSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkImageReader ()
 ~vtkImageReader ()
void ComputeTransformedSpacing (double Spacing[3])
void ComputeTransformedOrigin (double origin[3])
void ComputeTransformedExtent (int inExtent[6], int outExtent[6])
void ComputeTransformedIncrements (vtkIdType inIncr[3], vtkIdType outIncr[3])
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void ExecuteDataWithInformation (vtkDataObject *data, vtkInformation *outInfo)

Protected Attributes

vtkTypeUInt64 DataMask
vtkTransformTransform
int DataVOI [6]
char * ScalarArrayName

Detailed Description

Superclass of transformable binary file readers.

vtkImageReader provides methods needed to read a region from a file. It supports both transforms and masks on the input data, but as a result is more complicated and slower than its parent class vtkImageReader2.

See also:
vtkBMPReader vtkPNMReader vtkTIFFReader
Examples:
vtkImageReader (Examples)
Tests:
vtkImageReader (Tests)

Definition at line 43 of file vtkImageReader.h.


Member Typedef Documentation

Reimplemented from vtkImageReader2.

Reimplemented in vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, vtkPNMReader, and vtkNrrdReader.

Definition at line 47 of file vtkImageReader.h.


Constructor & Destructor Documentation


Member Function Documentation

static vtkImageReader* vtkImageReader::New ( ) [static]

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

Reimplemented from vtkImageReader2.

Reimplemented in vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, vtkNrrdReader, and vtkPNMReader.

static int vtkImageReader::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 vtkImageReader2.

Reimplemented in vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, vtkPNMReader, and vtkNrrdReader.

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

Reimplemented in vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, vtkPNMReader, and vtkNrrdReader.

virtual vtkObjectBase* vtkImageReader::NewInstanceInternal ( ) const [protected, virtual]
void vtkImageReader::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 vtkImageReader2.

Reimplemented in vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, vtkNrrdReader, and vtkPNMReader.

virtual void vtkImageReader::SetDataVOI ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

Set/get the data VOI. You can limit the reader to only read a subset of the data.

virtual void vtkImageReader::SetDataVOI ( int  [6]) [virtual]

Set/get the data VOI. You can limit the reader to only read a subset of the data.

virtual int* vtkImageReader::GetDataVOI ( ) [virtual]

Set/get the data VOI. You can limit the reader to only read a subset of the data.

virtual void vtkImageReader::GetDataVOI ( int ,
int ,
int ,
int ,
int ,
int  
) [virtual]

Set/get the data VOI. You can limit the reader to only read a subset of the data.

virtual void vtkImageReader::GetDataVOI ( int  [6]) [virtual]

Set/get the data VOI. You can limit the reader to only read a subset of the data.

virtual vtkTypeUInt64 vtkImageReader::GetDataMask ( ) [virtual]

Set/Get the Data mask. The data mask is a simply integer whose bits are treated as a mask to the bits read from disk. That is, the data mask is bitwise-and'ed to the numbers read from disk. This ivar is stored as 64 bits, the largest mask you will need. The mask will be truncated to the data size required to be read (using the least significant bits).

virtual void vtkImageReader::SetDataMask ( vtkTypeUInt64  ) [virtual]

Set/Get the Data mask. The data mask is a simply integer whose bits are treated as a mask to the bits read from disk. That is, the data mask is bitwise-and'ed to the numbers read from disk. This ivar is stored as 64 bits, the largest mask you will need. The mask will be truncated to the data size required to be read (using the least significant bits).

virtual void vtkImageReader::SetTransform ( vtkTransform ) [virtual]

Set/Get transformation matrix to transform the data from slice space into world space. This matrix must be a permutation matrix. To qualify, the sums of the rows must be + or - 1.

Set/Get transformation matrix to transform the data from slice space into world space. This matrix must be a permutation matrix. To qualify, the sums of the rows must be + or - 1.

void vtkImageReader::ComputeInverseTransformedExtent ( int  inExtent[6],
int  outExtent[6] 
)
int vtkImageReader::OpenAndSeekFile ( int  extent[6],
int  slice 
)
virtual void vtkImageReader::SetScalarArrayName ( const char *  ) [virtual]

Set/get the scalar array name for this data set.

virtual char* vtkImageReader::GetScalarArrayName ( ) [virtual]

Set/get the scalar array name for this data set.

void vtkImageReader::ComputeTransformedSpacing ( double  Spacing[3]) [protected]
void vtkImageReader::ComputeTransformedOrigin ( double  origin[3]) [protected]
void vtkImageReader::ComputeTransformedExtent ( int  inExtent[6],
int  outExtent[6] 
) [protected]
void vtkImageReader::ComputeTransformedIncrements ( vtkIdType  inIncr[3],
vtkIdType  outIncr[3] 
) [protected]
virtual int vtkImageReader::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

Reimplemented from vtkImageReader2.

Reimplemented in vtkNrrdReader.

void vtkImageReader::ExecuteDataWithInformation ( vtkDataObject output,
vtkInformation outInfo 
) [protected, virtual]

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

Reimplemented from vtkImageReader2.

Reimplemented in vtkBMPReader, vtkMPIImageReader, and vtkPNrrdReader.


Member Data Documentation

vtkTypeUInt64 vtkImageReader::DataMask [protected]

Definition at line 95 of file vtkImageReader.h.

Definition at line 97 of file vtkImageReader.h.

int vtkImageReader::DataVOI[6] [protected]

Definition at line 106 of file vtkImageReader.h.

Definition at line 108 of file vtkImageReader.h.


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