itk::TransformIOBase Class Reference

#include <itkTransformIOBase.h>

Inheritance diagram for itk::TransformIOBase:

Collaboration diagram for itk::TransformIOBase:

Detailed Description

Abstract superclass defining the Transform IO interface.

TransformIOBase is a pure virtual base class for dervied classes that read/write transform data. It's used by the TransformFileReader and TransformFileWriter classes. End users don't directly manipulate classes derived from TransformIOBase; the TransformIOFactory is used by the Reader/Writer to pick a concrete derived class to do the actual reading/writing of transforms.

Definition at line 40 of file itkTransformIOBase.h.

Public Types
typedef std::list < ConstTransformPointer >	ConstTransformListType
typedef TransformType::ConstPointer	ConstTransformPointer
typedef SmartPointer< Self >	Pointer
typedef TransformIOBase	Self
typedef LightProcessObject	Superclass
typedef std::list < TransformPointer >	TransformListType
typedef TransformType::Pointer	TransformPointer
typedef TransformBase	TransformType
Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightProcessObject	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 bool	CanReadFile (const char *)=0
virtual bool	CanWriteFile (const char *)=0
virtual const char *	GetNameOfClass () const
virtual void	Read ()=0
void	SetTransformList (ConstTransformListType &transformList)
virtual void	Write ()=0
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 ::itk::LightObject::Pointer	CreateAnother (void) const
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 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

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

Additional Inherited Members
Static Public Member Functions inherited from itk::LightProcessObject
static Pointer	New ()
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType
Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

typedef std::list< ConstTransformPointer > itk::TransformIOBase::ConstTransformListType

Definition at line 60 of file itkTransformIOBase.h.

typedef TransformType::ConstPointer itk::TransformIOBase::ConstTransformPointer

Definition at line 59 of file itkTransformIOBase.h.

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

Definition at line 46 of file itkTransformIOBase.h.

typedef TransformIOBase itk::TransformIOBase::Self

Standard class typedefs

Definition at line 44 of file itkTransformIOBase.h.

typedef LightProcessObject itk::TransformIOBase::Superclass

Definition at line 45 of file itkTransformIOBase.h.

typedef std::list< TransformPointer > itk::TransformIOBase::TransformListType

Definition at line 58 of file itkTransformIOBase.h.

typedef TransformType::Pointer itk::TransformIOBase::TransformPointer

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

Definition at line 57 of file itkTransformIOBase.h.

typedef TransformBase itk::TransformIOBase::TransformType

Transform types

Definition at line 49 of file itkTransformIOBase.h.

Constructor & Destructor Documentation

itk::TransformIOBase::TransformIOBase ( )

protected

virtual itk::TransformIOBase::~TransformIOBase ( )

protectedvirtual

Member Function Documentation

virtual void itk::TransformIOBase::AppendModeOff ( )

virtual

Set the writer to append to the specified file

virtual void itk::TransformIOBase::AppendModeOn ( )

virtual

Set the writer to append to the specified file

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

pure virtual

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

Implemented in itk::HDF5TransformIO, and itk::MatlabTransformIO.

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

pure virtual

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

Implemented in itk::HDF5TransformIO, and itk::MatlabTransformIO.

void itk::TransformIOBase::CreateTransform ( TransformPointer &  ptr, const std::string &  ClassName  )

protected

virtual bool itk::TransformIOBase::GetAppendMode ( ) const

virtual

Set the writer to append to the specified file

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

virtual

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

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::HDF5TransformIO, and itk::MatlabTransformIO.

TransformListType& itk::TransformIOBase::GetReadTransformList ( )

inline

Get the list of transforms resulting from a file read

Definition at line 83 of file itkTransformIOBase.h.

TransformListType& itk::TransformIOBase::GetTransformList ( )

inline

Get the list of transforms resulting from a file read

Definition at line 82 of file itkTransformIOBase.h.

ConstTransformListType& itk::TransformIOBase::GetWriteTransformList ( )

inline

Get the list of transforms resulting from a file read

Definition at line 84 of file itkTransformIOBase.h.

void itk::TransformIOBase::OpenStream ( std::ofstream &  out, bool  binary  )

protected

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

protectedvirtual

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.

virtual void itk::TransformIOBase::Read ( )

pure virtual

Reads the data from disk into the memory buffer provided.

Implemented in itk::HDF5TransformIO, and itk::MatlabTransformIO.

virtual void itk::TransformIOBase::SetAppendMode ( bool  _arg )

virtual

Set the writer to append to the specified file

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

virtual

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

void itk::TransformIOBase::SetTransformList

(

ConstTransformListType &

transformList

)

Set the list of transforms before writing

virtual void itk::TransformIOBase::Write ( )

pure virtual

Writes the transform list to disk.

Implemented in itk::HDF5TransformIO, and itk::MatlabTransformIO.

Member Data Documentation

bool itk::TransformIOBase::m_AppendMode

private

Definition at line 109 of file itkTransformIOBase.h.

std::string itk::TransformIOBase::m_FileName

private

Definition at line 106 of file itkTransformIOBase.h.

TransformListType itk::TransformIOBase::m_ReadTransformList

private

Definition at line 107 of file itkTransformIOBase.h.

ConstTransformListType itk::TransformIOBase::m_WriteTransformList

private

Definition at line 108 of file itkTransformIOBase.h.

---

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

• itkTransformIOBase.h