ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::TransformFileWriterTemplate< TParametersValueType > Class Template Reference
Group IO » Module ITKIOTransformBase

#include <itkTransformFileWriter.h>

Detailed Description

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

TODO.

ITK Sphinx Examples:
Examples
Examples/IO/TransformReadWrite.cxx.

Definition at line 39 of file itkTransformFileWriter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ConstTransformListType = typename TransformIOType::ConstTransformListType
 
using ConstTransformPointer = typename TransformIOType::ConstTransformPointer
 
using FixedParametersValueType = double
 
using ParametersValueType = TParametersValueType
 
using Pointer = SmartPointer< Self >
 
using Self = TransformFileWriterTemplate
 
using Superclass = LightProcessObject
 
using TransformIOType = TransformIOBaseTemplate< ParametersValueType >
 
using TransformPointer = typename TransformIOType::TransformPointer
 
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

void AddTransform (const Object *transform)
 
virtual const char * GetFileName () const
 
const TransformType * GetInput ()
 
const char * GetNameOfClass () const override
 
virtual void SetFileName (const char *_arg)
 
void SetInput (const Object *transform)
 
void Update ()
 
virtual void SetAppendMode (bool _arg)
 
virtual bool GetAppendMode () const
 
virtual void AppendModeOn ()
 
virtual void SetUseCompression (bool _arg)
 
virtual bool GetUseCompression () const
 
virtual void UseCompressionOn ()
 
virtual void SetTransformIO (TransformIOType *_arg)
 
virtual const TransformIOType * GetTransformIO () const
 
- Public Member Functions inherited from itk::LightProcessObject
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 *cmd) 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
 
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) const
 
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
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- 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 ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 TransformFileWriterTemplate ()
 
 ~TransformFileWriterTemplate () 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

void PushBackTransformList (const Object *transObj)
 
template<>
void ITKIOTransformBase_TEMPLATE_EXPORT PushBackTransformList (const Object *transObj)
 
template<>
void ITKIOTransformBase_TEMPLATE_EXPORT PushBackTransformList (const Object *transObj)
 

Private Attributes

bool m_AppendMode { false }
 
std::string m_FileName {}
 
TransformIOType::Pointer m_TransformIO {}
 
ConstTransformListType m_TransformList {}
 
bool m_UseCompression { false }
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TParametersValueType>
using itk::TransformFileWriterTemplate< TParametersValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 48 of file itkTransformFileWriter.h.

◆ ConstTransformListType

template<typename TParametersValueType>
using itk::TransformFileWriterTemplate< TParametersValueType >::ConstTransformListType = typename TransformIOType::ConstTransformListType

Definition at line 56 of file itkTransformFileWriter.h.

◆ ConstTransformPointer

template<typename TParametersValueType>
using itk::TransformFileWriterTemplate< TParametersValueType >::ConstTransformPointer = typename TransformIOType::ConstTransformPointer

Definition at line 55 of file itkTransformFileWriter.h.

◆ FixedParametersValueType

template<typename TParametersValueType>
using itk::TransformFileWriterTemplate< TParametersValueType >::FixedParametersValueType = double

Definition at line 51 of file itkTransformFileWriter.h.

◆ ParametersValueType

template<typename TParametersValueType>
using itk::TransformFileWriterTemplate< TParametersValueType >::ParametersValueType = TParametersValueType

Definition at line 50 of file itkTransformFileWriter.h.

◆ Pointer

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

Definition at line 47 of file itkTransformFileWriter.h.

◆ Self

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

SmartPointer type alias support

Definition at line 45 of file itkTransformFileWriter.h.

◆ Superclass

template<typename TParametersValueType>
using itk::TransformFileWriterTemplate< TParametersValueType >::Superclass = LightProcessObject

Definition at line 46 of file itkTransformFileWriter.h.

◆ TransformIOType

template<typename TParametersValueType>
using itk::TransformFileWriterTemplate< TParametersValueType >::TransformIOType = TransformIOBaseTemplate<ParametersValueType>

Definition at line 53 of file itkTransformFileWriter.h.

◆ TransformPointer

template<typename TParametersValueType>
using itk::TransformFileWriterTemplate< TParametersValueType >::TransformPointer = typename TransformIOType::TransformPointer

Definition at line 54 of file itkTransformFileWriter.h.

◆ TransformType

template<typename TParametersValueType>
using itk::TransformFileWriterTemplate< TParametersValueType >::TransformType = TransformBaseTemplate<ParametersValueType>

Definition at line 52 of file itkTransformFileWriter.h.

Constructor & Destructor Documentation

◆ TransformFileWriterTemplate()

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

◆ ~TransformFileWriterTemplate()

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

Member Function Documentation

◆ AddTransform()

template<typename TParametersValueType>
void itk::TransformFileWriterTemplate< TParametersValueType >::AddTransform ( const Object *  transform)

Add a transform to be written

◆ AppendModeOn()

template<typename TParametersValueType>
virtual void itk::TransformFileWriterTemplate< TParametersValueType >::AppendModeOn ( )
virtual

Set/Get the write mode (append/overwrite) for the filter.

◆ GetAppendMode()

template<typename TParametersValueType>
virtual bool itk::TransformFileWriterTemplate< TParametersValueType >::GetAppendMode ( ) const
virtual

Set/Get the write mode (append/overwrite) for the filter.

◆ GetFileName()

template<typename TParametersValueType>
virtual const char* itk::TransformFileWriterTemplate< TParametersValueType >::GetFileName ( ) const
virtual

Get the filename

◆ GetInput()

template<typename TParametersValueType>
const TransformType* itk::TransformFileWriterTemplate< TParametersValueType >::GetInput ( )

◆ GetNameOfClass()

template<typename TParametersValueType>
const char* itk::TransformFileWriterTemplate< TParametersValueType >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::LightProcessObject.

◆ GetTransformIO()

template<typename TParametersValueType>
virtual const TransformIOType* itk::TransformFileWriterTemplate< TParametersValueType >::GetTransformIO ( ) const
virtual

Set/Get the TransformIO class used internally to read to transform.

◆ GetUseCompression()

template<typename TParametersValueType>
virtual bool itk::TransformFileWriterTemplate< TParametersValueType >::GetUseCompression ( ) const
virtual

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

◆ New()

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

Method for creation through the object factory

Examples
SphinxExamples/src/IO/TransformBase/WriteTransformToFile/Code.cxx.

◆ PrintSelf()

template<typename TParametersValueType>
void itk::TransformFileWriterTemplate< 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.

◆ PushBackTransformList() [1/3]

template<typename TParametersValueType>
void itk::TransformFileWriterTemplate< TParametersValueType >::PushBackTransformList ( const Object *  transObj)
private

◆ PushBackTransformList() [2/3]

template<>
void ITKIOTransformBase_TEMPLATE_EXPORT itk::TransformFileWriterTemplate< double >::PushBackTransformList ( const Object *  transObj)
private

Declare specializations

◆ PushBackTransformList() [3/3]

template<>
void ITKIOTransformBase_TEMPLATE_EXPORT itk::TransformFileWriterTemplate< float >::PushBackTransformList ( const Object *  transObj)
private

Declare specializations

◆ SetAppendMode()

template<typename TParametersValueType>
virtual void itk::TransformFileWriterTemplate< TParametersValueType >::SetAppendMode ( bool  _arg)
virtual

Set/Get the write mode (append/overwrite) for the filter.

◆ SetFileName()

template<typename TParametersValueType>
virtual void itk::TransformFileWriterTemplate< TParametersValueType >::SetFileName ( const char *  _arg)
virtual

Set the filename

◆ SetInput()

template<typename TParametersValueType>
void itk::TransformFileWriterTemplate< TParametersValueType >::SetInput ( const Object *  transform)

Set/Get the input transform to write

◆ SetTransformIO()

template<typename TParametersValueType>
virtual void itk::TransformFileWriterTemplate< TParametersValueType >::SetTransformIO ( TransformIOType *  _arg)
virtual

Set/Get the TransformIO class used internally to read to transform.

◆ SetUseCompression()

template<typename TParametersValueType>
virtual void itk::TransformFileWriterTemplate< TParametersValueType >::SetUseCompression ( bool  _arg)
virtual

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

◆ Update()

template<typename TParametersValueType>
void itk::TransformFileWriterTemplate< TParametersValueType >::Update ( )

Write out the transform

◆ UseCompressionOn()

template<typename TParametersValueType>
virtual void itk::TransformFileWriterTemplate< TParametersValueType >::UseCompressionOn ( )
virtual

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

Member Data Documentation

◆ m_AppendMode

template<typename TParametersValueType>
bool itk::TransformFileWriterTemplate< TParametersValueType >::m_AppendMode { false }
private

Definition at line 128 of file itkTransformFileWriter.h.

◆ m_FileName

template<typename TParametersValueType>
std::string itk::TransformFileWriterTemplate< TParametersValueType >::m_FileName {}
private

Definition at line 126 of file itkTransformFileWriter.h.

◆ m_TransformIO

template<typename TParametersValueType>
TransformIOType::Pointer itk::TransformFileWriterTemplate< TParametersValueType >::m_TransformIO {}
private

Definition at line 131 of file itkTransformFileWriter.h.

◆ m_TransformList

template<typename TParametersValueType>
ConstTransformListType itk::TransformFileWriterTemplate< TParametersValueType >::m_TransformList {}
private

Definition at line 127 of file itkTransformFileWriter.h.

◆ m_UseCompression

template<typename TParametersValueType>
bool itk::TransformFileWriterTemplate< TParametersValueType >::m_UseCompression { false }
private

Should we compress the data?

Definition at line 130 of file itkTransformFileWriter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16