ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
TransformBaseTemplate< TParametersValueType > Class Template Referenceabstract
Group Core » Module ITKTransform

#include <itkTransformBase.h>

Detailed Description

template<typename TParametersValueType>
class TransformBaseTemplate< TParametersValueType >

/**

+ Inheritance diagram for TransformBaseTemplate< TParametersValueType >:
+ Collaboration diagram for 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
 
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

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

Definition at line 95 of file itkTransformBase.h.

◆ FixedParametersType

template<typename TParametersValueType >
using TransformBaseTemplate< TParametersValueType >::FixedParametersType = OptimizerParameters<FixedParametersValueType>

Definition at line 102 of file itkTransformBase.h.

◆ FixedParametersValueType

template<typename TParametersValueType >
using TransformBaseTemplate< TParametersValueType >::FixedParametersValueType = double

Definition at line 101 of file itkTransformBase.h.

◆ NumberOfParametersType

template<typename TParametersValueType >
using TransformBaseTemplate< TParametersValueType >::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

template<typename TParametersValueType >
using TransformBaseTemplate< TParametersValueType >::ParametersType = OptimizerParameters<ParametersValueType>

Definition at line 100 of file itkTransformBase.h.

◆ ParametersValueType

template<typename TParametersValueType >
using TransformBaseTemplate< TParametersValueType >::ParametersValueType = TParametersValueType

Type of the input parameters.

Definition at line 99 of file itkTransformBase.h.

◆ Pointer

template<typename TParametersValueType >
using TransformBaseTemplate< TParametersValueType >::Pointer = SmartPointer<Self>

Definition at line 94 of file itkTransformBase.h.

◆ Self

template<typename TParametersValueType >
using TransformBaseTemplate< TParametersValueType >::Self = TransformBaseTemplate

Standard class type aliases.

Definition at line 92 of file itkTransformBase.h.

◆ Superclass

template<typename TParametersValueType >
using TransformBaseTemplate< TParametersValueType >::Superclass = Object

Definition at line 93 of file itkTransformBase.h.

◆ TransformCategoryEnum

template<typename TParametersValueType >
using TransformBaseTemplate< TParametersValueType >::TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory

Definition at line 180 of file itkTransformBase.h.

◆ TransformCategoryType

template<typename TParametersValueType >
using TransformBaseTemplate< TParametersValueType >::TransformCategoryType = TransformCategoryEnum

Definition at line 192 of file itkTransformBase.h.

Constructor & Destructor Documentation

◆ TransformBaseTemplate()

template<typename TParametersValueType >
TransformBaseTemplate< TParametersValueType >::TransformBaseTemplate ( )
protecteddefault

◆ ~TransformBaseTemplate()

template<typename TParametersValueType >
TransformBaseTemplate< TParametersValueType >::~TransformBaseTemplate ( )
overrideprotecteddefault

Member Function Documentation

◆ CopyInFixedParameters()

template<typename TParametersValueType >
virtual void 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< double, VInputDimension, VOutputDimension >, itk::Transform< double, 3, 3 >, itk::Transform< double, VDimension, VDimension >, itk::Transform< double, VDimension, VSubDimensions >, itk::Transform< TParametersValueType, VDimension, VDimension >, itk::Transform< TParametersValueType, 3, 3 >, itk::Transform< double, 3, 2 >, and itk::Transform< float, VInputDimension, VOutputDimension >.

◆ CopyInParameters()

template<typename TParametersValueType >
virtual void 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< double, VInputDimension, VOutputDimension >, itk::Transform< double, 3, 3 >, itk::Transform< double, VDimension, VDimension >, itk::Transform< double, VDimension, VSubDimensions >, itk::Transform< TParametersValueType, VDimension, VDimension >, itk::Transform< TParametersValueType, 3, 3 >, itk::Transform< double, 3, 2 >, and itk::Transform< float, VInputDimension, VOutputDimension >.

◆ GetFixedParameters()

template<typename TParametersValueType >
virtual const FixedParametersType & TransformBaseTemplate< TParametersValueType >::GetFixedParameters ( ) const
pure virtual

Get the fixed parameters.

Implemented in itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >, itk::BSplineBaseTransform< double, 3, 3 >, itk::CenteredRigid2DTransform< TParametersValueType >, itk::CenteredSimilarity2DTransform< TParametersValueType >, itk::CompositeTransform< TParametersValueType, VDimension >, itk::Euler3DTransform< TParametersValueType >, itk::Euler3DTransform< double >, itk::IdentityTransform< TParametersValueType, VDimension >, itk::KernelTransform< TParametersValueType, VDimension >, itk::KernelTransform< double, 3 >, itk::KernelTransform< TParametersValueType, 3 >, itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >, itk::MatrixOffsetTransformBase< double, 3, 3 >, itk::MatrixOffsetTransformBase< double, VDimension, VDimension >, itk::MatrixOffsetTransformBase< double, 2, 2 >, itk::MatrixOffsetTransformBase< float, VDimension, VDimension >, itk::MatrixOffsetTransformBase< float, 3, 3 >, itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >, itk::MultiTransform< double, 3, 3 >, itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< double, VInputDimension, VOutputDimension >, itk::Transform< double, 3, 3 >, itk::Transform< double, VDimension, VDimension >, itk::Transform< double, VDimension, VSubDimensions >, itk::Transform< TParametersValueType, VDimension, VDimension >, itk::Transform< TParametersValueType, 3, 3 >, itk::Transform< double, 3, 2 >, itk::Transform< float, VInputDimension, VOutputDimension >, and itk::TranslationTransform< TParametersValueType, VDimension >.

◆ GetInputSpaceDimension()

template<typename TParametersValueType >
virtual unsigned int TransformBaseTemplate< TParametersValueType >::GetInputSpaceDimension ( ) const
pure virtual

Get the size of the input space

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

◆ GetNumberOfParameters()

template<typename TParametersValueType >
virtual NumberOfParametersType TransformBaseTemplate< TParametersValueType >::GetNumberOfParameters ( ) const
pure virtual

Return the number of parameters that completely define the Transform

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >, itk::CompositeTransform< TParametersValueType, VDimension >, itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >, itk::MultiTransform< double, 3, 3 >, itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< double, VInputDimension, VOutputDimension >, itk::Transform< double, 3, 3 >, itk::Transform< double, VDimension, VDimension >, itk::Transform< double, VDimension, VSubDimensions >, itk::Transform< TParametersValueType, VDimension, VDimension >, itk::Transform< TParametersValueType, 3, 3 >, itk::Transform< double, 3, 2 >, itk::Transform< float, VInputDimension, VOutputDimension >, itk::TranslationTransform< TParametersValueType, VDimension >, itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineBaseTransform< double, 3, 3 >.

◆ GetOutputSpaceDimension()

template<typename TParametersValueType >
virtual unsigned int TransformBaseTemplate< TParametersValueType >::GetOutputSpaceDimension ( ) const
pure virtual

Get the size of the output space

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

◆ GetParameters()

template<typename TParametersValueType >
virtual const ParametersType & TransformBaseTemplate< TParametersValueType >::GetParameters ( ) const
pure virtual

Get the Transformation Parameters.

Implemented in itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >, itk::BSplineBaseTransform< double, 3, 3 >, itk::CenteredAffineTransform< TParametersValueType, VDimension >, itk::CenteredEuler3DTransform< TParametersValueType >, itk::CenteredRigid2DTransform< TParametersValueType >, itk::CenteredSimilarity2DTransform< TParametersValueType >, itk::ComposeScaleSkewVersor3DTransform< TParametersValueType >, itk::CompositeTransform< TParametersValueType, VDimension >, itk::Euler3DTransform< TParametersValueType >, itk::Euler3DTransform< double >, itk::IdentityTransform< TParametersValueType, VDimension >, itk::KernelTransform< TParametersValueType, VDimension >, itk::KernelTransform< double, 3 >, itk::KernelTransform< TParametersValueType, 3 >, itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >, itk::MatrixOffsetTransformBase< double, 3, 3 >, itk::MatrixOffsetTransformBase< double, VDimension, VDimension >, itk::MatrixOffsetTransformBase< double, 2, 2 >, itk::MatrixOffsetTransformBase< float, VDimension, VDimension >, itk::MatrixOffsetTransformBase< float, 3, 3 >, itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >, itk::MultiTransform< double, 3, 3 >, itk::QuaternionRigidTransform< TParametersValueType >, itk::Rigid2DTransform< TParametersValueType >, itk::Rigid2DTransform< double >, itk::Rigid3DPerspectiveTransform< TParametersValueType >, itk::ScaleLogarithmicTransform< TParametersValueType, VDimension >, itk::ScaleSkewVersor3DTransform< TParametersValueType >, itk::ScaleTransform< TParametersValueType, VDimension >, itk::ScaleTransform< float, 3 >, itk::ScaleVersor3DTransform< TParametersValueType >, itk::Similarity2DTransform< TParametersValueType >, itk::Similarity2DTransform< double >, itk::Similarity3DTransform< TParametersValueType >, itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< double, VInputDimension, VOutputDimension >, itk::Transform< double, 3, 3 >, itk::Transform< double, VDimension, VDimension >, itk::Transform< double, VDimension, VSubDimensions >, itk::Transform< TParametersValueType, VDimension, VDimension >, itk::Transform< TParametersValueType, 3, 3 >, itk::Transform< double, 3, 2 >, itk::Transform< float, VInputDimension, VOutputDimension >, itk::TranslationTransform< TParametersValueType, VDimension >, itk::VersorRigid3DTransform< TParametersValueType >, itk::VersorRigid3DTransform< double >, itk::VersorTransform< TParametersValueType >, and itk::VersorTransform< double >.

◆ GetTransformCategory()

template<typename TParametersValueType >
virtual TransformCategoryEnum TransformBaseTemplate< TParametersValueType >::GetTransformCategory ( ) const
pure virtual

Get transform category

Implemented in itk::AzimuthElevationToCartesianTransform< TParametersValueType, VDimension >, itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >, itk::BSplineBaseTransform< double, 3, 3 >, itk::CompositeTransform< TParametersValueType, VDimension >, itk::IdentityTransform< TParametersValueType, VDimension >, itk::KernelTransform< TParametersValueType, VDimension >, itk::KernelTransform< double, 3 >, itk::KernelTransform< TParametersValueType, 3 >, itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >, itk::MatrixOffsetTransformBase< double, 3, 3 >, itk::MatrixOffsetTransformBase< double, VDimension, VDimension >, itk::MatrixOffsetTransformBase< double, 2, 2 >, itk::MatrixOffsetTransformBase< float, VDimension, VDimension >, itk::MatrixOffsetTransformBase< float, 3, 3 >, itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >, itk::MultiTransform< double, 3, 3 >, itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< double, VInputDimension, VOutputDimension >, itk::Transform< double, 3, 3 >, itk::Transform< double, VDimension, VDimension >, itk::Transform< double, VDimension, VSubDimensions >, itk::Transform< TParametersValueType, VDimension, VDimension >, itk::Transform< TParametersValueType, 3, 3 >, itk::Transform< double, 3, 2 >, itk::Transform< float, VInputDimension, VOutputDimension >, itk::TranslationTransform< TParametersValueType, VDimension >, and itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

◆ GetTransformTypeAsString()

template<typename TParametersValueType >
virtual std::string TransformBaseTemplate< TParametersValueType >::GetTransformTypeAsString ( ) const
pure virtual

Generate a platform independent name

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

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<typename TParametersValueType >
TransformBaseTemplate< TParametersValueType >::ITK_DISALLOW_COPY_AND_MOVE ( TransformBaseTemplate< TParametersValueType >  )

◆ itkGetConstReferenceMacro() [1/2]

template<typename TParametersValueType >
TransformBaseTemplate< TParametersValueType >::itkGetConstReferenceMacro ( InputSpaceName  ,
std::string   
)

◆ itkGetConstReferenceMacro() [2/2]

template<typename TParametersValueType >
TransformBaseTemplate< TParametersValueType >::itkGetConstReferenceMacro ( OutputSpaceName  ,
std::string   
)

◆ itkOverrideGetNameOfClassMacro()

template<typename TParametersValueType >
TransformBaseTemplate< TParametersValueType >::itkOverrideGetNameOfClassMacro ( TransformBaseTemplate< TParametersValueType >  )
See also
LightObject::GetNameOfClass()

◆ itkSetMacro() [1/2]

template<typename TParametersValueType >
TransformBaseTemplate< TParametersValueType >::itkSetMacro ( InputSpaceName  ,
std::string   
)

◆ itkSetMacro() [2/2]

template<typename TParametersValueType >
TransformBaseTemplate< TParametersValueType >::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()

template<typename TParametersValueType >
virtual void TransformBaseTemplate< TParametersValueType >::SetFixedParameters ( const FixedParametersType &  )
pure virtual

Set the fixed parameters.

Implemented in itk::IdentityTransform< TParametersValueType, VDimension >, itk::KernelTransform< TParametersValueType, VDimension >, itk::KernelTransform< TParametersValueType, 3 >, itk::ConstantVelocityFieldTransform< TParametersValueType, VDimension >, itk::DisplacementFieldTransform< TParametersValueType, VDimension >, itk::VelocityFieldTransform< TParametersValueType, VDimension >, itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< TParametersValueType, VDimension, VDimension >, and itk::Transform< TParametersValueType, 3, 3 >.

◆ SetParameters()

template<typename TParametersValueType >
virtual void TransformBaseTemplate< TParametersValueType >::SetParameters ( const ParametersType &  )
pure virtual

Set the transformation parameters and update internal transformation.

Implemented in itk::IdentityTransform< TParametersValueType, VDimension >, itk::KernelTransform< TParametersValueType, VDimension >, itk::KernelTransform< TParametersValueType, 3 >, itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< TParametersValueType, VDimension, VDimension >, itk::Transform< TParametersValueType, 3, 3 >, and itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

◆ SetParametersByValue()

template<typename TParametersValueType >
virtual void 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::Transform< TParametersValueType, VInputDimension, VOutputDimension >, itk::Transform< TParametersValueType, VDimension, VDimension >, and itk::Transform< TParametersValueType, 3, 3 >.

Member Data Documentation

◆ BSpline

template<typename TParametersValueType >
constexpr TransformCategoryEnum TransformBaseTemplate< TParametersValueType >::BSpline = TransformCategoryEnum::BSpline
staticconstexpr

Definition at line 186 of file itkTransformBase.h.

◆ DisplacementField

template<typename TParametersValueType >
constexpr TransformCategoryEnum TransformBaseTemplate< TParametersValueType >::DisplacementField = TransformCategoryEnum::DisplacementField
staticconstexpr

Definition at line 188 of file itkTransformBase.h.

◆ Linear

template<typename TParametersValueType >
constexpr TransformCategoryEnum TransformBaseTemplate< TParametersValueType >::Linear = TransformCategoryEnum::Linear
staticconstexpr

Definition at line 185 of file itkTransformBase.h.

◆ m_InputSpaceName

template<typename TParametersValueType >
std::string TransformBaseTemplate< TParametersValueType >::m_InputSpaceName {}
private

Definition at line 204 of file itkTransformBase.h.

◆ m_OutputSpaceName

template<typename TParametersValueType >
std::string TransformBaseTemplate< TParametersValueType >::m_OutputSpaceName {}
private

Definition at line 205 of file itkTransformBase.h.

◆ Spline

template<typename TParametersValueType >
constexpr TransformCategoryEnum TransformBaseTemplate< TParametersValueType >::Spline = TransformCategoryEnum::Spline
staticconstexpr

Definition at line 187 of file itkTransformBase.h.

◆ UnknownTransformCategory

template<typename TParametersValueType >
constexpr TransformCategoryEnum TransformBaseTemplate< TParametersValueType >::UnknownTransformCategory = TransformCategoryEnum::UnknownTransformCategory
staticconstexpr

Definition at line 184 of file itkTransformBase.h.

◆ VelocityField

template<typename TParametersValueType >
constexpr TransformCategoryEnum TransformBaseTemplate< TParametersValueType >::VelocityField = TransformCategoryEnum::VelocityField
staticconstexpr

Definition at line 189 of file itkTransformBase.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.9.3