itk::TransformFileWriterTemplate< TParametersValueType > Class Template Reference

#include <itkTransformFileWriter.h>

Inheritance diagram for itk::TransformFileWriterTemplate< TParametersValueType >:

Collaboration diagram for itk::TransformFileWriterTemplate< TParametersValueType >:

Detailed Description

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

TODO.

Wiki Examples:

• All Examples
• Write a transform to a file

Examples:

Examples/IO/TransformReadWrite.cxx.

Definition at line 39 of file itkTransformFileWriter.h.

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 ::itk::LightObject::Pointer	CreateAnother () const
bool	GetAppendMode ()
virtual const char *	GetFileName () const
const TransformType *	GetInput ()
virtual const char *	GetNameOfClass () const
void	SetAppendMode (bool mode)
void	SetAppendOff ()
void	SetAppendOn ()
virtual void	SetFileName (const char *_arg)
void	SetInput (const Object *transform)
void	Update ()
virtual void	SetUseCompression (bool _arg)
virtual bool	GetUseCompression () const
virtual void	UseCompressionOn ()
virtual void	UseCompressionOff ()
virtual void	SetTransformIO (TransformIOType *_arg)
virtual const TransformIOType *	GetTransformIO () const
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
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 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 flag)
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 &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 ()

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
std::string	m_FileName
TransformIOType::Pointer	m_TransformIO
ConstTransformListType	m_TransformList
bool	m_UseCompression

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

Member Typedef Documentation

template<typename TParametersValueType>

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

Definition at line 48 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

Definition at line 56 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

Definition at line 55 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

Definition at line 51 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

Definition at line 50 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

Definition at line 47 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

SmartPointer type alias support

Definition at line 45 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

Definition at line 46 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

Definition at line 53 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

Definition at line 54 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

Definition at line 52 of file itkTransformFileWriter.h.

Constructor & Destructor Documentation

template<typename TParametersValueType>

itk::TransformFileWriterTemplate< TParametersValueType >::TransformFileWriterTemplate ( )

protected

template<typename TParametersValueType>

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

overrideprotected

Member Function Documentation

template<typename TParametersValueType>

void itk::TransformFileWriterTemplate< TParametersValueType >::AddTransform

(

const Object *

transform

)

Add a transform to be written

template<typename TParametersValueType>

virtual::itk::LightObject::Pointer itk::TransformFileWriterTemplate< TParametersValueType >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightProcessObject.

template<typename TParametersValueType>

bool itk::TransformFileWriterTemplate< TParametersValueType >::GetAppendMode

(

)

template<typename TParametersValueType>

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

virtual

Get the filename

template<typename TParametersValueType>

const TransformType* itk::TransformFileWriterTemplate< TParametersValueType >::GetInput

(

)

template<typename TParametersValueType>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

template<typename TParametersValueType>

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

virtual

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

template<typename TParametersValueType>

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

virtual

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

template<typename TParametersValueType>

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

static

Method for creation through the object factory

Examples:

WikiExamples/IO/TransformFileWriter.cxx.

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.

template<typename TParametersValueType>

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

private

template<>

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

private

Declare specializations

template<>

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

private

Declare specializations

template<typename TParametersValueType>

void itk::TransformFileWriterTemplate< TParametersValueType >::SetAppendMode

(

bool

mode

)

template<typename TParametersValueType>

void itk::TransformFileWriterTemplate< TParametersValueType >::SetAppendOff

(

)

Set/Get the write mode (append/overwrite) for the Filter

template<typename TParametersValueType>

void itk::TransformFileWriterTemplate< TParametersValueType >::SetAppendOn

(

)

template<typename TParametersValueType>

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

virtual

Set the filename

template<typename TParametersValueType>

void itk::TransformFileWriterTemplate< TParametersValueType >::SetInput

(

const Object *

transform

)

Set/Get the input transform to write

template<typename TParametersValueType>

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

virtual

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

template<typename TParametersValueType>

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

virtual

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

template<typename TParametersValueType>

void itk::TransformFileWriterTemplate< TParametersValueType >::Update

(

)

Write out the transform

template<typename TParametersValueType>

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

virtual

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

template<typename TParametersValueType>

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

virtual

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

Member Data Documentation

template<typename TParametersValueType>

bool itk::TransformFileWriterTemplate< TParametersValueType >::m_AppendMode

private

Definition at line 112 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

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

private

Definition at line 110 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

TransformIOType::Pointer itk::TransformFileWriterTemplate< TParametersValueType >::m_TransformIO

private

Definition at line 115 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

ConstTransformListType itk::TransformFileWriterTemplate< TParametersValueType >::m_TransformList

private

Definition at line 111 of file itkTransformFileWriter.h.

template<typename TParametersValueType>

bool itk::TransformFileWriterTemplate< TParametersValueType >::m_UseCompression

private

Should we compress the data?

Definition at line 114 of file itkTransformFileWriter.h.

---

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

• itkTransformFileWriter.h