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

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

#include <itkQuaternionRigidTransform.h>

Inheritance diagram for itk::QuaternionRigidTransform< TScalarType >:

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

[legend]List of all members.

Public Types
typedef QuaternionRigidTransform	Self
typedef Rigid3DTransform< TScalarType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ScalarType	ScalarType
typedef Superclass::InputVectorType	InputVectorType
typedef Superclass::OutputVectorType	OutputVectorType
typedef Superclass::InputVnlVectorType	InputVnlVectorType
typedef Superclass::OutputVnlVectorType	OutputVnlVectorType
typedef Superclass::InputCovariantVectorType	InputCovariantVectorType
typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::JacobianType	JacobianType
typedef vnl_quaternion< TScalarType >	VnlQuaternionType
typedef Superclass::MatrixType	MatrixType
typedef Vector< TScalarType, itkGetStaticConstMacro(InputSpaceDimension)	OffsetType )
typedef Superclass::InputPointType	InputPointType
typedef Superclass::OutputPointType	OutputPointType
Public Member Functions
virtual const char *	GetClassName () const
const VnlQuaternionType &	GetRotation (void) const
virtual void	SetIdentity (void)
void	SetRotation (const VnlQuaternionType &rotation)
virtual void	ComputeOffset (void)
const JacobianType &	GetJacobian (const InputPointType &point) const
	itkStaticConstMacro (SpaceDimension, unsigned int, 3)
	itkStaticConstMacro (ParametersDimension, unsigned int, 7)
	itkStaticConstMacro (InputSpaceDimension, unsigned int, Superclass::InputSpaceDimension)
	itkStaticConstMacro (OutputSpaceDimension, unsigned int, Superclass::OutputSpaceDimension)
void	SetCenter (const InputPointType &center)
virtual const InputPointType &	GetCenter ()
void	SetTranslation (const OutputVectorType &translation)
virtual const OutputVectorType &	GetTranslation ()
void	SetParameters (const ParametersType &parameters)
virtual const ParametersType &	GetParameters () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	QuaternionRigidTransform ()
	~QuaternionRigidTransform ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

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

This transform applies a rotation and translation to the space

Definition at line 34 of file itkQuaternionRigidTransform.h.

---

Member Typedef Documentation

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 43 of file itkQuaternionRigidTransform.h.

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

Standard covariant vector type for this class. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 59 of file itkQuaternionRigidTransform.h.

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

Standard coordinate point type for this class. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 90 of file itkQuaternionRigidTransform.h. Referenced by itk::QuaternionRigidTransform< TScalarType >::GetRotation(), and itk::QuaternionRigidTransform< TScalarType >::~QuaternionRigidTransform().

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

Vector type. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 55 of file itkQuaternionRigidTransform.h.

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

Standard vnl_vector type for this class. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 57 of file itkQuaternionRigidTransform.h.

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

Jacobian type. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 66 of file itkQuaternionRigidTransform.h. Referenced by itk::QuaternionRigidTransform< TScalarType >::GetRotation().

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

Standard matrix type for this class. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 84 of file itkQuaternionRigidTransform.h.

template<class TScalarType = double> typedef Vector<TScalarType, itkGetStaticConstMacro(InputSpaceDimension) itk::QuaternionRigidTransform< TScalarType >::OffsetType)

Standard vector type for this class. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 87 of file itkQuaternionRigidTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 60 of file itkQuaternionRigidTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 91 of file itkQuaternionRigidTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 56 of file itkQuaternionRigidTransform.h. Referenced by itk::QuaternionRigidTransform< TScalarType >::GetRotation(), and itk::QuaternionRigidTransform< TScalarType >::~QuaternionRigidTransform().

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 58 of file itkQuaternionRigidTransform.h.

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

Parameters type. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 63 of file itkQuaternionRigidTransform.h. Referenced by itk::QuaternionRigidTransform< TScalarType >::GetRotation().

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 42 of file itkQuaternionRigidTransform.h.

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

Scalar type. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 52 of file itkQuaternionRigidTransform.h.

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

Standard class typedefs. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 39 of file itkQuaternionRigidTransform.h.

template<class TScalarType = double> typedef Rigid3DTransform< TScalarType > itk::QuaternionRigidTransform< TScalarType >::Superclass

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 40 of file itkQuaternionRigidTransform.h.

template<class TScalarType = double> typedef vnl_quaternion<TScalarType> itk::QuaternionRigidTransform< TScalarType >::VnlQuaternionType

VnlQuaternion type. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 69 of file itkQuaternionRigidTransform.h. Referenced by itk::QuaternionRigidTransform< TScalarType >::GetRotation(), and itk::QuaternionRigidTransform< TScalarType >::~QuaternionRigidTransform().

---

Constructor & Destructor Documentation

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

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

Definition at line 145 of file itkQuaternionRigidTransform.h. References itk::QuaternionRigidTransform< TScalarType >::InputPointType, itk::QuaternionRigidTransform< TScalarType >::OutputVectorType, and itk::QuaternionRigidTransform< TScalarType >::VnlQuaternionType.

---

Member Function Documentation

template<class TScalarType = double> virtual void itk::QuaternionRigidTransform< TScalarType >::ComputeOffset (  void   )  [virtual]

Compute the offset using the rotation center, the matrix and the final translation. This method MUST be called before using the transform for any mapping.

template<class TScalarType = double> virtual const InputPointType& itk::QuaternionRigidTransform< TScalarType >::GetCenter (   )  [virtual]

Set and Get the center of rotation

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

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

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

Compute the Jacobian of the transformation. This method computes the Jacobian matrix of the transformation. given point or vector, returning the transformed point or vector. The rank of the Jacobian will also indicate if the transform is invertible at this point. Reimplemented from itk::Rigid3DTransform< TScalarType >.

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

Set the transformation from a container of parameters. This is typically used by optimizers. There are 7 parameters. The first four represents the quaternion and the last three represents the offset. Reimplemented from itk::Transform< TScalarType, 3, 3 >.

template<class TScalarType = double> const VnlQuaternionType& itk::QuaternionRigidTransform< TScalarType >::GetRotation (  void   )  const [inline]

Get the rotation from an QuaternionRigidTransform. This method returns the value of the rotation of the QuaternionRigidTransform. * Definition at line 97 of file itkQuaternionRigidTransform.h. References itk::QuaternionRigidTransform< TScalarType >::InputPointType, itk::QuaternionRigidTransform< TScalarType >::JacobianType, itk::QuaternionRigidTransform< TScalarType >::OutputVectorType, itk::QuaternionRigidTransform< TScalarType >::ParametersType, and itk::QuaternionRigidTransform< TScalarType >::VnlQuaternionType.

template<class TScalarType = double> virtual const OutputVectorType& itk::QuaternionRigidTransform< TScalarType >::GetTranslation (   )  [virtual]

Set and Get the Translation to be applied after rotation

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

Dimension of the domain space.

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

Dimension of the domain space.

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

Dimension of parameters

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

Dimension of parameters

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

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

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

Print contents of an Rigid3DTransform Reimplemented from itk::Rigid3DTransform< TScalarType >.

template<class TScalarType = double> void itk::QuaternionRigidTransform< TScalarType >::SetCenter (  const InputPointType &  center  )

Set and Get the center of rotation

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

Set the parameters to the IdentityTransform Reimplemented from itk::Rigid3DTransform< TScalarType >.

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

Set the transformation from a container of parameters. This is typically used by optimizers. There are 7 parameters. The first four represents the quaternion and the last three represents the offset. Reimplemented from itk::Transform< TScalarType, 3, 3 >.

template<class TScalarType = double> void itk::QuaternionRigidTransform< TScalarType >::SetRotation (  const VnlQuaternionType &  rotation  )

Set the rotation of the rigid transform. This method sets the rotation of a QuaternionRigidTransform to a value specified by the user.

template<class TScalarType = double> void itk::QuaternionRigidTransform< TScalarType >::SetTranslation (  const OutputVectorType &  translation  )

Set and Get the Translation to be applied after rotation

---

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

• itkQuaternionRigidTransform.h

---