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

#include <itkSimilarity2DTransform.h>

Detailed Description

template<typename TParametersValueType = double>
class itk::Similarity2DTransform< TParametersValueType >

Similarity2DTransform of a vector space (e.g. space coordinates)

This transform applies a homogeneous scale and rigid transform in 2D space. The transform is specified as a scale and rotation around a arbitrary center and is followed by a translation. given one angle for rotation, a homogeneous scale and a 2D offset for translation.

The parameters for this transform can be set either using individual Set methods or in serialized form using SetParameters() and SetFixedParameters().

The serialization of the optimizable parameters is an array of 3 elements ordered as follows: p[0] = scale p[1] = angle p[2] = x component of the translation p[3] = y component of the translation

The serialization of the fixed parameters is an array of 2 elements ordered as follows: p[0] = x coordinate of the center p[1] = y coordinate of the center

Access methods for the center, translation and underlying matrix offset vectors are documented in the superclass MatrixOffsetTransformBase.

Access methods for the angle are documented in superclass Rigid2DTransform.

See also
Transform
MatrixOffsetTransformBase
Rigid2DTransform
Examples
Examples/Filtering/ResampleImageFilter5.cxx, and Examples/RegistrationITKv4/ImageRegistration7.cxx.

Definition at line 62 of file itkSimilarity2DTransform.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = typename Superclass::InverseTransformBaseType
 
using Pointer = SmartPointer< Self >
 
using ScaleType = TParametersValueType
 
using Self = Similarity2DTransform
 
using Superclass = Rigid2DTransform< TParametersValueType >
 
- Public Types inherited from itk::Rigid2DTransform< TParametersValueType >
using ConstPointer = SmartPointer< const Self >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = typename Superclass::InverseTransformBaseType
 
using Pointer = SmartPointer< Self >
 
using Self = Rigid2DTransform
 
using Superclass = MatrixOffsetTransformBase< TParametersValueType, 2, 2 >
 
- Public Types inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >
using CenterType = InputPointType
 
using ConstPointer = SmartPointer< const Self >
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, Self::InputSpaceDimension >
 
using InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using InputPointType = Point< TParametersValueType, Self::InputSpaceDimension >
 
using InputPointValueType = typename InputPointType::ValueType
 
using InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VInputDimension >
 
using InputTensorEigenVectorType = CovariantVector< TParametersValueType, InputDiffusionTensor3DType::Dimension >
 
using InputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using InputVectorType = Vector< TParametersValueType, Self::InputSpaceDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::InputSpaceDimension >
 
using InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >
 
using InverseMatrixType = Matrix< TParametersValueType, Self::InputSpaceDimension, Self::OutputSpaceDimension >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = typename Superclass::InverseTransformBaseType
 
using InverseTransformType = MatrixOffsetTransformBase< TParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianType = Array2D< ParametersValueType >
 
using MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using MatrixValueType = typename MatrixType::ValueType
 
using OffsetType = OutputVectorType
 
using OffsetValueType = typename OffsetType::ValueType
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using OutputPointType = Point< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputPointValueType = typename OutputPointType::ValueType
 
using OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VOutputDimension >
 
using OutputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using OutputVectorType = Vector< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputVectorValueType = typename OutputVectorType::ValueType
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::OutputSpaceDimension >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = ParametersValueType
 
using Self = MatrixOffsetTransformBase
 
using Superclass = Transform< TParametersValueType, VInputDimension, VOutputDimension >
 
using TranslationType = OutputVectorType
 
using TranslationValueType = typename TranslationType::ValueType
 
- Public Types inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array< ParametersValueType >
 
using DirectionChangeMatrix = Matrix< double, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, VInputDimension >
 
using InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using InputDirectionMatrix = Matrix< double, Self::InputSpaceDimension, Self::InputSpaceDimension >
 
using InputPointType = Point< TParametersValueType, VInputDimension >
 
using InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VInputDimension >
 
using InputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using InputVectorType = Vector< TParametersValueType, VInputDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, VInputDimension >
 
using InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = Transform< TParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianType = Array2D< ParametersValueType >
 
using MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, VOutputDimension >
 
using OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using OutputDirectionMatrix = Matrix< double, Self::OutputSpaceDimension, Self::OutputSpaceDimension >
 
using OutputPointType = Point< TParametersValueType, VOutputDimension >
 
using OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VOutputDimension >
 
using OutputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using OutputVectorType = Vector< TParametersValueType, VOutputDimension >
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, VOutputDimension >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = ParametersValueType
 
using Self = Transform
 
using Superclass = TransformBaseTemplate< TParametersValueType >
 

Public Member Functions

void CloneInverseTo (Pointer &result) const
 
void CloneTo (Pointer &result) const
 
void ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const override
 
bool GetInverse (Self *inverse) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
const char * GetNameOfClass () const override
 
const ParametersType & GetParameters () const override
 
virtual const ScaleType & GetScale () const
 
void SetIdentity () override
 
void SetMatrix (const MatrixType &matrix) override
 
void SetMatrix (const MatrixType &matrix, const TParametersValueType tolerance) override
 
void SetParameters (const ParametersType &parameters) override
 
void SetScale (ScaleType scale)
 
- Public Member Functions inherited from itk::Rigid2DTransform< TParametersValueType >
InputCovariantVectorType BackTransform (const OutputCovariantVectorType &vect) const
 
InputPointType BackTransform (const OutputPointType &point) const
 
InputVectorType BackTransform (const OutputVectorType &vect) const
 
InputVnlVectorType BackTransform (const OutputVnlVectorType &vect) const
 
void CloneInverseTo (Pointer &result) const
 
void CloneTo (Pointer &result) const
 
virtual const TParametersValueType & GetAngle () const
 
bool GetInverse (Self *inverse) const
 
const char * GetNameOfClass () const override
 
const ParametersType & GetParameters () const override
 
void SetAngle (TParametersValueType angle)
 
void SetAngleInDegrees (TParametersValueType angle)
 
void Translate (const OffsetType &offset, bool pre=false)
 
void SetRotation (TParametersValueType angle)
 
virtual const TParametersValueType & GetRotation () const
 
- Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >
void Compose (const Self *other, bool pre=false)
 
void ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, InverseJacobianPositionType &jac) const override
 
void ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const override
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const
 
void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) const override
 
const InputPointType & GetCenter () const
 
const FixedParametersType & GetFixedParameters () const override
 
InverseTransformBasePointer GetInverseTransform () const override
 
virtual const MatrixType & GetMatrix () const
 
const char * GetNameOfClass () const override
 
const OutputVectorType & GetOffset () const
 
const ParametersType & GetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
const OutputVectorType & GetTranslation () const
 
bool IsLinear () const override
 
void SetFixedParameters (const FixedParametersType &) override
 
void SetParameters (const ParametersType &parameters) override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vec) const override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const
 
OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vect) const override
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &point) const
 
OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const override
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const override
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
 
OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor) const override
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
 
OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor) const override
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &) const
 
OutputVectorPixelType TransformVector (const InputVectorPixelType &vect) const override
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputVectorType TransformVector (const InputVectorType &) const
 
OutputVectorType TransformVector (const InputVectorType &vect) const override
 
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &) const
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vect) const override
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
void SetOffset (const OutputVectorType &offset)
 
void SetCenter (const InputPointType &center)
 
void SetTranslation (const OutputVectorType &translation)
 
bool GetInverse (InverseTransformType *inverse) const
 
- Public Member Functions inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
virtual void ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const
 
void CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end) override
 
void CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end) override
 
const FixedParametersType & GetFixedParameters () const override
 
unsigned int GetInputSpaceDimension () const override
 
bool GetInverse (Self *) const
 
const char * GetNameOfClass () const override
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
const ParametersType & GetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
std::string GetTransformTypeAsString () const override
 
 itkCloneMacro (Self)
 
void SetParametersByValue (const ParametersType &p) override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
virtual void UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)
 
template<typename TImage >
template< typename TImage > std std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (SmartPointer< TImage > image) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Rigid2DTransform< TParametersValueType >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int InputSpaceDimension = 2
 
static constexpr unsigned int OutputSpaceDimension = 2
 
static constexpr unsigned int ParametersDimension = 4
 
static constexpr unsigned int SpaceDimension = 2
 
- Static Public Attributes inherited from itk::Rigid2DTransform< TParametersValueType >
static constexpr unsigned int InputSpaceDimension = 2
 
static constexpr unsigned int OutputSpaceDimension = 2
 
static constexpr unsigned int ParametersDimension = 3
 
- Static Public Attributes inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 
static constexpr unsigned int ParametersDimension
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
static constexpr unsigned int InputSpaceDimension = VInputDimension
 
static constexpr unsigned int OutputSpaceDimension = VOutputDimension
 

Protected Member Functions

void ComputeMatrix () override
 
void ComputeMatrixParameters () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void SetVarScale (ScaleType scale)
 
 Similarity2DTransform ()
 
 Similarity2DTransform (unsigned int outputSpaceDimension, unsigned int parametersDimension)
 
 Similarity2DTransform (unsigned int parametersDimension)
 
 ~Similarity2DTransform () override=default
 
- Protected Member Functions inherited from itk::Rigid2DTransform< TParametersValueType >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 Rigid2DTransform ()
 
 Rigid2DTransform (unsigned int outputSpaceDimension, unsigned int parametersDimension)
 
 Rigid2DTransform (unsigned int parametersDimension)
 
void SetVarAngle (TParametersValueType angle)
 
 ~Rigid2DTransform () override=default
 
- Protected Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >
virtual void ComputeOffset ()
 
virtual void ComputeTranslation ()
 
const InverseMatrixType & GetInverseMatrix () const
 
virtual bool GetSingular () const
 
const InverseMatrixType & GetVarInverseMatrix () const
 
bool InverseMatrixIsOld () const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void SetVarCenter (const InputPointType &center)
 
void SetVarInverseMatrix (const InverseMatrixType &matrix) const
 
void SetVarMatrix (const MatrixType &matrix)
 
void SetVarOffset (const OutputVectorType &offset)
 
void SetVarTranslation (const OutputVectorType &translation)
 
 ~MatrixOffsetTransformBase () override=default
 
 MatrixOffsetTransformBase (unsigned int paramDims=ParametersDimension)
 
- Protected Member Functions inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
LightObject::Pointer InternalClone () const override
 
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
 
 Transform ()=default
 
 Transform (NumberOfParametersType numberOfParameters)
 
 ~Transform () override=default
 

Private Attributes

ScaleType m_Scale {}
 

Additional Inherited Members

- Public Attributes inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
InverseJacobianPositionType &jacobian const
 
- Static Protected Member Functions inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
template<typename TTransform >
static InverseTransformBasePointer InvertTransform (const TTransform &transform)
 
- Protected Attributes inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
FixedParametersType m_FixedParameters {}
 
ParametersType m_Parameters {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 71 of file itkSimilarity2DTransform.h.

◆ InverseTransformBasePointer

template<typename TParametersValueType = double>
using itk::Similarity2DTransform< TParametersValueType >::InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

Definition at line 126 of file itkSimilarity2DTransform.h.

◆ InverseTransformBaseType

template<typename TParametersValueType = double>
using itk::Similarity2DTransform< TParametersValueType >::InverseTransformBaseType = typename Superclass::InverseTransformBaseType

Base inverse transform type. This type should not be changed to the concrete inverse transform type or inheritance would be lost.

Definition at line 125 of file itkSimilarity2DTransform.h.

◆ Pointer

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

Definition at line 70 of file itkSimilarity2DTransform.h.

◆ ScaleType

template<typename TParametersValueType = double>
using itk::Similarity2DTransform< TParametersValueType >::ScaleType = TParametersValueType

Definition at line 86 of file itkSimilarity2DTransform.h.

◆ Self

template<typename TParametersValueType = double>
using itk::Similarity2DTransform< TParametersValueType >::Self = Similarity2DTransform

Standard class type aliases.

Definition at line 68 of file itkSimilarity2DTransform.h.

◆ Superclass

template<typename TParametersValueType = double>
using itk::Similarity2DTransform< TParametersValueType >::Superclass = Rigid2DTransform<TParametersValueType>

Definition at line 69 of file itkSimilarity2DTransform.h.

Constructor & Destructor Documentation

◆ Similarity2DTransform() [1/3]

template<typename TParametersValueType = double>
itk::Similarity2DTransform< TParametersValueType >::Similarity2DTransform ( unsigned int  outputSpaceDimension,
unsigned int  parametersDimension 
)
protected

◆ Similarity2DTransform() [2/3]

template<typename TParametersValueType = double>
itk::Similarity2DTransform< TParametersValueType >::Similarity2DTransform ( unsigned int  parametersDimension)
protected

◆ Similarity2DTransform() [3/3]

template<typename TParametersValueType = double>
itk::Similarity2DTransform< TParametersValueType >::Similarity2DTransform ( )
protected

◆ ~Similarity2DTransform()

template<typename TParametersValueType = double>
itk::Similarity2DTransform< TParametersValueType >::~Similarity2DTransform ( )
overrideprotecteddefault

Member Function Documentation

◆ CloneInverseTo()

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::CloneInverseTo ( Pointer &  result) const

This method creates and returns a new Similarity2DTransform object which is the inverse of self.

◆ CloneTo()

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::CloneTo ( Pointer &  result) const

This method creates and returns a new Similarity2DTransform object which has the same parameters.

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::ComputeJacobianWithRespectToParameters ( const InputPointType &  p,
JacobianType &  jacobian 
) const
overridevirtual

This method computes the Jacobian matrix of the transformation at a given input point.

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

◆ ComputeMatrix()

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::ComputeMatrix ( )
overrideprotectedvirtual

Compute matrix from angle and scale. This is used in Set methods to update the underlying matrix whenever a transform parameter is changed.

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

◆ ComputeMatrixParameters()

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::ComputeMatrixParameters ( )
overrideprotectedvirtual

Compute the angle and scale from the matrix. This is used to compute transform parameters from a given matrix. This is used in MatrixOffsetTransformBase::Compose() and MatrixOffsetTransformBase::GetInverse().

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

◆ GetInverse()

template<typename TParametersValueType = double>
bool itk::Similarity2DTransform< TParametersValueType >::GetInverse ( Self *  inverse) const

Get an inverse of this transform.

◆ GetInverseTransform()

template<typename TParametersValueType = double>
InverseTransformBasePointer itk::Similarity2DTransform< TParametersValueType >::GetInverseTransform ( ) const
overridevirtual

Return an inverse of this transform.

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

◆ GetNameOfClass()

template<typename TParametersValueType = double>
const char* itk::Similarity2DTransform< TParametersValueType >::GetNameOfClass ( ) const
override
See also
LightObject::GetNameOfClass()

◆ GetParameters()

template<typename TParametersValueType = double>
const ParametersType& itk::Similarity2DTransform< TParametersValueType >::GetParameters ( ) const
override

Get the parameters that uniquely define the transform This is typically used by optimizers. There are 4 parameters. The first one represents the scale, the second represents the angle of rotation, and the last two represent the translation. The center of rotation is fixed.

See also
Transform::GetParameters()
Transform::GetFixedParameters()

◆ GetScale()

template<typename TParametersValueType = double>
virtual const ScaleType& itk::Similarity2DTransform< TParametersValueType >::GetScale ( ) const
virtual

◆ New()

template<typename TParametersValueType = double>
static Pointer itk::Similarity2DTransform< TParametersValueType >::New ( )
static

New macro for creation of through a Smart Pointer.

◆ PrintSelf()

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotected

◆ SetIdentity()

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::SetIdentity ( )
overridevirtual

Set the transformation to an identity.

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

◆ SetMatrix() [1/2]

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::SetMatrix ( const MatrixType &  matrix)
overridevirtual

Set the rotation Matrix of a Similarity 2D Transform

This method sets the 2x2 matrix representing a similarity transform. The Matrix is expected to be a valid similarity transform with a certain tolerance.

Warning
This method will throw an exception if the matrix provided as argument is not valid.
See also
MatrixOffsetTransformBase::SetMatrix()

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

◆ SetMatrix() [2/2]

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::SetMatrix ( const MatrixType &  matrix,
const TParametersValueType  tolerance 
)
overridevirtual

Set the rotation Matrix of a Similarity 2D Transform

This method sets the 2x2 matrix representing a similarity transform. The Matrix is expected to be a valid similarity transform within the given tolerance.

Warning
This method will throw an exception if the matrix provided as argument is not valid.
See also
MatrixOffsetTransformBase::SetMatrix()

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

◆ SetParameters()

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::SetParameters ( const ParametersType &  parameters)
overridevirtual

Set the transformation from a container of parameters This is typically used by optimizers. There are 4 parameters. The first one represents the scale, the second represents the angle of rotation and the last two represent the translation. The center of rotation is fixed.

See also
Transform::SetParameters()
Transform::SetFixedParameters()

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

◆ SetScale()

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::SetScale ( ScaleType  scale)

Set the Scale part of the transform.

◆ SetVarScale()

template<typename TParametersValueType = double>
void itk::Similarity2DTransform< TParametersValueType >::SetVarScale ( ScaleType  scale)
inlineprotected

Set the scale without updating underlying variables.

Definition at line 246 of file itkSimilarity2DTransform.h.

Member Data Documentation

◆ InputSpaceDimension

template<typename TParametersValueType = double>
constexpr unsigned int itk::Similarity2DTransform< TParametersValueType >::InputSpaceDimension = 2
staticconstexpr

Definition at line 81 of file itkSimilarity2DTransform.h.

◆ m_Scale

template<typename TParametersValueType = double>
ScaleType itk::Similarity2DTransform< TParametersValueType >::m_Scale {}
private

Definition at line 252 of file itkSimilarity2DTransform.h.

◆ OutputSpaceDimension

template<typename TParametersValueType = double>
constexpr unsigned int itk::Similarity2DTransform< TParametersValueType >::OutputSpaceDimension = 2
staticconstexpr

Definition at line 82 of file itkSimilarity2DTransform.h.

◆ ParametersDimension

template<typename TParametersValueType = double>
constexpr unsigned int itk::Similarity2DTransform< TParametersValueType >::ParametersDimension = 4
staticconstexpr

Definition at line 83 of file itkSimilarity2DTransform.h.

◆ SpaceDimension

template<typename TParametersValueType = double>
constexpr unsigned int itk::Similarity2DTransform< TParametersValueType >::SpaceDimension = 2
staticconstexpr

Dimension of parameters.

Definition at line 80 of file itkSimilarity2DTransform.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