vtkImageWriter Class Reference

#include <vtkImageWriter.h>

Inheritance diagram for vtkImageWriter:

Inheritance graph
[legend]
Collaboration diagram for vtkImageWriter:

Collaboration graph
[legend]

List of all members.


Detailed Description

Writes images to files.

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.

Definition at line 30 of file vtkImageWriter.h.


Public Types

typedef vtkImageAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Write ()
void DeleteFiles ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetFilePrefix (const char *)
virtual char * GetFilePrefix ()
virtual void SetFilePattern (const char *)
virtual char * GetFilePattern ()
virtual void SetFileDimensionality (int)
virtual int GetFileDimensionality ()
vtkImageDataGetInput ()

Static Public Member Functions

static vtkImageWriterNew ()
static int IsTypeOf (const char *type)
static vtkImageWriterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageWriter ()
 ~vtkImageWriter ()
virtual void RecursiveWrite (int dim, vtkImageData *region, ofstream *file)
virtual void RecursiveWrite (int dim, vtkImageData *cache, vtkImageData *data, ofstream *file)
virtual void WriteFile (ofstream *file, vtkImageData *data, int extent[6])
virtual void WriteFileHeader (ofstream *, vtkImageData *)
virtual void WriteFileTrailer (ofstream *, vtkImageData *)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)

Protected Attributes

int FileDimensionality
char * FilePrefix
char * FilePattern
char * FileName
int FileNumber
int FileLowerLeft
char * InternalFileName
int MinimumFileNumber
int MaximumFileNumber
int FilesDeleted

Member Typedef Documentation


Constructor & Destructor Documentation

vtkImageWriter::vtkImageWriter (  )  [protected]

vtkImageWriter::~vtkImageWriter (  )  [protected]


Member Function Documentation

static vtkImageWriter* vtkImageWriter::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkBMPWriter, vtkJPEGWriter, vtkMetaImageWriter, vtkMINCImageWriter, vtkPNGWriter, vtkPNMWriter, vtkPostScriptWriter, vtkTIFFWriter, and vtkPImageWriter.

virtual const char* vtkImageWriter::GetClassName (  )  [virtual]

static int vtkImageWriter::IsTypeOf ( const char *  name  )  [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 vtkImageAlgorithm.

Reimplemented in vtkBMPWriter, vtkJPEGWriter, vtkMetaImageWriter, vtkMINCImageWriter, vtkPNGWriter, vtkPNMWriter, vtkPostScriptWriter, vtkTIFFWriter, and vtkPImageWriter.

virtual int vtkImageWriter::IsA ( const char *  name  )  [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 vtkImageAlgorithm.

Reimplemented in vtkBMPWriter, vtkJPEGWriter, vtkMetaImageWriter, vtkMINCImageWriter, vtkPNGWriter, vtkPNMWriter, vtkPostScriptWriter, vtkTIFFWriter, and vtkPImageWriter.

static vtkImageWriter* vtkImageWriter::SafeDownCast ( vtkObject o  )  [static]

void vtkImageWriter::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 vtkImageAlgorithm.

Reimplemented in vtkBMPWriter, vtkJPEGWriter, vtkMetaImageWriter, vtkMINCImageWriter, vtkPNGWriter, vtkPNMWriter, vtkPostScriptWriter, vtkTIFFWriter, and vtkPImageWriter.

virtual void vtkImageWriter::SetFileName ( const char *   )  [virtual]

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.

Reimplemented in vtkMetaImageWriter, and vtkMINCImageWriter.

virtual char* vtkImageWriter::GetFileName (  )  [virtual]

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.

Reimplemented in vtkMetaImageWriter.

virtual void vtkImageWriter::SetFilePrefix ( const char *   )  [virtual]

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.

virtual char* vtkImageWriter::GetFilePrefix (  )  [virtual]

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.

virtual void vtkImageWriter::SetFilePattern ( const char *   )  [virtual]

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

virtual char* vtkImageWriter::GetFilePattern (  )  [virtual]

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

virtual void vtkImageWriter::SetFileDimensionality ( int   )  [virtual]

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.

virtual int vtkImageWriter::GetFileDimensionality (  )  [virtual]

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.

vtkImageData* vtkImageWriter::GetInput (  ) 

Set/Get the input object from the image pipeline.

Reimplemented from vtkImageAlgorithm.

virtual void vtkImageWriter::Write (  )  [virtual]

The main interface which triggers the writer to start.

Reimplemented in vtkJPEGWriter, vtkMetaImageWriter, vtkMINCImageWriter, and vtkPNGWriter.

void vtkImageWriter::DeleteFiles (  ) 

virtual void vtkImageWriter::RecursiveWrite ( int  dim,
vtkImageData region,
ofstream *  file 
) [protected, virtual]

Reimplemented in vtkPImageWriter.

virtual void vtkImageWriter::RecursiveWrite ( int  dim,
vtkImageData cache,
vtkImageData data,
ofstream *  file 
) [protected, virtual]

Reimplemented in vtkPImageWriter.

virtual void vtkImageWriter::WriteFile ( ofstream *  file,
vtkImageData data,
int  extent[6] 
) [protected, virtual]

virtual void vtkImageWriter::WriteFileHeader ( ofstream *  ,
vtkImageData  
) [inline, protected, virtual]

Reimplemented in vtkBMPWriter, vtkPNMWriter, vtkPostScriptWriter, and vtkTIFFWriter.

Definition at line 95 of file vtkImageWriter.h.

virtual void vtkImageWriter::WriteFileTrailer ( ofstream *  ,
vtkImageData  
) [inline, protected, virtual]

Reimplemented in vtkPostScriptWriter, and vtkTIFFWriter.

Definition at line 96 of file vtkImageWriter.h.

virtual int vtkImageWriter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMINCImageWriter.


Member Data Documentation

Definition at line 83 of file vtkImageWriter.h.

char* vtkImageWriter::FilePrefix [protected]

Definition at line 84 of file vtkImageWriter.h.

char* vtkImageWriter::FilePattern [protected]

Definition at line 85 of file vtkImageWriter.h.

char* vtkImageWriter::FileName [protected]

Definition at line 86 of file vtkImageWriter.h.

int vtkImageWriter::FileNumber [protected]

Definition at line 87 of file vtkImageWriter.h.

Definition at line 88 of file vtkImageWriter.h.

Definition at line 89 of file vtkImageWriter.h.

Definition at line 104 of file vtkImageWriter.h.

Definition at line 105 of file vtkImageWriter.h.

Definition at line 106 of file vtkImageWriter.h.


The documentation for this class was generated from the following file:

Generated on Wed Aug 24 11:42:53 2011 for VTK by  doxygen 1.5.6