ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
itk::TransformIOBaseTemplate< TParametersValueType > Class Template Referenceabstract

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

Public Types

typedef std::list
< ConstTransformPointer
ConstTransformListType
 
typedef TransformType::ConstPointer ConstTransformPointer
 
typedef double FixedParametersValueType
 
typedef TParametersValueType ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef TParametersValueType ScalarType
 
typedef TransformIOBaseTemplate Self
 
typedef LightProcessObject Superclass
 
typedef std::list
< TransformPointer
TransformListType
 
typedef TransformType::Pointer TransformPointer
 
typedef TransformBaseTemplate
< ParametersValueType
TransformType
 
- Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
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
 
TransformListTypeGetTransformList ()
 
TransformListTypeGetReadTransformList ()
 
ConstTransformListTypeGetWriteTransformList ()
 
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 () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 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
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TParametersValueType>
typedef std::list< ConstTransformPointer > itk::TransformIOBaseTemplate< TParametersValueType >::ConstTransformListType

Definition at line 72 of file itkTransformIOBase.h.

template<typename TParametersValueType>
typedef TransformType::ConstPointer itk::TransformIOBaseTemplate< TParametersValueType >::ConstTransformPointer

Definition at line 71 of file itkTransformIOBase.h.

template<typename TParametersValueType>
typedef double itk::TransformIOBaseTemplate< TParametersValueType >::FixedParametersValueType

Definition at line 62 of file itkTransformIOBase.h.

template<typename TParametersValueType>
typedef TParametersValueType itk::TransformIOBaseTemplate< TParametersValueType >::ParametersValueType

Definition at line 61 of file itkTransformIOBase.h.

template<typename TParametersValueType>
typedef SmartPointer<Self> itk::TransformIOBaseTemplate< TParametersValueType >::Pointer

Definition at line 54 of file itkTransformIOBase.h.

template<typename TParametersValueType>
typedef TParametersValueType itk::TransformIOBaseTemplate< TParametersValueType >::ScalarType

Transform types

Definition at line 57 of file itkTransformIOBase.h.

template<typename TParametersValueType>
typedef TransformIOBaseTemplate itk::TransformIOBaseTemplate< TParametersValueType >::Self

Standard class typedefs

Definition at line 52 of file itkTransformIOBase.h.

template<typename TParametersValueType>
typedef LightProcessObject itk::TransformIOBaseTemplate< TParametersValueType >::Superclass

Definition at line 53 of file itkTransformIOBase.h.

template<typename TParametersValueType>
typedef std::list< TransformPointer > itk::TransformIOBaseTemplate< TParametersValueType >::TransformListType

Definition at line 70 of file itkTransformIOBase.h.

template<typename TParametersValueType>
typedef TransformType::Pointer itk::TransformIOBaseTemplate< TParametersValueType >::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 69 of file itkTransformIOBase.h.

template<typename TParametersValueType>
typedef TransformBaseTemplate<ParametersValueType> itk::TransformIOBaseTemplate< TParametersValueType >::TransformType

Definition at line 64 of file itkTransformIOBase.h.

Constructor & Destructor Documentation

template<typename TParametersValueType>
itk::TransformIOBaseTemplate< TParametersValueType >::TransformIOBaseTemplate ( )
protected
template<typename TParametersValueType>
virtual itk::TransformIOBaseTemplate< TParametersValueType >::~TransformIOBaseTemplate ( )
protectedvirtual

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
template<typename TParametersValueType>
virtual bool itk::TransformIOBaseTemplate< TParametersValueType >::CanWriteFile ( const char *  )
pure virtual
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 116 of file itkTransformIOBase.h.

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

Definition at line 147 of file itkTransformIOBase.h.

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

Definition at line 160 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
template<typename TParametersValueType>
TransformListType& itk::TransformIOBaseTemplate< TParametersValueType >::GetReadTransformList ( )
inline

Get the list of transforms resulting from a file read

Definition at line 95 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 94 of file itkTransformIOBase.h.

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

Definition at line 137 of file itkTransformIOBase.h.

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

Definition at line 173 of file itkTransformIOBase.h.

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

Definition at line 181 of file itkTransformIOBase.h.

template<typename TParametersValueType>
ConstTransformListType& itk::TransformIOBaseTemplate< TParametersValueType >::GetWriteTransformList ( )
inline

Get the list of transforms resulting from a file read

Definition at line 96 of file itkTransformIOBase.h.

template<typename TParametersValueType>
void itk::TransformIOBaseTemplate< TParametersValueType >::OpenStream ( std::ofstream &  outputStream,
bool  binary 
)
protected
template<typename TParametersValueType>
virtual 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
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 >::Write ( )
pure virtual

Member Data Documentation

template<typename TParametersValueType>
bool itk::TransformIOBaseTemplate< TParametersValueType >::m_AppendMode
protected

Definition at line 133 of file itkTransformIOBase.h.

template<typename TParametersValueType>
std::string itk::TransformIOBaseTemplate< TParametersValueType >::m_FileName
protected

Definition at line 130 of file itkTransformIOBase.h.

template<typename TParametersValueType>
TransformListType itk::TransformIOBaseTemplate< TParametersValueType >::m_ReadTransformList
protected

Definition at line 131 of file itkTransformIOBase.h.

template<typename TParametersValueType>
ConstTransformListType itk::TransformIOBaseTemplate< TParametersValueType >::m_WriteTransformList
protected

Definition at line 132 of file itkTransformIOBase.h.


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