VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
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 Types

typedef vtkImageAlgorithm Superclass
- 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)
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 ()
- 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 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 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

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

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.


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 vtkMINCImageWriter, vtkMetaImageWriter, vtkPNGWriter, vtkJPEGWriter, vtkTIFFWriter, vtkPImageWriter, vtkBMPWriter, vtkPostScriptWriter, and vtkPNMWriter.

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 vtkMINCImageWriter, vtkMetaImageWriter, vtkPNGWriter, vtkJPEGWriter, vtkTIFFWriter, vtkPImageWriter, vtkBMPWriter, vtkPostScriptWriter, and vtkPNMWriter.

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 vtkMINCImageWriter, vtkMetaImageWriter, vtkPNGWriter, vtkJPEGWriter, vtkTIFFWriter, vtkPImageWriter, vtkBMPWriter, vtkPostScriptWriter, and vtkPNMWriter.

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 vtkMINCImageWriter, vtkMetaImageWriter, vtkPNGWriter, vtkJPEGWriter, vtkTIFFWriter, vtkPImageWriter, vtkBMPWriter, vtkPostScriptWriter, and vtkPNMWriter.

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 vtkMINCImageWriter, and vtkMetaImageWriter.

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 vtkMINCImageWriter, vtkMetaImageWriter, vtkPNGWriter, and vtkJPEGWriter.

void vtkImageWriter::DeleteFiles ( )
virtual void vtkImageWriter::RecursiveWrite ( int  dim,
vtkImageData region,
ofstream *  file 
)
protectedvirtual

Reimplemented in vtkPImageWriter.

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

Reimplemented in vtkPImageWriter.

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

Reimplemented in vtkTIFFWriter, vtkBMPWriter, vtkPostScriptWriter, and vtkPNMWriter.

Definition at line 95 of file vtkImageWriter.h.

virtual void vtkImageWriter::WriteFileTrailer ( ofstream *  ,
vtkImageData  
)
inlineprotectedvirtual

Reimplemented in vtkTIFFWriter, and vtkPostScriptWriter.

Definition at line 96 of file vtkImageWriter.h.

virtual int vtkImageWriter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

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

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMINCImageWriter.


Member Data Documentation

int vtkImageWriter::FileDimensionality
protected

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.

int vtkImageWriter::FileLowerLeft
protected

Definition at line 88 of file vtkImageWriter.h.

char* vtkImageWriter::InternalFileName
protected

Definition at line 89 of file vtkImageWriter.h.

int vtkImageWriter::MinimumFileNumber
protected

Definition at line 104 of file vtkImageWriter.h.

int vtkImageWriter::MaximumFileNumber
protected

Definition at line 105 of file vtkImageWriter.h.

int vtkImageWriter::FilesDeleted
protected

Definition at line 106 of file vtkImageWriter.h.


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