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

#include <itkSimilarity2DTransform.h>

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

Public Types

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

void CloneInverseTo (Pointer &newinverse) const
 
void CloneTo (Pointer &clone) const
 
void ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
bool GetInverse (Self *inverse) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
virtual const char * GetNameOfClass () const
 
const ParametersTypeGetParameters () const override
 
virtual const ScaleTypeGetScale () 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 &vector) const
 
InputPointType BackTransform (const OutputPointType &point) const
 
InputVectorType BackTransform (const OutputVectorType &vector) const
 
InputVnlVectorType BackTransform (const OutputVnlVectorType &vector) const
 
virtual const TParametersValueType & GetAngle () const
 
void SetAngle (TParametersValueType angle)
 
void SetAngleInDegrees (TParametersValueType angle)
 
void SetMatrix (const MatrixType &matrix) override
 
void Translate (const OffsetType &offset, bool pre=false)
 
void SetRotation (TParametersValueType angle)
 
virtual const TParametersValueType & GetRotation () const
 
void ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const override
 
void CloneInverseTo (Pointer &newinverse) const
 
bool GetInverse (Self *inverse) const
 
void CloneTo (Pointer &clone) const
 
- Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
TransformCategoryEnum GetTransformCategory () const override
 
virtual void SetMatrix (const MatrixType &matrix)
 
virtual const MatrixTypeGetMatrix () const
 
void SetOffset (const OutputVectorType &offset)
 
const OutputVectorTypeGetOffset () const
 
void SetCenter (const InputPointType &center)
 
const InputPointTypeGetCenter () const
 
void SetTranslation (const OutputVectorType &translation)
 
const OutputVectorTypeGetTranslation () const
 
void SetParameters (const ParametersType &parameters) override
 
const ParametersTypeGetParameters () const override
 
void SetFixedParameters (const FixedParametersType &) override
 
const FixedParametersTypeGetFixedParameters () const override
 
void Compose (const Self *other, bool pre=false)
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
OutputVectorType TransformVector (const InputVectorType &vector) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vector) const override
 
OutputVectorPixelType TransformVector (const InputVectorPixelType &vector) const override
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector) const override
 
OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector) const override
 
OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const override
 
OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const override
 
OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor) const override
 
OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor) const override
 
void ComputeJacobianWithRespectToParameters (const InputPointType &x, JacobianType &j) const override
 
void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) const override
 
void ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, InverseJacobianPositionType &jac) const override
 
bool GetInverse (Self *inverse) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
bool IsLinear () const override
 
- Public Member Functions inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
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
 
bool GetInverse (Self *) const
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () 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 &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor, 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)
 
virtual void ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const
 
 itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
 itkLegacyMacro (virtual void ComputeInverseJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
- Public Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
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 void SetFixedParameters (const FixedParametersType &)=0
 
virtual void SetParameters (const ParametersType &)=0
 
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
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) 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 Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- 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 = 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, NInputDimensions, NOutputDimensions >
static constexpr unsigned int InputSpaceDimension = NInputDimensions
 
static constexpr unsigned int OutputSpaceDimension = NOutputDimensions
 

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 >
 Rigid2DTransform (unsigned int outputSpaceDimension, unsigned int parametersDimension)
 
 Rigid2DTransform (unsigned int parametersDimension)
 
 Rigid2DTransform ()
 
 ~Rigid2DTransform () override=default
 
void SetVarAngle (TParametersValueType angle)
 
- Protected Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >
const InverseMatrixTypeGetInverseMatrix () const
 
 MatrixOffsetTransformBase (const MatrixType &matrix, const OutputVectorType &offset)
 
 MatrixOffsetTransformBase (unsigned int paramDims)
 
 MatrixOffsetTransformBase ()
 
 ~MatrixOffsetTransformBase () override=default
 
void PrintSelf (std::ostream &s, Indent indent) const override
 
const InverseMatrixTypeGetVarInverseMatrix () const
 
void SetVarInverseMatrix (const InverseMatrixType &matrix) const
 
bool InverseMatrixIsOld () const
 
void SetVarMatrix (const MatrixType &matrix)
 
virtual void ComputeTranslation ()
 
void SetVarTranslation (const OutputVectorType &translation)
 
virtual void ComputeOffset ()
 
void SetVarOffset (const OutputVectorType &offset)
 
void SetVarCenter (const InputPointType &center)
 
virtual bool GetSingular () const
 
- Protected Member Functions inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
LightObject::Pointer InternalClone () const override
 
 Transform ()
 
 Transform (NumberOfParametersType NumberOfParameters)
 
 ~Transform () override=default
 
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
 
- Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
 TransformBaseTemplate ()=default
 
 ~TransformBaseTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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

ScaleType m_Scale
 

Additional Inherited Members

- Protected Attributes inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
ParametersType m_Parameters
 
FixedParametersType m_FixedParameters
 
DirectionChangeMatrix m_DirectionChange
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 71 of file itkSimilarity2DTransform.h.

◆ FixedParametersType

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

Definition at line 91 of file itkSimilarity2DTransform.h.

◆ FixedParametersValueType

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

Definition at line 92 of file itkSimilarity2DTransform.h.

◆ InputCovariantVectorType

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

CovariantVector type.

Definition at line 116 of file itkSimilarity2DTransform.h.

◆ InputPointType

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

Point type.

Definition at line 108 of file itkSimilarity2DTransform.h.

◆ InputVectorType

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

Vector type.

Definition at line 112 of file itkSimilarity2DTransform.h.

◆ InputVnlVectorType

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

VnlVector type.

Definition at line 120 of file itkSimilarity2DTransform.h.

◆ InverseJacobianPositionType

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

Definition at line 97 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.

◆ JacobianPositionType

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

Definition at line 96 of file itkSimilarity2DTransform.h.

◆ JacobianType

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

Jacobian type.

Definition at line 95 of file itkSimilarity2DTransform.h.

◆ MatrixType

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

Matrix type.

Definition at line 104 of file itkSimilarity2DTransform.h.

◆ MatrixValueType

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

Definition at line 105 of file itkSimilarity2DTransform.h.

◆ OffsetType

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

Offset type.

Definition at line 100 of file itkSimilarity2DTransform.h.

◆ OffsetValueType

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

Definition at line 101 of file itkSimilarity2DTransform.h.

◆ OutputCovariantVectorType

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

Definition at line 117 of file itkSimilarity2DTransform.h.

◆ OutputPointType

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

Definition at line 109 of file itkSimilarity2DTransform.h.

◆ OutputVectorType

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

Definition at line 113 of file itkSimilarity2DTransform.h.

◆ OutputVnlVectorType

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

Definition at line 121 of file itkSimilarity2DTransform.h.

◆ ParametersType

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

Parameters type.

Definition at line 89 of file itkSimilarity2DTransform.h.

◆ ParametersValueType

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

Definition at line 90 of file itkSimilarity2DTransform.h.

◆ Pointer

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

Definition at line 70 of file itkSimilarity2DTransform.h.

◆ ScalarType

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

Definition at line 85 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 newinverse) 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 clone) 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
override

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

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

◆ CreateAnother()

template<typename TParametersValueType = double>
virtual::itk::LightObject::Pointer itk::Similarity2DTransform< TParametersValueType >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

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>
virtual const char* itk::Similarity2DTransform< TParametersValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

Reimplemented in itk::CenteredSimilarity2DTransform< TParametersValueType >.

◆ GetParameters()

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

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()

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

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

Print contents of an Rigid2DTransform

Reimplemented from itk::Rigid2DTransform< TParametersValueType >.

◆ 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)
override

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()

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