itk::VTKImageIO Class Reference

#include <itkVTKImageIO.h>

Inheritance diagram for itk::VTKImageIO:

Collaboration diagram for itk::VTKImageIO:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef VTKImageIO	Self
typedef StreamingImageIOBase	Superclass
Public Member Functions
virtual bool	CanReadFile (const char *)
virtual bool	CanStreamRead (void)
virtual bool	CanStreamWrite (void)
virtual bool	CanWriteFile (const char *)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual SizeType	GetHeaderSize () const
virtual const char *	GetNameOfClass () const
virtual void	Read (void *buffer)
virtual void	ReadImageInformation ()
virtual void	Write (const void *buffer)
virtual void	WriteImageInformation ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	InternalReadImageInformation (std::ifstream &file)
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead)
void	ReadHeaderSize (std::ifstream &file)
virtual void	ReadSymmetricTensorBufferAsBinary (std::istream &os, void *buffer, StreamingImageIOBase::SizeType num)
	VTKImageIO ()
virtual void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite)
void	WriteImageInformation (const void *buffer)
virtual void	WriteSymmetricTensorBufferAsBinary (std::ostream &os, const void *buffer, StreamingImageIOBase::SizeType num)
	~VTKImageIO ()
Private Member Functions
void	operator= (const Self &)
void	SetPixelTypeFromString (const std::string &pixelType)
	VTKImageIO (const Self &)
Private Attributes
SizeType	m_HeaderSize

---

Detailed Description

ImageIO class for reading VTK images.

This implementation was taken fron the Insight Joural: http://hdl.handle.net/10380/3171

Definition at line 48 of file itkVTKImageIO.h.

---

Member Typedef Documentation

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

Reimplemented from itk::LightProcessObject.

Definition at line 56 of file itkVTKImageIO.h.

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

Reimplemented from itk::StreamingImageIOBase.

Definition at line 55 of file itkVTKImageIO.h.

typedef VTKImageIO itk::VTKImageIO::Self

Standard class typedefs.

Reimplemented from itk::StreamingImageIOBase.

Definition at line 53 of file itkVTKImageIO.h.

typedef StreamingImageIOBase itk::VTKImageIO::Superclass

Reimplemented from itk::StreamingImageIOBase.

Definition at line 54 of file itkVTKImageIO.h.

---

Constructor & Destructor Documentation

itk::VTKImageIO::VTKImageIO

(

)

[protected]

itk::VTKImageIO::~VTKImageIO

(

)

[protected]

itk::VTKImageIO::VTKImageIO

(

const Self &

)

[private]

---

Member Function Documentation

virtual bool itk::VTKImageIO::CanReadFile

(

const char *

)

[virtual]

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

Implements itk::ImageIOBase.

virtual bool itk::VTKImageIO::CanStreamRead

(

void

)

[virtual]

Determine if the ImageIO can stream reading from the current settings. Default is false. If this is queried after the header of the file has been read then it will indicate if that file can be streamed

Reimplemented from itk::StreamingImageIOBase.

virtual bool itk::VTKImageIO::CanStreamWrite

(

void

)

[virtual]

Determine if the ImageIO can stream write from the current settings.

There are two types of non exclusive streaming: pasteing subregions, and iterative

Reimplemented from itk::StreamingImageIOBase.

virtual bool itk::VTKImageIO::CanWriteFile

(

const char *

)

[virtual]

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

Implements itk::ImageIOBase.

virtual::itk::LightObject::Pointer itk::VTKImageIO::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 SizeType itk::VTKImageIO::GetHeaderSize

(

void

)

const [inline, virtual]

returns the header size, if it is unknown it will return 0

Implements itk::StreamingImageIOBase.

Definition at line 102 of file itkVTKImageIO.h.

virtual const char* itk::VTKImageIO::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::StreamingImageIOBase.

void itk::VTKImageIO::InternalReadImageInformation

(

std::ifstream &

file

)

[protected]

static Pointer itk::VTKImageIO::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::LightProcessObject.

void itk::VTKImageIO::operator=

(

const Self &

)

[private]

This method causes the filter to generate its output.

Reimplemented from itk::StreamingImageIOBase.

void itk::VTKImageIO::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::StreamingImageIOBase.

virtual void itk::VTKImageIO::Read

(

void *

buffer

)

[virtual]

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual void itk::VTKImageIO::ReadBufferAsASCII	(	std::istream &	os,
		void *	buffer,
		IOComponentType	ctype,
		SizeType	numberOfBytesToBeRead
	)		[protected, virtual]

Convenient method to read a buffer as ASCII text.

Reimplemented from itk::ImageIOBase.

void itk::VTKImageIO::ReadHeaderSize

(

std::ifstream &

file

)

[protected]

virtual void itk::VTKImageIO::ReadImageInformation

(

)

[virtual]

Set the spacing and dimesion information for the current filename.

Implements itk::ImageIOBase.

virtual void itk::VTKImageIO::ReadSymmetricTensorBufferAsBinary	(	std::istream &	os,
		void *	buffer,
		StreamingImageIOBase::SizeType	num
	)		[protected, virtual]

We have a special method to read symmetric second rank tensors because the VTK file format expands the symmetry and only supports 3D tensors.

void itk::VTKImageIO::SetPixelTypeFromString

(

const std::string &

pixelType

)

[private]

virtual void itk::VTKImageIO::Write

(

const void *

buffer

)

[virtual]

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

Implements itk::ImageIOBase.

virtual void itk::VTKImageIO::WriteBufferAsASCII	(	std::ostream &	os,
		const void *	buffer,
		IOComponentType	ctype,
		SizeType	numberOfBytesToWrite
	)		[protected, virtual]

Convenient method to write a buffer as ASCII text.

Reimplemented from itk::ImageIOBase.

virtual void itk::VTKImageIO::WriteImageInformation

(

void

)

[inline, virtual]

Writes the spacing and dimentions of the image. Assumes SetFileName has been called with a valid file name.

Implements itk::ImageIOBase.

Definition at line 95 of file itkVTKImageIO.h.

void itk::VTKImageIO::WriteImageInformation

(

const void *

buffer

)

[protected]

virtual void itk::VTKImageIO::WriteSymmetricTensorBufferAsBinary	(	std::ostream &	os,
		const void *	buffer,
		StreamingImageIOBase::SizeType	num
	)		[protected, virtual]

We have a special method to write symmetric second rank tensors because the VTK file format expands the symmetry and only supports 3D tensors.

---

Member Data Documentation

SizeType itk::VTKImageIO::m_HeaderSize [private]

Definition at line 143 of file itkVTKImageIO.h.

---

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

• itkVTKImageIO.h