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

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 Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
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 int * GetImageRange ()
virtual void GetImageRange (int data[2])
virtual void SetDataSpacing (float, float, float)
virtual void SetDataSpacing (float[3])
virtual float * GetDataSpacing ()
virtual void GetDataSpacing (float data[3])
virtual void SetDataOrigin (float, float, float)
virtual void SetDataOrigin (float[3])
virtual float * GetDataOrigin ()
virtual void GetDataOrigin (float data[3])
virtual vtkStructuredPointsGetImage (int ImageNumber)=0

Static Public Methods

int IsTypeOf (const char *type)
vtkVolumeReader * SafeDownCast (vtkObject *o)

Protected Methods

 vtkVolumeReader ()
 ~vtkVolumeReader ()
 vtkVolumeReader (const vtkVolumeReader &)
void operator= (const vtkVolumeReader &)

Protected Attributes

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

Detailed Description

read image files.

Date:
2000/12/10 20:08:59
Revision:
1.23

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 77 of file vtkVolumeReader.h.


Constructor & Destructor Documentation

vtkVolumeReader::vtkVolumeReader   [protected]
 

vtkVolumeReader::~vtkVolumeReader   [protected]
 

vtkVolumeReader::vtkVolumeReader const vtkVolumeReader &    [inline, protected]
 

Definition at line 109 of file vtkVolumeReader.h.


Member Function Documentation

virtual const char* vtkVolumeReader::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 vtkStructuredPointsSource.

Reimplemented in vtkVolume16Reader.

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

Reimplemented in vtkVolume16Reader.

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

Reimplemented in vtkVolume16Reader.

vtkVolumeReader* vtkVolumeReader::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 vtkStructuredPointsSource.

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

Reimplemented in vtkVolume16Reader.

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

Specify file prefix for the image file(s).

virtual char* vtkVolumeReader::GetFilePrefix   [virtual]
 

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

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

virtual char* vtkVolumeReader::GetFilePattern   [virtual]
 

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

Set the range of files to read.

void vtkVolumeReader::SetImageRange int   [2]
 

virtual int* vtkVolumeReader::GetImageRange   [virtual]
 

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

virtual void vtkVolumeReader::SetDataSpacing float   ,
float   ,
float   
[virtual]
 

Specify the spacing for the data.

virtual void vtkVolumeReader::SetDataSpacing float   [3] [virtual]
 

virtual float* vtkVolumeReader::GetDataSpacing   [virtual]
 

virtual void vtkVolumeReader::GetDataSpacing float    data[3] [virtual]
 

virtual void vtkVolumeReader::SetDataOrigin float   ,
float   ,
float   
[virtual]
 

Specify the origin for the data.

virtual void vtkVolumeReader::SetDataOrigin float   [3] [virtual]
 

virtual float* vtkVolumeReader::GetDataOrigin   [virtual]
 

virtual void vtkVolumeReader::GetDataOrigin float    data[3] [virtual]
 

virtual vtkStructuredPoints* vtkVolumeReader::GetImage int    ImageNumber [pure virtual]
 

Other objects make use of this method.

Reimplemented in vtkVolume16Reader.

void vtkVolumeReader::operator= const vtkVolumeReader &    [inline, protected]
 

Definition at line 110 of file vtkVolumeReader.h.


Member Data Documentation

char* vtkVolumeReader::FilePrefix [protected]
 

Definition at line 112 of file vtkVolumeReader.h.

char* vtkVolumeReader::FilePattern [protected]
 

Definition at line 113 of file vtkVolumeReader.h.

int vtkVolumeReader::ImageRange[2] [protected]
 

Definition at line 114 of file vtkVolumeReader.h.

float vtkVolumeReader::DataSpacing[3] [protected]
 

Definition at line 115 of file vtkVolumeReader.h.

float vtkVolumeReader::DataOrigin[3] [protected]
 

Definition at line 116 of file vtkVolumeReader.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 13:01:52 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001