VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkTIFFWriter Class Reference

write out image data as a TIFF file More...

#include <vtkTIFFWriter.h>

Inheritance diagram for vtkTIFFWriter:
[legend]
Collaboration diagram for vtkTIFFWriter:
[legend]

List of all members.

Public Types

enum  {
  NoCompression, PackBits, JPEG, Deflate,
  LZW
}
typedef vtkImageWriter Superclass
- Public Types inherited from vtkImageWriter
- Public Types inherited from vtkImageAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

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 ()
- Public Member Functions inherited from vtkImageWriter
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 ()
- Public Member Functions inherited from vtkImageAlgorithm
vtkDataObjectGetInput (int port)
vtkImageDataGetImageDataInput (int port)
vtkImageDataGetOutput ()
vtkImageDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
virtual void AddInput (vtkDataObject *)
virtual void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkTIFFWriterNew ()
static int IsTypeOf (const char *type)
static vtkTIFFWriterSafeDownCast (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 Member Functions inherited from vtkImageWriter
 vtkImageWriter ()
 ~vtkImageWriter ()
virtual void RecursiveWrite (int dim, vtkImageData *region, ofstream *file)
virtual void RecursiveWrite (int dim, vtkImageData *cache, vtkImageData *data, ofstream *file)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 ~vtkImageAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void AllocateOutputData (vtkImageData *out, int *uExtent)
virtual vtkImageDataAllocateOutputData (vtkDataObject *out)
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

void * TIFFPtr
int Compression
- Protected Attributes inherited from vtkImageWriter
int FileDimensionality
char * FilePrefix
char * FilePattern
char * FileName
int FileNumber
int FileLowerLeft
char * InternalFileName
int MinimumFileNumber
int MaximumFileNumber
int FilesDeleted

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

Examples:
vtkTIFFWriter (Examples)
Tests:
vtkTIFFWriter (Tests)

Definition at line 37 of file vtkTIFFWriter.h.


Member Typedef Documentation

Reimplemented from vtkImageWriter.

Definition at line 41 of file vtkTIFFWriter.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
NoCompression 
PackBits 
JPEG 
Deflate 
LZW 

Definition at line 45 of file vtkTIFFWriter.h.


Constructor & Destructor Documentation

vtkTIFFWriter::vtkTIFFWriter ( )
protected
vtkTIFFWriter::~vtkTIFFWriter ( )
inlineprotected

Definition at line 69 of file vtkTIFFWriter.h.


Member Function Documentation

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

static int vtkTIFFWriter::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 vtkImageWriter.

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

static 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 60 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 61 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 62 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 63 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 64 of file vtkTIFFWriter.h.

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

Reimplemented from vtkImageWriter.

virtual void vtkTIFFWriter::WriteFileHeader ( ofstream *  ,
vtkImageData  
)
protectedvirtual

Reimplemented from vtkImageWriter.

virtual void vtkTIFFWriter::WriteFileTrailer ( ofstream *  ,
vtkImageData  
)
protectedvirtual

Reimplemented from vtkImageWriter.


Member Data Documentation

void* vtkTIFFWriter::TIFFPtr
protected

Definition at line 75 of file vtkTIFFWriter.h.

int vtkTIFFWriter::Compression
protected

Definition at line 76 of file vtkTIFFWriter.h.


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