ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::HDF5TransformIOTemplate< TParametersValueType > Class Template Reference

#include <itkHDF5TransformIO.h>

+ Inheritance diagram for itk::HDF5TransformIOTemplate< TParametersValueType >:
+ Collaboration diagram for itk::HDF5TransformIOTemplate< TParametersValueType >:

Detailed Description

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

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 82 of file itkHDF5TransformIO.h.

Public Types

typedef
TransformIOBaseTemplate
< ParametersValueType >
::ConstTransformListType 
ConstTransformListType
 
typedef
TransformType::FixedParametersType 
FixedParametersType
 
typedef
TransformType::FixedParametersValueType 
FixedParametersValueType
 
typedef
TransformType::ParametersType 
ParametersType
 
typedef
TransformType::ParametersValueType 
ParametersValueType
 
typedef SmartPointer< Self > Pointer
 
typedef HDF5TransformIOTemplate Self
 
typedef
TransformIOBaseTemplate
< TParametersValueType > 
Superclass
 
typedef
Superclass::TransformListType 
TransformListType
 
typedef
Superclass::TransformPointer 
TransformPointer
 
typedef Superclass::TransformType TransformType
 
- Public Types inherited from itk::TransformIOBaseTemplate< TParametersValueType >
typedef std::list
< ConstTransformPointer > 
ConstTransformListType
 
typedef TransformType::ConstPointer ConstTransformPointer
 
typedef double FixedParametersValueType
 
typedef TParametersValueType ParametersValueType
 
typedef SmartPointer< Self > Pointer
 
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 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 *) override
 
virtual bool CanWriteFile (const char *) override
 
virtual void Read () override
 
virtual void Write () override
 
- Public Member Functions inherited from itk::TransformIOBaseTemplate< TParametersValueType >
template<>
void CorrectTransformPrecisionType (std::string &inputTransformName)
 
template<>
void CorrectTransformPrecisionType (std::string &inputTransformName)
 
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 () 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 ()
 
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
 
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
 

Protected Member Functions

 HDF5TransformIOTemplate ()
 
virtual ~HDF5TransformIOTemplate () override
 
- Protected Member Functions inherited from itk::TransformIOBaseTemplate< TParametersValueType >
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 () 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)
 
virtual ~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 ()
 

Private Member Functions

ParametersType ReadParameters (const std::string &DataSetName) const
 
FixedParametersType ReadFixedParameters (const std::string &DataSetName) const
 
void WriteParameters (const std::string &name, const ParametersType &parameters)
 
void WriteFixedParameters (const std::string &name, const FixedParametersType &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

AutoPointer< H5::H5File > m_H5File
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
static Pointer New ()
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::TransformIOBaseTemplate< TParametersValueType >
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 ()
 
- Static Protected Member Functions inherited from itk::TransformIOBaseTemplate< TParametersValueType >
static const std::string GetTypeNameString ()
 
- Protected Attributes inherited from itk::TransformIOBaseTemplate< TParametersValueType >
bool m_AppendMode
 
std::string m_FileName
 
TransformListType m_ReadTransformList
 
ConstTransformListType m_WriteTransformList
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 
- Static Private Attributes inherited from itk::HDF5CommonPathNames
static const std::string HDFVersion
 
static const std::string ItkVersion
 
static const std::string OSName
 
static const std::string OSVersion
 
static const std::string transformFixedName
 
static const std::string transformGroupName
 
static const std::string transformParamsName
 
static const std::string transformTypeName
 

Member Typedef Documentation

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

Definition at line 99 of file itkHDF5TransformIO.h.

template<typename TParametersValueType >
typedef TransformType::FixedParametersType itk::HDF5TransformIOTemplate< TParametersValueType >::FixedParametersType

Definition at line 94 of file itkHDF5TransformIO.h.

template<typename TParametersValueType >
typedef TransformType::FixedParametersValueType itk::HDF5TransformIOTemplate< TParametersValueType >::FixedParametersValueType

Definition at line 95 of file itkHDF5TransformIO.h.

template<typename TParametersValueType >
typedef TransformType::ParametersType itk::HDF5TransformIOTemplate< TParametersValueType >::ParametersType

Definition at line 92 of file itkHDF5TransformIO.h.

template<typename TParametersValueType >
typedef TransformType::ParametersValueType itk::HDF5TransformIOTemplate< TParametersValueType >::ParametersValueType

Definition at line 93 of file itkHDF5TransformIO.h.

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

Definition at line 88 of file itkHDF5TransformIO.h.

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

Definition at line 86 of file itkHDF5TransformIO.h.

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

Definition at line 87 of file itkHDF5TransformIO.h.

template<typename TParametersValueType >
typedef Superclass::TransformListType itk::HDF5TransformIOTemplate< TParametersValueType >::TransformListType

Definition at line 91 of file itkHDF5TransformIO.h.

template<typename TParametersValueType >
typedef Superclass::TransformPointer itk::HDF5TransformIOTemplate< TParametersValueType >::TransformPointer

Definition at line 90 of file itkHDF5TransformIO.h.

template<typename TParametersValueType >
typedef Superclass::TransformType itk::HDF5TransformIOTemplate< TParametersValueType >::TransformType

Definition at line 89 of file itkHDF5TransformIO.h.

Constructor & Destructor Documentation

template<typename TParametersValueType >
itk::HDF5TransformIOTemplate< TParametersValueType >::HDF5TransformIOTemplate ( )
protected
template<typename TParametersValueType >
virtual itk::HDF5TransformIOTemplate< TParametersValueType >::~HDF5TransformIOTemplate ( )
overrideprotectedvirtual

Member Function Documentation

template<typename TParametersValueType >
virtual bool itk::HDF5TransformIOTemplate< TParametersValueType >::CanReadFile ( const char *  )
overridevirtual

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

Implements itk::TransformIOBaseTemplate< TParametersValueType >.

template<typename TParametersValueType >
virtual bool itk::HDF5TransformIOTemplate< TParametersValueType >::CanWriteFile ( const char *  )
overridevirtual

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

Implements itk::TransformIOBaseTemplate< TParametersValueType >.

template<typename TParametersValueType >
virtual::itk::LightObject::Pointer itk::HDF5TransformIOTemplate< TParametersValueType >::CreateAnother ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

template<typename TParametersValueType >
virtual const char* itk::HDF5TransformIOTemplate< TParametersValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::TransformIOBaseTemplate< TParametersValueType >.

template<typename TParametersValueType >
static Pointer itk::HDF5TransformIOTemplate< TParametersValueType >::New ( )
static

Run-time type information (and related methods).

template<typename TParametersValueType >
virtual void itk::HDF5TransformIOTemplate< TParametersValueType >::Read ( )
overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::TransformIOBaseTemplate< TParametersValueType >.

template<typename TParametersValueType >
FixedParametersType itk::HDF5TransformIOTemplate< TParametersValueType >::ReadFixedParameters ( const std::string &  DataSetName) const
private

Read a parameter array from the file location name

template<typename TParametersValueType >
ParametersType itk::HDF5TransformIOTemplate< TParametersValueType >::ReadParameters ( const std::string &  DataSetName) const
private

Read a parameter array from the file location name

template<typename TParametersValueType >
virtual void itk::HDF5TransformIOTemplate< TParametersValueType >::Write ( )
overridevirtual

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::TransformIOBaseTemplate< TParametersValueType >.

template<typename TParametersValueType >
void itk::HDF5TransformIOTemplate< TParametersValueType >::WriteFixedParameters ( const std::string &  name,
const FixedParametersType &  parameters 
)
private

Write a parameter array to the file location name

template<typename TParametersValueType >
void itk::HDF5TransformIOTemplate< TParametersValueType >::WriteOneTransform ( const int  transformIndex,
const TransformType *  transform 
)
private

write a string variable

template<typename TParametersValueType >
void itk::HDF5TransformIOTemplate< TParametersValueType >::WriteParameters ( const std::string &  name,
const ParametersType &  parameters 
)
private

Write a parameter array to the file location name

template<typename TParametersValueType >
void itk::HDF5TransformIOTemplate< TParametersValueType >::WriteString ( const std::string &  path,
const std::string &  value 
)
private

write a string variable

template<typename TParametersValueType >
void itk::HDF5TransformIOTemplate< TParametersValueType >::WriteString ( const std::string &  path,
const char *  value 
)
private

write a string variable

Member Data Documentation

template<typename TParametersValueType >
AutoPointer<H5::H5File> itk::HDF5TransformIOTemplate< TParametersValueType >::m_H5File
private

Definition at line 146 of file itkHDF5TransformIO.h.


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