ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::VersorTransform< TScalarType > Class Template Reference

#include <itkVersorTransform.h>

+ Inheritance diagram for itk::VersorTransform< TScalarType >:
+ Collaboration diagram for itk::VersorTransform< TScalarType >:

List of all members.

Public Types

typedef VersorType::ValueType AngleType
typedef VersorType::VectorType AxisType
typedef AxisType::ValueType AxisValueType
typedef Superclass::CenterType CenterType
typedef SmartPointer< const SelfConstPointer
typedef
Superclass::InputCovariantVectorType 
InputCovariantVectorType
typedef Superclass::InputPointType InputPointType
typedef Superclass::InputVectorType InputVectorType
typedef
Superclass::InputVnlVectorType 
InputVnlVectorType
typedef
Superclass::InverseMatrixType 
InverseMatrixType
typedef Superclass::JacobianType JacobianType
typedef Superclass::MatrixType MatrixType
typedef Superclass::OffsetType OffsetType
typedef
Superclass::OutputCovariantVectorType 
OutputCovariantVectorType
typedef Superclass::OutputPointType OutputPointType
typedef
Superclass::OutputVectorType 
OutputVectorType
typedef
Superclass::OutputVnlVectorType 
OutputVnlVectorType
typedef Superclass::ParametersType ParametersType
typedef ParametersType::ValueType ParameterValueType
typedef SmartPointer< SelfPointer
typedef Superclass::ScalarType ScalarType
typedef VersorTransform Self
typedef Rigid3DTransform
< TScalarType > 
Superclass
typedef Versor< TScalarType > VersorType
typedef vnl_quaternion
< TScalarType > 
VnlQuaternionType
- Public Types inherited from itk::Rigid3DTransform< TScalarType >
typedef
InverseTransformBaseType::Pointer 
InverseTransformBasePointer
typedef
Superclass::InverseTransformBaseType 
InverseTransformBaseType
typedef Superclass::MatrixValueType MatrixValueType
typedef
Superclass::OutputVectorValueType 
OutputVectorValueType
typedef
Superclass::ParametersValueType 
ParametersValueType
typedef Superclass::TranslationType TranslationType
- Public Types inherited from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >
typedef
Superclass::InputDiffusionTensor3DType 
InputDiffusionTensor3DType
typedef
Superclass::InputSymmetricSecondRankTensorType 
InputSymmetricSecondRankTensorType
typedef CovariantVector
< TScalarType,
InputDiffusionTensor3DType::Dimension > 
InputTensorEigenVectorType
typedef
Superclass::InputVectorPixelType 
InputVectorPixelType
typedef OffsetType::ValueType OffsetValueType
typedef
Superclass::OutputDiffusionTensor3DType 
OutputDiffusionTensor3DType
typedef
Superclass::OutputSymmetricSecondRankTensorType 
OutputSymmetricSecondRankTensorType
typedef
Superclass::OutputVectorPixelType 
OutputVectorPixelType
typedef TranslationType::ValueType TranslationValueType
typedef InputPointType::ValueType InputPointValueType
typedef OutputPointType::ValueType OutputPointValueType
- Public Types inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >
typedef Array
< ParametersValueType
DerivativeType
typedef Matrix< double,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 
DirectionChangeMatrix
typedef Matrix< double,
itkGetStaticConstMacro(InputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 
InputDirectionMatrix
typedef
Superclass::NumberOfParametersType 
NumberOfParametersType
typedef Matrix< double,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(OutputSpaceDimension)> 
OutputDirectionMatrix
- Public Types inherited from itk::TransformBase
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual void ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
const ParametersTypeGetParameters (void) const
virtual const VersorTypeGetVersor ()
virtual void SetIdentity (void)
void SetParameters (const ParametersType &parameters)
void SetRotation (const VersorType &versor)
void SetRotation (const AxisType &axis, AngleType angle)
- Public Member Functions inherited from itk::Rigid3DTransform< TScalarType >
bool MatrixIsOrthogonal (const MatrixType &matrix, double tol=1e-10)
virtual void SetMatrix (const MatrixType &matrix)
void Translate (const OffsetType &offset, bool pre=false)
 itkLegacyMacro (InputPointType BackTransform(const OutputPointType &point) const)
 itkLegacyMacro (InputVectorType BackTransform(const OutputVectorType &vector) const)
 itkLegacyMacro (InputVnlVectorType BackTransform(const OutputVnlVectorType &vector) const)
 itkLegacyMacro (InputCovariantVectorType BackTransform(const OutputCovariantVectorType &vector) const)
- Public Member Functions inherited from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >
void Compose (const Self *other, bool pre=0)
virtual void ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, JacobianType &jac) const
virtual void ComputeJacobianWithRespectToParameters (const InputPointType &x, JacobianType &j) const
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianType &jac) const
const InputPointTypeGetCenter () const
virtual const ParametersTypeGetFixedParameters (void) const
virtual InverseTransformBasePointer GetInverseTransform () const
virtual const MatrixTypeGetMatrix () const
const OutputVectorTypeGetOffset (void) const
const OutputVectorTypeGetTranslation (void) const
virtual bool IsLinear () const
virtual void SetFixedParameters (const ParametersType &)
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector) const
OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector) const
OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const
OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const
OutputPointType TransformPoint (const InputPointType &point) const
OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor) const
OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor) const
OutputVectorType TransformVector (const InputVectorType &vector) const
OutputVnlVectorType TransformVector (const InputVnlVectorType &vector) const
OutputVectorPixelType TransformVector (const InputVectorPixelType &vector) const
virtual void SetMatrix (const MatrixType &matrix)
void SetOffset (const OutputVectorType &offset)
void SetCenter (const InputPointType &center)
void SetTranslation (const OutputVectorType &translation)
bool GetInverse (Self *inverse) const
- Public Member Functions inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >
unsigned int GetInputSpaceDimension (void) const
virtual NumberOfParametersType GetNumberOfLocalParameters (void) const
virtual NumberOfParametersType GetNumberOfParameters (void) const
unsigned int GetOutputSpaceDimension (void) const
virtual std::string GetTransformTypeAsString () const
virtual bool HasLocalSupport () const
 itkCloneMacro (Self)
virtual void SetParametersByValue (const ParametersType &p)
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor, const InputPointType &point) const
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor, const InputPointType &point) const
virtual
OutputSymmetricSecondRankTensorType 
TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor, const InputPointType &point) const
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor, const InputPointType &point) const
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
virtual void UpdateTransformParameters (const DerivativeType &update, TScalarType factor=1.0)
- Public Member Functions inherited from itk::TransformBase
virtual void SetFixedParameters (const ParametersType &)=0
virtual void SetParameters (const ParametersType &)=0
virtual void SetParametersByValue (const ParametersType &p)=0
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int SpaceDimension = 3
static const unsigned int InputSpaceDimension = 3
static const unsigned int OutputSpaceDimension = 3
static const unsigned int ParametersDimension = 3
- Static Public Attributes inherited from itk::Rigid3DTransform< TScalarType >
- Static Public Attributes inherited from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >
- Static Public Attributes inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >

Protected Member Functions

void ComputeMatrix (void)
void ComputeMatrixParameters (void)
void PrintSelf (std::ostream &os, Indent indent) const
void SetVarVersor (const VersorType &newVersor)
 ~VersorTransform ()
 VersorTransform (const MatrixType &matrix, const OutputVectorType &offset)
 VersorTransform (unsigned int paramDims)
 VersorTransform ()
- Protected Member Functions inherited from itk::Rigid3DTransform< TScalarType >
 Rigid3DTransform (const MatrixType &matrix, const OutputVectorType &offset)
 Rigid3DTransform (unsigned int paramDim)
 Rigid3DTransform ()
 ~Rigid3DTransform ()
- Protected Member Functions inherited from itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >
virtual void ComputeOffset (void)
virtual void ComputeTranslation (void)
const InverseMatrixTypeGetInverseMatrix (void) const
const InverseMatrixTypeGetVarInverseMatrix (void) const
bool InverseMatrixIsOld (void) const
void SetVarCenter (const InputPointType &center)
void SetVarInverseMatrix (const InverseMatrixType &matrix) const
void SetVarMatrix (const MatrixType &matrix)
void SetVarOffset (const OutputVectorType &offset)
void SetVarTranslation (const OutputVectorType &translation)
virtual ~MatrixOffsetTransformBase ()
 MatrixOffsetTransformBase (const MatrixType &matrix, const OutputVectorType &offset)
 MatrixOffsetTransformBase (unsigned int paramDims)
 MatrixOffsetTransformBase ()
- Protected Member Functions inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >
virtual LightObject::Pointer InternalClone () const
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType, const JacobianType) const
 Transform ()
 Transform (NumberOfParametersType NumberOfParameters)
virtual ~Transform ()
- Protected Member Functions inherited from itk::TransformBase
 TransformBase ()
virtual ~TransformBase ()
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Private Member Functions

const Selfoperator= (const Self &)
 VersorTransform (const Self &other)

Private Attributes

VersorType m_Versor

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. Rotation is about a user specified center.

The serialization of the optimizable parameters is an array of 3 elements representing the right part of the versor.

The serialization of the fixed parameters is an array of 3 elements defining the center of rotation.

TODO: Need to make sure that the translation parameters in the baseclass cannot be set to non-zero values.

Definition at line 48 of file itkVersorTransform.h.


Member Typedef Documentation

template<class TScalarType = double>
typedef VersorType::ValueType itk::VersorTransform< TScalarType >::AngleType
template<class TScalarType = double>
typedef VersorType::VectorType itk::VersorTransform< TScalarType >::AxisType
template<class TScalarType = double>
typedef AxisType::ValueType itk::VersorTransform< TScalarType >::AxisValueType
template<class TScalarType = double>
typedef Superclass::CenterType itk::VersorTransform< TScalarType >::CenterType
template<class TScalarType = double>
typedef SmartPointer<const Self> itk::VersorTransform< TScalarType >::ConstPointer
template<class TScalarType = double>
typedef Superclass::InputCovariantVectorType itk::VersorTransform< TScalarType >::InputCovariantVectorType
template<class TScalarType = double>
typedef Superclass::InputPointType itk::VersorTransform< TScalarType >::InputPointType
template<class TScalarType = double>
typedef Superclass::InputVectorType itk::VersorTransform< TScalarType >::InputVectorType
template<class TScalarType = double>
typedef Superclass::InputVnlVectorType itk::VersorTransform< TScalarType >::InputVnlVectorType
template<class TScalarType = double>
typedef Superclass::InverseMatrixType itk::VersorTransform< TScalarType >::InverseMatrixType
template<class TScalarType = double>
typedef Superclass::JacobianType itk::VersorTransform< TScalarType >::JacobianType
template<class TScalarType = double>
typedef Superclass::MatrixType itk::VersorTransform< TScalarType >::MatrixType
template<class TScalarType = double>
typedef Superclass::OffsetType itk::VersorTransform< TScalarType >::OffsetType
template<class TScalarType = double>
typedef Superclass::OutputCovariantVectorType itk::VersorTransform< TScalarType >::OutputCovariantVectorType
template<class TScalarType = double>
typedef Superclass::OutputPointType itk::VersorTransform< TScalarType >::OutputPointType
template<class TScalarType = double>
typedef Superclass::OutputVectorType itk::VersorTransform< TScalarType >::OutputVectorType
template<class TScalarType = double>
typedef Superclass::OutputVnlVectorType itk::VersorTransform< TScalarType >::OutputVnlVectorType
template<class TScalarType = double>
typedef Superclass::ParametersType itk::VersorTransform< TScalarType >::ParametersType
template<class TScalarType = double>
typedef ParametersType::ValueType itk::VersorTransform< TScalarType >::ParameterValueType
template<class TScalarType = double>
typedef SmartPointer<Self> itk::VersorTransform< TScalarType >::Pointer
template<class TScalarType = double>
typedef Superclass::ScalarType itk::VersorTransform< TScalarType >::ScalarType
template<class TScalarType = double>
typedef VersorTransform itk::VersorTransform< TScalarType >::Self
template<class TScalarType = double>
typedef Rigid3DTransform<TScalarType> itk::VersorTransform< TScalarType >::Superclass
template<class TScalarType = double>
typedef Versor<TScalarType> itk::VersorTransform< TScalarType >::VersorType
template<class TScalarType = double>
typedef vnl_quaternion<TScalarType> itk::VersorTransform< TScalarType >::VnlQuaternionType

VnlQuaternion Type

Definition at line 89 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  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 ( )
inlineprotected

Destroy an VersorTransform object

Definition at line 137 of file itkVersorTransform.h.

template<class TScalarType = double>
itk::VersorTransform< TScalarType >::VersorTransform ( const Self other)
private

Copy a VersorTransform object


Member Function Documentation

template<class TScalarType = double>
virtual void itk::VersorTransform< TScalarType >::ComputeJacobianWithRespectToParameters ( const InputPointType p,
JacobianType jacobian 
) 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 in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::ScaleVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

template<class TScalarType = double>
void itk::VersorTransform< TScalarType >::ComputeMatrix ( void  )
protectedvirtual
template<class TScalarType = double>
void itk::VersorTransform< TScalarType >::ComputeMatrixParameters ( void  )
protectedvirtual
template<class TScalarType = double>
virtual::itk::LightObject::Pointer itk::VersorTransform< TScalarType >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

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

Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, itk::VersorRigid3DTransform< TScalarType >, and itk::ScaleVersor3DTransform< TScalarType >.

template<class TScalarType = double>
virtual const char* itk::VersorTransform< TScalarType >::GetNameOfClass ( ) const
virtual
template<class TScalarType = double>
const ParametersType& itk::VersorTransform< TScalarType >::GetParameters ( void  ) const
virtual
template<class TScalarType = double>
virtual const VersorType& itk::VersorTransform< TScalarType >::GetVersor ( )
virtual
template<class TScalarType = double>
static Pointer itk::VersorTransform< TScalarType >::New ( )
static
template<class TScalarType = double>
const Self& itk::VersorTransform< TScalarType >::operator= ( const Self )
private
template<class TScalarType = double>
void itk::VersorTransform< TScalarType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual
template<class TScalarType = double>
virtual void itk::VersorTransform< TScalarType >::SetIdentity ( void  )
virtual
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 vcl_sin( angle / 2 ).

Reimplemented from itk::Rigid3DTransform< TScalarType >.

Reimplemented in itk::ScaleSkewVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, itk::ScaleVersor3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

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

Set the rotational part of the transform

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

Definition at line 147 of file itkVersorTransform.h.


Member Data Documentation

template<class TScalarType = double>
const unsigned int itk::VersorTransform< TScalarType >::InputSpaceDimension = 3
static
template<class TScalarType = double>
VersorType itk::VersorTransform< TScalarType >::m_Versor
private

Versor containing the rotation

Definition at line 169 of file itkVersorTransform.h.

template<class TScalarType = double>
const unsigned int itk::VersorTransform< TScalarType >::OutputSpaceDimension = 3
static
template<class TScalarType = double>
const unsigned int itk::VersorTransform< TScalarType >::ParametersDimension = 3
static
template<class TScalarType = double>
const unsigned int itk::VersorTransform< TScalarType >::SpaceDimension = 3
static

Dimension of parameters

Reimplemented from itk::Rigid3DTransform< TScalarType >.

Reimplemented in itk::Similarity3DTransform< TScalarType >, and itk::VersorRigid3DTransform< TScalarType >.

Definition at line 65 of file itkVersorTransform.h.


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