ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::MeshFileWriter< TInputMesh > Class Template Reference

#include <itkMeshFileWriter.h>

+ Inheritance diagram for itk::MeshFileWriter< TInputMesh >:
+ Collaboration diagram for itk::MeshFileWriter< TInputMesh >:

Detailed Description

template<typename 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
Examples:
SphinxExamples/src/Core/Mesh/ExtractIsoSurface/Code.cxx, SphinxExamples/src/Core/Mesh/TranslateOneMesh/Code.cxx, SphinxExamples/src/Core/QuadEdgeMesh/CreateTriangularQuadEdgeMesh/Code.cxx, SphinxExamples/src/Core/QuadEdgeMesh/CutMesh/Code.cxx, SphinxExamples/src/Filtering/FastMarching/ComputeGeodesicDistanceOnMesh/Code.cxx, SphinxExamples/src/Filtering/QuadEdgeMeshFiltering/CleanQuadEdgeMesh/Code.cxx, SphinxExamples/src/Filtering/QuadEdgeMeshFiltering/ComputePlanarParameterizationOfAMesh/Code.cxx, SphinxExamples/src/Filtering/QuadEdgeMeshFiltering/DelaunayConformEdgeFlipping/Code.cxx, WikiExamples/Meshes/PointAndCellData.cxx, and WikiExamples/Meshes/ReadWrite.cxx.

Definition at line 52 of file itkMeshFileWriter.h.

Public Types

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

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
const InputMeshTypeGetInput ()
 
const InputMeshTypeGetInput (unsigned int idx)
 
virtual const char * GetNameOfClass () const
 
void SetFileTypeAsASCII ()
 
void SetFileTypeAsBINARY ()
 
void SetInput (const InputMeshType *input)
 
virtual void Update () override
 
virtual void Write ()
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
void SetMeshIO (MeshIOBase *io)
 
virtual MeshIOBaseGetModifiableMeshIO ()
 
virtual const MeshIOBaseGetMeshIO () const
 
virtual void SetUseCompression (bool _arg)
 
virtual const bool & GetUseCompression () const
 
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 () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
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 UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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 ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

template<typename Output >
void CopyCellDataToBuffer (Output *data)
 
template<typename Output >
void CopyCellsToBuffer (Output *data)
 
template<typename Output >
void CopyPointDataToBuffer (Output *data)
 
template<typename Output >
void CopyPointsToBuffer (Output *data)
 
 MeshFileWriter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
void WriteCellData ()
 
void WriteCells ()
 
void WritePointData ()
 
void WritePoints ()
 
 ~MeshFileWriter () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (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
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
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 SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () 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 () override
 
- 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 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 Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 59 of file itkMeshFileWriter.h.

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

Definition at line 72 of file itkMeshFileWriter.h.

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

Definition at line 71 of file itkMeshFileWriter.h.

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

Definition at line 69 of file itkMeshFileWriter.h.

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

Definition at line 70 of file itkMeshFileWriter.h.

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

Some convenient typedefs.

Definition at line 65 of file itkMeshFileWriter.h.

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

Definition at line 58 of file itkMeshFileWriter.h.

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

Standard class typedefs.

Definition at line 56 of file itkMeshFileWriter.h.

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

Definition at line 73 of file itkMeshFileWriter.h.

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

Definition at line 57 of file itkMeshFileWriter.h.

Constructor & Destructor Documentation

template<typename TInputMesh >
itk::MeshFileWriter< TInputMesh >::MeshFileWriter ( )
protected
template<typename TInputMesh >
itk::MeshFileWriter< TInputMesh >::~MeshFileWriter ( )
overrideprotected

Member Function Documentation

template<typename TInputMesh >
template<typename Output >
void itk::MeshFileWriter< TInputMesh >::CopyCellDataToBuffer ( Output *  data)
protected
template<typename TInputMesh >
template<typename Output >
void itk::MeshFileWriter< TInputMesh >::CopyCellsToBuffer ( Output *  data)
protected
template<typename TInputMesh >
template<typename Output >
void itk::MeshFileWriter< TInputMesh >::CopyPointDataToBuffer ( Output *  data)
protected
template<typename TInputMesh >
template<typename Output >
void itk::MeshFileWriter< TInputMesh >::CopyPointsToBuffer ( Output *  data)
protected
template<typename TInputMesh >
virtual::itk::LightObject::Pointer itk::MeshFileWriter< TInputMesh >::CreateAnother ( ) 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<typename TInputMesh >
virtual const char* itk::MeshFileWriter< TInputMesh >::GetFileName ( ) const
virtual

Specify the name of the output file to write.

template<typename TInputMesh >
const InputMeshType* itk::MeshFileWriter< TInputMesh >::GetInput ( )
template<typename TInputMesh >
const InputMeshType* itk::MeshFileWriter< TInputMesh >::GetInput ( unsigned int  idx)
template<typename 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<typename 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<typename TInputMesh >
virtual const char* itk::MeshFileWriter< TInputMesh >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

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

Set the compression On or Off

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

Method for creation through the object factory.

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

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<typename TInputMesh >
virtual void itk::MeshFileWriter< TInputMesh >::SetFileName ( const char *  _arg)
virtual

Specify the name of the output file to write.

template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::SetFileTypeAsASCII ( )
inline

Definition at line 110 of file itkMeshFileWriter.h.

template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::SetFileTypeAsBINARY ( )
inline

Definition at line 111 of file itkMeshFileWriter.h.

template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::SetInput ( const InputMeshType input)
template<typename 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 97 of file itkMeshFileWriter.h.

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

Set the compression On or Off

template<typename TInputMesh >
virtual void itk::MeshFileWriter< TInputMesh >::Update ( void  )
inlineoverridevirtual

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

Reimplemented from itk::ProcessObject.

Definition at line 120 of file itkMeshFileWriter.h.

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

Set the compression On or Off

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

Set the compression On or Off

template<typename TInputMesh >
virtual void itk::MeshFileWriter< TInputMesh >::Write ( )
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<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::WriteCellData ( )
protected
template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::WriteCells ( )
protected
template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::WritePointData ( )
protected
template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::WritePoints ( )
protected

Member Data Documentation

template<typename TInputMesh >
bool itk::MeshFileWriter< TInputMesh >::m_FactorySpecifiedMeshIO
private

Definition at line 163 of file itkMeshFileWriter.h.

template<typename TInputMesh >
std::string itk::MeshFileWriter< TInputMesh >::m_FileName
private

Definition at line 157 of file itkMeshFileWriter.h.

template<typename TInputMesh >
bool itk::MeshFileWriter< TInputMesh >::m_FileTypeIsBINARY
private

Definition at line 166 of file itkMeshFileWriter.h.

template<typename TInputMesh >
MeshIOBase::Pointer itk::MeshFileWriter< TInputMesh >::m_MeshIO
private

Definition at line 160 of file itkMeshFileWriter.h.

template<typename TInputMesh >
bool itk::MeshFileWriter< TInputMesh >::m_UseCompression
private

Definition at line 165 of file itkMeshFileWriter.h.

template<typename TInputMesh >
bool itk::MeshFileWriter< TInputMesh >::m_UserSpecifiedMeshIO
private

Definition at line 161 of file itkMeshFileWriter.h.


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