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

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

#include <itkRigid2DTransform.h>

Inheritance diagram for itk::Rigid2DTransform< TScalarType >:

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

[legend]List of all members.

Public Types
typedef Rigid2DTransform	Self
typedef MatrixOffsetTransformBase< TScalarType, 2, 2 >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ScalarType	ScalarType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::JacobianType	JacobianType
typedef Superclass::MatrixType	MatrixType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::InputVectorType	InputVectorType
typedef Superclass::OutputVectorType	OutputVectorType
typedef Superclass::InputCovariantVectorType	InputCovariantVectorType
typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType
typedef Superclass::InputVnlVectorType	InputVnlVectorType
typedef Superclass::OutputVnlVectorType	OutputVnlVectorType
typedef Superclass::InputPointType	InputPointType
typedef Superclass::OutputPointType	OutputPointType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetMatrix (const MatrixType &matrix)
void	Translate (const OffsetType &offset, bool pre=false)
InputCovariantVectorType	BackTransform (const OutputCovariantVectorType &vector) const
void	SetAngleInDegrees (TScalarType angle)
void	SetParameters (const ParametersType &parameters)
const ParametersType &	GetParameters (void) const
const JacobianType &	GetJacobian (const InputPointType &point) const
void	CloneInverseTo (Pointer &newinverse) const
void	CloneTo (Pointer &clone) const
virtual void	SetIdentity (void)
	itkStaticConstMacro (InputSpaceDimension, unsigned int, 2)
	itkStaticConstMacro (OutputSpaceDimension, unsigned int, 2)
	itkStaticConstMacro (ParametersDimension, unsigned int, 3)
virtual void	SetRotationMatrix (const MatrixType &matrix)
const MatrixType &	GetRotationMatrix () const
InputPointType	BackTransform (const OutputPointType &point) const
InputVectorType	BackTransform (const OutputVectorType &vector) const
InputVnlVectorType	BackTransform (const OutputVnlVectorType &vector) const
void	SetAngle (TScalarType angle)
virtual const TScalarType &	GetAngle ()
void	SetRotation (TScalarType angle)
virtual const TScalarType &	GetRotation () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	Rigid2DTransform ()
	Rigid2DTransform (unsigned int outputSpaceDimension, unsigned int parametersDimension)
	~Rigid2DTransform ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ComputeMatrix (void)
virtual void	ComputeMatrixParameters (void)
void	SetVarAngle (TScalarType angle)

---

Detailed Description

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

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

This transform applies a rigid transformation in 2D space. The transform is specified as a rotation around a arbitrary center and is followed by a translation.

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

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

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

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

See also:

Transfrom

MatrixOffsetTransformBase

Definition at line 57 of file itkRigid2DTransform.h.

---

Member Typedef Documentation

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

Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 65 of file itkRigid2DTransform.h.

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

Standard covariant vector type for this class. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 99 of file itkRigid2DTransform.h.

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

Standard coordinate point type for this class. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 107 of file itkRigid2DTransform.h. Referenced by itk::Rigid2DTransform< TScalarType >::SetRotation().

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

Standard vector type for this class. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 95 of file itkRigid2DTransform.h.

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

Standard vnl_vector type for this class. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 103 of file itkRigid2DTransform.h.

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

Jacobian type. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 86 of file itkRigid2DTransform.h. Referenced by itk::Rigid2DTransform< TScalarType >::SetRotation().

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

Standard matrix type for this class. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 89 of file itkRigid2DTransform.h.

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

Standard vector type for this class. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 92 of file itkRigid2DTransform.h.

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

Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 100 of file itkRigid2DTransform.h.

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

Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 108 of file itkRigid2DTransform.h.

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

Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 96 of file itkRigid2DTransform.h.

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

Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 104 of file itkRigid2DTransform.h.

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

Parameters type. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 83 of file itkRigid2DTransform.h. Referenced by itk::Rigid2DTransform< TScalarType >::SetRotation().

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

Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 64 of file itkRigid2DTransform.h. Referenced by itk::Rigid2DTransform< TScalarType >::SetRotation().

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

Scalar type. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 80 of file itkRigid2DTransform.h.

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

Standard class typedefs. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 62 of file itkRigid2DTransform.h. Referenced by itk::Rigid2DTransform< TScalarType >::SetVarAngle().

template<class TScalarType = double> typedef MatrixOffsetTransformBase< TScalarType, 2, 2 > itk::Rigid2DTransform< TScalarType >::Superclass

Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >. Definition at line 63 of file itkRigid2DTransform.h.

---

Constructor & Destructor Documentation

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

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

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

---

Member Function Documentation

template<class TScalarType = double> InputCovariantVectorType itk::Rigid2DTransform< TScalarType >::BackTransform (  const OutputCovariantVectorType &  vector  )  const [inline]

template<class TScalarType = double> InputVnlVectorType itk::Rigid2DTransform< TScalarType >::BackTransform (  const OutputVnlVectorType &  vector  )  const [inline]

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

template<class TScalarType = double> InputVectorType itk::Rigid2DTransform< TScalarType >::BackTransform (  const OutputVectorType &  vector  )  const [inline]

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

template<class TScalarType = double> InputPointType itk::Rigid2DTransform< TScalarType >::BackTransform (  const OutputPointType &  point  )  const [inline]

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

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

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

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

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

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

Compute the matrix from angle. This is used in Set methods to update the underlying matrix whenever a transform parameter is changed. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::Similarity2DTransform< TScalarType >.

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

Compute the angle from the matrix. This is used to compute transform parameters from a given matrix. This is used in MatrixOffsetTransformBase::Compose() and MatrixOffsetTransformBase::GetInverse(). Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::Similarity2DTransform< TScalarType >.

template<class TScalarType = double> virtual const TScalarType& itk::Rigid2DTransform< TScalarType >::GetAngle (   )  [virtual]

Set/Get the angle of rotation in radians

template<class TScalarType = double> const JacobianType& itk::Rigid2DTransform< 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::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >.

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

Run-time type information (and related methods). Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >.

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

Get the parameters that uniquely define the transform This is typically used by optimizers. There are 3 parameters. The first one represents the angle or rotation in radians and the last two represents the translation. The center of rotation is fixed. See also: Transform::GetParameters() Transform::GetFixedParameters() Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >.

template<class TScalarType = double> virtual const TScalarType& itk::Rigid2DTransform< TScalarType >::GetRotation (  void   )  const [inline, virtual]

Set/Get the angle of rotation in radians. These methods are old and are retained for backward compatibility. Instead, use SetAngle() and GetAngle(). Definition at line 174 of file itkRigid2DTransform.h.

template<class TScalarType = double> const MatrixType& itk::Rigid2DTransform< TScalarType >::GetRotationMatrix (   )  const [inline]

Set/Get the rotation matrix. These methods are old and are retained for backward compatibility. Instead, use SetMatrix() GetMatrix(). Definition at line 131 of file itkRigid2DTransform.h.

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

Dimension of the space. Reimplemented in itk::Euler2DTransform< TScalarType >.

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

Dimension of the space. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >.

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

Dimension of the space. Reimplemented in itk::CenteredSimilarity2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >.

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

New macro for creation of through a Smart Pointer Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >.

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

Print contents of an Rigid2DTransform Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, itk::Euler2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >.

template<class TScalarType = double> void itk::Rigid2DTransform< TScalarType >::SetAngle (  TScalarType  angle  )

Set/Get the angle of rotation in radians

template<class TScalarType = double> void itk::Rigid2DTransform< TScalarType >::SetAngleInDegrees (  TScalarType  angle  )

Set the angle of rotation in degrees.

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

Reset the parameters to create and identity transform. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::Similarity2DTransform< TScalarType >.

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

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

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

Set the transformation from a container of parameters This is typically used by optimizers. There are 3 parameters. The first one represents the angle of rotation in radians and the last two represents the translation. The center of rotation is fixed. See also: Transform::SetParameters() Transform::SetFixedParameters() Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >. Reimplemented in itk::CenteredRigid2DTransform< TScalarType >, itk::CenteredSimilarity2DTransform< TScalarType >, and itk::Similarity2DTransform< TScalarType >.

template<class TScalarType = double> void itk::Rigid2DTransform< TScalarType >::SetRotation (  TScalarType  angle  )  [inline]

Set/Get the angle of rotation in radians. These methods are old and are retained for backward compatibility. Instead, use SetAngle() and GetAngle(). Definition at line 172 of file itkRigid2DTransform.h. References itk::Rigid2DTransform< TScalarType >::InputPointType, itk::Rigid2DTransform< TScalarType >::JacobianType, itk::Rigid2DTransform< TScalarType >::ParametersType, and itk::Rigid2DTransform< TScalarType >::Pointer.

template<class TScalarType = double> virtual void itk::Rigid2DTransform< TScalarType >::SetRotationMatrix (  const MatrixType &  matrix  )  [inline, virtual]

Set/Get the rotation matrix. These methods are old and are retained for backward compatibility. Instead, use SetMatrix() GetMatrix(). Definition at line 129 of file itkRigid2DTransform.h.

template<class TScalarType = double> void itk::Rigid2DTransform< TScalarType >::SetVarAngle (  TScalarType  angle  )  [inline, protected]

Update angle without recomputation of other internal variables. Definition at line 243 of file itkRigid2DTransform.h. References itk::Rigid2DTransform< TScalarType >::Self.

template<class TScalarType = double> void itk::Rigid2DTransform< TScalarType >::Translate (  const OffsetType &  offset, bool  pre = false )

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

---

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

• itkRigid2DTransform.h

---