itk::MeshFileWriter< TInputMesh > Class Template Reference

#include <itkMeshFileWriter.h>

Inheritance diagram for itk::MeshFileWriter< TInputMesh >:

Collaboration diagram for itk::MeshFileWriter< TInputMesh >:

Detailed Description

template<class TInputMesh>
class itk::MeshFileWriter< TInputMesh >

Writes mesh data to a single file.

MeshFileWriter writes its input data to a single output file. MeshFileWriter interfaces with an MeshIO class to write out the data.

A pluggable factory pattern is used that allows different kinds of writers to be registered (even at run time) without having to modify the code in this class. You can either manually instantiate the MeshIO object and associate it with the MeshFileWriter, or let the class figure it out from the extension. Normally just setting the filename with a suitable suffix (".vtk", etc) and setting the input to the writer is enough to get the writer to work properly.

Author

Wanlin Zhu. Uviversity of New South Wales, Australia.

See Also

MeshIOBase

Definition at line 77 of file itkMeshFileWriter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef InputMeshType::CellType	InputMeshCellType
typedef InputMeshType::PixelType	InputMeshPixelType
typedef InputMeshType::Pointer	InputMeshPointer
typedef InputMeshType::RegionType	InputMeshRegionType
typedef TInputMesh	InputMeshType
typedef SmartPointer< Self >	Pointer
typedef MeshFileWriter	Self
typedef MeshIOBase::SizeValueType	SizeValueType
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const InputMeshType *	GetInput (void)
const InputMeshType *	GetInput (unsigned int idx)
virtual const char *	GetNameOfClass () const
void	SetFileTypeAsASCII ()
void	SetFileTypeAsBINARY ()
void	SetInput (const InputMeshType *input)
virtual void	Update ()
virtual void	Write (void)
virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const
void	SetMeshIO (MeshIOBase *io)
virtual MeshIOBase *	GetModifiableMeshIO ()
virtual const MeshIOBase *	GetMeshIO () const
virtual void	SetUseCompression (bool _arg)
virtual const bool &	GetUseCompression ()
virtual void	UseCompressionOn ()
virtual void	UseCompressionOff ()
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
template<class Output >
void	CopyCellDataToBuffer (Output *data)
template<class Output >
void	CopyCellsToBuffer (Output *data)
template<class Output >
void	CopyPointDataToBuffer (Output *data)
template<class Output >
void	CopyPointsToBuffer (Output *data)
	MeshFileWriter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	WriteCellData ()
void	WriteCells ()
void	WritePointData ()
void	WritePoints ()
	~MeshFileWriter ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName (void) const
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
void	SetRequiredInputNames (const NameArray &)
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
	MeshFileWriter (const Self &)
void	operator= (const Self &)

Private Attributes
bool	m_FactorySpecifiedMeshIO
std::string	m_FileName
bool	m_FileTypeIsBINARY
MeshIOBase::Pointer	m_MeshIO
bool	m_UseCompression
bool	m_UserSpecifiedMeshIO

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating

Member Typedef Documentation

template<class TInputMesh >

typedef SmartPointer< const Self > itk::MeshFileWriter< TInputMesh >::ConstPointer

Definition at line 84 of file itkMeshFileWriter.h.

template<class TInputMesh >

typedef InputMeshType::CellType itk::MeshFileWriter< TInputMesh >::InputMeshCellType

Definition at line 97 of file itkMeshFileWriter.h.

template<class TInputMesh >

typedef InputMeshType::PixelType itk::MeshFileWriter< TInputMesh >::InputMeshPixelType

Definition at line 96 of file itkMeshFileWriter.h.

template<class TInputMesh >

typedef InputMeshType::Pointer itk::MeshFileWriter< TInputMesh >::InputMeshPointer

Definition at line 94 of file itkMeshFileWriter.h.

template<class TInputMesh >

typedef InputMeshType::RegionType itk::MeshFileWriter< TInputMesh >::InputMeshRegionType

Definition at line 95 of file itkMeshFileWriter.h.

template<class TInputMesh >

typedef TInputMesh itk::MeshFileWriter< TInputMesh >::InputMeshType

Some convenient typedefs.

Definition at line 90 of file itkMeshFileWriter.h.

template<class TInputMesh >

typedef SmartPointer< Self > itk::MeshFileWriter< TInputMesh >::Pointer

Definition at line 83 of file itkMeshFileWriter.h.

template<class TInputMesh >

typedef MeshFileWriter itk::MeshFileWriter< TInputMesh >::Self

Standard class typedefs.

Definition at line 81 of file itkMeshFileWriter.h.

template<class TInputMesh >

typedef MeshIOBase::SizeValueType itk::MeshFileWriter< TInputMesh >::SizeValueType

Definition at line 98 of file itkMeshFileWriter.h.

template<class TInputMesh >

typedef ProcessObject itk::MeshFileWriter< TInputMesh >::Superclass

Definition at line 82 of file itkMeshFileWriter.h.

Constructor & Destructor Documentation

template<class TInputMesh >

itk::MeshFileWriter< TInputMesh >::MeshFileWriter ( )

protected

template<class TInputMesh >

itk::MeshFileWriter< TInputMesh >::~MeshFileWriter ( )

protected

template<class TInputMesh >

itk::MeshFileWriter< TInputMesh >::MeshFileWriter ( const Self &  )

private

Member Function Documentation

template<class TInputMesh >

template<class Output >

void itk::MeshFileWriter< TInputMesh >::CopyCellDataToBuffer ( Output *  data )

protected

template<class TInputMesh >

template<class Output >

void itk::MeshFileWriter< TInputMesh >::CopyCellsToBuffer ( Output *  data )

protected

template<class TInputMesh >

template<class Output >

void itk::MeshFileWriter< TInputMesh >::CopyPointDataToBuffer ( Output *  data )

protected

template<class TInputMesh >

template<class Output >

void itk::MeshFileWriter< TInputMesh >::CopyPointsToBuffer ( Output *  data )

protected

template<class TInputMesh >

virtual::itk::LightObject::Pointer itk::MeshFileWriter< TInputMesh >::CreateAnother ( void  ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TInputMesh >

virtual const char* itk::MeshFileWriter< TInputMesh >::GetFileName ( ) const

virtual

Specify the name of the output file to write.

template<class TInputMesh >

const InputMeshType* itk::MeshFileWriter< TInputMesh >::GetInput

(

void

)

template<class TInputMesh >

const InputMeshType* itk::MeshFileWriter< TInputMesh >::GetInput

(

unsigned int

idx

)

template<class TInputMesh >

virtual const MeshIOBase* itk::MeshFileWriter< TInputMesh >::GetMeshIO ( ) const

virtual

Set/Get the MeshIO helper class. Usually this is created via the object factory mechanism that determines whether a particular MeshIO can write a certain file. This method provides a way to get the MeshIO instance that is created, or one can be manually set where the IO factory mechanism may not work (some mesh files with non-standard filename suffix's. If the user specifies the MeshIO, we assume she makes the correct choice and will allow a file to be created regardless of the file extension. If the factory has set the MeshIO, the extension must be supported by the specified MeshIO.

template<class TInputMesh >

virtual MeshIOBase* itk::MeshFileWriter< TInputMesh >::GetModifiableMeshIO ( )

virtual

Set/Get the MeshIO helper class. Usually this is created via the object factory mechanism that determines whether a particular MeshIO can write a certain file. This method provides a way to get the MeshIO instance that is created, or one can be manually set where the IO factory mechanism may not work (some mesh files with non-standard filename suffix's. If the user specifies the MeshIO, we assume she makes the correct choice and will allow a file to be created regardless of the file extension. If the factory has set the MeshIO, the extension must be supported by the specified MeshIO.

template<class TInputMesh >

virtual const char* itk::MeshFileWriter< TInputMesh >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<class TInputMesh >

virtual const bool& itk::MeshFileWriter< TInputMesh >::GetUseCompression ( )

virtual

Set the compression On or Off

template<class TInputMesh >

static Pointer itk::MeshFileWriter< TInputMesh >::New ( )

static

Method for creation through the object factory.

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::operator= ( const Self &  )

private

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

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 itk::ProcessObject.

template<class TInputMesh >

virtual void itk::MeshFileWriter< TInputMesh >::SetFileName ( const char *  _arg )

virtual

Specify the name of the output file to write.

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::SetFileTypeAsASCII ( )

inline

Definition at line 135 of file itkMeshFileWriter.h.

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::SetFileTypeAsBINARY ( )

inline

Definition at line 136 of file itkMeshFileWriter.h.

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::SetInput

(

const InputMeshType *

input

)

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::SetMeshIO ( MeshIOBase *  io )

inline

Set/Get the MeshIO helper class. Usually this is created via the object factory mechanism that determines whether a particular MeshIO can write a certain file. This method provides a way to get the MeshIO instance that is created, or one can be manually set where the IO factory mechanism may not work (some mesh files with non-standard filename suffix's. If the user specifies the MeshIO, we assume she makes the correct choice and will allow a file to be created regardless of the file extension. If the factory has set the MeshIO, the extension must be supported by the specified MeshIO.

Definition at line 122 of file itkMeshFileWriter.h.

template<class TInputMesh >

virtual void itk::MeshFileWriter< TInputMesh >::SetUseCompression ( bool  _arg )

virtual

Set the compression On or Off

template<class TInputMesh >

virtual void itk::MeshFileWriter< TInputMesh >::Update ( void  )

inlinevirtual

Aliased to the Write() method to be consistent with the rest of the pipeline.

Reimplemented from itk::ProcessObject.

Definition at line 145 of file itkMeshFileWriter.h.

template<class TInputMesh >

virtual void itk::MeshFileWriter< TInputMesh >::UseCompressionOff ( )

virtual

Set the compression On or Off

template<class TInputMesh >

virtual void itk::MeshFileWriter< TInputMesh >::UseCompressionOn ( )

virtual

Set the compression On or Off

template<class TInputMesh >

virtual void itk::MeshFileWriter< TInputMesh >::Write ( void  )

virtual

A special version of the Update() method for writers. It invokes start and end events and handles releasing data. It eventually calls GenerateData() which does the actual writing.

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::WriteCellData ( )

protected

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::WriteCells ( )

protected

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::WritePointData ( )

protected

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::WritePoints ( )

protected

Member Data Documentation

template<class TInputMesh >

bool itk::MeshFileWriter< TInputMesh >::m_FactorySpecifiedMeshIO

private

Definition at line 189 of file itkMeshFileWriter.h.

template<class TInputMesh >

std::string itk::MeshFileWriter< TInputMesh >::m_FileName

private

Definition at line 185 of file itkMeshFileWriter.h.

template<class TInputMesh >

bool itk::MeshFileWriter< TInputMesh >::m_FileTypeIsBINARY

private

Definition at line 192 of file itkMeshFileWriter.h.

template<class TInputMesh >

MeshIOBase::Pointer itk::MeshFileWriter< TInputMesh >::m_MeshIO

private

Definition at line 186 of file itkMeshFileWriter.h.

template<class TInputMesh >

bool itk::MeshFileWriter< TInputMesh >::m_UseCompression

private

Definition at line 191 of file itkMeshFileWriter.h.

template<class TInputMesh >

bool itk::MeshFileWriter< TInputMesh >::m_UserSpecifiedMeshIO

private

Definition at line 187 of file itkMeshFileWriter.h.

---

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

• itkMeshFileWriter.h