vtkTIFFWriter Class Reference

#include <vtkTIFFWriter.h>

Inheritance diagram for vtkTIFFWriter:

[legend]Collaboration diagram for vtkTIFFWriter:

[legend]List of all members.

Detailed Description

write out image data as a TIFF file

vtkTIFFWriter writes image data as a TIFF data file. Data can be written uncompressed or compressed. Several forms of compression are supported including packed bits, JPEG, deflation, and LZW. (Note: LZW compression is currently under patent in the US and is disabled until the patent expires. However, the mechanism for supporting this compression is available for those with a valid license or to whom the patent does not apply.)

Created by:

Martin, Ken

CVS contributions (if > 5%):

Martin, Ken (46%)
Cedilnik, Andy (38%)

CVS logs (CVSweb):

.cxx (/IO/vtkTIFFWriter.cxx)
.h (/IO/vtkTIFFWriter.h)

Examples:: vtkTIFFWriter (Examples)

Tests:: vtkTIFFWriter (Tests)

Definition at line 48 of file vtkTIFFWriter.h.

Public Types

typedef vtkImageWriter Superclass

enum {
NoCompression, PackBits, JPEG, Deflate,
LZW
}

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

virtual void PrintSelf (ostream &os, vtkIndent indent)

virtual void SetCompression (int)

virtual int GetCompression ()

void SetCompressionToNoCompression ()

void SetCompressionToPackBits ()

void SetCompressionToJPEG ()

void SetCompressionToDeflate ()

void SetCompressionToLZW ()

Static Public Member Functions

vtkTIFFWriter * New ()

int IsTypeOf (const char *type)

vtkTIFFWriter * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkTIFFWriter ()

~vtkTIFFWriter ()

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

virtual void WriteFileHeader (ofstream *, vtkImageData *)

virtual void WriteFileTrailer (ofstream *, vtkImageData *)

Protected Attributes

void * TIFFPtr

int Compression

Member Typedef Documentation

typedef vtkImageWriter vtkTIFFWriter::Superclass

Reimplemented from vtkImageWriter.
Definition at line 52 of file vtkTIFFWriter.h.

Member Enumeration Documentation

anonymous enum

Enumeration values:

NoCompression

PackBits

JPEG

Deflate

LZW

Definition at line 56 of file vtkTIFFWriter.h.

Constructor & Destructor Documentation

vtkTIFFWriter::vtkTIFFWriter ( ) [protected]

vtkTIFFWriter::~vtkTIFFWriter ( ) [inline, protected]

Definition at line 80 of file vtkTIFFWriter.h.

Member Function Documentation

vtkTIFFWriter* vtkTIFFWriter::New ( ) [static]

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

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

Reimplemented from vtkImageWriter.

int vtkTIFFWriter::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImageWriter.

virtual int vtkTIFFWriter::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImageWriter.

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

Reimplemented from vtkImageWriter.

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

virtual void vtkTIFFWriter::SetCompression ( int ) [virtual]

Set compression type. Sinze LZW compression is patented outside US, the additional work steps have to be taken in order to use that compression.

virtual int vtkTIFFWriter::GetCompression ( ) [virtual]

Set compression type. Sinze LZW compression is patented outside US, the additional work steps have to be taken in order to use that compression.

void vtkTIFFWriter::SetCompressionToNoCompression ( ) [inline]

Set compression type. Sinze LZW compression is patented outside US, the additional work steps have to be taken in order to use that compression.
Definition at line 71 of file vtkTIFFWriter.h.

void vtkTIFFWriter::SetCompressionToPackBits ( ) [inline]

Set compression type. Sinze LZW compression is patented outside US, the additional work steps have to be taken in order to use that compression.
Definition at line 72 of file vtkTIFFWriter.h.

void vtkTIFFWriter::SetCompressionToJPEG ( ) [inline]

Set compression type. Sinze LZW compression is patented outside US, the additional work steps have to be taken in order to use that compression.
Definition at line 73 of file vtkTIFFWriter.h.

void vtkTIFFWriter::SetCompressionToDeflate ( ) [inline]

Set compression type. Sinze LZW compression is patented outside US, the additional work steps have to be taken in order to use that compression.
Definition at line 74 of file vtkTIFFWriter.h.

void vtkTIFFWriter::SetCompressionToLZW ( ) [inline]

Set compression type. Sinze LZW compression is patented outside US, the additional work steps have to be taken in order to use that compression.
Definition at line 75 of file vtkTIFFWriter.h.

virtual void vtkTIFFWriter::WriteFile ( ofstream * file,

vtkImageData * data,

int ext[6]

) [protected, virtual]

Reimplemented from vtkImageWriter.

virtual void vtkTIFFWriter::WriteFileHeader ( ofstream * ,

vtkImageData *

) [protected, virtual]

Reimplemented from vtkImageWriter.

virtual void vtkTIFFWriter::WriteFileTrailer ( ofstream * ,

vtkImageData *

) [protected, virtual]

Reimplemented from vtkImageWriter.

Member Data Documentation

void* vtkTIFFWriter::TIFFPtr [protected]

Definition at line 86 of file vtkTIFFWriter.h.

int vtkTIFFWriter::Compression [protected]

Definition at line 87 of file vtkTIFFWriter.h.

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

dox/IO/vtkTIFFWriter.h


Public Types
typedef vtkImageWriter	Superclass
enum	{ NoCompression, PackBits, JPEG, Deflate, LZW }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetCompression (int)
virtual int	GetCompression ()
void	SetCompressionToNoCompression ()
void	SetCompressionToPackBits ()
void	SetCompressionToJPEG ()
void	SetCompressionToDeflate ()
void	SetCompressionToLZW ()
Static Public Member Functions
vtkTIFFWriter *	New ()
int	IsTypeOf (const char *type)
vtkTIFFWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkTIFFWriter ()
	~vtkTIFFWriter ()
virtual void	WriteFile (ofstream file, vtkImageData data, int ext[6])
virtual void	WriteFileHeader (ofstream , vtkImageData )
virtual void	WriteFileTrailer (ofstream , vtkImageData )
Protected Attributes
void *	TIFFPtr
int	Compression