#include <itkTransformBase.h>

Detailed Description

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

This class is an abstract class to represent a spatial transform.

This class is templated over the scalar type used to store the transform's parameters.

Definition at line 68 of file itkTransformBase.h.

Inheritance diagram for itk::TransformBaseTemplate< TParametersValueType >:

Collaboration diagram for itk::TransformBaseTemplate< TParametersValueType >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	FixedParametersType = OptimizerParameters< FixedParametersValueType >

using	FixedParametersValueType = double

using	NumberOfParametersType = IdentifierType

using	ParametersType = OptimizerParameters< ParametersValueType >

using	ParametersValueType = TParametersValueType

using	Pointer = SmartPointer< Self >

using	Self = TransformBaseTemplate

using	Superclass = Object

using	TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory

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
virtual void	CopyInFixedParameters (const FixedParametersValueType const begin, const FixedParametersValueType const end)=0

virtual void	CopyInParameters (const ParametersValueType const begin, const ParametersValueType const end)=0

virtual const FixedParametersType &	GetFixedParameters () const =0

virtual unsigned int	GetInputSpaceDimension () const =0

virtual const std::string &	GetInputSpaceName () const

const char *	GetNameOfClass () const override

virtual NumberOfParametersType	GetNumberOfParameters () const =0

virtual unsigned int	GetOutputSpaceDimension () const =0

virtual const std::string &	GetOutputSpaceName () const

virtual const ParametersType &	GetParameters () const =0

virtual TransformCategoryEnum	GetTransformCategory () const =0

virtual std::string	GetTransformTypeAsString () const =0

virtual void	SetFixedParameters (const FixedParametersType &)=0

virtual void	SetInputSpaceName (std::string _arg)

virtual void	SetOutputSpaceName (std::string _arg)

virtual void	SetParameters (const ParametersType &)=0

virtual void	SetParametersByValue (const ParametersType &p)=0

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

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

Protected Member Functions
	TransformBaseTemplate ()=default

	~TransformBaseTemplate () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

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 Attributes
std::string	m_InputSpaceName {}

std::string	m_OutputSpaceName {}

Additional Inherited Members
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 Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TParametersValueType>

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

Definition at line 77 of file itkTransformBase.h.

◆ FixedParametersType

template<typename TParametersValueType>

using itk::TransformBaseTemplate< TParametersValueType >::FixedParametersType = OptimizerParameters<FixedParametersValueType>

Definition at line 84 of file itkTransformBase.h.

◆ FixedParametersValueType

template<typename TParametersValueType>

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

Definition at line 83 of file itkTransformBase.h.

◆ NumberOfParametersType

template<typename TParametersValueType>

using itk::TransformBaseTemplate< TParametersValueType >::NumberOfParametersType = IdentifierType

The number of parameters can potentially be very large, therefore we use here a large capacity integer.

Definition at line 91 of file itkTransformBase.h.

◆ ParametersType

template<typename TParametersValueType>

using itk::TransformBaseTemplate< TParametersValueType >::ParametersType = OptimizerParameters<ParametersValueType>

Definition at line 82 of file itkTransformBase.h.

◆ ParametersValueType

template<typename TParametersValueType>

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

Type of the input parameters.

Definition at line 81 of file itkTransformBase.h.

◆ Pointer

template<typename TParametersValueType>

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

Definition at line 76 of file itkTransformBase.h.

◆ Self

template<typename TParametersValueType>

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

Standard class type aliases.

Definition at line 74 of file itkTransformBase.h.

◆ Superclass

template<typename TParametersValueType>

using itk::TransformBaseTemplate< TParametersValueType >::Superclass = Object

Definition at line 75 of file itkTransformBase.h.

◆ TransformCategoryEnum

template<typename TParametersValueType>

using itk::TransformBaseTemplate< TParametersValueType >::TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory

Definition at line 162 of file itkTransformBase.h.

Constructor & Destructor Documentation

◆ TransformBaseTemplate()

template<typename TParametersValueType>

itk::TransformBaseTemplate< TParametersValueType >::TransformBaseTemplate ( )

protecteddefault

◆ ~TransformBaseTemplate()

template<typename TParametersValueType>

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

overrideprotecteddefault

Member Function Documentation

◆ CopyInFixedParameters()

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::CopyInFixedParameters	(	const FixedParametersValueType *const	begin,
		const FixedParametersValueType *const	end
	)

pure virtual

This function allow copying a range of values into the FixedParameters The range of values must conform to std::copy(begin, end, m_FixedParameters) requirements.

Implemented in itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, VDimension, VSubDimensions >, and itk::Transform< TParametersValueType, VDimension, VDimension >.

◆ CopyInParameters()

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::CopyInParameters	(	const ParametersValueType *const	begin,
		const ParametersValueType *const	end
	)

pure virtual

This function allow copying a range of values into the Parameters The range of values must conform to std::copy(begin, end, m_Parameters) requirements.

Implemented in itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, VDimension, VSubDimensions >, and itk::Transform< TParametersValueType, VDimension, VDimension >.

◆ GetFixedParameters()

template<typename TParametersValueType>

virtual const FixedParametersType& itk::TransformBaseTemplate< TParametersValueType >::GetFixedParameters ( ) const

pure virtual

Get the fixed parameters.

◆ GetInputSpaceDimension()

template<typename TParametersValueType>

virtual unsigned int itk::TransformBaseTemplate< TParametersValueType >::GetInputSpaceDimension ( ) const

pure virtual

Get the size of the input space

Implemented in itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, VDimension, VSubDimensions >, and itk::Transform< TParametersValueType, VDimension, VDimension >.

◆ GetInputSpaceName()

template<typename TParametersValueType>

virtual const std::string& itk::TransformBaseTemplate< TParametersValueType >::GetInputSpaceName ( ) const

virtual

◆ GetNameOfClass()

template<typename TParametersValueType>

const char* itk::TransformBaseTemplate< TParametersValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetNumberOfParameters()

template<typename TParametersValueType>

virtual NumberOfParametersType itk::TransformBaseTemplate< TParametersValueType >::GetNumberOfParameters ( ) const

pure virtual

Return the number of parameters that completely define the Transform

◆ GetOutputSpaceDimension()

template<typename TParametersValueType>

virtual unsigned int itk::TransformBaseTemplate< TParametersValueType >::GetOutputSpaceDimension ( ) const

pure virtual

Get the size of the output space

Implemented in itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, VDimension, VSubDimensions >, and itk::Transform< TParametersValueType, VDimension, VDimension >.

◆ GetOutputSpaceName()

template<typename TParametersValueType>

virtual const std::string& itk::TransformBaseTemplate< TParametersValueType >::GetOutputSpaceName ( ) const

virtual

◆ GetParameters()

template<typename TParametersValueType>

virtual const ParametersType& itk::TransformBaseTemplate< TParametersValueType >::GetParameters ( ) const

pure virtual

Get the Transformation Parameters.

◆ GetTransformCategory()

template<typename TParametersValueType>

virtual TransformCategoryEnum itk::TransformBaseTemplate< TParametersValueType >::GetTransformCategory ( ) const

pure virtual

Get transform category

◆ GetTransformTypeAsString()

template<typename TParametersValueType>

virtual std::string itk::TransformBaseTemplate< TParametersValueType >::GetTransformTypeAsString ( ) const

pure virtual

Generate a platform independent name

Implemented in itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, VDimension, VSubDimensions >, itk::Transform< TParametersValueType, VDimension, VDimension >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetFixedParameters()

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::SetFixedParameters ( const FixedParametersType & )

pure virtual

Set the fixed parameters.

◆ SetInputSpaceName()

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::SetInputSpaceName ( std::string _arg )

virtual

◆ SetOutputSpaceName()

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::SetOutputSpaceName ( std::string _arg )

virtual

For storing the name of InputSpace/OutputSpace.

InputSpaceName, OutputSpaceName provide identifiers for the world spaces that the transform applied to and the direction of the spatial transformation. The direction of the transform goes from the input space to output space. Typical values include the names of an atlas or a dataset.

◆ SetParameters()

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::SetParameters ( const ParametersType & )

pure virtual

Set the transformation parameters and update internal transformation.

◆ SetParametersByValue()

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::SetParametersByValue ( const ParametersType & p )

pure virtual

Set the transformation by copying parameters and update internal transformation. This method forces the transform to copy the parameters. The default implementation is to call SetParameters. This call must be overridden if the transform normally implements SetParameters by keeping a reference to the parameters.

See also: SetParameters

Implemented in itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

Member Data Documentation

◆ m_InputSpaceName

template<typename TParametersValueType>

std::string itk::TransformBaseTemplate< TParametersValueType >::m_InputSpaceName {}

private

Definition at line 186 of file itkTransformBase.h.

◆ m_OutputSpaceName

template<typename TParametersValueType>

std::string itk::TransformBaseTemplate< TParametersValueType >::m_OutputSpaceName {}

private

Definition at line 187 of file itkTransformBase.h.

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

itkTransformBase.h

Detailed Description

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

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ FixedParametersType

◆ FixedParametersValueType

◆ NumberOfParametersType

◆ ParametersType

◆ ParametersValueType

◆ Pointer

◆ Self

◆ Superclass

◆ TransformCategoryEnum

Constructor & Destructor Documentation

◆ TransformBaseTemplate()

◆ ~TransformBaseTemplate()

Member Function Documentation

◆ CopyInFixedParameters()

◆ CopyInParameters()

◆ GetFixedParameters()

◆ GetInputSpaceDimension()

◆ GetInputSpaceName()

◆ GetNameOfClass()

◆ GetNumberOfParameters()

◆ GetOutputSpaceDimension()

◆ GetOutputSpaceName()

◆ GetParameters()

◆ GetTransformCategory()

◆ GetTransformTypeAsString()

◆ SetFixedParameters()

◆ SetInputSpaceName()

◆ SetOutputSpaceName()

◆ SetParameters()

◆ SetParametersByValue()

Member Data Documentation

◆ m_InputSpaceName

◆ m_OutputSpaceName

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