itk::HDF5TransformIO Class Reference

#include <itkHDF5TransformIO.h>

Inheritance diagram for itk::HDF5TransformIO:

Collaboration diagram for itk::HDF5TransformIO:

List of all members.

Public Types
typedef TransformType::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef HDF5TransformIO	Self
typedef TransformIOBase	Superclass
typedef Superclass::TransformListType	TransformListType
typedef Superclass::TransformPointer	TransformPointer
typedef TransformBase	TransformType
Public Types inherited from itk::TransformIOBase
typedef std::list < ConstTransformPointer >	ConstTransformListType
typedef TransformType::ConstPointer	ConstTransformPointer
Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self >	ConstPointer
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual bool	CanReadFile (const char *)
virtual bool	CanWriteFile (const char *)
virtual void	Read ()
virtual void	Write ()
Public Member Functions inherited from itk::TransformIOBase
void	SetTransformList (ConstTransformListType &transformList)
virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const
TransformListType &	GetTransformList ()
TransformListType &	GetReadTransformList ()
ConstTransformListType &	GetWriteTransformList ()
virtual void	SetAppendMode (bool _arg)
virtual bool	GetAppendMode () const
virtual void	AppendModeOn ()
virtual void	AppendModeOff ()
Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress ()
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 unsigned long	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

Protected Member Functions
	HDF5TransformIO ()
virtual	~HDF5TransformIO ()
Protected Member Functions inherited from itk::TransformIOBase
void	CreateTransform (TransformPointer &ptr, const std::string &ClassName)
void	OpenStream (std::ofstream &out, bool binary)
	TransformIOBase ()
virtual	~TransformIOBase ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Member Functions inherited from itk::LightProcessObject
	LightProcessObject ()
	~LightProcessObject ()
virtual void	GenerateData ()
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 ()

Private Member Functions
ParametersType	ReadParameters (const std::string &DataSetName)
void	WriteParameters (const std::string &name, const ParametersType &parameters)
void	WriteString (const std::string &path, const std::string &value)
void	WriteString (const std::string &path, const char *value)
void	WriteOneTransform (const int transformIndex, const TransformType *transform)

Private Attributes
H5::H5File *	m_H5File
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
static Pointer	New ()

Additional Inherited Members

---

Detailed Description

Read&Write transforms in HDF5 Format.

See hdfgroup.org/HDF5 – HDF5 is a physics/astrophysics format, but it is very general and can store pretty much any sort of data.

Definition at line 46 of file itkHDF5TransformIO.h.

---

Member Typedef Documentation

typedef TransformType::ParametersType itk::HDF5TransformIO::ParametersType

Definition at line 55 of file itkHDF5TransformIO.h.

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

Reimplemented from itk::TransformIOBase.

Definition at line 51 of file itkHDF5TransformIO.h.

typedef HDF5TransformIO itk::HDF5TransformIO::Self

Standard class typedefs

Reimplemented from itk::TransformIOBase.

Definition at line 49 of file itkHDF5TransformIO.h.

typedef TransformIOBase itk::HDF5TransformIO::Superclass

Reimplemented from itk::TransformIOBase.

Definition at line 50 of file itkHDF5TransformIO.h.

typedef Superclass::TransformListType itk::HDF5TransformIO::TransformListType

Reimplemented from itk::TransformIOBase.

Definition at line 54 of file itkHDF5TransformIO.h.

typedef Superclass::TransformPointer itk::HDF5TransformIO::TransformPointer

For writing, a const transform list gets passed in, for reading, a non-const transform list is created from the file.

Reimplemented from itk::TransformIOBase.

Definition at line 53 of file itkHDF5TransformIO.h.

typedef TransformBase itk::HDF5TransformIO::TransformType

Transform types

Reimplemented from itk::TransformIOBase.

Definition at line 52 of file itkHDF5TransformIO.h.

---

Constructor & Destructor Documentation

itk::HDF5TransformIO::HDF5TransformIO ( )

protected

virtual itk::HDF5TransformIO::~HDF5TransformIO ( )

protectedvirtual

---

Member Function Documentation

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

virtual

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

Implements itk::TransformIOBase.

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

virtual

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

Implements itk::TransformIOBase.

virtual::itk::LightObject::Pointer itk::HDF5TransformIO::CreateAnother ( void  ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::TransformIOBase.

static Pointer itk::HDF5TransformIO::New ( )

static

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

virtual void itk::HDF5TransformIO::Read ( )

virtual

Reads the data from disk into the memory buffer provided.

Implements itk::TransformIOBase.

ParametersType itk::HDF5TransformIO::ReadParameters ( const std::string &  DataSetName )

private

Read a parameter array from the file location name

virtual void itk::HDF5TransformIO::Write ( )

virtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegions has been set properly. The buffer is cast to a pointer to the beginning of the image data.

Implements itk::TransformIOBase.

void itk::HDF5TransformIO::WriteOneTransform ( const int  transformIndex, const TransformType *  transform  )

private

write a string variable

void itk::HDF5TransformIO::WriteParameters ( const std::string &  name, const ParametersType &  parameters  )

private

Write a parameter array to the file location name

void itk::HDF5TransformIO::WriteString ( const std::string &  path, const std::string &  value  )

private

write a string variable

void itk::HDF5TransformIO::WriteString ( const std::string &  path, const char *  value  )

private

write a string variable

---

Member Data Documentation

H5::H5File* itk::HDF5TransformIO::m_H5File

private

Definition at line 95 of file itkHDF5TransformIO.h.

---

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

• itkHDF5TransformIO.h