vtkImageWriter Class Reference

Writes images to files. More...

#include <vtkImageWriter.h>

Inheritance diagram for vtkImageWriter:

Collaboration diagram for vtkImageWriter:

Public Types
typedef vtkImageAlgorithm	Superclass
Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
vtkImageWriter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
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 ()
vtkImageData *	GetInput ()
virtual void	Write ()
void	DeleteFiles ()
Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const
vtkImageData *	GetOutput ()
vtkImageData *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) VTK_OVERRIDE
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetInput ()
vtkImageData *	GetImageDataInput (int port)
virtual void	AddInputData (vtkDataObject *)
virtual void	AddInputData (int, vtkDataObject *)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	Register (vtkObjectBase *o) VTK_OVERRIDE
void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	UpdateProgress (double amount)
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)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
vtkDataObject *	GetInputDataObject (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)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive (int port, int index)
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetInputInformation ()
vtkInformation *	GetOutputInformation (int port)
virtual void	Update (int port)
virtual void	Update ()
virtual int	Update (int port, vtkInformationVector *requests)
virtual int	Update (vtkInformation *requests)
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
virtual int	UpdateExtent (const int extents[6])
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int port, int extent[6])
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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	InitializeObjectBase ()
void	Print (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkImageWriter *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkImageWriter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)
static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
virtual void	RecursiveWrite (int dim, vtkImageData *region, vtkInformation *inInfo, ofstream *file)
virtual void	RecursiveWrite (int dim, vtkImageData *cache, vtkImageData *data, vtkInformation *inInfo, ofstream *file)
virtual void	WriteFile (ofstream *file, vtkImageData *data, int extent[6], int wExtent[6])
virtual void	WriteFileHeader (ofstream *, vtkImageData *, int[6])
virtual void	WriteFileTrailer (ofstream *, vtkImageData *)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Protected Member Functions inherited from 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	ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
virtual void	ExecuteData (vtkDataObject *output)
virtual void	Execute ()
virtual void	AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
virtual void	CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
int	FillOutputPortInformation (int port, vtkInformation *info) VTK_OVERRIDE
int	FillInputPortInformation (int port, vtkInformation *info) VTK_OVERRIDE
Protected Member Functions inherited from 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)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	SetErrorCode (unsigned long)
void	ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void	SetNumberOfInputConnections (int port, int n)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
Protected Member Functions inherited from vtkObject
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
virtual void	CollectRevisions (ostream &)
	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
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
unsigned long	ErrorCode
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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.

Member Function Documentation

GetInput()

vtkImageData* vtkImageWriter::GetInput

(

)

Set/Get the input object from the image pipeline.

IsA()

virtual vtkTypeBool 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 vtkNIFTIWriter, and vtkDICOMWriter.

PrintSelf()

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

RequestData()

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

protectedvirtual

This is called in response to a REQUEST_DATA request from the executive. Subclasses should override either this method or the ExecuteDataWithInformation method in order to generate data for their outputs. For images, the output arrays will already be allocated, so all that is necessary is to fill in the voxel values.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkNIFTIWriter, and vtkDICOMWriter.

SetFileDimensionality()

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.

SetFileName()

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.

SetFilePattern()

virtual void vtkImageWriter::SetFilePattern ( const char *  )

virtual

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

SetFilePrefix()

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.

Write()

virtual void vtkImageWriter::Write ( )

virtual

The main interface which triggers the writer to start.

Reimplemented in vtkDICOMWriter.

---

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

• vtkImageWriter.h