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

#include <itkVersorTransform.h>

Inheritance diagram for itk::VersorTransform< TScalarType >:

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

[legend]List of all members.

Public Types
typedef VersorTransform	Self
typedef Rigid3DTransform< TScalarType >	Superclass
typedef Superclass::ScalarType	ScalarType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::JacobianType	JacobianType
typedef Superclass::VnlQuaternionType	VnlQuaternionType
typedef Superclass::VersorType	VersorType
typedef VersorType::VectorType	AxisType
typedef VersorType::ValueType	AngleType
typedef Superclass::OffsetType	OffsetType
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
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
Public Member Functions
	itkStaticConstMacro (SpaceDimension, unsigned int, 3)
	itkStaticConstMacro (ParametersDimension, unsigned int, 3)
virtual const char *	GetClassName () const
void	SetParameters (const ParametersType &parameters)
const JacobianType &	GetJacobian (const InputPointType &point) const
void	SetRotation (const VersorType &versor)
void	SetRotation (const AxisType &axis, AngleType angle)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	VersorTransform ()
	VersorTransform (const Self &other)
	~VersorTransform ()
const Self &	operator= (const Self &)
void	ComputeMatrix (void)

---

Detailed Description

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

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

This transform applies a rotation and translation to the space

Definition at line 37 of file itkVersorTransform.h.

---

Member Typedef Documentation

template<class TScalarType = double> typedef VersorType::ValueType itk::VersorTransform< TScalarType >::AngleType

Definition at line 85 of file itkVersorTransform.h.

template<class TScalarType = double> typedef VersorType::VectorType itk::VersorTransform< TScalarType >::AxisType

Definition at line 84 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 123 of file itkVersorTransform.h.

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

CovariantVector Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 107 of file itkVersorTransform.h.

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

Point Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 95 of file itkVersorTransform.h.

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

Vector Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 101 of file itkVersorTransform.h.

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

VnlVector Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 113 of file itkVersorTransform.h.

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

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

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

Offset Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 90 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 108 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 96 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 102 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 114 of file itkVersorTransform.h.

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

Parameters Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 67 of file itkVersorTransform.h.

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

Smart pointer typedef support Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 122 of file itkVersorTransform.h.

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

Scalar Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 61 of file itkVersorTransform.h.

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

Standard Self Typedef Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 45 of file itkVersorTransform.h. Referenced by itk::VersorTransform< TScalarType >::~VersorTransform().

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

Standard "Superclass" typedef. Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 55 of file itkVersorTransform.h.

template<class TScalarType = double> typedef Superclass::VersorType itk::VersorTransform< TScalarType >::VersorType

Versor Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 83 of file itkVersorTransform.h. Referenced by itk::VersorTransform< TScalarType >::~VersorTransform().

template<class TScalarType = double> typedef Superclass::VnlQuaternionType itk::VersorTransform< TScalarType >::VnlQuaternionType

VnlQuaternion Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Definition at line 78 of file itkVersorTransform.h.

---

Constructor & Destructor Documentation

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

Construct an VersorTransform object

template<class TScalarType = double> itk::VersorTransform< TScalarType >::VersorTransform (  const Self &  other  )  [protected]

Copy a VersorTransform object This method creates a new VersorTransform object and initializes it to be a copy of an existing VersorTransform.

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

Destroy an VersorTransform object Definition at line 194 of file itkVersorTransform.h. References itk::VersorTransform< TScalarType >::Self, and itk::VersorTransform< TScalarType >::VersorType.

---

Member Function Documentation

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

Compute Matrix Compute the components of the rotation matrix in the superclass

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

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

template<class TScalarType = double> const JacobianType& itk::VersorTransform< 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> itk::VersorTransform< TScalarType >::itkStaticConstMacro (  ParametersDimension  , unsigned  int, 3  )

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

Dimension of parameters.

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

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

template<class TScalarType = double> const Self& itk::VersorTransform< TScalarType >::operator= (  const Self &   )  [protected]

Assignment operator Reimplemented from itk::Rigid3DTransform< TScalarType >.

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

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

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

Set the transformation from a container of parameters This is typically used by optimizers. There are 3 parameters. They represent the components of the right part of the versor. This can be seen as the components of the vector parallel to the rotation axis and multiplied by sin( angle / 2 ). Reimplemented from itk::Transform< TScalarType, 3, 3 >.

template<class TScalarType = double> void itk::VersorTransform< TScalarType >::SetRotation (  const AxisType &  axis, AngleType  angle )

Set the rotational part of the transform

template<class TScalarType = double> void itk::VersorTransform< TScalarType >::SetRotation (  const VersorType &  versor  )

Set the rotational part of the transform

---

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

• itkVersorTransform.h

---