itk::Similarity2DTransform< TScalarType > Class Template Reference
[Transforms]

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

#include <itkSimilarity2DTransform.h>

Inheritance diagram for itk::Similarity2DTransform< TScalarType >:

[legend]Collaboration diagram for itk::Similarity2DTransform< TScalarType >:

[legend]List of all members.

Public Types
typedef Similarity2DTransform	Self
typedef Rigid2DTransform< TScalarType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ScalarType	ScalarType
typedef TScalarType	ScaleType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::JacobianType	JacobianType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::MatrixType	MatrixType
typedef Superclass::InputPointType	InputPointType
typedef Superclass::OutputPointType	OutputPointType
typedef Superclass::InputVectorType	InputVectorType
typedef Superclass::OutputVectorType	OutputVectorType
typedef Superclass::InputCovariantVectorType	InputCovariantVectorType
typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType
typedef Superclass::InputVnlVectorType	InputVnlVectorType
typedef Superclass::OutputVnlVectorType	OutputVnlVectorType
Public Member Functions
virtual const char *	GetNameOfClass () const
void	SetParameters (const ParametersType &parameters)
const ParametersType &	GetParameters (void) const
const JacobianType &	GetJacobian (const InputPointType &point) const
virtual void	SetIdentity (void)
void	CloneInverseTo (Pointer &newinverse) const
void	CloneTo (Pointer &clone) const
virtual void	SetMatrix (const MatrixType &matrix)
	itkStaticConstMacro (SpaceDimension, unsigned int, 2)
	itkStaticConstMacro (InputSpaceDimension, unsigned int, 2)
	itkStaticConstMacro (OutputSpaceDimension, unsigned int, 2)
	itkStaticConstMacro (ParametersDimension, unsigned int, 4)
void	SetScale (ScaleType scale)
virtual const ScaleType &	GetScale ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	Similarity2DTransform ()
	Similarity2DTransform (unsigned int spaceDimension, unsigned int parametersDimension)
	~Similarity2DTransform ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ComputeMatrix (void)
virtual void	ComputeMatrixParameters (void)
void	SetVarScale (ScaleType scale)

---

Detailed Description

template<class TScalarType = double>
class itk::Similarity2DTransform< TScalarType >

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

This transform applies a homogenous 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.

---

Member Typedef Documentation

template<class TScalarType = double> typedef SmartPointer<const Self> itk::Similarity2DTransform< TScalarType >::ConstPointer

Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 70 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::InputCovariantVectorType itk::Similarity2DTransform< TScalarType >::InputCovariantVectorType

CovariantVector type. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 110 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::InputPointType itk::Similarity2DTransform< TScalarType >::InputPointType

Point type. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 102 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::InputVectorType itk::Similarity2DTransform< TScalarType >::InputVectorType

Vector type. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 106 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::InputVnlVectorType itk::Similarity2DTransform< TScalarType >::InputVnlVectorType

VnlVector type. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 114 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::JacobianType itk::Similarity2DTransform< TScalarType >::JacobianType

Jacobian type. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 93 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::MatrixType itk::Similarity2DTransform< TScalarType >::MatrixType

Matrix type. Reimplemented from itk::Rigid2DTransform< TScalarType >. Definition at line 99 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::OffsetType itk::Similarity2DTransform< TScalarType >::OffsetType

Offset type. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 96 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::OutputCovariantVectorType itk::Similarity2DTransform< TScalarType >::OutputCovariantVectorType

Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 111 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::OutputPointType itk::Similarity2DTransform< TScalarType >::OutputPointType

Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 103 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::OutputVectorType itk::Similarity2DTransform< TScalarType >::OutputVectorType

Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 107 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::OutputVnlVectorType itk::Similarity2DTransform< TScalarType >::OutputVnlVectorType

Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 115 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::ParametersType itk::Similarity2DTransform< TScalarType >::ParametersType

Parameters type. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 90 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef SmartPointer<Self> itk::Similarity2DTransform< TScalarType >::Pointer

Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 69 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef Superclass::ScalarType itk::Similarity2DTransform< TScalarType >::ScalarType

Scalar type. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 86 of file itkSimilarity2DTransform.h.

template<class TScalarType = double> typedef TScalarType itk::Similarity2DTransform< TScalarType >::ScaleType

Definition at line 87 of file itkSimilarity2DTransform.h. Referenced by itk::Similarity2DTransform< TScalarType >::SetVarScale(), and itk::Similarity2DTransform< TScalarType >::~Similarity2DTransform().

template<class TScalarType = double> typedef Similarity2DTransform itk::Similarity2DTransform< TScalarType >::Self

Standard class typedefs. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 67 of file itkSimilarity2DTransform.h. Referenced by itk::Similarity2DTransform< TScalarType >::SetVarScale().

template<class TScalarType = double> typedef Rigid2DTransform< TScalarType > itk::Similarity2DTransform< TScalarType >::Superclass

Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >. Definition at line 68 of file itkSimilarity2DTransform.h.

---

Constructor & Destructor Documentation

template<class TScalarType = double> itk::Similarity2DTransform< TScalarType >::Similarity2DTransform (   )  [protected]

template<class TScalarType = double> itk::Similarity2DTransform< TScalarType >::Similarity2DTransform (  unsigned int  spaceDimension, unsigned int  parametersDimension )  [protected]

template<class TScalarType = double> itk::Similarity2DTransform< TScalarType >::~Similarity2DTransform (   )  [inline, protected]

Definition at line 185 of file itkSimilarity2DTransform.h. References itk::Similarity2DTransform< TScalarType >::ScaleType.

---

Member Function Documentation

template<class TScalarType = double> void itk::Similarity2DTransform< TScalarType >::CloneInverseTo (  Pointer &  newinverse  )  const

This method creates and returns a new Similarity2DTransform object which is the inverse of self. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> void itk::Similarity2DTransform< TScalarType >::CloneTo (  Pointer &  clone  )  const

This method creates and returns a new Similarity2DTransform object which has the same parameters. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> virtual void itk::Similarity2DTransform< TScalarType >::ComputeMatrix (  void   )  [protected, virtual]

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

template<class TScalarType = double> virtual void itk::Similarity2DTransform< TScalarType >::ComputeMatrixParameters (  void   )  [protected, virtual]

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

template<class TScalarType = double> const JacobianType& itk::Similarity2DTransform< TScalarType >::GetJacobian (  const InputPointType &  point  )  const [virtual]

This method computes the Jacobian matrix of the transformation at a given input point. See also: Transform::GetJacobian() Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> virtual const char* itk::Similarity2DTransform< TScalarType >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> const ParametersType& itk::Similarity2DTransform< TScalarType >::GetParameters (  void   )  const [virtual]

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< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> virtual const ScaleType& itk::Similarity2DTransform< TScalarType >::GetScale (   )  [virtual]

Set the Scale part of the transform.

template<class TScalarType = double> itk::Similarity2DTransform< TScalarType >::itkStaticConstMacro (  ParametersDimension  , unsigned  int, 4  )

Dimension of parameters.

template<class TScalarType = double> itk::Similarity2DTransform< TScalarType >::itkStaticConstMacro (  OutputSpaceDimension  , unsigned  int, 2  )

Dimension of parameters. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> itk::Similarity2DTransform< TScalarType >::itkStaticConstMacro (  InputSpaceDimension  , unsigned  int, 2  )

Dimension of parameters. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> itk::Similarity2DTransform< TScalarType >::itkStaticConstMacro (  SpaceDimension  , unsigned  int, 2  )

Dimension of parameters. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> Pointer itk::Similarity2DTransform< TScalarType >::New (   )  [static]

New macro for creation of through a Smart Pointer. Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> void itk::Similarity2DTransform< TScalarType >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Print contents of an Rigid2DTransform Reimplemented from itk::Rigid2DTransform< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> virtual void itk::Similarity2DTransform< TScalarType >::SetIdentity (  void   )  [virtual]

Set the transformation to an identity. Reimplemented from itk::Rigid2DTransform< TScalarType >.

template<class TScalarType = double> virtual void itk::Similarity2DTransform< TScalarType >::SetMatrix (  const MatrixType &  matrix  )  [virtual]

Set the rotation Matrix of a Similarity 2D Transform This method sets the 2x2 matrix representing a similarity transform. The Matrix is expected to be a valid similarity transform with a certain tolerance. Warning: This method will throw an exception if the matrix provided as argument is not valid. See also: MatrixOffsetTransformBase::SetMatrix() Reimplemented from itk::Rigid2DTransform< TScalarType >.

template<class TScalarType = double> void itk::Similarity2DTransform< TScalarType >::SetParameters (  const ParametersType &  parameters  )  [virtual]

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< TScalarType >. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >.

template<class TScalarType = double> void itk::Similarity2DTransform< TScalarType >::SetScale (  ScaleType  scale  )

Set the Scale part of the transform.

template<class TScalarType = double> void itk::Similarity2DTransform< TScalarType >::SetVarScale (  ScaleType  scale  )  [inline, protected]

Set the scale without updating underlying variables. Definition at line 200 of file itkSimilarity2DTransform.h. References itk::Similarity2DTransform< TScalarType >::ScaleType, and itk::Similarity2DTransform< TScalarType >::Self.

---

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

• itkSimilarity2DTransform.h

---