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::Rigid2DTransform< TParametersValueType > Class Template Reference

#include <itkRigid2DTransform.h>

Detailed Description

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

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

This transform applies a rigid transformation in 2D space. The transform is specified as a rotation around a arbitrary center and is followed by a 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] = angle p[1] = x component of the translation p[2] = 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.

See also
Transform
MatrixOffsetTransformBase

Definition at line 56 of file itkRigid2DTransform.h.

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

Public Types

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

Public Member Functions

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
 
void ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &j) const override
 
virtual const TParametersValueType & GetAngle () const
 
bool GetInverse (Self *inverse) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
const char * GetNameOfClass () const override
 
const ParametersTypeGetParameters () const override
 
void SetAngle (TParametersValueType angle)
 
void SetAngleInDegrees (TParametersValueType angle)
 
void SetIdentity () override
 
void SetMatrix (const MatrixType &matrix) override
 
virtual void SetMatrix (const MatrixType &matrix, const TParametersValueType tolerance)
 
void SetParameters (const ParametersType &parameters) override
 
void Translate (const OffsetType &offset, bool pre=false)
 
void SetRotation (TParametersValueType angle)
 
virtual const TParametersValueType & GetRotation () const
 
- Public Member Functions inherited from itk::MatrixOffsetTransformBase< double, 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 InputPointTypeGetCenter () const
 
const FixedParametersTypeGetFixedParameters () const override
 
InverseTransformBasePointer GetInverseTransform () const override
 
virtual const MatrixTypeGetMatrix () const
 
const char * GetNameOfClass () const override
 
const OutputVectorTypeGetOffset () const
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
const OutputVectorTypeGetTranslation () const
 
bool IsLinear () const override
 
void SetFixedParameters (const FixedParametersType &) override
 
virtual void SetIdentity ()
 
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
 
virtual void SetMatrix (const MatrixType &matrix)
 
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< double, 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 FixedParametersTypeGetFixedParameters () const override
 
unsigned int GetInputSpaceDimension () const override
 
bool GetInverse (Self *) const
 
virtual InverseTransformBasePointer GetInverseTransform () const
 
const char * GetNameOfClass () const override
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
std::string GetTransformTypeAsString () const override
 
virtual bool IsLinear () const
 
 itkCloneMacro (Self)
 
void SetFixedParameters (const FixedParametersType &) override=0
 
void SetParameters (const ParametersType &) override=0
 
void SetParametersByValue (const ParametersType &p) override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const
 
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
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputPointType TransformPoint (const InputPointType &) const=0
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputVectorType TransformVector (const InputVectorType &) const
 
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
virtual void UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)
 
virtual void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const=0
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const
 
template< typename TImage > std std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (SmartPointer< TImage > image) const
 
- Public Member Functions inherited from TransformBaseTemplate< double >
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 FixedParametersTypeGetFixedParameters () const=0
 
virtual unsigned int GetInputSpaceDimension () const=0
 
virtual NumberOfParametersType GetNumberOfParameters () const=0
 
virtual unsigned int GetOutputSpaceDimension () const=0
 
virtual const ParametersTypeGetParameters () 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 Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::MatrixOffsetTransformBase< double, 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 = 3
 
- Static Public Attributes inherited from itk::MatrixOffsetTransformBase< double, 2, 2 >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 
static constexpr unsigned int ParametersDimension
 
- Static Public Attributes inherited from itk::Transform< double, VInputDimension, VOutputDimension >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 
- Static Public Attributes inherited from TransformBaseTemplate< double >
static constexpr TransformCategoryEnum BSpline
 
static constexpr TransformCategoryEnum DisplacementField
 
static constexpr TransformCategoryEnum Linear
 
static constexpr TransformCategoryEnum Spline
 
static constexpr TransformCategoryEnum UnknownTransformCategory
 
static constexpr TransformCategoryEnum VelocityField
 

Protected Member Functions

void ComputeMatrix () override
 
void ComputeMatrixParameters () override
 
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< double, 2, 2 >
virtual void ComputeMatrix ()
 
virtual void ComputeMatrixParameters ()
 
virtual void ComputeOffset ()
 
virtual void ComputeTranslation ()
 
const InverseMatrixTypeGetInverseMatrix () const
 
virtual bool GetSingular () const
 
const InverseMatrixTypeGetVarInverseMatrix () 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< double, VInputDimension, VOutputDimension >
LightObject::Pointer InternalClone () const override
 
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
 
 Transform ()=default
 
 Transform (NumberOfParametersType numberOfParameters)
 
 ~Transform () override=default
 
- Protected Member Functions inherited from TransformBaseTemplate< double >
 TransformBaseTemplate ()=default
 
 ~TransformBaseTemplate () override=default
 

Private Attributes

TParametersValueType m_Angle {}
 

Additional Inherited Members

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

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 65 of file itkRigid2DTransform.h.

◆ InputCovariantVectorType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputCovariantVectorType = CovariantVector<TParametersValueType, Self::InputSpaceDimension>

Standard covariant vector type for this class

Definition at line 153 of file itkMatrixOffsetTransformBase.h.

◆ InputPointType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputPointType = Point<TParametersValueType, Self::InputSpaceDimension>

Standard coordinate point type for this class

Definition at line 174 of file itkMatrixOffsetTransformBase.h.

◆ InputVectorType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputVectorType = Vector<TParametersValueType, Self::InputSpaceDimension>

Standard vector type for this class

Definition at line 148 of file itkMatrixOffsetTransformBase.h.

◆ InputVnlVectorType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputVnlVectorType = vnl_vector_fixed<TParametersValueType, Self::InputSpaceDimension>

Standard vnl_vector type for this class

Definition at line 170 of file itkMatrixOffsetTransformBase.h.

◆ InverseJacobianPositionType

template<typename TParametersValueType = double>
using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InverseJacobianPositionType = vnl_matrix_fixed<ParametersValueType, VInputDimension, VOutputDimension>

Definition at line 139 of file itkTransform.h.

◆ InverseTransformBasePointer

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

Definition at line 120 of file itkRigid2DTransform.h.

◆ InverseTransformBaseType

template<typename TParametersValueType = double>
using itk::Rigid2DTransform< 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 119 of file itkRigid2DTransform.h.

◆ JacobianPositionType

template<typename TParametersValueType = double>
using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::JacobianPositionType = vnl_matrix_fixed<ParametersValueType, VOutputDimension, VInputDimension>

Definition at line 138 of file itkTransform.h.

◆ JacobianType

template<typename TParametersValueType = double>
using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::JacobianType = Array2D<ParametersValueType>

Type of the Jacobian matrix.

Definition at line 137 of file itkTransform.h.

◆ MatrixType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::MatrixType = Matrix<TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension>

Standard matrix type for this class

Definition at line 180 of file itkMatrixOffsetTransformBase.h.

◆ MatrixValueType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::MatrixValueType = typename MatrixType::ValueType

Definition at line 181 of file itkMatrixOffsetTransformBase.h.

◆ OffsetType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OffsetType = OutputVectorType

Definition at line 188 of file itkMatrixOffsetTransformBase.h.

◆ OffsetValueType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OffsetValueType = typename OffsetType::ValueType

Definition at line 189 of file itkMatrixOffsetTransformBase.h.

◆ OutputCovariantVectorType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputCovariantVectorType = CovariantVector<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 154 of file itkMatrixOffsetTransformBase.h.

◆ OutputPointType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputPointType = Point<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 176 of file itkMatrixOffsetTransformBase.h.

◆ OutputVectorType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputVectorType = Vector<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 149 of file itkMatrixOffsetTransformBase.h.

◆ OutputVectorValueType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputVectorValueType = typename OutputVectorType::ValueType

Definition at line 150 of file itkMatrixOffsetTransformBase.h.

◆ OutputVnlVectorType

template<typename TParametersValueType = double>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputVnlVectorType = vnl_vector_fixed<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 171 of file itkMatrixOffsetTransformBase.h.

◆ Pointer

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

Definition at line 64 of file itkRigid2DTransform.h.

◆ ScalarType

template<typename TParametersValueType = double>
using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::ScalarType = ParametersValueType

Type of the scalar representing coordinate and vector elements.

Definition at line 145 of file itkTransform.h.

◆ Self

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

Standard class type aliases.

Definition at line 62 of file itkRigid2DTransform.h.

◆ Superclass

template<typename TParametersValueType = double>
using itk::Rigid2DTransform< TParametersValueType >::Superclass = MatrixOffsetTransformBase<TParametersValueType, 2, 2>

Definition at line 63 of file itkRigid2DTransform.h.

Constructor & Destructor Documentation

◆ Rigid2DTransform() [1/3]

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

◆ Rigid2DTransform() [2/3]

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

◆ Rigid2DTransform() [3/3]

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

◆ ~Rigid2DTransform()

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

Member Function Documentation

◆ BackTransform() [1/4]

template<typename TParametersValueType >
auto itk::Rigid2DTransform< TParametersValueType >::BackTransform ( const OutputCovariantVectorType vect) const
inline

Definition at line 331 of file itkRigid2DTransform.h.

◆ BackTransform() [2/4]

template<typename TParametersValueType >
auto itk::Rigid2DTransform< TParametersValueType >::BackTransform ( const OutputPointType point) const
inline

Back transform by an rigid transformation.

The BackTransform() methods are slated to be removed from ITK. Instead, please use GetInverse() or CloneInverseTo() to generate an inverse transform and then perform the transform using that inverted transform.

Definition at line 301 of file itkRigid2DTransform.h.

References itk::point().

◆ BackTransform() [3/4]

template<typename TParametersValueType >
auto itk::Rigid2DTransform< TParametersValueType >::BackTransform ( const OutputVectorType vect) const
inline

Definition at line 311 of file itkRigid2DTransform.h.

◆ BackTransform() [4/4]

template<typename TParametersValueType >
auto itk::Rigid2DTransform< TParametersValueType >::BackTransform ( const OutputVnlVectorType vect) const
inline

Definition at line 321 of file itkRigid2DTransform.h.

◆ CloneInverseTo()

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

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

◆ CloneTo()

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

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

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = double>
void itk::Rigid2DTransform< TParametersValueType >::ComputeJacobianWithRespectToParameters ( const InputPointType p,
JacobianType j 
) const
override

Compute the Jacobian Matrix of the transformation at one point, allowing for thread-safety.

◆ ComputeMatrix()

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

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

Reimplemented from itk::MatrixOffsetTransformBase< double, 2, 2 >.

Reimplemented in itk::Similarity2DTransform< double >.

◆ ComputeMatrixParameters()

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

Compute the angle 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::MatrixOffsetTransformBase< double, 2, 2 >.

Reimplemented in itk::Similarity2DTransform< double >.

◆ GetAngle()

template<typename TParametersValueType = double>
virtual const TParametersValueType & itk::Rigid2DTransform< TParametersValueType >::GetAngle ( ) const
virtual

◆ GetInverse()

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

Get an inverse of this transform.

◆ GetInverseTransform()

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

Return an inverse of this transform.

Reimplemented from itk::Transform< double, VInputDimension, VOutputDimension >.

Reimplemented in itk::Similarity2DTransform< double >.

◆ GetNameOfClass()

template<typename TParametersValueType = double>
const char * itk::Rigid2DTransform< TParametersValueType >::GetNameOfClass ( ) const
override

◆ GetParameters()

template<typename TParametersValueType = double>
const ParametersType & itk::Rigid2DTransform< TParametersValueType >::GetParameters ( ) const
overridevirtual

Get the parameters that uniquely define the transform This is typically used by optimizers. There are 3 parameters. The first one represents the angle or rotation in radians and the last two represents the translation. The center of rotation is fixed.

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

Implements TransformBaseTemplate< double >.

Reimplemented in itk::Similarity2DTransform< double >.

◆ GetRotation()

template<typename TParametersValueType = double>
virtual const TParametersValueType & itk::Rigid2DTransform< TParametersValueType >::GetRotation ( ) const
inlinevirtual

Set/Get the angle of rotation in radians. These methods are old and are retained for backward compatibility. Instead, use SetAngle() and GetAngle().

Definition at line 201 of file itkRigid2DTransform.h.

◆ New()

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

New macro for creation of through a Smart Pointer

◆ PrintSelf()

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

Print contents of an Rigid2DTransform

◆ SetAngle()

template<typename TParametersValueType = double>
void itk::Rigid2DTransform< TParametersValueType >::SetAngle ( TParametersValueType  angle)

Set/Get the angle of rotation in radians

◆ SetAngleInDegrees()

template<typename TParametersValueType = double>
void itk::Rigid2DTransform< TParametersValueType >::SetAngleInDegrees ( TParametersValueType  angle)

Set the angle of rotation in degrees.

◆ SetIdentity()

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

Reset the parameters to create and identity transform.

Reimplemented from itk::MatrixOffsetTransformBase< double, 2, 2 >.

Reimplemented in itk::Similarity2DTransform< double >.

◆ SetMatrix() [1/2]

template<typename TParametersValueType = double>
void itk::Rigid2DTransform< TParametersValueType >::SetMatrix ( const MatrixType matrix)
override

Set the rotation Matrix of a Rigid2D Transform

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

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

Reimplemented in itk::Similarity2DTransform< double >.

◆ SetMatrix() [2/2]

template<typename TParametersValueType = double>
virtual void itk::Rigid2DTransform< TParametersValueType >::SetMatrix ( const MatrixType matrix,
const TParametersValueType  tolerance 
)
virtual

Set the rotation Matrix of a Rigid2D Transform

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

Warning
This method will throw an exception is the matrix provided as argument is not orthogonal within the given tolerance.
See also
MatrixOffsetTransformBase::SetMatrix()

Reimplemented in itk::Similarity2DTransform< double >.

◆ SetParameters()

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

Set the transformation from a container of parameters This is typically used by optimizers. There are 3 parameters. The first one represents the angle of rotation in radians and the last two represents the translation. The center of rotation is fixed.

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

Implements itk::Transform< double, VInputDimension, VOutputDimension >.

Reimplemented in itk::Similarity2DTransform< double >.

◆ SetRotation()

template<typename TParametersValueType = double>
void itk::Rigid2DTransform< TParametersValueType >::SetRotation ( TParametersValueType  angle)
inline

Set/Get the angle of rotation in radians. These methods are old and are retained for backward compatibility. Instead, use SetAngle() and GetAngle().

Definition at line 196 of file itkRigid2DTransform.h.

◆ SetVarAngle()

template<typename TParametersValueType = double>
void itk::Rigid2DTransform< TParametersValueType >::SetVarAngle ( TParametersValueType  angle)
inlineprotected

Update angle without recomputation of other internal variables.

Definition at line 288 of file itkRigid2DTransform.h.

◆ Translate()

template<typename TParametersValueType = double>
void itk::Rigid2DTransform< TParametersValueType >::Translate ( const OffsetType offset,
bool  pre = false 
)

Compose the transformation with a translation

This method modifies self to include a translation of the origin. The translation is precomposed with self if pre is true, and postcomposed otherwise.

Member Data Documentation

◆ InputSpaceDimension

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

Dimension of the space.

Definition at line 74 of file itkRigid2DTransform.h.

◆ m_Angle

template<typename TParametersValueType = double>
TParametersValueType itk::Rigid2DTransform< TParametersValueType >::m_Angle {}
private

Definition at line 294 of file itkRigid2DTransform.h.

◆ OutputSpaceDimension

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

Definition at line 75 of file itkRigid2DTransform.h.

◆ ParametersDimension

template<typename TParametersValueType = double>
constexpr unsigned int itk::Rigid2DTransform< TParametersValueType >::ParametersDimension = 3
staticconstexpr

Definition at line 76 of file itkRigid2DTransform.h.


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