#include <itkSimilarity2DTransform.h>

Detailed Description

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

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

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

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

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

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

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

Access methods for the angle are documented in superclass Rigid2DTransform.

See also: Transform; MatrixOffsetTransformBase; Rigid2DTransform

Definition at line 62 of file itkSimilarity2DTransform.h.

Inheritance diagram for itk::Similarity2DTransform< TParametersValueType >:

Collaboration diagram for itk::Similarity2DTransform< TParametersValueType >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	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	OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::OutputSpaceDimension >

using	Pointer = SmartPointer< Self >

using	ScalarType = ParametersValueType

using	ScaleType = TParametersValueType

using	Self = Similarity2DTransform

using	Superclass = Rigid2DTransform< TParametersValueType >

Public Types inherited from itk::Rigid2DTransform< double >
using	ConstPointer = SmartPointer< const Self >

using	InputCovariantVectorType = CovariantVector< double, Self::InputSpaceDimension >

using	InputPointType = Point< double, Self::InputSpaceDimension >

using	InputVectorType = Vector< double, Self::InputSpaceDimension >

using	InputVnlVectorType = vnl_vector_fixed< double, 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< 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	OutputPointType = Point< double, Self::OutputSpaceDimension >

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 = Rigid2DTransform

using	Superclass = MatrixOffsetTransformBase< double, 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
void	CloneInverseTo (Pointer &result) const

void	CloneTo (Pointer &result) const

void	ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const override

bool	GetInverse (Self *inverse) const

InverseTransformBasePointer	GetInverseTransform () const override

const char *	GetNameOfClass () const override

const ParametersType &	GetParameters () const override

virtual const ScaleType &	GetScale () const

void	SetIdentity () override

void	SetMatrix (const MatrixType &matrix) override

void	SetMatrix (const MatrixType &matrix, const TParametersValueType tolerance) override

void	SetParameters (const ParametersType &parameters) override

void	SetScale (ScaleType scale)

Public Member Functions inherited from itk::Rigid2DTransform< double >
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 double &	GetAngle () const

bool	GetInverse (Self *inverse) const

InverseTransformBasePointer	GetInverseTransform () const override

const char *	GetNameOfClass () const override

const ParametersType &	GetParameters () const override

void	SetAngle (double angle)

void	SetAngleInDegrees (double angle)

void	SetIdentity () override

void	SetMatrix (const MatrixType &matrix) override

virtual void	SetMatrix (const MatrixType &matrix, const double tolerance)

void	SetParameters (const ParametersType &parameters) override

void	Translate (const OffsetType &offset, bool pre=false)

void	SetRotation (double angle)

virtual const double &	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 InputPointType &	GetCenter () const

const FixedParametersType &	GetFixedParameters () const override

InverseTransformBasePointer	GetInverseTransform () const override

virtual const MatrixType &	GetMatrix () const

const char *	GetNameOfClass () const override

const OutputVectorType &	GetOffset () const

const ParametersType &	GetParameters () const override

TransformCategoryEnum	GetTransformCategory () const override

const OutputVectorType &	GetTranslation () const

bool	IsLinear () const override

void	SetFixedParameters (const FixedParametersType &) override

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

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 FixedParametersType &	GetFixedParameters () 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 ParametersType &	GetParameters () 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 FixedParametersType &	GetFixedParameters () const=0

virtual unsigned int	GetInputSpaceDimension () const=0

virtual NumberOfParametersType	GetNumberOfParameters () const=0

virtual unsigned int	GetOutputSpaceDimension () const=0

virtual const ParametersType &	GetParameters () const=0

virtual TransformCategoryEnum	GetTransformCategory () const=0

virtual std::string	GetTransformTypeAsString () const=0

	ITK_DISALLOW_COPY_AND_MOVE (TransformBaseTemplate)

	itkGetConstReferenceMacro (InputSpaceName, std::string)

	itkGetConstReferenceMacro (OutputSpaceName, std::string)

	itkOverrideGetNameOfClassMacro (TransformBaseTemplate)

	itkSetMacro (InputSpaceName, std::string)

	itkSetMacro (OutputSpaceName, std::string)

virtual void	SetFixedParameters (const FixedParametersType &)=0

virtual void	SetParameters (const ParametersType &)=0

virtual void	SetParametersByValue (const ParametersType &p)=0

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Rigid2DTransform< double >
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 = 4

static constexpr unsigned int	SpaceDimension = 2

Static Public Attributes inherited from itk::Rigid2DTransform< double >
static constexpr unsigned int	InputSpaceDimension

static constexpr unsigned int	OutputSpaceDimension

static constexpr unsigned int	ParametersDimension

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

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< double >
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 (double 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 InverseMatrixType &	GetInverseMatrix () const

virtual bool	GetSingular () const

const InverseMatrixType &	GetVarInverseMatrix () const

bool	InverseMatrixIsOld () const

void	PrintSelf (std::ostream &os, Indent indent) const override

void	SetVarCenter (const InputPointType &center)

void	SetVarInverseMatrix (const InverseMatrixType &matrix) const

void	SetVarMatrix (const MatrixType &matrix)

void	SetVarOffset (const OutputVectorType &offset)

void	SetVarTranslation (const OutputVectorType &translation)

	~MatrixOffsetTransformBase () override=default

	MatrixOffsetTransformBase (unsigned int paramDims=ParametersDimension)

Protected Member Functions inherited from itk::Transform< 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
ScaleType	m_Scale {}

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::Similarity2DTransform< TParametersValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 71 of file itkSimilarity2DTransform.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 106 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 114 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 101 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 110 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 90 of file itkTransform.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::Transform< TParametersValueType, VInputDimension, VOutputDimension >::JacobianPositionType = vnl_matrix_fixed<ParametersValueType, VOutputDimension, VInputDimension>

Definition at line 89 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 88 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 93 of file itkMatrixOffsetTransformBase.h.

◆ MatrixValueType

template<typename TParametersValueType = double>

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

Definition at line 94 of file itkMatrixOffsetTransformBase.h.

◆ OffsetType

template<typename TParametersValueType = double>

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

Definition at line 97 of file itkMatrixOffsetTransformBase.h.

◆ OffsetValueType

template<typename TParametersValueType = double>

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

Definition at line 98 of file itkMatrixOffsetTransformBase.h.

◆ OutputCovariantVectorType

template<typename TParametersValueType = double>

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

Definition at line 107 of file itkMatrixOffsetTransformBase.h.

◆ OutputPointType

template<typename TParametersValueType = double>

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

Definition at line 115 of file itkMatrixOffsetTransformBase.h.

◆ OutputVectorType

template<typename TParametersValueType = double>

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

Definition at line 102 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 111 of file itkMatrixOffsetTransformBase.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::Transform< TParametersValueType, VInputDimension, VOutputDimension >::ScalarType = ParametersValueType

Type of the scalar representing coordinate and vector elements.

Definition at line 79 of file itkTransform.h.

◆ ScaleType

template<typename TParametersValueType = double>

using itk::Similarity2DTransform< TParametersValueType >::ScaleType = TParametersValueType

Definition at line 86 of file itkSimilarity2DTransform.h.

◆ Self

template<typename TParametersValueType = double>

using itk::Similarity2DTransform< TParametersValueType >::Self = Similarity2DTransform

Standard class type aliases.

Definition at line 68 of file itkSimilarity2DTransform.h.

◆ Superclass

template<typename TParametersValueType = double>

using itk::Similarity2DTransform< TParametersValueType >::Superclass = Rigid2DTransform<TParametersValueType>

Definition at line 69 of file itkSimilarity2DTransform.h.

Constructor & Destructor Documentation

◆ Similarity2DTransform() [1/3]

template<typename TParametersValueType = double>

itk::Similarity2DTransform< TParametersValueType >::Similarity2DTransform	(	unsigned int	outputSpaceDimension,
		unsigned int	parametersDimension
	)

protected

◆ Similarity2DTransform() [2/3]

template<typename TParametersValueType = double>

itk::Similarity2DTransform< TParametersValueType >::Similarity2DTransform ( unsigned int parametersDimension )

protected

◆ Similarity2DTransform() [3/3]

template<typename TParametersValueType = double>

itk::Similarity2DTransform< TParametersValueType >::Similarity2DTransform ( )

protected

◆ ~Similarity2DTransform()

template<typename TParametersValueType = double>

itk::Similarity2DTransform< TParametersValueType >::~Similarity2DTransform ( )

overrideprotecteddefault

Member Function Documentation

◆ CloneInverseTo()

template<typename TParametersValueType = double>

void itk::Similarity2DTransform< TParametersValueType >::CloneInverseTo ( Pointer & result ) const

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

◆ CloneTo()

template<typename TParametersValueType = double>

void itk::Similarity2DTransform< TParametersValueType >::CloneTo ( Pointer & result ) const

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

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = double>

void itk::Similarity2DTransform< TParametersValueType >::ComputeJacobianWithRespectToParameters	(	const InputPointType &	p,
		JacobianType &	jacobian
	)		const

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

◆ 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::MatrixOffsetTransformBase< double, 2, 2 >.

◆ 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::Transform< double, VInputDimension, VOutputDimension >.

◆ GetNameOfClass()

template<typename TParametersValueType = double>

const char * itk::Similarity2DTransform< TParametersValueType >::GetNameOfClass ( ) const

override

See also: LightObject::GetNameOfClass()

◆ GetParameters()

template<typename TParametersValueType = double>

const ParametersType & itk::Similarity2DTransform< TParametersValueType >::GetParameters ( ) const

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

Implements TransformBaseTemplate< double >.

◆ GetScale()

template<typename TParametersValueType = double>

virtual const ScaleType & itk::Similarity2DTransform< TParametersValueType >::GetScale ( ) const

virtual

◆ New()

template<typename TParametersValueType = double>

static Pointer itk::Similarity2DTransform< TParametersValueType >::New ( )

static

New macro for creation of through a Smart Pointer.

◆ PrintSelf()

template<typename TParametersValueType = double>

void itk::Similarity2DTransform< TParametersValueType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotected

◆ SetIdentity()

template<typename TParametersValueType = double>

void itk::Similarity2DTransform< TParametersValueType >::SetIdentity ( )

overridevirtual

Set the transformation to an identity.

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

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

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 within the given tolerance.

Warning: This method will throw an exception if the matrix provided as argument is not valid.

See also: MatrixOffsetTransformBase::SetMatrix()

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

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

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

itkSimilarity2DTransform.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InputCovariantVectorType

◆ InputPointType

◆ InputVectorType

◆ InputVnlVectorType

◆ InverseJacobianPositionType

◆ InverseTransformBasePointer

◆ InverseTransformBaseType

◆ JacobianPositionType

◆ JacobianType

◆ MatrixType

◆ MatrixValueType

◆ OffsetType

◆ OffsetValueType

◆ OutputCovariantVectorType

◆ OutputPointType

◆ OutputVectorType

◆ OutputVnlVectorType

◆ Pointer

◆ ScalarType

◆ ScaleType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ Similarity2DTransform() [1/3]

◆ Similarity2DTransform() [2/3]

◆ Similarity2DTransform() [3/3]

◆ ~Similarity2DTransform()

Member Function Documentation

◆ CloneInverseTo()

◆ CloneTo()

◆ ComputeJacobianWithRespectToParameters()

◆ ComputeMatrix()

◆ ComputeMatrixParameters()

◆ GetInverse()

◆ GetInverseTransform()

◆ GetNameOfClass()

◆ GetParameters()

◆ GetScale()

◆ New()

◆ PrintSelf()

◆ SetIdentity()

◆ SetMatrix() [1/2]

◆ SetMatrix() [2/2]

◆ SetParameters()

◆ SetScale()

◆ SetVarScale()

Member Data Documentation

◆ InputSpaceDimension

◆ m_Scale

◆ OutputSpaceDimension

◆ ParametersDimension

◆ SpaceDimension