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

#include <itkHDF5TransformIO.h>

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

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

Public Types

using ConstTransformListType = typename TransformIOBaseTemplate< ParametersValueType >::ConstTransformListType
 
using FixedParametersType = typename TransformType::FixedParametersType
 
using FixedParametersValueType = typename TransformType::FixedParametersValueType
 
using ParametersType = typename TransformType::ParametersType
 
using ParametersValueType = typename TransformType::ParametersValueType
 
using Pointer = SmartPointer< Self >
 
using Self = HDF5TransformIOTemplate
 
using Superclass = TransformIOBaseTemplate< TParametersValueType >
 
- Public Types inherited from itk::TransformIOBaseTemplate< TParametersValueType >
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

bool CanReadFile (const char *) override
 
bool CanWriteFile (const char *) override
 
void Read () override
 
void Write () override
 
- Public Member Functions inherited from itk::TransformIOBaseTemplate< TParametersValueType >
template<>
void CorrectTransformPrecisionType (std::string &inputTransformName)
 
template<>
void CorrectTransformPrecisionType (std::string &inputTransformName)
 
 itkOverrideGetNameOfClassMacro (TransformIOBaseTemplate)
 
void SetTransformList (ConstTransformListType &transformList)
 
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 SetUseCompression (bool _arg)
 
virtual bool GetUseCompression () const
 
virtual void UseCompressionOn ()
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
 itkOverrideGetNameOfClassMacro (LightProcessObject)
 
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
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
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
 
 itkOverrideGetNameOfClassMacro (Object)
 
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 noexcept override
 
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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 HDF5TransformIOTemplate ()
 
 ~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)
 
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 &timeStamp)
 
 ~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

H5::PredType GetH5TypeFromString () const
 
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 &fixedParameters)
 
void WriteString (const std::string &path, const std::string &value)
 
void WriteString (const std::string &path, const char *s)
 
void WriteOneTransform (const int transformIndex, const TransformType *curTransform)
 

Private Attributes

std::unique_ptr< H5::H5File > m_H5File
 
 itkOverrideGetNameOfClassMacro (HDF5TransformIOTemplate)
 
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 val)
 
- 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::LightObject
std::atomic< 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 transformFixedNameCorrected
 
static const std::string transformFixedNameMisspelled
 
static const std::string transformGroupName
 
static const std::string transformParamsName
 
static const std::string transformParamsNameCorrected
 
static const std::string transformParamsNameMisspelled
 
static const std::string transformTypeName
 

Member Typedef Documentation

◆ ConstTransformListType

template<typename TParametersValueType >
using itk::HDF5TransformIOTemplate< TParametersValueType >::ConstTransformListType = typename TransformIOBaseTemplate<ParametersValueType>::ConstTransformListType

Definition at line 102 of file itkHDF5TransformIO.h.

◆ FixedParametersType

template<typename TParametersValueType >
using itk::HDF5TransformIOTemplate< TParametersValueType >::FixedParametersType = typename TransformType::FixedParametersType

Definition at line 99 of file itkHDF5TransformIO.h.

◆ FixedParametersValueType

template<typename TParametersValueType >
using itk::HDF5TransformIOTemplate< TParametersValueType >::FixedParametersValueType = typename TransformType::FixedParametersValueType

Definition at line 100 of file itkHDF5TransformIO.h.

◆ ParametersType

template<typename TParametersValueType >
using itk::HDF5TransformIOTemplate< TParametersValueType >::ParametersType = typename TransformType::ParametersType

Definition at line 97 of file itkHDF5TransformIO.h.

◆ ParametersValueType

template<typename TParametersValueType >
using itk::HDF5TransformIOTemplate< TParametersValueType >::ParametersValueType = typename TransformType::ParametersValueType

Definition at line 98 of file itkHDF5TransformIO.h.

◆ Pointer

template<typename TParametersValueType >
using itk::HDF5TransformIOTemplate< TParametersValueType >::Pointer = SmartPointer<Self>

Definition at line 93 of file itkHDF5TransformIO.h.

◆ Self

template<typename TParametersValueType >
using itk::HDF5TransformIOTemplate< TParametersValueType >::Self = HDF5TransformIOTemplate

Definition at line 91 of file itkHDF5TransformIO.h.

◆ Superclass

template<typename TParametersValueType >
using itk::HDF5TransformIOTemplate< TParametersValueType >::Superclass = TransformIOBaseTemplate<TParametersValueType>

Definition at line 92 of file itkHDF5TransformIO.h.

Constructor & Destructor Documentation

◆ HDF5TransformIOTemplate()

template<typename TParametersValueType >
itk::HDF5TransformIOTemplate< TParametersValueType >::HDF5TransformIOTemplate ( )
protected

◆ ~HDF5TransformIOTemplate()

template<typename TParametersValueType >
itk::HDF5TransformIOTemplate< TParametersValueType >::~HDF5TransformIOTemplate ( )
overrideprotected

Member Function Documentation

◆ CanReadFile()

template<typename TParametersValueType >
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 >.

◆ CanWriteFile()

template<typename TParametersValueType >
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 >.

◆ GetH5TypeFromString()

template<typename TParametersValueType >
H5::PredType itk::HDF5TransformIOTemplate< TParametersValueType >::GetH5TypeFromString ( ) const
private

Utility function for inferring data storage type from class template.

Returns
H5 code PredType

◆ itkOverrideGetNameOfClassMacro()

template<typename TParametersValueType >
itk::HDF5TransformIOTemplate< TParametersValueType >::itkOverrideGetNameOfClassMacro ( HDF5TransformIOTemplate< TParametersValueType >  )

Run-time type information (and related methods).

◆ New()

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

Run-time type information (and related methods).

◆ Read()

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

Reads the data from disk into the memory buffer provided.

Implements itk::TransformIOBaseTemplate< TParametersValueType >.

◆ ReadFixedParameters()

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

Read a parameter array from the file location name

◆ ReadParameters()

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

Read a parameter array from the file location name

◆ Write()

template<typename TParametersValueType >
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 >.

◆ WriteFixedParameters()

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

Write a parameter array to the file location name

◆ WriteOneTransform()

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

write a string variable

◆ WriteParameters()

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

◆ WriteString() [1/2]

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

write a string variable

◆ WriteString() [2/2]

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

write a string variable

Member Data Documentation

◆ m_H5File

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

Definition at line 157 of file itkHDF5TransformIO.h.


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