Documentation for vtkImageWriter

vtkImageWriter - Writes images to files.

Super Class: vtkProcessObject

Description:

vtkImageWriter writes images to files with any data type. The data type of the file is the same scalar type as the input. The dimensionality determines whether the data will be written in one or multiple files. This class is used as the superclass of most image writing classes such as vtkBMPWriter etc. It supports streaming.

 

Methods:

void vtkImageWriter ()
void vtkImageWriter ()
static vtkImageWriter *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void SetFileName (char *)
char *GetFileName ()
void SetFilePrefix (char *)
char *GetFilePrefix ()
void SetFilePattern (char *)
char *GetFilePattern ()
void SetFileDimensionality (int )
int GetFileDimensionality ()
void SetInput (vtkImageCache *)
vtkImageCache *GetInput ()
void SetInput (vtkStructuredPoints *)
void Write ()
void RecursiveWrite (int ,vtkImageCache * ,unknown *)
void RecursiveWrite (int ,vtkImageCache * ,vtkImageData * ,unknown *)
void WriteFile (unknown * ,vtkImageData * ,int )
void WriteFileHeader (unknown * ,vtkImageCache *)

 

Detailed Method Descriptions:

Specify file name for the image file. You should specify either a FileName or a FilePrefix. Use FilePrefix if the data is stored in multiple files.

void SetFileName (char *)
char *GetFileName ()

Specify file prefix for the image file(s).You should specify either a FileName or FilePrefix. Use FilePrefix if the data is stored in multiple files.

void SetFilePrefix (char *)
char *GetFilePrefix ()

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

void SetFilePattern (char *)
char *GetFilePattern ()

What dimension are the files to be written. Usually this is 2, or 3. If it is 2 and the input is a volume then the volume will be written as a series of 2d slices.

void SetFileDimensionality (int )
int GetFileDimensionality ()

Set/Get the input object from the image pipeline.

void SetInput (vtkImageCache *)
vtkImageCache *GetInput ()

The main interface which triggers the writer to start.

void SetInput (vtkStructuredPoints *)
void Write ()