NAME
vtkVolume16Reader - read 16 bit image files
SYNOPSIS
#include "/opt/vtk-c++/graphics/vtkVolume16Reader.h"
class VTK_EXPORT vtkVolume16Reader : public vtkVolumeReader
vtkVolume16Reader();
static vtkVolume16Reader *New() {return new vtkVolume16Reader;};
const char *GetClassName() {return "vtkVolume16Reader";};
void PrintSelf(ostream& os, vtkIndent indent);
void SetDataDimensions(int, int);
void SetDataDimensions(int *);
int *GetDataDimensions();
void GetDataDimensions(int data[2]);
void SetDataMask(unsigned short);
unsigned short GetDataMask();
void SetHeaderSize(int);
int GetHeaderSize();
void SetDataByteOrderToBigEndian();
void SetDataByteOrderToLittleEndian();
int GetDataByteOrder();
void SetDataByteOrder(int);
char *GetDataByteOrderAsString();
void SetSwapBytes(int);
int GetSwapBytes();
void SwapBytesOn();
void SwapBytesOff();
void SetTransform(vtkTransform*);
void SetTransform(vtkTransform& );
vtkTransform *GetTransform();
vtkStructuredPoints *GetImage(int ImageNumber);
DESCRIPTION
vtkVolume16Reader is a source object that reads 16 bit image files.
Volume16Reader 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.
The Transform instance variable specifies a permutation transformation to map slice space into world space.
SEE ALSO
vtkSliceCubes vtkMarchingCubes
DEFINED MACROS
VTK_FILE_BYTE_ORDER_BIG_ENDIAN 0
VTK_FILE_BYTE_ORDER_LITTLE_ENDIAN 1
SUMMARY
void SetDataDimensions(int, int)
void SetDataDimensions(int *)
Specify the dimensions for the data.
void SetDataMask(unsigned short)
Specify a mask used to eliminate data in the data file (e.g., connectivity bits).
void SetHeaderSize(int)
Specify the number of bytes to seek over at start of image.
void SetSwapBytes(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.
Turn on/off byte swapping.
void SetTransform(vtkTransform*)
void SetTransform(vtkTransform& )
Set/Get transformation matrix to transform the data from slice space into world space. This matirx must be a permutation matrix. To qualify, the sums of the rows must be + or - 1.
vtkVolume16Reader()
Construct object with NULL file prefix; file pattern "%s.%d"; image range set to (1,1); data origin (0,0,0); data spacing (1,1,1); no data mask; header size 0; and byte swapping turned off.
vtkScalars *ReadImage(int sliceNumber)
Read a slice of volume data.
vtkScalars *ReadVolume(int first, int last)
Read a volume of data.