itk::MeshIOBase Class Reference

#include <itkMeshIOBase.h>

Inheritance diagram for itk::MeshIOBase:

Collaboration diagram for itk::MeshIOBase:

Detailed Description

Abstract superclass defines mesh IO interface.

MeshIOBase is a class that reads and/or writes Mesh / QuadEdgeMesh data of a particular format (such as PNG or raw binary). The MeshIOBase encapsulates both the reading and writing of data. The MeshIOBase is used by the MeshFileReader class (to read data) and the MeshFileWriter (to write data) into a single file. Normally the user does not directly manipulate this class other than to instantiate it, set the FileName, and assign it to a MeshFileReader or MeshFileWriter.

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.

Author

Wanlin Zhu. Uviversity of New South Wales, Australia.

See Also

MeshFileWriter

MeshFileReader

Definition at line 69 of file itkMeshIOBase.h.

Classes
struct	MapComponentType
class	UnknownType

Public Types
using	ArrayOfExtensionsType = std::vector< std::string >
enum	ByteOrder {   BigEndian,   LittleEndian,   OrderNotApplicable }
enum	CellGeometryType {   VERTEX_CELL = 0,   LINE_CELL,   TRIANGLE_CELL,   QUADRILATERAL_CELL,   POLYGON_CELL,   TETRAHEDRON_CELL,   HEXAHEDRON_CELL,   QUADRATIC_EDGE_CELL,   QUADRATIC_TRIANGLE_CELL,   LAST_ITK_CELL,   MAX_ITK_CELLS = 255 }
using	ConstPointer = SmartPointer< const Self >
enum	FileType {   ASCII,   BINARY,   TYPENOTAPPLICABLE }
enum	IOComponentType {   UNKNOWNCOMPONENTTYPE,   UCHAR,   CHAR,   USHORT,   SHORT,   UINT,   INT,   ULONG,   LONG,   LONGLONG,   ULONGLONG,   FLOAT,   DOUBLE,   LDOUBLE }
enum	IOPixelType {   UNKNOWNPIXELTYPE,   SCALAR,   RGB,   RGBA,   OFFSET,   VECTOR,   POINT,   COVARIANTVECTOR,   SYMMETRICSECONDRANKTENSOR,   DIFFUSIONTENSOR3D,   COMPLEX,   FIXEDARRAY,   ARRAY,   MATRIX,   VARIABLELENGTHVECTOR,   VARIABLESIZEMATRIX }
using	Pointer = SmartPointer< Self >
using	Self = MeshIOBase
using	SizeValueType = IdentifierType
using	StreamOffsetType = std::streamoff
using	Superclass = LightProcessObject
Public Types inherited from itk::LightProcessObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightProcessObject
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 bool	CanReadFile (const char *)=0
virtual bool	CanWriteFile (const char *)=0
std::string	GetByteOrderAsString (ByteOrder) const
unsigned int	GetComponentSize (IOComponentType componentType) const
std::string	GetComponentTypeAsString (IOComponentType) const
std::string	GetFileTypeAsString (FileType) const
virtual const char *	GetNameOfClass () const
std::string	GetPixelTypeAsString (IOPixelType) const
const ArrayOfExtensionsType &	GetSupportedReadExtensions () const
const ArrayOfExtensionsType &	GetSupportedWriteExtensions () const
virtual void	ReadCellData (void *buffer)=0
virtual void	ReadCells (void *buffer)=0
virtual void	ReadMeshInformation ()=0
virtual void	ReadPointData (void *buffer)=0
virtual void	ReadPoints (void *buffer)=0
void	SetByteOrderToBigEndian ()
void	SetByteOrderToLittleEndian ()
void	SetFileTypeToASCII ()
void	SetFileTypeToBinary ()
template<typename T >
void	SetPixelType (const T &, bool UsePointPixel=true)
template<typename T >
void	SetPixelType (const RGBPixel< T > &, bool UsePointPixel=true)
template<typename T >
void	SetPixelType (const RGBAPixel< T > &, bool UsePointPixel=true)
template<typename T , unsigned int VLength>
void	SetPixelType (const Vector< T, VLength > &, bool UsePointPixel=true)
template<typename T , unsigned int VLength>
void	SetPixelType (const CovariantVector< T, VLength > &, bool UsePointPixel=true)
template<typename T , unsigned int VLength>
void	SetPixelType (const FixedArray< T, VLength > &, bool UsePointPixel=true)
template<typename T , unsigned int VLength>
void	SetPixelType (const SymmetricSecondRankTensor< T, VLength >, bool UsePointPixel=true)
template<typename T >
void	SetPixelType (const DiffusionTensor3D< T > &, bool UsePointPixel=true)
template<typename T , unsigned int NR, unsigned int NC>
void	SetPixelType (const Matrix< T, NR, NC > &, bool UsePointPixel=true)
template<typename T >
void	SetPixelType (const std::complex< T > &, bool UsePointPixel=true)
template<typename T >
void	SetPixelType (const Array< T > &array, bool UsePointPixel=true)
template<typename T >
void	SetPixelType (const VariableLengthVector< T > &vector, bool UsePointPixel=true)
template<typename T >
void	SetPixelType (const VariableSizeMatrix< T > &matrix, bool UsePointPixel=true)
virtual void	Write ()=0
virtual void	WriteCellData (void *buffer)=0
virtual void	WriteCells (void *buffer)=0
virtual void	WriteMeshInformation ()=0
virtual void	WritePointData (void *buffer)=0
virtual void	WritePoints (void *buffer)=0
virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const
virtual void	SetPointPixelType (const IOPixelType _arg)
virtual IOPixelType	GetPointPixelType () const
virtual void	SetCellPixelType (const IOPixelType _arg)
virtual IOPixelType	GetCellPixelType () const
virtual void	SetPointComponentType (const IOComponentType _arg)
virtual IOComponentType	GetPointComponentType () const
virtual void	SetCellComponentType (const IOComponentType _arg)
virtual IOComponentType	GetCellComponentType () const
virtual void	SetPointPixelComponentType (const IOComponentType _arg)
virtual IOComponentType	GetPointPixelComponentType () const
virtual void	SetCellPixelComponentType (const IOComponentType _arg)
virtual IOComponentType	GetCellPixelComponentType () const
virtual void	SetNumberOfPointPixelComponents (unsigned int _arg)
virtual unsigned int	GetNumberOfPointPixelComponents () const
virtual void	SetNumberOfCellPixelComponents (unsigned int _arg)
virtual unsigned int	GetNumberOfCellPixelComponents () const
virtual void	SetPointDimension (unsigned int _arg)
virtual unsigned int	GetPointDimension () const
virtual void	SetNumberOfPoints (SizeValueType _arg)
virtual SizeValueType	GetNumberOfPoints () const
virtual void	SetNumberOfCells (SizeValueType _arg)
virtual SizeValueType	GetNumberOfCells () const
virtual void	SetNumberOfPointPixels (SizeValueType _arg)
virtual SizeValueType	GetNumberOfPointPixels () const
virtual void	SetNumberOfCellPixels (SizeValueType _arg)
virtual SizeValueType	GetNumberOfCellPixels () const
virtual void	SetCellBufferSize (SizeValueType _arg)
virtual SizeValueType	GetCellBufferSize () const
virtual void	SetUpdatePoints (bool _arg)
virtual bool	GetUpdatePoints () const
virtual void	SetUpdateCells (bool _arg)
virtual bool	GetUpdateCells () const
virtual void	SetUpdatePointData (bool _arg)
virtual bool	GetUpdatePointData () const
virtual void	SetUpdateCellData (bool _arg)
virtual bool	GetUpdateCellData () const
virtual void	SetFileType (const FileType _arg)
virtual FileType	GetFileType () const
virtual void	SetByteOrder (const ByteOrder _arg)
virtual ByteOrder	GetByteOrder () const
virtual void	SetUseCompression (bool _arg)
virtual bool	GetUseCompression () const
virtual void	UseCompressionOn ()
virtual void	UseCompressionOff ()
Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const bool &	GetAbortGenerateData () const
virtual void	SetAbortGenerateData (bool _arg)
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () 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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
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

Protected Member Functions
void	AddSupportedReadExtension (const char *extension)
void	AddSupportedWriteExtension (const char *extension)
	MeshIOBase ()
void	PrintSelf (std::ostream &os, Indent indent) const override
template<typename T >
void	ReadBufferAsBinary (T *buffer, std::ifstream &inputFile, SizeValueType numberOfComponents)
	~MeshIOBase () override=default
template<typename T >
void	ReadBufferAsAscii (T *buffer, std::ifstream &inputFile, SizeValueType numberOfComponents)
template<typename T >
void	WriteBufferAsAscii (T *buffer, std::ofstream &outputFile, SizeValueType numberOfLines, SizeValueType numberOfComponents)
template<typename TOutput , typename TInput >
void	WriteBufferAsBinary (TInput *buffer, std::ofstream &outputFile, SizeValueType numberOfComponents)
template<typename TInput , typename TOutput >
void	ReadCellsBuffer (TInput *input, TOutput *output)
template<typename TInput , typename TOutput >
void	ReadCellsBuffer (TInput *input, TOutput *output, MeshIOBase::CellGeometryType type)
template<typename TInput , typename TOutput >
void	WriteCellsBuffer (TInput *input, TOutput *output, CellGeometryType cellType, unsigned int numberOfPoints, SizeValueType numberOfCells)
template<typename TInput , typename TOutput >
void	WriteCellsBuffer (TInput *input, TOutput *output, CellGeometryType cellType, SizeValueType numberOfCells)
Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()
	LightProcessObject ()
	~LightProcessObject () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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 ()

Protected Attributes
ByteOrder	m_ByteOrder {OrderNotApplicable}
SizeValueType	m_CellBufferSize
IOComponentType	m_CellComponentType {UNKNOWNCOMPONENTTYPE}
IOComponentType	m_CellPixelComponentType {UNKNOWNCOMPONENTTYPE}
IOPixelType	m_CellPixelType {SCALAR}
std::string	m_FileName
FileType	m_FileType {ASCII}
unsigned int	m_NumberOfCellPixelComponents {0}
SizeValueType	m_NumberOfCellPixels
SizeValueType	m_NumberOfCells
unsigned int	m_NumberOfPointPixelComponents {0}
SizeValueType	m_NumberOfPointPixels
SizeValueType	m_NumberOfPoints
IOComponentType	m_PointComponentType {UNKNOWNCOMPONENTTYPE}
SizeValueType	m_PointDimension {3}
IOComponentType	m_PointPixelComponentType {UNKNOWNCOMPONENTTYPE}
IOPixelType	m_PointPixelType {SCALAR}
bool	m_UpdateCellData {false}
bool	m_UpdateCells {false}
bool	m_UpdatePointData {false}
bool	m_UpdatePoints {false}
bool	m_UseCompression {false}
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Private Attributes
ArrayOfExtensionsType	m_SupportedReadExtensions
ArrayOfExtensionsType	m_SupportedWriteExtensions

Additional Inherited Members
Static Public Member Functions inherited from itk::LightProcessObject
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 ()

Member Typedef Documentation

using itk::MeshIOBase::ArrayOfExtensionsType = std::vector< std::string >

Type for the list of strings to be used for extensions.

Definition at line 81 of file itkMeshIOBase.h.

using itk::MeshIOBase::ConstPointer = SmartPointer< const Self >

Definition at line 77 of file itkMeshIOBase.h.

using itk::MeshIOBase::Pointer = SmartPointer< Self >

Definition at line 78 of file itkMeshIOBase.h.

using itk::MeshIOBase::Self = MeshIOBase

Standard class type aliases.

Definition at line 75 of file itkMeshIOBase.h.

using itk::MeshIOBase::SizeValueType = IdentifierType

Definition at line 86 of file itkMeshIOBase.h.

using itk::MeshIOBase::StreamOffsetType = std::streamoff

Type for representing size of bytes, and or positions along a file

Definition at line 84 of file itkMeshIOBase.h.

using itk::MeshIOBase::Superclass = LightProcessObject

Definition at line 76 of file itkMeshIOBase.h.

Member Enumeration Documentation

enum itk::MeshIOBase::ByteOrder

Enums used to specify byte order; whether Big Endian or Little Endian. Some subclasses use this, some ignore it.

Enumerator
BigEndian
LittleEndian
OrderNotApplicable

Definition at line 123 of file itkMeshIOBase.h.

enum itk::MeshIOBase::CellGeometryType

Enums used to specify cell type

Enumerator
VERTEX_CELL
LINE_CELL
TRIANGLE_CELL
QUADRILATERAL_CELL
POLYGON_CELL
TETRAHEDRON_CELL
HEXAHEDRON_CELL
QUADRATIC_EDGE_CELL
QUADRATIC_TRIANGLE_CELL
LAST_ITK_CELL
MAX_ITK_CELLS

Definition at line 126 of file itkMeshIOBase.h.

enum itk::MeshIOBase::FileType

Enums used to specify write style: whether binary or ASCII. Some subclasses use this, some ignore it.

Enumerator
ASCII
BINARY
TYPENOTAPPLICABLE

Definition at line 119 of file itkMeshIOBase.h.

enum itk::MeshIOBase::IOComponentType

Enums used to manipulate the component type. The component type refers to the actual storage class associated with either a SCALAR pixel type or elements of a compound pixel.

Enumerator
UNKNOWNCOMPONENTTYPE
UCHAR
CHAR
USHORT
SHORT
UINT
INT
ULONG
LONG
LONGLONG
ULONGLONG
FLOAT
DOUBLE
LDOUBLE

Definition at line 114 of file itkMeshIOBase.h.

enum itk::MeshIOBase::IOPixelType

Enums used to manipulate the point/cell pixel type. The pixel type provides context for automatic data conversions (for instance, RGB to SCALAR, VECTOR to SCALAR).

Enumerator
UNKNOWNPIXELTYPE
SCALAR
RGB
RGBA
OFFSET
VECTOR
POINT
COVARIANTVECTOR
SYMMETRICSECONDRANKTENSOR
DIFFUSIONTENSOR3D
COMPLEX
FIXEDARRAY
ARRAY
MATRIX
VARIABLELENGTHVECTOR
VARIABLESIZEMATRIX

Definition at line 106 of file itkMeshIOBase.h.

Constructor & Destructor Documentation

itk::MeshIOBase::MeshIOBase ( )

protected

itk::MeshIOBase::~MeshIOBase ( )

overrideprotecteddefault

Member Function Documentation

void itk::MeshIOBase::AddSupportedReadExtension ( const char *  extension )

protected

Insert an extension to the list of supported extensions for reading.

void itk::MeshIOBase::AddSupportedWriteExtension ( const char *  extension )

protected

Insert an extension to the list of supported extensions for writing.

virtual bool itk::MeshIOBase::CanReadFile ( const char *  )

pure virtual

Determine the file type. Returns true if this MeshIO can read the file specified.

Implemented in itk::GiftiMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, itk::STLMeshIO, and itk::OBJMeshIO.

virtual bool itk::MeshIOBase::CanWriteFile ( const char *  )

pure virtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegions has been set properly.

Implemented in itk::GiftiMeshIO, itk::STLMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

virtual ByteOrder itk::MeshIOBase::GetByteOrder ( ) const

virtual

These methods indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. Note: most UNIX machines are BigEndian while PC's and VAX's are LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetByteOrderToLittleEndian() otherwise SetByteOrderToBigEndian(). Some MeshIOBase subclasses ignore these methods.

std::string itk::MeshIOBase::GetByteOrderAsString

(

ByteOrder

)

const

Convenience method returns the ByteOrder as a string. This can be used for writing output files.

virtual SizeValueType itk::MeshIOBase::GetCellBufferSize ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual IOComponentType itk::MeshIOBase::GetCellComponentType ( ) const

virtual

Set/Get the component type of the point, cell, point data and cell data. This is always a native type.

virtual IOComponentType itk::MeshIOBase::GetCellPixelComponentType ( ) const

virtual

Set/Get the component type of the point, cell, point data and cell data. This is always a native type.

virtual IOPixelType itk::MeshIOBase::GetCellPixelType ( ) const

virtual

Set/Get the type of the point/cell pixel. The PixelTypes provides context to the IO mechanisms for data conversions. PixelTypes can be SCALAR, RGB, RGBA, VECTOR, COVARIANTVECTOR, POINT, INDEX. If the PIXELTYPE is SCALAR, then the NumberOfComponents should be 1. Any other of PIXELTYPE will have more than one component.

unsigned int itk::MeshIOBase::GetComponentSize

(

IOComponentType

componentType

)

const

std::string itk::MeshIOBase::GetComponentTypeAsString

(

IOComponentType

)

const

Convenience method returns the IOComponentType as a string. This can be used for writing output files.

virtual const char* itk::MeshIOBase::GetFileName ( ) const

virtual

Set/Get the name of the file to be read.

virtual FileType itk::MeshIOBase::GetFileType ( ) const

virtual

These methods control whether the file is written binary or ASCII. Many file formats (i.e., subclasses) ignore this flag.

std::string itk::MeshIOBase::GetFileTypeAsString

(

FileType

)

const

Convenience method returns the FileType as a string. This can be used for writing output files.

virtual const char* itk::MeshIOBase::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::VTKPolyDataMeshIO, itk::GiftiMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, itk::STLMeshIO, and itk::OBJMeshIO.

virtual unsigned int itk::MeshIOBase::GetNumberOfCellPixelComponents ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual SizeValueType itk::MeshIOBase::GetNumberOfCellPixels ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual SizeValueType itk::MeshIOBase::GetNumberOfCells ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual unsigned int itk::MeshIOBase::GetNumberOfPointPixelComponents ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual SizeValueType itk::MeshIOBase::GetNumberOfPointPixels ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual SizeValueType itk::MeshIOBase::GetNumberOfPoints ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

std::string itk::MeshIOBase::GetPixelTypeAsString

(

IOPixelType

)

const

Convenience method returns the IOPixelType as a string. This can be used for writing output files.

virtual IOComponentType itk::MeshIOBase::GetPointComponentType ( ) const

virtual

Set/Get the component type of the point, cell, point data and cell data. This is always a native type.

virtual unsigned int itk::MeshIOBase::GetPointDimension ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual IOComponentType itk::MeshIOBase::GetPointPixelComponentType ( ) const

virtual

Set/Get the component type of the point, cell, point data and cell data. This is always a native type.

virtual IOPixelType itk::MeshIOBase::GetPointPixelType ( ) const

virtual

Set/Get the type of the point/cell pixel. The PixelTypes provides context to the IO mechanisms for data conversions. PixelTypes can be SCALAR, RGB, RGBA, VECTOR, COVARIANTVECTOR, POINT, INDEX. If the PIXELTYPE is SCALAR, then the NumberOfComponents should be 1. Any other of PIXELTYPE will have more than one component.

const ArrayOfExtensionsType& itk::MeshIOBase::GetSupportedReadExtensions

(

)

const

This method returns an array with the list of filename extensions supported for reading by this MeshIO class. This is intended to facilitate GUI and application level integration.

const ArrayOfExtensionsType& itk::MeshIOBase::GetSupportedWriteExtensions

(

)

const

This method returns an array with the list of filename extensions supported for writing by this MeshIO class. This is intended to facilitate GUI and application level integration.

virtual bool itk::MeshIOBase::GetUpdateCellData ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual bool itk::MeshIOBase::GetUpdateCells ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

Reimplemented in itk::STLMeshIO.

virtual bool itk::MeshIOBase::GetUpdatePointData ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual bool itk::MeshIOBase::GetUpdatePoints ( ) const

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

Reimplemented in itk::STLMeshIO.

virtual bool itk::MeshIOBase::GetUseCompression ( ) const

virtual

Set/Get a boolean to use the compression or not.

void itk::MeshIOBase::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::LightProcessObject.

Reimplemented in itk::OFFMeshIO, itk::FreeSurferBinaryMeshIO, itk::OBJMeshIO, itk::FreeSurferAsciiMeshIO, itk::BYUMeshIO, itk::STLMeshIO, itk::GiftiMeshIO, and itk::VTKPolyDataMeshIO.

template<typename T >

void itk::MeshIOBase::ReadBufferAsAscii ( T *  buffer, std::ifstream &  inputFile, SizeValueType  numberOfComponents  )

inlineprotected

Read data from input file stream to buffer with ascii style

Definition at line 537 of file itkMeshIOBase.h.

template<typename T >

void itk::MeshIOBase::ReadBufferAsBinary ( T *  buffer, std::ifstream &  inputFile, SizeValueType  numberOfComponents  )

inlineprotected

Read data from input file to buffer with binary style

Definition at line 548 of file itkMeshIOBase.h.

References itk::ByteSwapper< T >::SwapRangeFromSystemToBigEndian(), and itk::ByteSwapper< T >::SwapRangeFromSystemToLittleEndian().

virtual void itk::MeshIOBase::ReadCellData ( void *  buffer )

pure virtual

Implemented in itk::GiftiMeshIO, itk::STLMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

virtual void itk::MeshIOBase::ReadCells ( void *  buffer )

pure virtual

Implemented in itk::GiftiMeshIO, itk::VTKPolyDataMeshIO, itk::STLMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

template<typename TInput , typename TOutput >

void itk::MeshIOBase::ReadCellsBuffer ( TInput *  input, TOutput *  output  )

inlineprotected

Read cells from a data buffer, used when writting cells. This function write all kind of cells as it is stored in cells container. It is used when cells container have only one kind of cells

Definition at line 628 of file itkMeshIOBase.h.

template<typename TInput , typename TOutput >

void itk::MeshIOBase::ReadCellsBuffer ( TInput *  input, TOutput *  output, MeshIOBase::CellGeometryType  type  )

inlineprotected

Read cells from input buffer, used when Writting cells. This function only write specified type of cells(used when input cells container composes multiple type of cells and only want to write a specified cell type

Definition at line 651 of file itkMeshIOBase.h.

virtual void itk::MeshIOBase::ReadMeshInformation ( )

pure virtual

Determin the required information and whether need to ReadPoints, ReadCells, ReadPointData and ReadCellData

Implemented in itk::GiftiMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::STLMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

virtual void itk::MeshIOBase::ReadPointData ( void *  buffer )

pure virtual

Implemented in itk::GiftiMeshIO, itk::STLMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

virtual void itk::MeshIOBase::ReadPoints ( void *  buffer )

pure virtual

Reads the data from disk into the memory buffer provided.

Implemented in itk::GiftiMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::STLMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

virtual void itk::MeshIOBase::SetByteOrder ( const ByteOrder  _arg )

virtual

These methods indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. Note: most UNIX machines are BigEndian while PC's and VAX's are LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetByteOrderToLittleEndian() otherwise SetByteOrderToBigEndian(). Some MeshIOBase subclasses ignore these methods.

void itk::MeshIOBase::SetByteOrderToBigEndian ( )

inline

Definition at line 451 of file itkMeshIOBase.h.

void itk::MeshIOBase::SetByteOrderToLittleEndian ( )

inline

Definition at line 456 of file itkMeshIOBase.h.

virtual void itk::MeshIOBase::SetCellBufferSize ( SizeValueType  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetCellComponentType ( const IOComponentType  _arg )

virtual

Set/Get the component type of the point, cell, point data and cell data. This is always a native type.

virtual void itk::MeshIOBase::SetCellPixelComponentType ( const IOComponentType  _arg )

virtual

Set/Get the component type of the point, cell, point data and cell data. This is always a native type.

virtual void itk::MeshIOBase::SetCellPixelType ( const IOPixelType  _arg )

virtual

Set/Get the type of the point/cell pixel. The PixelTypes provides context to the IO mechanisms for data conversions. PixelTypes can be SCALAR, RGB, RGBA, VECTOR, COVARIANTVECTOR, POINT, INDEX. If the PIXELTYPE is SCALAR, then the NumberOfComponents should be 1. Any other of PIXELTYPE will have more than one component.

virtual void itk::MeshIOBase::SetFileName ( const char *  _arg )

virtual

Set/Get the name of the file to be read.

virtual void itk::MeshIOBase::SetFileType ( const FileType  _arg )

virtual

These methods control whether the file is written binary or ASCII. Many file formats (i.e., subclasses) ignore this flag.

void itk::MeshIOBase::SetFileTypeToASCII ( )

inline

Definition at line 426 of file itkMeshIOBase.h.

void itk::MeshIOBase::SetFileTypeToBinary ( )

inline

Definition at line 431 of file itkMeshIOBase.h.

virtual void itk::MeshIOBase::SetNumberOfCellPixelComponents ( unsigned int  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetNumberOfCellPixels ( SizeValueType  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetNumberOfCells ( SizeValueType  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetNumberOfPointPixelComponents ( unsigned int  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetNumberOfPointPixels ( SizeValueType  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetNumberOfPoints ( SizeValueType  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

template<typename T >

void itk::MeshIOBase::SetPixelType ( const T &  , bool  UsePointPixel = true  )

inline

Definition at line 160 of file itkMeshIOBase.h.

template<typename T >

void itk::MeshIOBase::SetPixelType ( const RGBPixel< T > &  , bool  UsePointPixel = true  )

inline

Definition at line 177 of file itkMeshIOBase.h.

template<typename T >

void itk::MeshIOBase::SetPixelType ( const RGBAPixel< T > &  , bool  UsePointPixel = true  )

inline

Definition at line 194 of file itkMeshIOBase.h.

template<typename T , unsigned int VLength>

void itk::MeshIOBase::SetPixelType ( const Vector< T, VLength > &  , bool  UsePointPixel = true  )

inline

Definition at line 211 of file itkMeshIOBase.h.

template<typename T , unsigned int VLength>

void itk::MeshIOBase::SetPixelType ( const CovariantVector< T, VLength > &  , bool  UsePointPixel = true  )

inline

Definition at line 228 of file itkMeshIOBase.h.

template<typename T , unsigned int VLength>

void itk::MeshIOBase::SetPixelType ( const FixedArray< T, VLength > &  , bool  UsePointPixel = true  )

inline

Definition at line 245 of file itkMeshIOBase.h.

template<typename T , unsigned int VLength>

void itk::MeshIOBase::SetPixelType ( const SymmetricSecondRankTensor< T, VLength >  , bool  UsePointPixel = true  )

inline

Definition at line 262 of file itkMeshIOBase.h.

template<typename T >

void itk::MeshIOBase::SetPixelType ( const DiffusionTensor3D< T > &  , bool  UsePointPixel = true  )

inline

Definition at line 279 of file itkMeshIOBase.h.

template<typename T , unsigned int NR, unsigned int NC>

void itk::MeshIOBase::SetPixelType ( const Matrix< T, NR, NC > &  , bool  UsePointPixel = true  )

inline

Definition at line 296 of file itkMeshIOBase.h.

template<typename T >

void itk::MeshIOBase::SetPixelType ( const std::complex< T > &  , bool  UsePointPixel = true  )

inline

Definition at line 313 of file itkMeshIOBase.h.

template<typename T >

void itk::MeshIOBase::SetPixelType ( const Array< T > &  array, bool  UsePointPixel = true  )

inline

Definition at line 330 of file itkMeshIOBase.h.

References itk::Array< TValue >::Size().

template<typename T >

void itk::MeshIOBase::SetPixelType ( const VariableLengthVector< T > &  vector, bool  UsePointPixel = true  )

inline

Definition at line 347 of file itkMeshIOBase.h.

References itk::VariableLengthVector< TValue >::Size().

template<typename T >

void itk::MeshIOBase::SetPixelType ( const VariableSizeMatrix< T > &  matrix, bool  UsePointPixel = true  )

inline

Definition at line 364 of file itkMeshIOBase.h.

References itk::VariableSizeMatrix< T >::Cols(), and itk::VariableSizeMatrix< T >::Rows().

virtual void itk::MeshIOBase::SetPointComponentType ( const IOComponentType  _arg )

virtual

Set/Get the component type of the point, cell, point data and cell data. This is always a native type.

virtual void itk::MeshIOBase::SetPointDimension ( unsigned int  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetPointPixelComponentType ( const IOComponentType  _arg )

virtual

Set/Get the component type of the point, cell, point data and cell data. This is always a native type.

virtual void itk::MeshIOBase::SetPointPixelType ( const IOPixelType  _arg )

virtual

Set/Get the type of the point/cell pixel. The PixelTypes provides context to the IO mechanisms for data conversions. PixelTypes can be SCALAR, RGB, RGBA, VECTOR, COVARIANTVECTOR, POINT, INDEX. If the PIXELTYPE is SCALAR, then the NumberOfComponents should be 1. Any other of PIXELTYPE will have more than one component.

virtual void itk::MeshIOBase::SetUpdateCellData ( bool  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetUpdateCells ( bool  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetUpdatePointData ( bool  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetUpdatePoints ( bool  _arg )

virtual

Set/Get the number of components per pixel in the mesh. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual void itk::MeshIOBase::SetUseCompression ( bool  _arg )

virtual

Set/Get a boolean to use the compression or not.

virtual void itk::MeshIOBase::UseCompressionOff ( )

virtual

Set/Get a boolean to use the compression or not.

virtual void itk::MeshIOBase::UseCompressionOn ( )

virtual

Set/Get a boolean to use the compression or not.

virtual void itk::MeshIOBase::Write ( )

pure virtual

Implemented in itk::GiftiMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::STLMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

template<typename T >

void itk::MeshIOBase::WriteBufferAsAscii ( T *  buffer, std::ofstream &  outputFile, SizeValueType  numberOfLines, SizeValueType  numberOfComponents  )

inlineprotected

Write buffer to output file stream with ascii style

Definition at line 570 of file itkMeshIOBase.h.

template<typename TOutput , typename TInput >

void itk::MeshIOBase::WriteBufferAsBinary ( TInput *  buffer, std::ofstream &  outputFile, SizeValueType  numberOfComponents  )

inlineprotected

Write buffer to output file stream with binary style

Definition at line 586 of file itkMeshIOBase.h.

References itk::ByteSwapper< T >::SwapRangeFromSystemToBigEndian(), and itk::ByteSwapper< T >::SwapRangeFromSystemToLittleEndian().

virtual void itk::MeshIOBase::WriteCellData ( void *  buffer )

pure virtual

Implemented in itk::STLMeshIO, itk::GiftiMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

virtual void itk::MeshIOBase::WriteCells ( void *  buffer )

pure virtual

Implemented in itk::STLMeshIO, itk::GiftiMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

template<typename TInput , typename TOutput >

void itk::MeshIOBase::WriteCellsBuffer ( TInput *  input, TOutput *  output, CellGeometryType  cellType, unsigned int  numberOfPoints, SizeValueType  numberOfCells  )

inlineprotected

Write cells to a data buffer, used when readding mesh, used for cellType with constant number of points

Definition at line 682 of file itkMeshIOBase.h.

template<typename TInput , typename TOutput >

void itk::MeshIOBase::WriteCellsBuffer ( TInput *  input, TOutput *  output, CellGeometryType  cellType, SizeValueType  numberOfCells  )

inlineprotected

Write cells to a data buffer, used when readding mesh, used for cellType with non-constant number of points

Definition at line 704 of file itkMeshIOBase.h.

virtual void itk::MeshIOBase::WriteMeshInformation ( )

pure virtual

Implemented in itk::GiftiMeshIO, itk::STLMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

virtual void itk::MeshIOBase::WritePointData ( void *  buffer )

pure virtual

Implemented in itk::STLMeshIO, itk::GiftiMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

virtual void itk::MeshIOBase::WritePoints ( void *  buffer )

pure virtual

Implemented in itk::GiftiMeshIO, itk::STLMeshIO, itk::VTKPolyDataMeshIO, itk::FreeSurferBinaryMeshIO, itk::BYUMeshIO, itk::FreeSurferAsciiMeshIO, itk::OFFMeshIO, and itk::OBJMeshIO.

Member Data Documentation

ByteOrder itk::MeshIOBase::m_ByteOrder {OrderNotApplicable}

protected

Big or Little Endian, and the type of the file. (May be ignored.)

Definition at line 726 of file itkMeshIOBase.h.

SizeValueType itk::MeshIOBase::m_CellBufferSize

protected

The buffer size of cells

Definition at line 760 of file itkMeshIOBase.h.

IOComponentType itk::MeshIOBase::m_CellComponentType {UNKNOWNCOMPONENTTYPE}

protected

Definition at line 737 of file itkMeshIOBase.h.

IOComponentType itk::MeshIOBase::m_CellPixelComponentType {UNKNOWNCOMPONENTTYPE}

protected

Definition at line 739 of file itkMeshIOBase.h.

IOPixelType itk::MeshIOBase::m_CellPixelType {SCALAR}

protected

Definition at line 743 of file itkMeshIOBase.h.

std::string itk::MeshIOBase::m_FileName

protected

Filename to read

Definition at line 730 of file itkMeshIOBase.h.

FileType itk::MeshIOBase::m_FileType {ASCII}

protected

Definition at line 727 of file itkMeshIOBase.h.

unsigned int itk::MeshIOBase::m_NumberOfCellPixelComponents {0}

protected

Definition at line 748 of file itkMeshIOBase.h.

SizeValueType itk::MeshIOBase::m_NumberOfCellPixels

protected

Definition at line 757 of file itkMeshIOBase.h.

SizeValueType itk::MeshIOBase::m_NumberOfCells

protected

Definition at line 755 of file itkMeshIOBase.h.

unsigned int itk::MeshIOBase::m_NumberOfPointPixelComponents {0}

protected

Stores the number of components per pixel. This will be 1 for grayscale images, 3 for RGBPixel images, and 4 for RGBPixelA images.

Definition at line 747 of file itkMeshIOBase.h.

SizeValueType itk::MeshIOBase::m_NumberOfPointPixels

protected

Definition at line 756 of file itkMeshIOBase.h.

SizeValueType itk::MeshIOBase::m_NumberOfPoints

protected

The number of points and cells

Definition at line 754 of file itkMeshIOBase.h.

IOComponentType itk::MeshIOBase::m_PointComponentType {UNKNOWNCOMPONENTTYPE}

protected

Used internally to keep track of the type of the component.

Definition at line 736 of file itkMeshIOBase.h.

SizeValueType itk::MeshIOBase::m_PointDimension {3}

protected

The number of independent dimensions in the point.

Definition at line 751 of file itkMeshIOBase.h.

IOComponentType itk::MeshIOBase::m_PointPixelComponentType {UNKNOWNCOMPONENTTYPE}

protected

Definition at line 738 of file itkMeshIOBase.h.

IOPixelType itk::MeshIOBase::m_PointPixelType {SCALAR}

protected

Used internally to keep track of the type of the pixel.

Definition at line 742 of file itkMeshIOBase.h.

ArrayOfExtensionsType itk::MeshIOBase::m_SupportedReadExtensions

private

Definition at line 770 of file itkMeshIOBase.h.

ArrayOfExtensionsType itk::MeshIOBase::m_SupportedWriteExtensions

private

Definition at line 771 of file itkMeshIOBase.h.

bool itk::MeshIOBase::m_UpdateCellData {false}

protected

Definition at line 767 of file itkMeshIOBase.h.

bool itk::MeshIOBase::m_UpdateCells {false}

protected

Definition at line 765 of file itkMeshIOBase.h.

bool itk::MeshIOBase::m_UpdatePointData {false}

protected

Definition at line 766 of file itkMeshIOBase.h.

bool itk::MeshIOBase::m_UpdatePoints {false}

protected

Flags indicate whether read or write points, cells, point data and cell data

Definition at line 764 of file itkMeshIOBase.h.

bool itk::MeshIOBase::m_UseCompression {false}

protected

Should we compress the data?

Definition at line 733 of file itkMeshIOBase.h.

---

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

• itkMeshIOBase.h