Main Page   Class Hierarchy   Alphabetical List   Compound List   Compound Members   Related Pages  

vtkImageReader Class Reference

Superclass of 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 Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetFileName (const char *)
virtual char * GetFileName ()
void SetFilePrefix (const char *)
virtual char * GetFilePrefix ()
void SetFilePattern (const char *)
virtual char * GetFilePattern ()
void SetDataScalarType (int type)
void SetDataScalarTypeToFloat ()
void SetDataScalarTypeToDouble ()
void SetDataScalarTypeToInt ()
void SetDataScalarTypeToShort ()
void SetDataScalarTypeToUnsignedShort ()
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 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 void SetFileDimensionality (int)
int GetFileDimensionality ()
virtual void SetDataSpacing (float, float, float)
virtual void SetDataSpacing (float[3])
virtual float * GetDataSpacing ()
virtual void GetDataSpacing (float &, float &, float &)
virtual void GetDataSpacing (float[3])
virtual void SetDataOrigin (float, float, float)
virtual void SetDataOrigin (float[3])
virtual float * GetDataOrigin ()
virtual void GetDataOrigin (float &, float &, float &)
virtual void GetDataOrigin (float[3])
int GetHeaderSize ()
int GetHeaderSize (int slice)
void SetHeaderSize (int size)
virtual unsigned short GetDataMask ()
void SetDataMask (int val)
virtual void SetTransform (vtkTransform *)
virtual vtkTransformGetTransform ()
void SetDataByteOrderToBigEndian ()
void SetDataByteOrderToLittleEndian ()
int GetDataByteOrder ()
void SetDataByteOrder (int)
const char * GetDataByteOrderAsString ()
virtual void SetSwapBytes (int)
int GetSwapBytes ()
virtual void SwapBytesOn ()
virtual void SwapBytesOff ()
ifstream * GetFile ()
virtual unsigned long * GetDataIncrements ()
virtual void GetDataIncrements (unsigned long data[4])
void ComputeInverseTransformedExtent (int inExtent[6], int outExtent[6])
void ComputeInverseTransformedIncrements (int inIncr[3], int outIncr[3])
void OpenFile ()
void OpenAndSeekFile (int extent[6], int slice)
virtual void FileLowerLeftOn ()
virtual void FileLowerLeftOff ()
virtual int GetFileLowerLeft ()
virtual void SetFileLowerLeft (int)
void ComputeInternalFileName (int slice)
virtual char * GetInternalFileName ()

Static Public Methods

vtkImageReader * New ()
int IsTypeOf (const char *type)
vtkImageReader * SafeDownCast (vtkObject *o)

Protected Methods

 vtkImageReader ()
 ~vtkImageReader ()
 vtkImageReader (const vtkImageReader &)
void operator= (const vtkImageReader &)
void ComputeTransformedSpacing (float Spacing[3])
void ComputeTransformedOrigin (float origin[3])
void ComputeTransformedExtent (int inExtent[6], int outExtent[6])
void ComputeTransformedIncrements (int inIncr[3], int outIncr[3])
void ExecuteInformation ()
void Execute ()
void Execute (vtkImageData *data)
virtual void ComputeDataIncrements ()

Protected Attributes

char * InternalFileName
char * FileName
char * FilePrefix
char * FilePattern
int NumberOfScalarComponents
int FileLowerLeft
ifstream * File
unsigned long DataIncrements [4]
int DataExtent [6]
unsigned short DataMask
int SwapBytes
int FileDimensionality
int HeaderSize
int DataScalarType
int ManualHeaderSize
int Initialized
vtkTransformTransform
int DataDimensions [3]
float DataSpacing [3]
float DataOrigin [3]
int DataVOI [6]

Detailed Description

Superclass of binary file readers.

Date:
2000/12/10 20:09:10
Revision:
1.53
Thanks:
Thanks to C. Charles Law who developed this class.
vtkImageReader provides methods needed to read a region from a file.

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


Member Function Documentation

void vtkImageReader::ComputeInternalFileName int    slice
 

Set/Get the internal file name

virtual void vtkImageReader::FileLowerLeftOn   [virtual]
 

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

virtual const char* vtkImageReader::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageSource.

Reimplemented in vtkBMPReader.

virtual unsigned short vtkImageReader::GetDataMask   [virtual]
 

Set/Get the Data mask.

virtual int vtkImageReader::GetDataScalarType   [virtual]
 

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

int vtkImageReader::GetHeaderSize  
 

Get the size of the header computed by this object.

virtual int vtkImageReader::IsA const char *    type [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 vtkImageSource.

Reimplemented in vtkBMPReader.

int vtkImageReader::IsTypeOf const char *    type [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 vtkImageSource.

Reimplemented in vtkBMPReader.

vtkImageReader* vtkImageReader::New   [static]
 

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkImageSource.

Reimplemented in vtkBMPReader.

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

Reimplemented in vtkBMPReader.

vtkImageReader* vtkImageReader::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageSource.

Reimplemented in vtkBMPReader.

void vtkImageReader::SetDataByteOrderToBigEndian  
 

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 vtkImageReader::SetDataExtent int   ,
int   ,
int   ,
int   ,
int   ,
int   
[virtual]
 

Get/Set the extent of the data on disk.

virtual void vtkImageReader::SetDataOrigin float   ,
float   ,
float   
[virtual]
 

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

void vtkImageReader::SetDataScalarType int    type
 

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

virtual void vtkImageReader::SetDataSpacing float   ,
float   ,
float   
[virtual]
 

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

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::SetFileDimensionality int    [virtual]
 

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

void vtkImageReader::SetFileName const char *   
 

Specify file name for the image file. You should specify either a FileName or a FilePrefix. Use FilePrefix if the data is stored in multiple files.

void vtkImageReader::SetFilePattern const char *   
 

The sprintf format used to build filename from FilePrefix and number.

void vtkImageReader::SetFilePrefix const char *   
 

Specify file prefix for the image file(s).You should specify either a FileName or FilePrefix. Use FilePrefix if the data is stored in multiple files.

void vtkImageReader::SetHeaderSize int    size
 

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

virtual void vtkImageReader::SetNumberOfScalarComponents int    [virtual]
 

Set/Get the number of scalar components

virtual void vtkImageReader::SetSwapBytes int    [virtual]
 

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

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.


The documentation for this class was generated from the following file:
Generated on Tue Mar 19 13:26:52 2002 for VTK by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002