ITK  6.0.0
Insight 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>

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 plugable 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. University of New South Wales, Australia.
See also
MeshIOBase

Definition at line 52 of file itkMeshFileWriter.h.

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

Public Types

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

Public Member Functions

const InputMeshTypeGetInput ()
 
const InputMeshTypeGetInput (unsigned int idx)
 
const char * GetNameOfClass () const override
 
void SetFileTypeAsASCII ()
 
void SetFileTypeAsBINARY ()
 
void SetInput (const InputMeshType *input)
 
void Update () override
 
virtual void Write ()
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
void SetMeshIO (MeshIOBase *io)
 
virtual MeshIOBaseGetModifiableMeshIO ()
 
virtual void SetUseCompression (bool _arg)
 
virtual const bool & GetUseCompression () const
 
virtual void UseCompressionOn ()
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
const char * GetNameOfClass () const override
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

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 val)
 
- 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 ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void WriteCellData ()
 
void WriteCells ()
 
void WritePointData ()
 
void WritePoints ()
 
 ~MeshFileWriter () override=default
 
- 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 DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
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 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

bool m_FactorySpecifiedMeshIO { false }
 
std::string m_FileName {}
 
bool m_FileTypeIsBINARY { false }
 
MeshIOBase::Pointer m_MeshIO { nullptr }
 
bool m_UseCompression { false }
 
bool m_UserSpecifiedMeshIO { false }
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 61 of file itkMeshFileWriter.h.

◆ InputMeshCellType

template<typename TInputMesh >
using itk::MeshFileWriter< TInputMesh >::InputMeshCellType = typename InputMeshType::CellType

Definition at line 74 of file itkMeshFileWriter.h.

◆ InputMeshPixelType

template<typename TInputMesh >
using itk::MeshFileWriter< TInputMesh >::InputMeshPixelType = typename InputMeshType::PixelType

Definition at line 73 of file itkMeshFileWriter.h.

◆ InputMeshPointer

template<typename TInputMesh >
using itk::MeshFileWriter< TInputMesh >::InputMeshPointer = typename InputMeshType::Pointer

Definition at line 71 of file itkMeshFileWriter.h.

◆ InputMeshRegionType

template<typename TInputMesh >
using itk::MeshFileWriter< TInputMesh >::InputMeshRegionType = typename InputMeshType::RegionType

Definition at line 72 of file itkMeshFileWriter.h.

◆ InputMeshType

template<typename TInputMesh >
using itk::MeshFileWriter< TInputMesh >::InputMeshType = TInputMesh

Some convenient type alias.

Definition at line 70 of file itkMeshFileWriter.h.

◆ Pointer

template<typename TInputMesh >
using itk::MeshFileWriter< TInputMesh >::Pointer = SmartPointer<Self>

Definition at line 60 of file itkMeshFileWriter.h.

◆ Self

template<typename TInputMesh >
using itk::MeshFileWriter< TInputMesh >::Self = MeshFileWriter

Standard class type aliases.

Definition at line 58 of file itkMeshFileWriter.h.

◆ SizeValueType

template<typename TInputMesh >
using itk::MeshFileWriter< TInputMesh >::SizeValueType = typename MeshIOBase::SizeValueType

Definition at line 75 of file itkMeshFileWriter.h.

◆ Superclass

template<typename TInputMesh >
using itk::MeshFileWriter< TInputMesh >::Superclass = ProcessObject

Definition at line 59 of file itkMeshFileWriter.h.

Constructor & Destructor Documentation

◆ MeshFileWriter()

template<typename TInputMesh >
itk::MeshFileWriter< TInputMesh >::MeshFileWriter ( )
protecteddefault

◆ ~MeshFileWriter()

template<typename TInputMesh >
itk::MeshFileWriter< TInputMesh >::~MeshFileWriter ( )
overrideprotecteddefault

Member Function Documentation

◆ CopyCellDataToBuffer()

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

◆ CopyCellsToBuffer()

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

◆ CopyPointDataToBuffer()

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

◆ CopyPointsToBuffer()

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

◆ GetFileName()

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

Specify the name of the output file to write.

◆ GetInput() [1/2]

template<typename TInputMesh >
const InputMeshType * itk::MeshFileWriter< TInputMesh >::GetInput ( )

◆ GetInput() [2/2]

template<typename TInputMesh >
const InputMeshType * itk::MeshFileWriter< TInputMesh >::GetInput ( unsigned int  idx)

◆ GetModifiableMeshIO()

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.

◆ GetNameOfClass()

template<typename TInputMesh >
const char * itk::MeshFileWriter< TInputMesh >::GetNameOfClass ( ) const
overridevirtual

◆ GetUseCompression()

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

Set the compression On or Off

◆ New()

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

Method for creation through the object factory.

Referenced by itk::WriteMesh().

◆ PrintSelf()

template<typename TInputMesh >
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.

◆ SetFileName()

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

Specify the name of the output file to write.

◆ SetFileTypeAsASCII()

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

Definition at line 117 of file itkMeshFileWriter.h.

◆ SetFileTypeAsBINARY()

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

Definition at line 122 of file itkMeshFileWriter.h.

◆ SetInput()

template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::SetInput ( const InputMeshType input)

◆ SetMeshIO()

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 103 of file itkMeshFileWriter.h.

◆ SetUseCompression()

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

Set the compression On or Off

◆ Update()

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

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

Reimplemented from itk::ProcessObject.

Definition at line 136 of file itkMeshFileWriter.h.

◆ UseCompressionOn()

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

Set the compression On or Off

◆ Write()

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.

◆ WriteCellData()

template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::WriteCellData ( )
protected

◆ WriteCells()

template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::WriteCells ( )
protected

◆ WritePointData()

template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::WritePointData ( )
protected

◆ WritePoints()

template<typename TInputMesh >
void itk::MeshFileWriter< TInputMesh >::WritePoints ( )
protected

Member Data Documentation

◆ m_FactorySpecifiedMeshIO

template<typename TInputMesh >
bool itk::MeshFileWriter< TInputMesh >::m_FactorySpecifiedMeshIO { false }
private

Definition at line 185 of file itkMeshFileWriter.h.

◆ m_FileName

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

Definition at line 182 of file itkMeshFileWriter.h.

◆ m_FileTypeIsBINARY

template<typename TInputMesh >
bool itk::MeshFileWriter< TInputMesh >::m_FileTypeIsBINARY { false }
private

Definition at line 187 of file itkMeshFileWriter.h.

◆ m_MeshIO

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

Definition at line 183 of file itkMeshFileWriter.h.

◆ m_UseCompression

template<typename TInputMesh >
bool itk::MeshFileWriter< TInputMesh >::m_UseCompression { false }
private

Definition at line 186 of file itkMeshFileWriter.h.

◆ m_UserSpecifiedMeshIO

template<typename TInputMesh >
bool itk::MeshFileWriter< TInputMesh >::m_UserSpecifiedMeshIO { false }
private

Definition at line 184 of file itkMeshFileWriter.h.


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