#include <itkTransformIOBase.h>

Inheritance diagram for itk::TransformIOBaseTemplate< TScalar >:

Collaboration diagram for itk::TransformIOBaseTemplate< TScalar >:

Detailed Description

template<typename TScalar>
class itk::TransformIOBaseTemplate< TScalar >

Abstract superclass defining the Transform IO interface.

TransformIOBaseTemplate is a pure virtual base class for derived classes that read/write transform data considering the type of input transform. First, TransformIOBase is derived from this class for legacy read/write transform. This class also is used by the TransformFileReader and TransformFileWriter classes. End users don't directly manipulate classes derived from TransformIOBaseTemplate; 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 46 of file itkTransformIOBase.h.

Public Types
typedef std::list < ConstTransformPointer >	ConstTransformListType

typedef TransformType::ConstPointer	ConstTransformPointer

typedef SmartPointer< Self >	Pointer

typedef TScalar	ScalarType

typedef TransformIOBaseTemplate	Self

typedef LightProcessObject	Superclass

typedef std::list < TransformPointer >	TransformListType

typedef TransformType::Pointer	TransformPointer

typedef TransformBaseTemplate < ScalarType >	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

template<>
void	CorrectTransformPrecisionType (std::string &inputTransformName)

template<>
void	CorrectTransformPrecisionType (std::string &inputTransformName)

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 () 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

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 ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

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

Static Public Member Functions
static void	CorrectTransformPrecisionType (std::string &)

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 ()

Protected Member Functions
void	CreateTransform (TransformPointer &ptr, const std::string &ClassName)

template<>
const std::string	GetTypeNameString ()

template<>
const std::string	GetTypeNameString ()

void	OpenStream (std::ofstream &outputStream, bool binary)

virtual void	PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE

	TransformIOBaseTemplate ()

virtual	~TransformIOBaseTemplate ()

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 ()

Static Protected Member Functions
static const std::string	GetTypeNameString ()

Protected Attributes
bool	m_AppendMode

std::string	m_FileName

TransformListType	m_ReadTransformList

ConstTransformListType	m_WriteTransformList

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Member Typedef Documentation

template<typename TScalar>

typedef std::list< ConstTransformPointer > itk::TransformIOBaseTemplate< TScalar >::ConstTransformListType

Definition at line 67 of file itkTransformIOBase.h.

template<typename TScalar>

typedef TransformType::ConstPointer itk::TransformIOBaseTemplate< TScalar >::ConstTransformPointer

Definition at line 66 of file itkTransformIOBase.h.

template<typename TScalar>

typedef SmartPointer< Self > itk::TransformIOBaseTemplate< TScalar >::Pointer

Definition at line 52 of file itkTransformIOBase.h.

template<typename TScalar>

typedef TScalar itk::TransformIOBaseTemplate< TScalar >::ScalarType

Transform types

Definition at line 55 of file itkTransformIOBase.h.

template<typename TScalar>

typedef TransformIOBaseTemplate itk::TransformIOBaseTemplate< TScalar >::Self

Standard class typedefs

Definition at line 50 of file itkTransformIOBase.h.

template<typename TScalar>

typedef LightProcessObject itk::TransformIOBaseTemplate< TScalar >::Superclass

Definition at line 51 of file itkTransformIOBase.h.

template<typename TScalar>

typedef std::list< TransformPointer > itk::TransformIOBaseTemplate< TScalar >::TransformListType

Definition at line 65 of file itkTransformIOBase.h.

template<typename TScalar>

typedef TransformType::Pointer itk::TransformIOBaseTemplate< TScalar >::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 64 of file itkTransformIOBase.h.

template<typename TScalar>

typedef TransformBaseTemplate<ScalarType> itk::TransformIOBaseTemplate< TScalar >::TransformType

Definition at line 59 of file itkTransformIOBase.h.

Constructor & Destructor Documentation

template<typename TScalar>

itk::TransformIOBaseTemplate< TScalar >::TransformIOBaseTemplate ( )

protected

template<typename TScalar>

virtual itk::TransformIOBaseTemplate< TScalar >::~TransformIOBaseTemplate ( )

protectedvirtual

Member Function Documentation

template<typename TScalar>

virtual void itk::TransformIOBaseTemplate< TScalar >::AppendModeOff ( )

virtual

Set the writer to append to the specified file

template<typename TScalar>

virtual void itk::TransformIOBaseTemplate< TScalar >::AppendModeOn ( )

virtual

Set the writer to append to the specified file

template<typename TScalar>

virtual bool itk::TransformIOBaseTemplate< TScalar >::CanReadFile ( const char * )

pure virtual

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

Implemented in itk::HDF5TransformIOTemplate< TInternalComputationValueType >, itk::MatlabTransformIOTemplate< ParametersValueType >, and itk::TxtTransformIOTemplate< ParametersValueType >.

template<typename TScalar>

virtual bool itk::TransformIOBaseTemplate< TScalar >::CanWriteFile ( const char * )

pure virtual

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

Implemented in itk::HDF5TransformIOTemplate< TInternalComputationValueType >, itk::MatlabTransformIOTemplate< ParametersValueType >, and itk::TxtTransformIOTemplate< ParametersValueType >.

template<typename TScalar>

static void itk::TransformIOBaseTemplate< TScalar >::CorrectTransformPrecisionType ( std::string & )

inlinestatic

The transform type has a string representation used when reading and writing transform files. In the case where a double-precision transform is to be written as float, or vice versa, the transform type name used to write the file needs to patched in order for the transform I/O hierachy to work correctly. These template functions will be chosen at compile time within template classes in order to patch up the type name.

Definition at line 111 of file itkTransformIOBase.h.

template<>

void itk::TransformIOBaseTemplate< float >::CorrectTransformPrecisionType ( std::string & inputTransformName )

inline

Definition at line 142 of file itkTransformIOBase.h.

template<>

void itk::TransformIOBaseTemplate< double >::CorrectTransformPrecisionType ( std::string & inputTransformName )

inline

Definition at line 155 of file itkTransformIOBase.h.

template<typename TScalar>

void itk::TransformIOBaseTemplate< TScalar >::CreateTransform	(	TransformPointer &	ptr,
		const std::string &	ClassName
	)

protected

template<typename TScalar>

virtual bool itk::TransformIOBaseTemplate< TScalar >::GetAppendMode ( ) const

virtual

Set the writer to append to the specified file

template<typename TScalar>

virtual const char* itk::TransformIOBaseTemplate< TScalar >::GetFileName ( ) const

virtual

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

template<typename TScalar>

virtual const char* itk::TransformIOBaseTemplate< TScalar >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::HDF5TransformIOTemplate< TInternalComputationValueType >, itk::MatlabTransformIOTemplate< ParametersValueType >, and itk::TxtTransformIOTemplate< ParametersValueType >.

template<typename TScalar>

TransformListType& itk::TransformIOBaseTemplate< TScalar >::GetReadTransformList ( )

inline

Get the list of transforms resulting from a file read

Definition at line 90 of file itkTransformIOBase.h.

template<typename TScalar>

TransformListType& itk::TransformIOBaseTemplate< TScalar >::GetTransformList ( )

inline

Get the list of transforms resulting from a file read

Definition at line 89 of file itkTransformIOBase.h.

template<typename TScalar>

static const std::string itk::TransformIOBaseTemplate< TScalar >::GetTypeNameString ( )

inlinestaticprotected

Definition at line 132 of file itkTransformIOBase.h.

template<>

const std::string itk::TransformIOBaseTemplate< float >::GetTypeNameString ( )

inlineprotected

Definition at line 168 of file itkTransformIOBase.h.

template<>

const std::string itk::TransformIOBaseTemplate< double >::GetTypeNameString ( )

inlineprotected

Definition at line 176 of file itkTransformIOBase.h.

template<typename TScalar>

ConstTransformListType& itk::TransformIOBaseTemplate< TScalar >::GetWriteTransformList ( )

inline

Get the list of transforms resulting from a file read

Definition at line 91 of file itkTransformIOBase.h.

template<typename TScalar>

void itk::TransformIOBaseTemplate< TScalar >::OpenStream	(	std::ofstream &	outputStream,
		bool	binary
	)

protected

template<typename TScalar>

virtual void itk::TransformIOBaseTemplate< TScalar >::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.

template<typename TScalar>

virtual void itk::TransformIOBaseTemplate< TScalar >::Read ( )

pure virtual

Reads the data from disk into the memory buffer provided.

Implemented in itk::HDF5TransformIOTemplate< TInternalComputationValueType >, itk::MatlabTransformIOTemplate< ParametersValueType >, and itk::TxtTransformIOTemplate< ParametersValueType >.

template<typename TScalar>

virtual void itk::TransformIOBaseTemplate< TScalar >::SetAppendMode ( bool _arg )

virtual

Set the writer to append to the specified file

template<typename TScalar>

virtual void itk::TransformIOBaseTemplate< TScalar >::SetFileName ( const char * _arg )