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

vtkImageReader2 Class Reference

Superclass of binary file readers. More...

#include <vtkImageReader2.h>

Inheritance diagram for vtkImageReader2:

Inheritance graph
[legend]
Collaboration diagram for vtkImageReader2:

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 SetHeaderSize (int size)
ifstream * GetFile ()
virtual unsigned long * GetDataIncrements ()
virtual void GetDataIncrements (unsigned long data[4])
void OpenFile ()
void SeekFile (int i, int j, int k)
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 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 SetDataByteOrderToBigEndian ()
void SetDataByteOrderToLittleEndian ()
int GetDataByteOrder ()
void SetDataByteOrder (int)
const char * GetDataByteOrderAsString ()
virtual void SetSwapBytes (int)
int GetSwapBytes ()
virtual void SwapBytesOn ()
virtual void SwapBytesOff ()
virtual void FileLowerLeftOn ()
virtual void FileLowerLeftOff ()
virtual int GetFileLowerLeft ()
virtual void SetFileLowerLeft (int)
void ComputeInternalFileName (int slice)
virtual char * GetInternalFileName ()

Static Public Methods

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

Protected Methods

 vtkImageReader2 ()
 ~vtkImageReader2 ()
virtual void ExecuteInformation ()
virtual void ExecuteData (vtkDataObject *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]
int SwapBytes
int FileDimensionality
int HeaderSize
int DataScalarType
int ManualHeaderSize
float DataSpacing [3]
float DataOrigin [3]

Detailed Description

Superclass of binary file readers.

Date:
2002/01/09 21:21:48
Revision:
1.4.2.1

vtkImageReader2 is a slightly simplified version of vtkImageReader, it is a good superclass for streaming readers

See also:
vtkBMPReader vtkPNMReader vtkTIFFReader

Definition at line 60 of file vtkImageReader2.h.

Constructor & Destructor Documentation

vtkImageReader2::vtkImageReader2 (    )  [protected]
 

vtkImageReader2::~vtkImageReader2 (    )  [protected]
 

Member Function Documentation

vtkImageReader2* vtkImageReader2::New (    )  [static]
 

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

Reimplemented from vtkImageSource.

Reimplemented in vtkGESignaReader, vtkJPEGReader, and vtkPNGReader.

virtual const char* vtkImageReader2::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 vtkGESignaReader, vtkJPEGReader, and vtkPNGReader.

int vtkImageReader2::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 vtkGESignaReader, vtkJPEGReader, and vtkPNGReader.

virtual int vtkImageReader2::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 vtkGESignaReader, vtkJPEGReader, and vtkPNGReader.

vtkImageReader2* vtkImageReader2::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 vtkGESignaReader, vtkJPEGReader, and vtkPNGReader.

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

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

virtual char* vtkImageReader2::GetFileName (    )  [virtual]
 

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

virtual char* vtkImageReader2::GetFilePrefix (    )  [virtual]
 

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 vtkImageReader2::SetFilePattern (  const char *    ) 
 

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

virtual char* vtkImageReader2::GetFilePattern (    )  [virtual]
 

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

void vtkImageReader2::SetDataScalarType (  int    type ) 
 

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.

void vtkImageReader2::SetDataScalarTypeToFloat (    )  [inline]
 

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 94 of file vtkImageReader2.h.

void vtkImageReader2::SetDataScalarTypeToDouble (    )  [inline]
 

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.

void vtkImageReader2::SetDataScalarTypeToInt (    )  [inline]
 

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 96 of file vtkImageReader2.h.

void vtkImageReader2::SetDataScalarTypeToShort (    )  [inline]
 

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.

void vtkImageReader2::SetDataScalarTypeToUnsignedShort (    )  [inline]
 

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 98 of file vtkImageReader2.h.

void vtkImageReader2::SetDataScalarTypeToUnsignedChar (    )  [inline]
 

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 100 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 124 of file vtkImageReader2.h.

virtual void vtkImageReader2::SetDataSpacing (  float   ,
float   ,
float   
)  [virtual]
 

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

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

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

virtual float* vtkImageReader2::GetDataSpacing (    )  [virtual]
 

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

virtual void vtkImageReader2::GetDataSpacing (  float &   ,
float &   ,
float &   
)  [virtual]
 

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

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

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

virtual void vtkImageReader2::SetDataOrigin (  float   ,
float   ,
float   
)  [virtual]
 

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

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

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

virtual float* vtkImageReader2::GetDataOrigin (    )  [virtual]
 

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

virtual void vtkImageReader2::GetDataOrigin (  float &   ,
float &   ,
float &   
)  [virtual]
 

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

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

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

int vtkImageReader2::GetHeaderSize (    ) 
 

Get the size of the header computed by this object.

int vtkImageReader2::GetHeaderSize (  int    slice ) 
 

Get the size of the header computed by this object.

void vtkImageReader2::SetHeaderSize (  int    size ) 
 

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

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

void vtkImageReader2::SetDataByteOrderToLittleEndian (    ) 
 

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.

int vtkImageReader2::GetDataByteOrder (    ) 
 

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.

void vtkImageReader2::SetDataByteOrder (  int    ) 
 

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.

const char* vtkImageReader2::GetDataByteOrderAsString (    ) 
 

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::SetSwapBytes (  int    )  [virtual]
 

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

int vtkImageReader2::GetSwapBytes (    )  [inline]
 

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

Definition at line 170 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 175 of file vtkImageReader2.h.

virtual unsigned long* vtkImageReader2::GetDataIncrements (    )  [virtual]
 

virtual void vtkImageReader2::GetDataIncrements (  unsigned long    data[4] )  [virtual]
 

void vtkImageReader2::OpenFile (    ) 
 

void vtkImageReader2::SeekFile (  int    i,
int    j,
int    k
) 
 

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.

void vtkImageReader2::ComputeInternalFileName (  int    slice ) 
 

Set/Get the internal file name

virtual char* vtkImageReader2::GetInternalFileName (    )  [virtual]
 

Set/Get the internal file name

virtual void vtkImageReader2::ExecuteInformation (    )  [protected, virtual]
 

Reimplemented from vtkSource.

Reimplemented in vtkGESignaReader, vtkJPEGReader, and vtkPNGReader.

virtual void vtkImageReader2::ExecuteData (  vtkDataObject *    out )  [protected, virtual]
 

Reimplemented in vtkGESignaReader, vtkJPEGReader, and vtkPNGReader.

virtual void vtkImageReader2::ComputeDataIncrements (    )  [protected, virtual]
 

Member Data Documentation

char* vtkImageReader2::InternalFileName [protected]
 

Definition at line 200 of file vtkImageReader2.h.

char* vtkImageReader2::FileName [protected]
 

Definition at line 201 of file vtkImageReader2.h.

char* vtkImageReader2::FilePrefix [protected]
 

Definition at line 202 of file vtkImageReader2.h.

char* vtkImageReader2::FilePattern [protected]
 

Definition at line 203 of file vtkImageReader2.h.

int vtkImageReader2::NumberOfScalarComponents [protected]
 

Definition at line 204 of file vtkImageReader2.h.

int vtkImageReader2::FileLowerLeft [protected]
 

Definition at line 205 of file vtkImageReader2.h.

ifstream* vtkImageReader2::File [protected]
 

Definition at line 207 of file vtkImageReader2.h.

unsigned long vtkImageReader2::DataIncrements[4] [protected]
 

Definition at line 208 of file vtkImageReader2.h.

int vtkImageReader2::DataExtent[6] [protected]
 

Definition at line 209 of file vtkImageReader2.h.

int vtkImageReader2::SwapBytes [protected]
 

Definition at line 210 of file vtkImageReader2.h.

int vtkImageReader2::FileDimensionality [protected]
 

Definition at line 212 of file vtkImageReader2.h.

int vtkImageReader2::HeaderSize [protected]
 

Definition at line 213 of file vtkImageReader2.h.

int vtkImageReader2::DataScalarType [protected]
 

Definition at line 214 of file vtkImageReader2.h.

int vtkImageReader2::ManualHeaderSize [protected]
 

Definition at line 215 of file vtkImageReader2.h.

float vtkImageReader2::DataSpacing[3] [protected]
 

Definition at line 217 of file vtkImageReader2.h.

float vtkImageReader2::DataOrigin[3] [protected]
 

Definition at line 218 of file vtkImageReader2.h.

The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:31:14 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001