ITK  5.3.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>

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

Public Types

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 InputPointType = Point< TParametersValueType, Self::InputSpaceDimension >
 
using InputPointValueType = typename InputPointType::ValueType
 
using InputTensorEigenVectorType = CovariantVector< TParametersValueType, InputDiffusionTensor3DType::Dimension >
 
using InputVectorType = Vector< TParametersValueType, Self::InputSpaceDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::InputSpaceDimension >
 
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 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 OutputPointValueType = typename OutputPointType::ValueType
 
using OutputVectorType = Vector< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputVectorValueType = typename OutputVectorType::ValueType
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::OutputSpaceDimension >
 
using Pointer = SmartPointer< Self >
 
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 Types inherited from itk::TransformBaseTemplate< TParametersValueType >
using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = OptimizerParameters< FixedParametersValueType >
 
using FixedParametersValueType = double
 
using NumberOfParametersType = IdentifierType
 
using ParametersType = OptimizerParameters< ParametersValueType >
 
using ParametersValueType = TParametersValueType
 
using Pointer = SmartPointer< Self >
 
using Self = TransformBaseTemplate
 
using Superclass = Object
 
using TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

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
 
virtual const char * GetNameOfClass () const
 
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< 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
 
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 OutputVectorTypeGetOffset () const
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
const OutputVectorTypeGetTranslation () const
 
bool IsLinear () const override
 
void SetFixedParameters (const FixedParametersType &) override
 
void SetParameters (const ParametersType &parameters) override
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vec) const override
 
OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vect) const override
 
OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const override
 
OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const override
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor) const override
 
OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor) const override
 
OutputVectorPixelType TransformVector (const InputVectorPixelType &vect) const override
 
OutputVectorType TransformVector (const InputVectorType &vect) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vect) const override
 
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
 
unsigned int GetInputSpaceDimension () const override
 
virtual const std::string & GetInputSpaceName () const
 
bool GetInverse (Self *) const
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
virtual const std::string & GetOutputSpaceName () const
 
std::string GetTransformTypeAsString () const override
 
 itkCloneMacro (Self)
 
void SetFixedParameters (const FixedParametersType &) override=0
 
virtual void SetInputSpaceName (std::string _arg)
 
virtual void SetOutputSpaceName (std::string _arg)
 
void SetParameters (const ParametersType &) override=0
 
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)
 
 itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
 itkLegacyMacro (virtual void ComputeInverseJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
template<typename TImage >
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (TImage *image) const
 
template<typename TImage >
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (SmartPointer< TImage > image) const
 
- Public Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
virtual void SetParametersByValue (const ParametersType &p)=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

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< 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
 
 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 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 (const MatrixType &matrix, const OutputVectorType &offset)
 
 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
 
- Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
 TransformBaseTemplate ()=default
 
 ~TransformBaseTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

TParametersValueType m_Angle
 

Additional Inherited Members

- Protected Attributes inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
FixedParametersType m_FixedParameters
 
ParametersType m_Parameters
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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
Transfrom
MatrixOffsetTransformBase
Examples
Examples/RegistrationITKv4/ModelToImageRegistration2.cxx, SphinxExamples/src/Core/Common/ApplyCustomOperationToEachPixelInImage/Code.cxx, SphinxExamples/src/IO/TransformBase/WriteTransformToFile/Code.cxx, and SphinxExamples/src/Registration/Common/RegisterImageToAnotherUsingLandmarks/Code.cxx.

Definition at line 56 of file itkRigid2DTransform.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 65 of file itkRigid2DTransform.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.

◆ Pointer

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

Definition at line 64 of file itkRigid2DTransform.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 >
Rigid2DTransform< TParametersValueType >::InputCovariantVectorType itk::Rigid2DTransform< TParametersValueType >::BackTransform ( const OutputCovariantVectorType vect) const
inline

Definition at line 331 of file itkRigid2DTransform.h.

◆ BackTransform() [2/4]

template<typename TParametersValueType >
Rigid2DTransform< TParametersValueType >::InputPointType 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 >
Rigid2DTransform< TParametersValueType >::InputVectorType itk::Rigid2DTransform< TParametersValueType >::BackTransform ( const OutputVectorType vect) const
inline

Definition at line 311 of file itkRigid2DTransform.h.

◆ BackTransform() [4/4]

template<typename TParametersValueType >
Rigid2DTransform< TParametersValueType >::InputVnlVectorType 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
overridevirtual

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

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

Reimplemented in itk::Similarity2DTransform< TParametersValueType >.

◆ 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< TParametersValueType, 2, 2 >.

Reimplemented in itk::Similarity2DTransform< TParametersValueType >.

◆ 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< TParametersValueType, 2, 2 >.

Reimplemented in itk::Similarity2DTransform< TParametersValueType >.

◆ 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

◆ GetNameOfClass()

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

◆ 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 itk::TransformBaseTemplate< TParametersValueType >.

Reimplemented in itk::Similarity2DTransform< TParametersValueType >.

◆ 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
overrideprotectedvirtual

Print contents of an Rigid2DTransform

Reimplemented from itk::Object.

Reimplemented in itk::Similarity2DTransform< TParametersValueType >.

◆ 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< TParametersValueType, 2, 2 >.

Reimplemented in itk::Similarity2DTransform< TParametersValueType >.

◆ SetMatrix() [1/2]

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

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 from itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >.

Reimplemented in itk::Similarity2DTransform< TParametersValueType >.

◆ 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< TParametersValueType >.

◆ 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::TransformBaseTemplate< TParametersValueType >.

Reimplemented in itk::Similarity2DTransform< TParametersValueType >.

◆ 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: