#include <itkMeshFileReader.h>

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

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

Detailed Description

template<class TOutputMesh, class 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.

Definition at line 103 of file itkMeshFileReader.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef OutputMeshType::CellAutoPointer	OutputCellAutoPointer

typedef OutputMeshType::CellIdentifier	OutputCellIdentifier

typedef OutputMeshType::CellPixelType	OutputCellPixelType

typedef OutputMeshType::CellType	OutputCellType

typedef OutputMeshType::CoordRepType	OutputCoordRepType

typedef HexahedronCell < OutputCellType >	OutputHexahedronCellType

typedef LineCell< OutputCellType >	OutputLineCellType

typedef TOutputMesh	OutputMeshType

typedef OutputMeshType::PointIdentifier	OutputPointIdentifier

typedef OutputMeshType::PixelType	OutputPointPixelType

typedef OutputMeshType::PointType	OutputPointType

typedef PolygonCell < OutputCellType >	OutputPolygonCellType

typedef QuadraticEdgeCell < OutputCellType >	OutputQuadraticEdgeCellType

typedef QuadraticTriangleCell < OutputCellType >	OutputQuadraticTriangleCellType

typedef QuadrilateralCell < OutputCellType >	OutputQuadrilateralCellType

typedef TetrahedronCell < OutputCellType >	OutputTetrahedronCellType

typedef TriangleCell < OutputCellType >	OutputTriangleCellType

typedef VertexCell < OutputCellType >	OutputVertexCellType

typedef SmartPointer< Self >	Pointer

typedef MeshFileReader	Self

typedef MeshIOBase::SizeValueType	SizeValueType

typedef MeshSource< TOutputMesh >	Superclass

Public Types inherited from itk::MeshSource< TOutputMesh >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef OutputMeshType::Pointer	OutputMeshPointer

typedef TOutputMesh	OutputMeshType

typedef SmartPointer< Self >	Pointer

typedef MeshSource	Self

typedef ProcessObject	Superclass

typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual void	GenerateOutputInformation ()

virtual MeshIOBase *	GetMeshIO ()

virtual const char *	GetNameOfClass () const

void	ReadCellData ()

template<typename T >
void	ReadCells (T *buffer)

void	ReadPointData ()

template<typename T >
void	ReadPoints (T *buffer)

void	SetMeshIO (MeshIOBase *meshIO)


virtual void	SetFileName (const char *_arg)

virtual const char *	GetFileName () const

Public Member Functions inherited from itk::MeshSource< TOutputMesh >
OutputMeshType *	GetOutput (void)

OutputMeshType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

void	SetOutput (TOutputMesh *output)

virtual void	GraftOutput (DataObject *output)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData ()

NameArray	GetInputNames () const

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

virtual const float &	GetProgress ()

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	SetProgress (float _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float amount)

DataObjectPointerArray	GetInputs ()

DataObjectPointerArray	GetOutputs ()

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::MeshSource< TOutputMesh >
static Pointer	New ()

Static Public Attributes
static const unsigned int	OutputPointDimension = OutputMeshType::PointDimension

Protected Member Functions
template<typename T >
void	ConvertCellPixelBuffer (void inputData, T outputData, vcl_size_t numberOfPixels)

template<typename T >
void	ConvertPointPixelBuffer (void inputData, T outputData, vcl_size_t numberOfPixels)

virtual void	GenerateData ()

	MeshFileReader ()

void	PrintSelf (std::ostream &os, Indent indent) const

void	TestFileExistanceAndReadability ()

	~MeshFileReader ()

Protected Member Functions inherited from itk::MeshSource< TOutputMesh >
void	GenerateInputRequestedRegion ()

	MeshSource ()

virtual	~MeshSource ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

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	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 ()

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PopBackInput ()

virtual void	PushFrontInput (const DataObject *input)

virtual void	PopFrontInput ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
std::string	m_FileName

MeshIOBase::Pointer	m_MeshIO

bool	m_UserSpecifiedMeshIO

Private Member Functions
	MeshFileReader (const Self &)

void	operator= (const Self &)

Private Attributes
std::string	m_ExceptionMessage

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType