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 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 vnl_quaternion< TScalarType >	VnlQuaternionType
typedef Versor< TScalarType >	VersorType
typedef VersorType::VectorType	AxisType
typedef VersorType::ValueType	AngleType
Public Member Functions
virtual const char *	GetNameOfClass () const
void	SetParameters (const ParametersType &parameters)
const ParametersType &	GetParameters (void) const
virtual void	SetIdentity (void)
const JacobianType &	GetJacobian (const InputPointType &point) const
	itkStaticConstMacro (SpaceDimension, unsigned int, 3)
	itkStaticConstMacro (InputSpaceDimension, unsigned int, 3)
	itkStaticConstMacro (OutputSpaceDimension, unsigned int, 3)
	itkStaticConstMacro (ParametersDimension, unsigned int, 3)
void	SetRotation (const VersorType &versor)
void	SetRotation (const AxisType &axis, AngleType angle)
virtual const VersorType &	GetVersor ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	~VersorTransform ()
virtual void	SetRotationMatrix (const MatrixType &matrix)
void	SetVarVersor (const VersorType &newVersor)
void	PrintSelf (std::ostream &os, Indent indent) const
	VersorTransform (const MatrixType &matrix, const OutputVectorType &offset)
	VersorTransform (unsigned int outputDims, unsigned int paramDims)
	VersorTransform ()
void	ComputeMatrix (void)
void	ComputeMatrixParameters (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 to the space.

Definition at line 39 of file itkVersorTransform.h.

---

Member Typedef Documentation

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

Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 92 of file itkVersorTransform.h.

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

Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 91 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 79 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 48 of file itkVersorTransform.h.

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

Standard covariant vector type for this class Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 74 of file itkVersorTransform.h.

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

Standard coordinate point type for this class Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 67 of file itkVersorTransform.h.

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

Standard vector type for this class Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 69 of file itkVersorTransform.h.

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

Standard vnl_vector type for this class Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 71 of file itkVersorTransform.h.

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

Standard inverse matrix type for this class Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 78 of file itkVersorTransform.h.

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

Jacobian Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 65 of file itkVersorTransform.h.

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

Standard matrix type for this class Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 77 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 80 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 76 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 68 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 70 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 72 of file itkVersorTransform.h.

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

Parameters Type Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 64 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 47 of file itkVersorTransform.h.

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

Standard scalar type for this class Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 66 of file itkVersorTransform.h.

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

Standard Self Typedef Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 45 of file itkVersorTransform.h.

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

Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 46 of file itkVersorTransform.h.

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

Versor Type Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >. Definition at line 90 of file itkVersorTransform.h. Referenced by itk::VersorTransform< TScalarType >::SetRotationMatrix().

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

VnlQuaternion Type Definition at line 85 of file itkVersorTransform.h.

---

Constructor & Destructor Documentation

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

Construct an VersorTransform object

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

Construct an VersorTransform object

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

Construct an VersorTransform object

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

Destroy an VersorTransform object Definition at line 147 of file itkVersorTransform.h.

---

Member Function Documentation

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

Compute Matrix Compute the components of the rotation matrix in the superclass Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, and itk::Similarity3DTransform< TScalarType >.

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

Compute Matrix Compute the components of the rotation matrix in the superclass Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >. Reimplemented in itk::ScaleSkewVersor3DTransform< 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::MatrixOffsetTransformBase< TScalarType, 3, 3 >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

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

Run-time type information (and related methods). Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

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

Get the Transformation Parameters. Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

template<class TScalarType = double> virtual const VersorType& itk::VersorTransform< TScalarType >::GetVersor (   )  [virtual]

Set the rotational part of the transform

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

Dimension of parameters

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

Dimension of parameters Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

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

Dimension of parameters Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

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

Dimension of parameters Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

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

New macro for creation of through a Smart Pointer Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< 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 >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

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

Set the parameters to the IdentityTransform Reimplemented from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >. Reimplemented in itk::ScaleSkewVersor3DTransform< 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::MatrixOffsetTransformBase< TScalarType, 3, 3 >. Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

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

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

This method must be made protected here because it is not a safe way of initializing the Versor Reimplemented from itk::Rigid3DTransform< TScalarType >. Reimplemented in itk::VersorRigid3DTransform< TScalarType >. Definition at line 151 of file itkVersorTransform.h. References itk::VersorTransform< TScalarType >::VersorType.

template<class TScalarType = double> void itk::VersorTransform< TScalarType >::SetVarVersor (  const VersorType &  newVersor  )  [inline, protected]

Definition at line 154 of file itkVersorTransform.h.

---

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

• itkVersorTransform.h

---