vtkMetaImageWriter Class Reference

write a binary UNC meta image data More...

#include <vtkMetaImageWriter.h>

Inheritance diagram for vtkMetaImageWriter:

Collaboration diagram for vtkMetaImageWriter:

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

Public Member Functions
virtual int	IsA (const char *type)
vtkMetaImageWriter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetCompression (bool compress)
virtual bool	GetCompression (void)
virtual void	Write ()
virtual void	SetFileName (const char *fname)
virtual char *	GetFileName ()
virtual void	SetRAWFileName (const char *fname)
virtual char *	GetRAWFileName ()
Public Member Functions inherited from vtkImageWriter
vtkImageWriter *	NewInstance () const
void	DeleteFiles ()
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 ()
Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const
vtkImageData *	GetOutput ()
vtkImageData *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
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)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
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)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
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)
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	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 ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
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
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool 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)
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	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMetaImageWriter *	SafeDownCast (vtkObjectBase *o)
static vtkMetaImageWriter *	New ()
Static Public Member Functions inherited from vtkImageWriter
static vtkImageWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkImageWriter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkImageAlgorithm
static int	IsTypeOf (const char *type)
static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	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 int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
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 int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkMetaImageWriter ()
	~vtkMetaImageWriter ()
virtual void	SetMHDFileName (const char *)
Protected Member Functions inherited from vtkImageWriter
	vtkImageWriter ()
	~vtkImageWriter ()
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
	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	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)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
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 vtkExecutive *	CreateDefaultExecutive ()
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)
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 void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *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 &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
char *	MHDFileName
bool	Compress
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
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
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

write a binary UNC meta image data

One of the formats for which a reader is already available in the toolkit is the MetaImage file format. This is a fairly simple yet powerful format consisting of a text header and a binary data section. The following instructions describe how you can write a MetaImage header for the data that you download from the BrainWeb page.

The minimal structure of the MetaImage header is the following:

NDims = 3 DimSize = 181 217 181 ElementType = MET_UCHAR ElementSpacing = 1.0 1.0 1.0 ElementByteOrderMSB = False ElementDataFile = brainweb1.raw

NDims indicate that this is a 3D image. ITK can handle images of arbitrary dimension. DimSize indicates the size of the volume in pixels along each direction. ElementType indicate the primitive type used for pixels. In this case is "unsigned char", implying that the data is digitized in 8 bits / pixel. ElementSpacing indicates the physical separation between the center of one pixel and the center of the next pixel along each direction in space. The units used are millimeters. ElementByteOrderMSB indicates is the data is encoded in little or big endian order. You might want to play with this value when moving data between different computer platforms. ElementDataFile is the name of the file containing the raw binary data of the image. This file must be in the same directory as the header.

MetaImage headers are expected to have extension: ".mha" or ".mhd"

Once you write this header text file, it should be possible to read the image into your ITK based application using the itk::FileIOToImageFilter class.

See also

vtkImageWriter vtkMetaImageReader

Tests:

vtkMetaImageWriter (Tests)

Definition at line 74 of file vtkMetaImageWriter.h.

Member Typedef Documentation

typedef vtkImageWriter vtkMetaImageWriter::Superclass

Definition at line 77 of file vtkMetaImageWriter.h.

Constructor & Destructor Documentation

vtkMetaImageWriter::vtkMetaImageWriter ( )

protected

vtkMetaImageWriter::~vtkMetaImageWriter ( )

protected

Member Function Documentation

static int vtkMetaImageWriter::IsTypeOf ( const char *  type )

static

virtual int vtkMetaImageWriter::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 vtkMetaImageWriter* vtkMetaImageWriter::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkMetaImageWriter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageWriter.

vtkMetaImageWriter* vtkMetaImageWriter::NewInstance

(

)

const

void vtkMetaImageWriter::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.

static vtkMetaImageWriter* vtkMetaImageWriter::New ( )

static

Construct object with FlipNormals turned off and Normals set to true.

virtual void vtkMetaImageWriter::SetFileName ( const char *  fname )

virtual

Specify file name of meta file

Reimplemented from vtkImageWriter.

virtual char* vtkMetaImageWriter::GetFileName ( )

inlinevirtual

Specify file name of meta file

Reimplemented from vtkImageWriter.

Definition at line 86 of file vtkMetaImageWriter.h.

virtual void vtkMetaImageWriter::SetRAWFileName ( const char *  fname )

virtual

Specify the file name of the raw image data.

virtual char* vtkMetaImageWriter::GetRAWFileName ( )

virtual

Specify the file name of the raw image data.

virtual void vtkMetaImageWriter::SetCompression ( bool  compress )

inlinevirtual

Definition at line 95 of file vtkMetaImageWriter.h.

virtual bool vtkMetaImageWriter::GetCompression ( void  )

inlinevirtual

Definition at line 99 of file vtkMetaImageWriter.h.

virtual void vtkMetaImageWriter::Write ( )

virtual

The main interface which triggers the writer to start.

Reimplemented from vtkImageWriter.

virtual void vtkMetaImageWriter::SetMHDFileName ( const char *  )

protectedvirtual

Member Data Documentation

char* vtkMetaImageWriter::MHDFileName

protected

Definition at line 112 of file vtkMetaImageWriter.h.

bool vtkMetaImageWriter::Compress

protected

Definition at line 114 of file vtkMetaImageWriter.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Image/vtkMetaImageWriter.h