itk::VTKPolyDataMeshIO Class Reference

This class defines how to read and write vtk legacy file format. More...

#include <itkVTKPolyDataMeshIO.h>

Inheritance diagram for itk::VTKPolyDataMeshIO:

Collaboration diagram for itk::VTKPolyDataMeshIO:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef std::vector < SizeValueType >	PointIdVector
typedef PolylinesContainerType::Pointer	PolylinesContainerPointer
typedef VectorContainer < SizeValueType, PointIdVector >	PolylinesContainerType
typedef VTKPolyDataMeshIO	Self
typedef Superclass::SizeValueType	SizeValueType
typedef std::stringstream	StringStreamType
typedef std::string	StringType
typedef std::vector< StringType >	StringVectorType
typedef MeshIOBase	Superclass
Public Member Functions
virtual bool	CanReadFile (const char *FileNameToRead)
virtual bool	CanWriteFile (const char *FileNameToWrite)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	ReadCellData (void *buffer)
virtual void	ReadCells (void *buffer)
virtual void	ReadMeshInformation ()
virtual void	ReadPointData (void *buffer)
virtual void	ReadPoints (void *buffer)
virtual void	Write ()
virtual void	WriteCellData (void *buffer)
virtual void	WriteCells (void *buffer)
virtual void	WriteMeshInformation ()
virtual void	WritePointData (void *buffer)
virtual void	WritePoints (void *buffer)
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
template<typename T >
void	ReadCellDataBufferAsBINARY (std::ifstream &inputFile, T *buffer)
template<typename TInput , typename TOutput >
void	ReadCellsBuffer (TInput *input, TOutput *output)
void	ReadCellsBufferAsASCII (std::ifstream &inputFile, void *buffer)
void	ReadCellsBufferAsBINARY (std::ifstream &inputFile, void *buffer)
template<typename T >
void	ReadPointDataBufferAsBINARY (std::ifstream &inputFile, T *buffer)
template<typename T >
void	ReadPointsBufferAsASCII (std::ifstream &inputFile, T *buffer)
template<typename T >
void	UpdateCellInformation (T *buffer)
	VTKPolyDataMeshIO ()
template<typename T >
void	WriteCellDataBufferAsASCII (std::ofstream &outputFile, T *buffer, const StringType &cellPixelComponentName)
template<typename T >
void	WriteCellDataBufferAsBINARY (std::ofstream &outputFile, T *buffer, const StringType &cellPixelComponentName)
template<typename T >
void	WriteColorScalarBufferAsASCII (std::ofstream &outputFile, T *buffer, unsigned int numberOfPixelComponents, SizeValueType numberOfPixels)
template<typename T >
void	WriteColorScalarBufferAsBINARY (std::ofstream &outputFile, T *buffer, unsigned int numberOfPixelComponents, SizeValueType numberOfPixels)
template<typename T >
void	WritePointDataBufferAsASCII (std::ofstream &outputFile, T *buffer, const StringType &pointPixelComponentName)
template<typename T >
void	WritePointDataBufferAsBINARY (std::ofstream &outputFile, T *buffer, const StringType &pointPixelComponentName)
template<typename T >
void	WritePointsBufferAsASCII (std::ofstream &outputFile, T *buffer, const StringType &pointComponentType)
template<typename T >
void	WritePointsBufferAsBINARY (std::ofstream &outputFile, T *buffer, const StringType &pointComponentType)
virtual	~VTKPolyDataMeshIO ()
template<typename T >
void	ReadPointsBufferAsBINARY (std::ifstream &inputFile, T *buffer)
template<typename T >
void	ReadPointDataBufferAsASCII (std::ifstream &inputFile, T *buffer)
template<typename T >
void	ReadCellDataBufferAsASCII (std::ifstream &inputFile, T *buffer)
template<typename T >
void	WriteCellsBufferAsASCII (std::ofstream &outputFile, T *buffer)
template<typename T >
void	WriteCellsBufferAsBINARY (std::ofstream &outputFile, T *buffer)
Private Member Functions
void	operator= (const Self &)
	VTKPolyDataMeshIO (const Self &)

---

Detailed Description

This class defines how to read and write vtk legacy file format.

Author:

Wanlin Zhu. Uviversity of New South Wales, Australia.

Definition at line 38 of file itkVTKPolyDataMeshIO.h.

---

Member Typedef Documentation

typedef SmartPointer< const Self > itk::VTKPolyDataMeshIO::ConstPointer

Reimplemented from itk::MeshIOBase.

Definition at line 45 of file itkVTKPolyDataMeshIO.h.

typedef SmartPointer< Self > itk::VTKPolyDataMeshIO::Pointer

Reimplemented from itk::MeshIOBase.

Definition at line 44 of file itkVTKPolyDataMeshIO.h.

typedef std::vector< SizeValueType > itk::VTKPolyDataMeshIO::PointIdVector

Definition at line 52 of file itkVTKPolyDataMeshIO.h.

typedef PolylinesContainerType::Pointer itk::VTKPolyDataMeshIO::PolylinesContainerPointer

Definition at line 54 of file itkVTKPolyDataMeshIO.h.

typedef VectorContainer< SizeValueType, PointIdVector > itk::VTKPolyDataMeshIO::PolylinesContainerType

Definition at line 53 of file itkVTKPolyDataMeshIO.h.

typedef VTKPolyDataMeshIO itk::VTKPolyDataMeshIO::Self

Standard "Self" typedef.

Reimplemented from itk::MeshIOBase.

Definition at line 42 of file itkVTKPolyDataMeshIO.h.

typedef Superclass::SizeValueType itk::VTKPolyDataMeshIO::SizeValueType

Reimplemented from itk::MeshIOBase.

Definition at line 47 of file itkVTKPolyDataMeshIO.h.

typedef std::stringstream itk::VTKPolyDataMeshIO::StringStreamType

Definition at line 51 of file itkVTKPolyDataMeshIO.h.

typedef std::string itk::VTKPolyDataMeshIO::StringType

Definition at line 49 of file itkVTKPolyDataMeshIO.h.

typedef std::vector< StringType > itk::VTKPolyDataMeshIO::StringVectorType

Definition at line 50 of file itkVTKPolyDataMeshIO.h.

typedef MeshIOBase itk::VTKPolyDataMeshIO::Superclass

Reimplemented from itk::MeshIOBase.

Definition at line 43 of file itkVTKPolyDataMeshIO.h.

---

Constructor & Destructor Documentation

itk::VTKPolyDataMeshIO::VTKPolyDataMeshIO

(

)

[protected]

virtual itk::VTKPolyDataMeshIO::~VTKPolyDataMeshIO

(

)

[inline, protected, virtual]

Definition at line 107 of file itkVTKPolyDataMeshIO.h.

itk::VTKPolyDataMeshIO::VTKPolyDataMeshIO

(

const Self &

)

[private]

---

Member Function Documentation

virtual bool itk::VTKPolyDataMeshIO::CanReadFile

(

const char *

FileNameToRead

)

[virtual]

-------- This part of the interfaces deals with reading data. ----- Determine if the file can be read with this MeshIO implementation.

Parameters:

FileNameToRead

The name of the file to test for reading.

Postcondition:

Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite

Returns:

Returns true if this MeshIO can read the file specified.

Implements itk::MeshIOBase.

virtual bool itk::VTKPolyDataMeshIO::CanWriteFile

(

const char *

FileNameToWrite

)

[virtual]

Determine if the file can be written with this MeshIO implementation.

Parameters:

FileNameToWrite

The name of the file to test for writing.

Postcondition:

Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite

Returns:

Returns true if this MeshIO can write the file specified.

Implements itk::MeshIOBase.

virtual::itk::LightObject::Pointer itk::VTKPolyDataMeshIO::CreateAnother

(

void

)

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::LightProcessObject.

virtual const char* itk::VTKPolyDataMeshIO::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::MeshIOBase.

static Pointer itk::VTKPolyDataMeshIO::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::LightProcessObject.

void itk::VTKPolyDataMeshIO::operator=

(

const Self &

)

[private]

This method causes the filter to generate its output.

Reimplemented from itk::MeshIOBase.

void itk::VTKPolyDataMeshIO::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

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::MeshIOBase.

virtual void itk::VTKPolyDataMeshIO::ReadCellData

(

void *

buffer

)

[virtual]

Implements itk::MeshIOBase.

template<typename T >

void itk::VTKPolyDataMeshIO::ReadCellDataBufferAsASCII	(	std::ifstream &	inputFile,
		T *	buffer
	)		[inline, protected]

For scalars we have to read the next line of LOOKUP_TABLE

for VECTORS or NORMALS or TENSORS, we could read them directly

Definition at line 311 of file itkVTKPolyDataMeshIO.h.

References itkExceptionMacro.

template<typename T >

void itk::VTKPolyDataMeshIO::ReadCellDataBufferAsBINARY	(	std::ifstream &	inputFile,
		T *	buffer
	)		[inline, protected]

For scalars we have to read the next line of LOOKUP_TABLE

For VECTORS or NORMALS or TENSORS, we could read them directly

Definition at line 358 of file itkVTKPolyDataMeshIO.h.

References itkExceptionMacro.

virtual void itk::VTKPolyDataMeshIO::ReadCells

(

void *

buffer

)

[virtual]

Implements itk::MeshIOBase.

template<typename TInput , typename TOutput >

void itk::VTKPolyDataMeshIO::ReadCellsBuffer	(	TInput *	input,
		TOutput *	output
	)		[inline, protected]

Convert cells buffer for output cells buffer, it's user's responsibility to make sure the input cells don't contain any cell type that coule not be written as polygon cell

Reimplemented from itk::MeshIOBase.

Definition at line 1129 of file itkVTKPolyDataMeshIO.h.

void itk::VTKPolyDataMeshIO::ReadCellsBufferAsASCII	(	std::ifstream &	inputFile,
		void *	buffer
	)		[protected]

void itk::VTKPolyDataMeshIO::ReadCellsBufferAsBINARY	(	std::ifstream &	inputFile,
		void *	buffer
	)		[protected]

virtual void itk::VTKPolyDataMeshIO::ReadMeshInformation

(

)

[virtual]

Set the spacing and dimension information for the set filename.

Implements itk::MeshIOBase.

virtual void itk::VTKPolyDataMeshIO::ReadPointData

(

void *

buffer

)

[virtual]

Implements itk::MeshIOBase.

template<typename T >

void itk::VTKPolyDataMeshIO::ReadPointDataBufferAsASCII	(	std::ifstream &	inputFile,
		T *	buffer
	)		[inline, protected]

For scalars we have to read the next line of LOOKUP_TABLE

for VECTORS or NORMALS or TENSORS, we could read them directly

Definition at line 215 of file itkVTKPolyDataMeshIO.h.

References itkExceptionMacro.

template<typename T >

void itk::VTKPolyDataMeshIO::ReadPointDataBufferAsBINARY	(	std::ifstream &	inputFile,
		T *	buffer
	)		[inline, protected]

For scalars we have to read the next line of LOOKUP_TABLE

for VECTORS or NORMALS or TENSORS, we could read them directly

Definition at line 262 of file itkVTKPolyDataMeshIO.h.

References itkExceptionMacro.

virtual void itk::VTKPolyDataMeshIO::ReadPoints

(

void *

buffer

)

[virtual]

Reads the data from disk into the memory buffer provided.

Implements itk::MeshIOBase.

template<typename T >

void itk::VTKPolyDataMeshIO::ReadPointsBufferAsASCII	(	std::ifstream &	inputFile,
		T *	buffer
	)		[inline, protected]

Load the point coordinates into the itk::Mesh

Definition at line 167 of file itkVTKPolyDataMeshIO.h.

template<typename T >

void itk::VTKPolyDataMeshIO::ReadPointsBufferAsBINARY	(	std::ifstream &	inputFile,
		T *	buffer
	)		[inline, protected]

Load the point coordinates into the itk::Mesh

Definition at line 188 of file itkVTKPolyDataMeshIO.h.

template<typename T >

void itk::VTKPolyDataMeshIO::UpdateCellInformation

(

T *

buffer

)

[inline, protected]

Definition at line 112 of file itkVTKPolyDataMeshIO.h.

References itkExceptionMacro.

virtual void itk::VTKPolyDataMeshIO::Write

(

)

[virtual]

Implements itk::MeshIOBase.

virtual void itk::VTKPolyDataMeshIO::WriteCellData

(

void *

buffer

)

[virtual]

Implements itk::MeshIOBase.

template<typename T >

void itk::VTKPolyDataMeshIO::WriteCellDataBufferAsASCII	(	std::ofstream &	outputFile,
		T *	buffer,
		const StringType &	cellPixelComponentName
	)		[inline, protected]

Definition at line 892 of file itkVTKPolyDataMeshIO.h.

References ITK_LOCATION, and itkExceptionMacro.

template<typename T >

void itk::VTKPolyDataMeshIO::WriteCellDataBufferAsBINARY	(	std::ofstream &	outputFile,
		T *	buffer,
		const StringType &	cellPixelComponentName
	)		[inline, protected]

Definition at line 1023 of file itkVTKPolyDataMeshIO.h.

References itkExceptionMacro.

virtual void itk::VTKPolyDataMeshIO::WriteCells

(

void *

buffer

)

[virtual]

Implements itk::MeshIOBase.

template<typename T >

void itk::VTKPolyDataMeshIO::WriteCellsBufferAsASCII	(	std::ofstream &	outputFile,
		T *	buffer
	)		[inline, protected]

Write vertices

Write lines

Write polygons

Definition at line 438 of file itkVTKPolyDataMeshIO.h.

template<typename T >

void itk::VTKPolyDataMeshIO::WriteCellsBufferAsBINARY	(	std::ofstream &	outputFile,
		T *	buffer
	)		[inline, protected]

Write vertices

Write lines

Write polygons

Definition at line 579 of file itkVTKPolyDataMeshIO.h.

template<typename T >

void itk::VTKPolyDataMeshIO::WriteColorScalarBufferAsASCII	(	std::ofstream &	outputFile,
		T *	buffer,
		unsigned int	numberOfPixelComponents,
		SizeValueType	numberOfPixels
	)		[inline, protected]

Definition at line 1085 of file itkVTKPolyDataMeshIO.h.

template<typename T >

void itk::VTKPolyDataMeshIO::WriteColorScalarBufferAsBINARY	(	std::ofstream &	outputFile,
		T *	buffer,
		unsigned int	numberOfPixelComponents,
		SizeValueType	numberOfPixels
	)		[inline, protected]

Definition at line 1106 of file itkVTKPolyDataMeshIO.h.

virtual void itk::VTKPolyDataMeshIO::WriteMeshInformation

(

)

[virtual]

Set the spacing and dimension information for the set filename.

Implements itk::MeshIOBase.

virtual void itk::VTKPolyDataMeshIO::WritePointData

(

void *

buffer

)

[virtual]

Implements itk::MeshIOBase.

template<typename T >

void itk::VTKPolyDataMeshIO::WritePointDataBufferAsASCII	(	std::ofstream &	outputFile,
		T *	buffer,
		const StringType &	pointPixelComponentName
	)		[inline, protected]

Definition at line 698 of file itkVTKPolyDataMeshIO.h.

References ITK_LOCATION, and itkExceptionMacro.

template<typename T >

void itk::VTKPolyDataMeshIO::WritePointDataBufferAsBINARY	(	std::ofstream &	outputFile,
		T *	buffer,
		const StringType &	pointPixelComponentName
	)		[inline, protected]

Definition at line 830 of file itkVTKPolyDataMeshIO.h.

References itkExceptionMacro.

virtual void itk::VTKPolyDataMeshIO::WritePoints

(

void *

buffer

)

[virtual]

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

Implements itk::MeshIOBase.

template<typename T >

void itk::VTKPolyDataMeshIO::WritePointsBufferAsASCII	(	std::ofstream &	outputFile,
		T *	buffer,
		const StringType &	pointComponentType
	)		[inline, protected]

1. Write number of points

Definition at line 406 of file itkVTKPolyDataMeshIO.h.

template<typename T >

void itk::VTKPolyDataMeshIO::WritePointsBufferAsBINARY	(	std::ofstream &	outputFile,
		T *	buffer,
		const StringType &	pointComponentType
	)		[inline, protected]

1. Write number of points

Definition at line 426 of file itkVTKPolyDataMeshIO.h.

---

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

• itkVTKPolyDataMeshIO.h