TransformBaseTemplate Class Reference

#include <itkTransformBase.h>

Detailed Description

/**

Inheritance diagram for TransformBaseTemplate:

Collaboration diagram for TransformBaseTemplate:

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
using	TransformCategoryType = TransformCategoryEnum

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 NumberOfParametersType	GetNumberOfParameters () const =0
virtual unsigned int	GetOutputSpaceDimension () const =0
virtual const ParametersType &	GetParameters () const =0
virtual TransformCategoryEnum	GetTransformCategory () const =0
virtual std::string	GetTransformTypeAsString () const =0
	ITK_DISALLOW_COPY_AND_MOVE (TransformBaseTemplate)
	itkGetConstReferenceMacro (InputSpaceName, std::string)
	itkGetConstReferenceMacro (OutputSpaceName, std::string)
	itkOverrideGetNameOfClassMacro (TransformBaseTemplate)
	itkSetMacro (InputSpaceName, std::string)
	itkSetMacro (OutputSpaceName, std::string)
virtual void	SetFixedParameters (const FixedParametersType &)=0
virtual void	SetParameters (const ParametersType &)=0
virtual void	SetParametersByValue (const ParametersType &p)=0

Static Public Attributes
static constexpr TransformCategoryEnum	BSpline = TransformCategoryEnum::BSpline
static constexpr TransformCategoryEnum	DisplacementField = TransformCategoryEnum::DisplacementField
static constexpr TransformCategoryEnum	Linear = TransformCategoryEnum::Linear
static constexpr TransformCategoryEnum	Spline = TransformCategoryEnum::Spline
static constexpr TransformCategoryEnum	UnknownTransformCategory = TransformCategoryEnum::UnknownTransformCategory
static constexpr TransformCategoryEnum	VelocityField = TransformCategoryEnum::VelocityField

Protected Member Functions
	TransformBaseTemplate ()=default
	~TransformBaseTemplate () override=default

Private Attributes
std::string	m_InputSpaceName {}
std::string	m_OutputSpaceName {}

Member Typedef Documentation

ConstPointer

using TransformBaseTemplate::ConstPointer = SmartPointer<const Self>

Definition at line 95 of file itkTransformBase.h.

FixedParametersType

using TransformBaseTemplate::FixedParametersType = OptimizerParameters<FixedParametersValueType>

Definition at line 102 of file itkTransformBase.h.

FixedParametersValueType

using TransformBaseTemplate::FixedParametersValueType = double

Definition at line 101 of file itkTransformBase.h.

NumberOfParametersType

using TransformBaseTemplate::NumberOfParametersType = IdentifierType

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

Definition at line 109 of file itkTransformBase.h.

ParametersType

using TransformBaseTemplate::ParametersType = OptimizerParameters<ParametersValueType>

Definition at line 100 of file itkTransformBase.h.

ParametersValueType

using TransformBaseTemplate::ParametersValueType = TParametersValueType

Type of the input parameters.

Definition at line 99 of file itkTransformBase.h.

Pointer

using TransformBaseTemplate::Pointer = SmartPointer<Self>

Definition at line 94 of file itkTransformBase.h.

Self

using TransformBaseTemplate::Self = TransformBaseTemplate

Standard class type aliases.

Definition at line 92 of file itkTransformBase.h.

Superclass

using TransformBaseTemplate::Superclass = Object

Definition at line 93 of file itkTransformBase.h.

TransformCategoryEnum

using TransformBaseTemplate::TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory

Definition at line 180 of file itkTransformBase.h.

TransformCategoryType

using TransformBaseTemplate::TransformCategoryType = TransformCategoryEnum

Definition at line 192 of file itkTransformBase.h.

Constructor & Destructor Documentation

TransformBaseTemplate()

TransformBaseTemplate::TransformBaseTemplate ( )

protecteddefault

~TransformBaseTemplate()

TransformBaseTemplate::~TransformBaseTemplate ( )

overrideprotecteddefault

Member Function Documentation

CopyInFixedParameters()

virtual void TransformBaseTemplate::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.

CopyInParameters()

virtual void TransformBaseTemplate::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.

GetFixedParameters()

virtual const FixedParametersType& TransformBaseTemplate::GetFixedParameters ( ) const

pure virtual

Get the fixed parameters.

GetInputSpaceDimension()

virtual unsigned int TransformBaseTemplate::GetInputSpaceDimension ( ) const

pure virtual

Get the size of the input space

GetNumberOfParameters()

virtual NumberOfParametersType TransformBaseTemplate::GetNumberOfParameters ( ) const

pure virtual

Return the number of parameters that completely define the Transform

GetOutputSpaceDimension()

virtual unsigned int TransformBaseTemplate::GetOutputSpaceDimension ( ) const

pure virtual

Get the size of the output space

GetParameters()

virtual const ParametersType& TransformBaseTemplate::GetParameters ( ) const

pure virtual

Get the Transformation Parameters.

GetTransformCategory()

virtual TransformCategoryEnum TransformBaseTemplate::GetTransformCategory ( ) const

pure virtual

Get transform category

GetTransformTypeAsString()

virtual std::string TransformBaseTemplate::GetTransformTypeAsString ( ) const

pure virtual

Generate a platform independent name

ITK_DISALLOW_COPY_AND_MOVE()

TransformBaseTemplate::ITK_DISALLOW_COPY_AND_MOVE

(

TransformBaseTemplate

)

itkGetConstReferenceMacro() [1/2]

TransformBaseTemplate::itkGetConstReferenceMacro	(	InputSpaceName	,
		std::string
	)

itkGetConstReferenceMacro() [2/2]

TransformBaseTemplate::itkGetConstReferenceMacro	(	OutputSpaceName	,
		std::string
	)

itkOverrideGetNameOfClassMacro()

TransformBaseTemplate::itkOverrideGetNameOfClassMacro

(

TransformBaseTemplate

)

See also

LightObject::GetNameOfClass()

itkSetMacro() [1/2]

TransformBaseTemplate::itkSetMacro	(	InputSpaceName	,
		std::string
	)

itkSetMacro() [2/2]

TransformBaseTemplate::itkSetMacro	(	OutputSpaceName	,
		std::string
	)

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.

SetFixedParameters()

virtual void TransformBaseTemplate::SetFixedParameters ( const FixedParametersType &  )

pure virtual

Set the fixed parameters.

SetParameters()

virtual void TransformBaseTemplate::SetParameters ( const ParametersType &  )

pure virtual

Set the transformation parameters and update internal transformation.

SetParametersByValue()

virtual void TransformBaseTemplate::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

Member Data Documentation

BSpline

constexpr TransformCategoryEnum TransformBaseTemplate::BSpline = TransformCategoryEnum::BSpline

staticconstexpr

Definition at line 186 of file itkTransformBase.h.

DisplacementField

constexpr TransformCategoryEnum TransformBaseTemplate::DisplacementField = TransformCategoryEnum::DisplacementField

staticconstexpr

Definition at line 188 of file itkTransformBase.h.

Linear

constexpr TransformCategoryEnum TransformBaseTemplate::Linear = TransformCategoryEnum::Linear

staticconstexpr

Definition at line 185 of file itkTransformBase.h.

m_InputSpaceName

std::string TransformBaseTemplate::m_InputSpaceName {}

private

Definition at line 204 of file itkTransformBase.h.

m_OutputSpaceName

std::string TransformBaseTemplate::m_OutputSpaceName {}

private

Definition at line 205 of file itkTransformBase.h.

Spline

constexpr TransformCategoryEnum TransformBaseTemplate::Spline = TransformCategoryEnum::Spline

staticconstexpr

Definition at line 187 of file itkTransformBase.h.

UnknownTransformCategory

constexpr TransformCategoryEnum TransformBaseTemplate::UnknownTransformCategory = TransformCategoryEnum::UnknownTransformCategory

staticconstexpr

Definition at line 184 of file itkTransformBase.h.

VelocityField

constexpr TransformCategoryEnum TransformBaseTemplate::VelocityField = TransformCategoryEnum::VelocityField

staticconstexpr

Definition at line 189 of file itkTransformBase.h.

---

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

• itkTransformBase.h