ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits > Class Template Reference

#include <itkMeshFileReader.h>

+ Inheritance diagram for itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >:
+ Collaboration diagram for itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using OutputCellAutoPointer = typename OutputMeshType::CellAutoPointer
 
using OutputCellIdentifier = typename OutputMeshType::CellIdentifier
 
using OutputCellPixelType = typename OutputMeshType::CellPixelType
 
using OutputCellType = typename OutputMeshType::CellType
 
using OutputCoordRepType = typename OutputMeshType::CoordRepType
 
using OutputHexahedronCellType = HexahedronCell< OutputCellType >
 
using OutputLineCellType = LineCell< OutputCellType >
 
using OutputMeshType = TOutputMesh
 
using OutputPointIdentifier = typename OutputMeshType::PointIdentifier
 
using OutputPointPixelType = typename OutputMeshType::PixelType
 
using OutputPointType = typename OutputMeshType::PointType
 
using OutputPolygonCellType = PolygonCell< OutputCellType >
 
using OutputQuadraticEdgeCellType = QuadraticEdgeCell< OutputCellType >
 
using OutputQuadraticTriangleCellType = QuadraticTriangleCell< OutputCellType >
 
using OutputQuadrilateralCellType = QuadrilateralCell< OutputCellType >
 
using OutputTetrahedronCellType = TetrahedronCell< OutputCellType >
 
using OutputTriangleCellType = TriangleCell< OutputCellType >
 
using OutputVertexCellType = VertexCell< OutputCellType >
 
using Pointer = SmartPointer< Self >
 
using Self = MeshFileReader
 
using SizeValueType = typename MeshIOBase::SizeValueType
 
using Superclass = MeshSource< TOutputMesh >
 
- Public Types inherited from itk::MeshSource< TOutputMesh >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using OutputMeshPointer = typename OutputMeshType::Pointer
 
using OutputMeshType = TOutputMesh
 
using Pointer = SmartPointer< Self >
 
using Self = MeshSource
 
using Superclass = ProcessObject
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
- 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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::MeshSource< TOutputMesh >
OutputMeshTypeGetOutput ()
 
OutputMeshTypeGetOutput (unsigned int idx)
 
void SetOutput (TOutputMesh *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- 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 ()
 
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 void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
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
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::MeshSource< TOutputMesh >
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 ()
 

Static Public Attributes

static constexpr unsigned int OutputPointDimension = OutputMeshType::PointDimension
 
MeshIOBase::Pointer m_MeshIO
 
bool m_UserSpecifiedMeshIO
 
std::string m_FileName
 
std::string m_ExceptionMessage
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
void SetMeshIO (MeshIOBase *meshIO)
 
virtual MeshIOBaseGetModifiableMeshIO ()
 
virtual const MeshIOBaseGetMeshIO () const
 
void GenerateOutputInformation () override
 
template<typename T >
void ReadPoints (T *buffer)
 
template<typename T >
void ReadCells (T *buffer)
 
void ReadPointData ()
 
void ReadCellData ()
 
 MeshFileReader ()
 
 ~MeshFileReader () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
template<typename T >
void ConvertPointPixelBuffer (void *inputData, T *outputData, vcl_size_t numberOfPixels)
 
template<typename T >
void ConvertCellPixelBuffer (void *inputData, T *outputData, vcl_size_t numberOfPixels)
 
void TestFileExistanceAndReadability ()
 
void GenerateData () override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::MeshSource< TOutputMesh >
 MeshSource ()
 
 ~MeshSource () override=default
 
void GenerateInputRequestedRegion () override
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TOutputMesh, typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
class itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >

Mesh source that reads mesh data from a single file.

This source object is a general filter to read data from a variety of file formats. It works with a MeshIOBase subclass to actually do the reading of the data. Object factory machinery can be used to automatically create the MeshIOBase, or the MeshIOBase can be manually created and set.

TOutputMesh is the type expected by the external users of the filter. If data stored in the file is stored in a different format then specified by TOutputMesh, than this filter converts data between the file type and the external expected type. The ConvertTraits template argument is used to do the conversion.

A Pluggable factory pattern is used this allows different kinds of readers to be registered (even at run time) without having to modify the code in this class. Normally just setting the FileName with the appropriate suffix is enough to get the reader to instantiate the correct MeshIO and read the file properly. However, some files have no accepted suffix, so you will have to manually create the MeshIO instance of the write type.

See also
MeshIOBase
Author
Wanlin Zhu. Uviversity of New South Wales, Australia.
ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/Mesh/ConvertTriangleMeshToBinaryImage/Code.cxx, SphinxExamples/src/Core/Mesh/TranslateOneMesh/Code.cxx, SphinxExamples/src/Core/QuadEdgeMesh/CutMesh/Code.cxx, SphinxExamples/src/Core/QuadEdgeMesh/GetListOfFacesAroundAGivenVertex/Code.cxx, SphinxExamples/src/Core/QuadEdgeMesh/PrintVertexNeighbors/Code.cxx, SphinxExamples/src/Filtering/FastMarching/ComputeGeodesicDistanceOnMesh/Code.cxx, SphinxExamples/src/Filtering/QuadEdgeMeshFiltering/CleanQuadEdgeMesh/Code.cxx, SphinxExamples/src/Filtering/QuadEdgeMeshFiltering/ComputeNormalsOfAMesh/Code.cxx, SphinxExamples/src/Filtering/QuadEdgeMeshFiltering/ComputePlanarParameterizationOfAMesh/Code.cxx, SphinxExamples/src/Filtering/QuadEdgeMeshFiltering/DelaunayConformEdgeFlipping/Code.cxx, and SphinxExamples/src/IO/Mesh/ReadMesh/Code.cxx.

Definition at line 81 of file itkMeshFileReader.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::ConstPointer = SmartPointer<const Self>

Definition at line 89 of file itkMeshFileReader.h.

◆ OutputCellAutoPointer

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputCellAutoPointer = typename OutputMeshType::CellAutoPointer

Definition at line 106 of file itkMeshFileReader.h.

◆ OutputCellIdentifier

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputCellIdentifier = typename OutputMeshType::CellIdentifier

Definition at line 105 of file itkMeshFileReader.h.

◆ OutputCellPixelType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputCellPixelType = typename OutputMeshType::CellPixelType

Definition at line 102 of file itkMeshFileReader.h.

◆ OutputCellType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputCellType = typename OutputMeshType::CellType

Definition at line 107 of file itkMeshFileReader.h.

◆ OutputCoordRepType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputCoordRepType = typename OutputMeshType::CoordRepType

Definition at line 100 of file itkMeshFileReader.h.

◆ OutputHexahedronCellType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputHexahedronCellType = HexahedronCell<OutputCellType>

Definition at line 115 of file itkMeshFileReader.h.

◆ OutputLineCellType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputLineCellType = LineCell<OutputCellType>

Definition at line 111 of file itkMeshFileReader.h.

◆ OutputMeshType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputMeshType = TOutputMesh

Define output mesh types

Definition at line 99 of file itkMeshFileReader.h.

◆ OutputPointIdentifier

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputPointIdentifier = typename OutputMeshType::PointIdentifier

Definition at line 104 of file itkMeshFileReader.h.

◆ OutputPointPixelType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputPointPixelType = typename OutputMeshType::PixelType

Definition at line 101 of file itkMeshFileReader.h.

◆ OutputPointType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputPointType = typename OutputMeshType::PointType

Definition at line 103 of file itkMeshFileReader.h.

◆ OutputPolygonCellType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputPolygonCellType = PolygonCell<OutputCellType>

Definition at line 113 of file itkMeshFileReader.h.

◆ OutputQuadraticEdgeCellType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputQuadraticEdgeCellType = QuadraticEdgeCell<OutputCellType>

Definition at line 117 of file itkMeshFileReader.h.

◆ OutputQuadraticTriangleCellType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputQuadraticTriangleCellType = QuadraticTriangleCell<OutputCellType>

Definition at line 118 of file itkMeshFileReader.h.

◆ OutputQuadrilateralCellType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputQuadrilateralCellType = QuadrilateralCell<OutputCellType>

Definition at line 116 of file itkMeshFileReader.h.

◆ OutputTetrahedronCellType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputTetrahedronCellType = TetrahedronCell<OutputCellType>

Definition at line 114 of file itkMeshFileReader.h.

◆ OutputTriangleCellType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputTriangleCellType = TriangleCell<OutputCellType>

Definition at line 112 of file itkMeshFileReader.h.

◆ OutputVertexCellType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputVertexCellType = VertexCell<OutputCellType>

Definition at line 110 of file itkMeshFileReader.h.

◆ Pointer

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::Pointer = SmartPointer<Self>

Definition at line 90 of file itkMeshFileReader.h.

◆ Self

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::Self = MeshFileReader

Standard class type aliases.

Definition at line 87 of file itkMeshFileReader.h.

◆ SizeValueType

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::SizeValueType = typename MeshIOBase::SizeValueType

Definition at line 108 of file itkMeshFileReader.h.

◆ Superclass

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
using itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::Superclass = MeshSource<TOutputMesh>

Definition at line 88 of file itkMeshFileReader.h.

Constructor & Destructor Documentation

◆ MeshFileReader()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::MeshFileReader ( )
protected

Specify the file to read. This is forwarded to the IO instance.

◆ ~MeshFileReader()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::~MeshFileReader ( )
overrideprotecteddefault

Specify the file to read. This is forwarded to the IO instance.

Member Function Documentation

◆ ConvertCellPixelBuffer()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
template<typename T >
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::ConvertCellPixelBuffer ( void *  inputData,
T *  outputData,
vcl_size_t  numberOfPixels 
)
protected

Specify the file to read. This is forwarded to the IO instance.

◆ ConvertPointPixelBuffer()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
template<typename T >
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::ConvertPointPixelBuffer ( void *  inputData,
T *  outputData,
vcl_size_t  numberOfPixels 
)
protected

Convert a block of pixels from one type to another.

◆ CreateAnother()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
virtual::itk::LightObject::Pointer itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::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::MeshSource< TOutputMesh >.

◆ GenerateData()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::GenerateData ( )
overrideprotectedvirtual

Does the real work.

Reimplemented from itk::ProcessObject.

◆ GenerateOutputInformation()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::GenerateOutputInformation ( )
overridevirtual

Prepare the allocation of the output mesh during the first back propagation of the pipeline.

Reimplemented from itk::ProcessObject.

◆ GetFileName()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
virtual const char* itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::GetFileName ( ) const
virtual

Specify the file to read. This is forwarded to the IO instance.

◆ GetMeshIO()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
virtual const MeshIOBase* itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::GetMeshIO ( ) const
virtual

Specify the file to read. This is forwarded to the IO instance.

◆ GetModifiableMeshIO()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
virtual MeshIOBase* itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::GetModifiableMeshIO ( )
virtual

Specify the file to read. This is forwarded to the IO instance.

◆ GetNameOfClass()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
virtual const char* itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::MeshSource< TOutputMesh >.

◆ New()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
static Pointer itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Specify the file to read. This is forwarded to the IO instance.

Reimplemented from itk::MeshSource< TOutputMesh >.

◆ ReadCellData()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::ReadCellData ( )

Specify the file to read. This is forwarded to the IO instance.

◆ ReadCells()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
template<typename T >
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::ReadCells ( T *  buffer)

Specify the file to read. This is forwarded to the IO instance.

◆ ReadPointData()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::ReadPointData ( )

Specify the file to read. This is forwarded to the IO instance.

◆ ReadPoints()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
template<typename T >
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::ReadPoints ( T *  buffer)

Specify the file to read. This is forwarded to the IO instance.

◆ SetFileName()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
virtual void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::SetFileName ( const char *  _arg)
virtual

Specify the file to read. This is forwarded to the IO instance.

◆ SetMeshIO()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::SetMeshIO ( MeshIOBase meshIO)

Set/Get the MeshIO helper class. Often this is created via the object factory mechanism that determines whether a particular MeshIO can read a certain file. This method provides a way to get the MeshIO instance that is created. Or you can directly specify the MeshIO to use to read a particular file in case the factory mechanism will not work properly (e.g., unknown or unusual extension).

◆ TestFileExistanceAndReadability()

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
void itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::TestFileExistanceAndReadability ( )
protected

Test whether the given filename exist and it is readable, this is intended to be called before attempting to use MeshIO classes for actually reading the file. If the file doesn't exist or it is not readable, and exception with an appropriate message will be thrown.

Member Data Documentation

◆ m_ExceptionMessage

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
std::string itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::m_ExceptionMessage
private

Specify the file to read. This is forwarded to the IO instance.

Definition at line 191 of file itkMeshFileReader.h.

◆ m_FileName

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
std::string itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::m_FileName
protected

Specify the file to read. This is forwarded to the IO instance.

Definition at line 188 of file itkMeshFileReader.h.

◆ m_MeshIO

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
MeshIOBase::Pointer itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::m_MeshIO
protected

Specify the file to read. This is forwarded to the IO instance.

Definition at line 185 of file itkMeshFileReader.h.

◆ m_UserSpecifiedMeshIO

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
bool itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::m_UserSpecifiedMeshIO
protected

Specify the file to read. This is forwarded to the IO instance.

Definition at line 186 of file itkMeshFileReader.h.

◆ OutputPointDimension

template<typename TOutputMesh , typename ConvertPointPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::PixelType>, class ConvertCellPixelTraits = MeshConvertPixelTraits<typename TOutputMesh::CellPixelType>>
constexpr unsigned int itk::MeshFileReader< TOutputMesh, ConvertPointPixelTraits, ConvertCellPixelTraits >::OutputPointDimension = OutputMeshType::PointDimension
staticconstexpr

Define output point dimension

Definition at line 121 of file itkMeshFileReader.h.


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