itk::TransformIOBaseTemplate< TParametersValueType > Class Template Reference

#include <itkTransformIOBase.h>

Inheritance diagram for itk::TransformIOBaseTemplate< TParametersValueType >:

Collaboration diagram for itk::TransformIOBaseTemplate< TParametersValueType >:

Detailed Description

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

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 57 of file itkTransformIOBase.h.

Public Types
using	ConstTransformListType = std::list< ConstTransformPointer >
using	ConstTransformPointer = typename TransformType::ConstPointer
using	FixedParametersValueType = double
using	ParametersValueType = TParametersValueType
using	Pointer = SmartPointer< Self >
using	ScalarType = TParametersValueType
using	Self = TransformIOBaseTemplate
using	Superclass = LightProcessObject
using	TransformListType = std::list< TransformPointer >
using	TransformPointer = typename TransformType::Pointer
using	TransformType = TransformBaseTemplate< ParametersValueType >
Public Types inherited from itk::LightProcessObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightProcessObject
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

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 ()
virtual void	SetUseCompression (bool _arg)
virtual bool	GetUseCompression () const
virtual void	UseCompressionOn ()
virtual void	UseCompressionOff ()
Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual ::itk::LightObject::Pointer	CreateAnother () 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
LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () 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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
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)
void	PrintSelf (std::ostream &os, Indent indent) const override
	TransformIOBaseTemplate ()
	~TransformIOBaseTemplate () override
Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()
	LightProcessObject ()
	~LightProcessObject () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~Object () override
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 ()

Private Attributes
bool	m_AppendMode {false}
std::string	m_FileName
TransformListType	m_ReadTransformList
bool	m_UseCompression {false}
ConstTransformListType	m_WriteTransformList

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::ConstTransformListType = std::list< ConstTransformPointer >

Definition at line 81 of file itkTransformIOBase.h.

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::ConstTransformPointer = typename TransformType::ConstPointer

Definition at line 80 of file itkTransformIOBase.h.

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::FixedParametersValueType = double

Definition at line 71 of file itkTransformIOBase.h.

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::ParametersValueType = TParametersValueType

Definition at line 70 of file itkTransformIOBase.h.

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::Pointer = SmartPointer<Self>

Definition at line 63 of file itkTransformIOBase.h.

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::ScalarType = TParametersValueType

Transform types

Definition at line 69 of file itkTransformIOBase.h.

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::Self = TransformIOBaseTemplate

Standard class type aliases

Definition at line 61 of file itkTransformIOBase.h.

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::Superclass = LightProcessObject

Definition at line 62 of file itkTransformIOBase.h.

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::TransformListType = std::list< TransformPointer >

Definition at line 79 of file itkTransformIOBase.h.

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::TransformPointer = typename TransformType::Pointer

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

Definition at line 78 of file itkTransformIOBase.h.

template<typename TParametersValueType>

using itk::TransformIOBaseTemplate< TParametersValueType >::TransformType = TransformBaseTemplate<ParametersValueType>

Definition at line 73 of file itkTransformIOBase.h.

Constructor & Destructor Documentation

template<typename TParametersValueType>

itk::TransformIOBaseTemplate< TParametersValueType >::TransformIOBaseTemplate ( )

protected

template<typename TParametersValueType>

itk::TransformIOBaseTemplate< TParametersValueType >::~TransformIOBaseTemplate ( )

overrideprotected

Member Function Documentation

template<typename TParametersValueType>

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

virtual

Set the writer to append to the specified file

template<typename TParametersValueType>

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

virtual

Set the writer to append to the specified file

template<typename TParametersValueType>

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

pure virtual

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

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

template<typename TParametersValueType>

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

pure virtual

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

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

template<typename TParametersValueType>

static void itk::TransformIOBaseTemplate< TParametersValueType >::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 131 of file itkTransformIOBase.h.

template<>

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

inline

Definition at line 166 of file itkTransformIOBase.h.

template<>

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

inline

Definition at line 179 of file itkTransformIOBase.h.

template<typename TParametersValueType>

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

protected

template<typename TParametersValueType>

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

virtual

Set the writer to append to the specified file

template<typename TParametersValueType>

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

virtual

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

template<typename TParametersValueType>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

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

template<typename TParametersValueType>

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

inline

Get the list of transforms resulting from a file read

Definition at line 104 of file itkTransformIOBase.h.

template<typename TParametersValueType>

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

inline

Get the list of transforms resulting from a file read

Definition at line 103 of file itkTransformIOBase.h.

template<typename TParametersValueType>

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

inlinestaticprotected

Definition at line 147 of file itkTransformIOBase.h.

template<>

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

inlineprotected

Definition at line 192 of file itkTransformIOBase.h.

template<>

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

inlineprotected

Definition at line 200 of file itkTransformIOBase.h.

template<typename TParametersValueType>

virtual bool itk::TransformIOBaseTemplate< TParametersValueType >::GetUseCompression ( ) const

virtual

Set/Get a boolean to use the compression or not.

template<typename TParametersValueType>

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

inline

Get the list of transforms resulting from a file read

Definition at line 105 of file itkTransformIOBase.h.

template<typename TParametersValueType>

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

protected

template<typename TParametersValueType>

void itk::TransformIOBaseTemplate< TParametersValueType >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

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 TParametersValueType>

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

pure virtual

Reads the data from disk into the memory buffer provided.

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

template<typename TParametersValueType>

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

virtual

Set the writer to append to the specified file

template<typename TParametersValueType>

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

virtual

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

template<typename TParametersValueType>

void itk::TransformIOBaseTemplate< TParametersValueType >::SetTransformList

(

ConstTransformListType &

transformList

)

Set the list of transforms before writing

template<typename TParametersValueType>

virtual void itk::TransformIOBaseTemplate< TParametersValueType >::SetUseCompression ( bool  _arg )

virtual

Set/Get a boolean to use the compression or not.

template<typename TParametersValueType>

virtual void itk::TransformIOBaseTemplate< TParametersValueType >::UseCompressionOff ( )

virtual

Set/Get a boolean to use the compression or not.

template<typename TParametersValueType>

virtual void itk::TransformIOBaseTemplate< TParametersValueType >::UseCompressionOn ( )

virtual

Set/Get a boolean to use the compression or not.

template<typename TParametersValueType>

virtual void itk::TransformIOBaseTemplate< TParametersValueType >::Write ( )

pure virtual

Writes the transform list to disk.

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

Member Data Documentation

template<typename TParametersValueType>

bool itk::TransformIOBaseTemplate< TParametersValueType >::m_AppendMode {false}

private

Definition at line 156 of file itkTransformIOBase.h.

template<typename TParametersValueType>

std::string itk::TransformIOBaseTemplate< TParametersValueType >::m_FileName

private

Definition at line 153 of file itkTransformIOBase.h.

template<typename TParametersValueType>

TransformListType itk::TransformIOBaseTemplate< TParametersValueType >::m_ReadTransformList

private

Definition at line 154 of file itkTransformIOBase.h.

template<typename TParametersValueType>

bool itk::TransformIOBaseTemplate< TParametersValueType >::m_UseCompression {false}

private

Should we compress the data?

Definition at line 158 of file itkTransformIOBase.h.

template<typename TParametersValueType>

ConstTransformListType itk::TransformIOBaseTemplate< TParametersValueType >::m_WriteTransformList

private

Definition at line 155 of file itkTransformIOBase.h.

---

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

• itkTransformIOBase.h