Documentation for vtkVolumeReader

vtkVolumeReader - read image files

Super Class: vtkStructuredPointsSource

Description:

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]" 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

 

Methods:

void vtkVolumeReader ()
void vtkVolumeReader ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void SetFilePrefix (char *)
char *GetFilePrefix ()
void SetFilePattern (char *)
char *GetFilePattern ()
void SetImageRange (int ,int )
void SetImageRange (int *)
int *GetImageRange ()
void SetDataSpacing (float ,float ,float )
void SetDataSpacing (float *)
float *GetDataSpacing ()
void SetDataOrigin (float ,float ,float )
void SetDataOrigin (float *)
float *GetDataOrigin ()
vtkStructuredPoints *GetImage (int )

 

Detailed Method Descriptions:

Specify file prefix for the image file(s).

void SetFilePrefix (char *)
char *GetFilePrefix ()

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

void SetFilePattern (char *)
char *GetFilePattern ()

Set the range of files to read.

void SetImageRange (int ,int )
void SetImageRange (int *)
int *GetImageRange ()

Specify the spacing for the data.

void SetDataSpacing (float ,float ,float )
void SetDataSpacing (float *)
float *GetDataSpacing ()

Specify the origin for the data.

void SetDataOrigin (float ,float ,float )
void SetDataOrigin (float *)
float *GetDataOrigin ()

Other objects make use of this method.

vtkStructuredPoints *GetImage (int )