---

vtkImageWriter Class Reference

Writes images to files. More...

#include <vtkImageWriter.h>

Inheritance diagram for vtkImageWriter:

[legend]Collaboration diagram for vtkImageWriter:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetFileName (const char *)
virtual char *	GetFileName ()
void	SetFilePrefix (char *filePrefix)
virtual char *	GetFilePrefix ()
void	SetFilePattern (const char *filePattern)
virtual char *	GetFilePattern ()
virtual void	SetFileDimensionality (int)
virtual int	GetFileDimensionality ()
virtual void	SetInput (vtkImageData *input)
vtkImageData *	GetInput ()
virtual void	Write ()
virtual void	SetMemoryLimit (unsigned long)
virtual unsigned long	GetMemoryLimit ()
Static Public Methods
vtkImageWriter *	New ()
int	IsTypeOf (const char *type)
vtkImageWriter *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageWriter ()
	~vtkImageWriter ()
	vtkImageWriter (const vtkImageWriter &)
void	operator= (const vtkImageWriter &)
void	RecursiveWrite (int dim, vtkImageData *region, ofstream *file)
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 *)
Protected Attributes
int	FileDimensionality
char *	FilePrefix
char *	FilePattern
char *	FileName
int	FileNumber
int	FileLowerLeft
char *	InternalFileName
unsigned long	MemoryLimit

---

Detailed Description

Writes images to files.

Date:

2000/12/10 20:09:12

Revision:

1.25

Thanks:

Thanks to C. Charles Law who developed this class.

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.

Examples:

vtkImageWriter (examples)

Definition at line 64 of file vtkImageWriter.h.

---

Constructor & Destructor Documentation

vtkImageWriter::vtkImageWriter (    )  [protected]

vtkImageWriter::~vtkImageWriter (    )  [protected]

vtkImageWriter::vtkImageWriter (  const vtkImageWriter &    )  [inline, protected]

Definition at line 108 of file vtkImageWriter.h.

---

Member Function Documentation

vtkImageWriter* vtkImageWriter::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkProcessObject. Reimplemented in vtkBMPWriter, vtkPNMWriter, vtkPostScriptWriter, and vtkTIFFWriter.

virtual const char* vtkImageWriter::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 vtkProcessObject. Reimplemented in vtkBMPWriter, vtkPNMWriter, vtkPostScriptWriter, and vtkTIFFWriter.

int vtkImageWriter::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 vtkProcessObject. Reimplemented in vtkBMPWriter, vtkPNMWriter, vtkPostScriptWriter, and vtkTIFFWriter.

virtual int vtkImageWriter::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 vtkProcessObject. Reimplemented in vtkBMPWriter, vtkPNMWriter, vtkPostScriptWriter, and vtkTIFFWriter.

vtkImageWriter* vtkImageWriter::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 vtkProcessObject. Reimplemented in vtkBMPWriter, vtkPNMWriter, vtkPostScriptWriter, and vtkTIFFWriter.

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

void vtkImageWriter::SetFileName (  const char *    )

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.

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

void vtkImageWriter::SetFilePrefix (  char *    filePrefix )

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]

void vtkImageWriter::SetFilePattern (  const char *    filePattern )

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

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

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]

virtual void vtkImageWriter::SetInput (  vtkImageData *    input )  [virtual]

Set/Get the input object from the image pipeline.

vtkImageData* vtkImageWriter::GetInput (    )

virtual void vtkImageWriter::Write (    )  [virtual]

The main interface which triggers the writer to start.

virtual void vtkImageWriter::SetMemoryLimit (  unsigned    long )  [virtual]

Set / Get the memory limit in kilobytes. The writer will stream to attempt to keep the pipeline size within this limit

virtual unsigned long vtkImageWriter::GetMemoryLimit (    )  [virtual]

void vtkImageWriter::operator= (  const vtkImageWriter &    )  [inline, protected]

Definition at line 109 of file vtkImageWriter.h.

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

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

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

Reimplemented in vtkBMPWriter, vtkPNMWriter, vtkPostScriptWriter, and vtkTIFFWriter.

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

Reimplemented in vtkBMPWriter, vtkPNMWriter, vtkPostScriptWriter, and vtkTIFFWriter. Definition at line 125 of file vtkImageWriter.h.

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

Reimplemented in vtkPostScriptWriter. Definition at line 126 of file vtkImageWriter.h.

---

Member Data Documentation

int vtkImageWriter::FileDimensionality [protected]

Definition at line 111 of file vtkImageWriter.h.

char* vtkImageWriter::FilePrefix [protected]

Definition at line 112 of file vtkImageWriter.h.

char* vtkImageWriter::FilePattern [protected]

Definition at line 113 of file vtkImageWriter.h.

char* vtkImageWriter::FileName [protected]

Definition at line 114 of file vtkImageWriter.h.

int vtkImageWriter::FileNumber [protected]

Definition at line 115 of file vtkImageWriter.h.

int vtkImageWriter::FileLowerLeft [protected]

Definition at line 116 of file vtkImageWriter.h.

char* vtkImageWriter::InternalFileName [protected]

Definition at line 117 of file vtkImageWriter.h.

unsigned long vtkImageWriter::MemoryLimit [protected]

Definition at line 119 of file vtkImageWriter.h.

---

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

• imaging/vtkImageWriter.h

---