Man Page for vtkVolumeReader
Table of Contents

NAME

vtkVolumeReader - read image files

SYNOPSIS


#include "/opt/vtk-c++/graphics/vtkVolumeReader.h"

class VTK_EXPORT vtkVolumeReader : public vtkStructuredPointsSource

vtkVolumeReader();
const char *GetClassName() {return "vtkVolumeReader";};
void PrintSelf(ostream& os, vtkIndent indent);
void SetFilePrefix(char *);
char *GetFilePrefix();
void SetFilePattern(char *);
char *GetFilePattern();
void SetImageRange(int, int);
void SetImageRange(int *);
int *GetImageRange();
void GetImageRange(int data[2]);
void SetDataSpacing(float, float, float);
void SetDataSpacing(float *);
float *GetDataSpacing();
void GetDataSpacing(float data[3]);
void SetDataOrigin(float, float, float);
void SetDataOrigin(float *);
float *GetDataOrigin();
void GetDataOrigin(float data[3]);
virtual vtkStructuredPoints *GetImage(int ImageNumber) = 0;

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] = 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.

SEE ALSO

vtkSliceCubes vtkMarchingCubes vtkPNMReader vtkVolume16Reader

SUMMARY

void SetFilePrefix(char *)
Specify file prefix for the image file(s).

void SetFilePattern(char *)
The sprintf format used to build filename from FilePrefix and number.

void SetImageRange(int, int)
void SetImageRange(int *)
Set the range of files to read.

void SetDataSpacing(float, float, float)
void SetDataSpacing(float *)
Specify the spacing for the data.

void SetDataOrigin(float, float, float)
void SetDataOrigin(float *)
Specify the origin for the data.

vtkVolumeReader()
Construct object with NULL file prefix; file pattern "%s.%d"; image range set to (1,1);


Table of Contents