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::ParametersType	ParametersType
typedef Superclass::JacobianType	JacobianType
typedef Superclass::ScalarType	ScalarType
typedef Superclass::InputPointType	InputPointType
typedef Superclass::OutputPointType	OutputPointType
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::MatrixType	MatrixType
typedef Superclass::InverseMatrixType	InverseMatrixType
typedef Superclass::CenterType	CenterType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::TranslationType	TranslationType
typedef vnl_quaternion< TScalarType >	VnlQuaternionType
Public Member Functions
virtual const char *	GetNameOfClass () const
void	SetRotation (const VnlQuaternionType &rotation)
const VnlQuaternionType &	GetRotation (void) const
virtual void	SetIdentity (void)
const JacobianType &	GetJacobian (const InputPointType &point) const
	itkStaticConstMacro (InputSpaceDimension, unsigned int, 3)
	itkStaticConstMacro (OutputSpaceDimension, unsigned int, 3)
	itkStaticConstMacro (SpaceDimension, unsigned int, 3)
	itkStaticConstMacro (ParametersDimension, unsigned int, 7)
void	SetParameters (const ParametersType &parameters)
virtual const ParametersType &	GetParameters () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	QuaternionRigidTransform (const MatrixType &matrix, const OutputVectorType &offset)
	QuaternionRigidTransform (unsigned int outputDims, unsigned int paramDims)
	QuaternionRigidTransform ()
	~QuaternionRigidTransform ()
void	ComputeMatrix ()
void	ComputeMatrixParameters ()
void	SetVarRotation (const VnlQuaternionType &rotation)
const InverseMatrixType &	GetInverseMatrix (void) const
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 Superclass::CenterType itk::QuaternionRigidTransform< TScalarType >::CenterType

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

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 42 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 68 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 61 of file itkQuaternionRigidTransform.h. Referenced by itk::QuaternionRigidTransform< TScalarType >::GetRotation().

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

Standard vector type for this class Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 63 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 65 of file itkQuaternionRigidTransform.h.

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

Standard inverse matrix type for this class Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 72 of file itkQuaternionRigidTransform.h. Referenced by itk::QuaternionRigidTransform< TScalarType >::SetVarRotation().

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

Jacobian Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 59 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 71 of file itkQuaternionRigidTransform.h. Referenced by itk::QuaternionRigidTransform< TScalarType >::GetRotation().

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

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

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

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

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

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

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

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

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 66 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 58 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 41 of file itkQuaternionRigidTransform.h.

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

Standard scalar type for this class Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 60 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. Referenced by itk::QuaternionRigidTransform< TScalarType >::SetVarRotation().

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 Superclass::TranslationType itk::QuaternionRigidTransform< TScalarType >::TranslationType

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

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

VnlQuaternion type. Definition at line 79 of file itkQuaternionRigidTransform.h. Referenced by itk::QuaternionRigidTransform< TScalarType >::SetVarRotation(), and itk::QuaternionRigidTransform< TScalarType >::~QuaternionRigidTransform().

---

Constructor & Destructor Documentation

template<class TScalarType = double> itk::QuaternionRigidTransform< TScalarType >::QuaternionRigidTransform (  const MatrixType &  matrix, const OutputVectorType &  offset )  [protected]

template<class TScalarType = double> itk::QuaternionRigidTransform< TScalarType >::QuaternionRigidTransform (  unsigned int  outputDims, unsigned int  paramDims )  [protected]

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

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

Definition at line 119 of file itkQuaternionRigidTransform.h. References itk::QuaternionRigidTransform< TScalarType >::VnlQuaternionType.

---

Member Function Documentation

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

Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

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

Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

template<class TScalarType = double> const InverseMatrixType& itk::QuaternionRigidTransform< TScalarType >::GetInverseMatrix (  void   )  const [protected]

Deprecated: Use GetInverse instead. Method will eventually be made a protected member function Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

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::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

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

Run-time type information (and related methods). 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::MatrixOffsetTransformBase< 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 91 of file itkQuaternionRigidTransform.h. References itk::QuaternionRigidTransform< TScalarType >::InputPointType, itk::QuaternionRigidTransform< TScalarType >::JacobianType, itk::QuaternionRigidTransform< TScalarType >::MatrixType, itk::QuaternionRigidTransform< TScalarType >::OutputVectorType, and itk::QuaternionRigidTransform< TScalarType >::ParametersType.

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 Reimplemented from itk::Rigid3DTransform< TScalarType >.

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

Dimension of parameters Reimplemented from itk::Rigid3DTransform< TScalarType >.

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

Dimension of parameters Reimplemented from itk::Rigid3DTransform< TScalarType >.

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> virtual void itk::QuaternionRigidTransform< TScalarType >::SetIdentity (  void   )  [virtual]

Set the parameters to the IdentityTransform Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >.

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::MatrixOffsetTransformBase< 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 >::SetVarRotation (  const VnlQuaternionType &  rotation  )  [inline, protected]

Definition at line 125 of file itkQuaternionRigidTransform.h. References itk::QuaternionRigidTransform< TScalarType >::InverseMatrixType, itk::QuaternionRigidTransform< TScalarType >::Self, and itk::QuaternionRigidTransform< TScalarType >::VnlQuaternionType.

---

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

• itkQuaternionRigidTransform.h

---