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

read image files More...

#include <vtkVolumeReader.h>

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

List of all members.

Public Types

typedef vtkImageAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkVolumeReaderNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkImageDataGetImage (int ImageNumber)=0
virtual void SetFilePrefix (const char *)
virtual char * GetFilePrefix ()
virtual void SetFilePattern (const char *)
virtual char * GetFilePattern ()
virtual void SetImageRange (int, int)
void SetImageRange (int[2])
virtual intGetImageRange ()
virtual void GetImageRange (int data[2])
virtual void SetDataSpacing (double, double, double)
virtual void SetDataSpacing (double[3])
virtual doubleGetDataSpacing ()
virtual void GetDataSpacing (double data[3])
virtual void SetDataOrigin (double, double, double)
virtual void SetDataOrigin (double[3])
virtual doubleGetDataOrigin ()
virtual void GetDataOrigin (double data[3])

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkVolumeReaderSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkVolumeReader ()
 ~vtkVolumeReader ()

Protected Attributes

char * FilePrefix
char * FilePattern
int ImageRange [2]
double DataSpacing [3]
double DataOrigin [3]

Detailed Description

read image files

vtkVolumeReader is a source object that reads image files.

VolumeReader creates structured point datasets. The dimension of the dataset depends upon the number of files read. Reading a single file results in a 2D image, while reading more than one file results in a 3D volume.

File names are created using FilePattern and FilePrefix as follows: sprintf (filename, FilePattern, FilePrefix, number); where number is in the range ImageRange[0] to ImageRange[1]. If ImageRange[1] <= ImageRange[0], then slice number ImageRange[0] is read. Thus to read an image set ImageRange[0] = ImageRange[1] = slice number. The default behavior is to read a single file (i.e., image slice 1).

The DataMask instance variable is used to read data files with imbedded connectivity or segmentation information. For example, some data has the high order bit set to indicate connected surface. The DataMask allows you to select this data. Other important ivars include HeaderSize, which allows you to skip over initial info, and SwapBytes, which turns on/off byte swapping. Consider using vtkImageReader as a replacement.

See also:
vtkSliceCubes vtkMarchingCubes vtkPNMReader vtkVolume16Reader vtkImageReader

Definition at line 50 of file vtkVolumeReader.h.


Member Typedef Documentation

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkVolume16Reader.

Definition at line 53 of file vtkVolumeReader.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkVolumeReader::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 vtkVolume16Reader.

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

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkVolume16Reader.

virtual vtkObjectBase* vtkVolumeReader::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkVolume16Reader.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkVolume16Reader.

void vtkVolumeReader::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 vtkVolume16Reader.

virtual void vtkVolumeReader::SetFilePrefix ( const char *  ) [virtual]

Specify file prefix for the image file(s).

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

Specify file prefix for the image file(s).

virtual void vtkVolumeReader::SetFilePattern ( const char *  ) [virtual]

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

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

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

virtual void vtkVolumeReader::SetImageRange ( int  ,
int   
) [virtual]

Set the range of files to read.

Set the range of files to read.

virtual int* vtkVolumeReader::GetImageRange ( ) [virtual]

Set the range of files to read.

virtual void vtkVolumeReader::GetImageRange ( int  data[2]) [virtual]

Set the range of files to read.

virtual void vtkVolumeReader::SetDataSpacing ( double  ,
double  ,
double   
) [virtual]

Specify the spacing for the data.

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

Specify the spacing for the data.

virtual double* vtkVolumeReader::GetDataSpacing ( ) [virtual]

Specify the spacing for the data.

virtual void vtkVolumeReader::GetDataSpacing ( double  data[3]) [virtual]

Specify the spacing for the data.

virtual void vtkVolumeReader::SetDataOrigin ( double  ,
double  ,
double   
) [virtual]

Specify the origin for the data.

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

Specify the origin for the data.

virtual double* vtkVolumeReader::GetDataOrigin ( ) [virtual]

Specify the origin for the data.

virtual void vtkVolumeReader::GetDataOrigin ( double  data[3]) [virtual]

Specify the origin for the data.

virtual vtkImageData* vtkVolumeReader::GetImage ( int  ImageNumber) [pure virtual]

Other objects make use of this method.

Implemented in vtkVolume16Reader.


Member Data Documentation

char* vtkVolumeReader::FilePrefix [protected]

Definition at line 93 of file vtkVolumeReader.h.

char* vtkVolumeReader::FilePattern [protected]

Definition at line 94 of file vtkVolumeReader.h.

Definition at line 95 of file vtkVolumeReader.h.

Definition at line 96 of file vtkVolumeReader.h.

Definition at line 97 of file vtkVolumeReader.h.


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