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:
[legend]
Collaboration diagram for vtkImageReader:
[legend]

List of all members.

Public Types

typedef vtkImageReader2 Superclass
- Public Types inherited from vtkImageReader2
- 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)
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 int * GetDataVOI ()
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 ()
- Public Member Functions inherited from vtkImageReader2
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 ()
virtual const char * GetDescriptiveName ()
- 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 vtkImageReaderNew ()
static int IsTypeOf (const char *type)
static vtkImageReaderSafeDownCast (vtkObject *o)

Protected Member Functions

 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 ExecuteData (vtkDataObject *data)
- Protected Member Functions inherited from vtkImageReader2
virtual void ExecuteInformation ()
virtual void ComputeDataIncrements ()
 vtkImageReader2 ()
 ~vtkImageReader2 ()
- 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

vtkTypeUInt64 DataMask
vtkTransformTransform
int DataVOI [6]
char * ScalarArrayName
- Protected Attributes inherited from vtkImageReader2
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

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 42 of file vtkImageReader.h.


Member Typedef Documentation

Reimplemented from vtkImageReader2.

Reimplemented in vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, and vtkPNMReader.

Definition at line 46 of file vtkImageReader.h.


Constructor & Destructor Documentation

vtkImageReader::vtkImageReader ( )
protected
vtkImageReader::~vtkImageReader ( )
protected

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, and vtkPNMReader.

virtual const char* vtkImageReader::GetClassName ( )
virtual

Reimplemented from vtkImageReader2.

Reimplemented in vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, 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, and vtkPNMReader.

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, and vtkPNMReader.

static vtkImageReader* vtkImageReader::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkImageReader2.

Reimplemented in vtkMPIImageReader, vtkBMPReader, vtkPNrrdReader, and vtkPNMReader.

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, 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.

virtual vtkTransform* vtkImageReader::GetTransform ( )
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.

void vtkImageReader::ComputeInverseTransformedExtent ( int  inExtent[6],
int  outExtent[6] 
)
void vtkImageReader::ComputeInverseTransformedIncrements ( vtkIdType  inIncr[3],
vtkIdType  outIncr[3] 
)
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 
)
protectedvirtual

Reimplemented from vtkImageReader2.

Reimplemented in vtkPNrrdReader.

void vtkImageReader::ExecuteData ( vtkDataObject output)
protectedvirtual

This method is the old style execute method

Reimplemented from vtkImageReader2.

Reimplemented in vtkBMPReader, and vtkMPIImageReader.


Member Data Documentation

vtkTypeUInt64 vtkImageReader::DataMask
protected

Definition at line 94 of file vtkImageReader.h.

vtkTransform* vtkImageReader::Transform
protected

Definition at line 96 of file vtkImageReader.h.

int vtkImageReader::DataVOI[6]
protected

Definition at line 105 of file vtkImageReader.h.

char* vtkImageReader::ScalarArrayName
protected

Definition at line 107 of file vtkImageReader.h.


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