Writes mesh data to a single file. More...

#include <itkMeshFileWriter.h>

Inheritance diagram for itk::MeshFileWriter< TInputMesh >:

Collaboration diagram for itk::MeshFileWriter< TInputMesh >:

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 Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const InputMeshType *	GetInput (void)
const InputMeshType *	GetInput (unsigned int idx)
virtual MeshIOBase *	GetMeshIO ()
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 void	SetUseCompression (bool _arg)
virtual const bool &	GetUseCompression ()
virtual void	UseCompressionOn ()
virtual void	UseCompressionOff ()
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 ()
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

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.

Member Typedef Documentation

template<class TInputMesh >

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

Reimplemented from itk::ProcessObject.

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

Reimplemented from itk::ProcessObject.

Definition at line 83 of file itkMeshFileWriter.h.

template<class TInputMesh >

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

Standard class typedefs.

Reimplemented from itk::ProcessObject.

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

Reimplemented from itk::ProcessObject.

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 MeshIOBase* itk::MeshFileWriter< TInputMesh >::GetMeshIO ( ) [virtual]

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.

Reimplemented from itk::Object.

template<class TInputMesh >

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

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, 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 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 136 of file itkMeshFileWriter.h.

template<class TInputMesh >

void itk::MeshFileWriter< TInputMesh >::SetFileTypeAsBINARY ( ) [inline]

Definition at line 137 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 ) [inline, virtual]

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

Reimplemented from itk::ProcessObject.

Definition at line 146 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]