Detailed Description

template<typename TParametersValueType = double>
class itk::VersorTransform< TParametersValueType >

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 47 of file itkVersorTransform.h.

Public Types
typedef VersorType::ValueType	AngleType

typedef VersorType::VectorType	AxisType

typedef AxisType::ValueType	AxisValueType

typedef Superclass::CenterType	CenterType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::FixedParametersType	FixedParametersType

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	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalarType	ScalarType

typedef VersorTransform	Self

typedef Rigid3DTransform < TParametersValueType >	Superclass

typedef Versor < TParametersValueType >	VersorType

typedef vnl_quaternion < TParametersValueType >	VnlQuaternionType

Public Types inherited from itk::Rigid3DTransform< TParametersValueType >
typedef Superclass::CenterType	CenterType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::FixedParametersType	FixedParametersType

typedef Superclass::FixedParametersValueType	FixedParametersValueType

typedef Superclass::InputCovariantVectorType	InputCovariantVectorType

typedef Superclass::InputPointType	InputPointType

typedef Superclass::InputVectorType	InputVectorType

typedef Superclass::InputVnlVectorType	InputVnlVectorType

typedef Superclass::InverseMatrixType	InverseMatrixType

typedef InverseTransformBaseType::Pointer	InverseTransformBasePointer

typedef Superclass::InverseTransformBaseType	InverseTransformBaseType

typedef Superclass::JacobianType	JacobianType

typedef Superclass::MatrixType	MatrixType

typedef Superclass::MatrixValueType	MatrixValueType

typedef Superclass::OffsetType	OffsetType

typedef Superclass::OutputCovariantVectorType	OutputCovariantVectorType

typedef Superclass::OutputPointType	OutputPointType

typedef Superclass::OutputVectorType	OutputVectorType

typedef Superclass::OutputVectorValueType	OutputVectorValueType

typedef Superclass::OutputVnlVectorType	OutputVnlVectorType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalarType	ScalarType

typedef Rigid3DTransform	Self

typedef MatrixOffsetTransformBase < TParametersValueType, 3, 3 >	Superclass

typedef Superclass::TranslationType	TranslationType

Public Types inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >
typedef InputPointType	CenterType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::FixedParametersType	FixedParametersType

typedef Superclass::FixedParametersValueType	FixedParametersValueType

typedef Superclass::InputDiffusionTensor3DType	InputDiffusionTensor3DType

typedef Superclass::InputSymmetricSecondRankTensorType	InputSymmetricSecondRankTensorType

typedef CovariantVector < TParametersValueType, InputDiffusionTensor3DType::Dimension >	InputTensorEigenVectorType

typedef Superclass::InputVectorPixelType	InputVectorPixelType

typedef Matrix < TParametersValueType, itkGetStaticConstMacro(InputSpaceDimension), itkGetStaticConstMacro(OutputSpaceDimension)>	InverseMatrixType

typedef InverseTransformBaseType::Pointer	InverseTransformBasePointer

typedef Superclass::InverseTransformBaseType	InverseTransformBaseType

typedef Superclass::JacobianType	JacobianType

typedef OutputVectorType	OffsetType

typedef OffsetType::ValueType	OffsetValueType

typedef Superclass::OutputDiffusionTensor3DType	OutputDiffusionTensor3DType

typedef Superclass::OutputSymmetricSecondRankTensorType	OutputSymmetricSecondRankTensorType

typedef Superclass::OutputVectorPixelType	OutputVectorPixelType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef Superclass::ScalarType	ScalarType

typedef MatrixOffsetTransformBase	Self

typedef Transform < TParametersValueType, NInputDimensions, NOutputDimensions >	Superclass

typedef Superclass::TransformCategoryType	TransformCategoryType

typedef OutputVectorType	TranslationType

typedef TranslationType::ValueType	TranslationValueType

typedef Vector < TParametersValueType, itkGetStaticConstMacro(InputSpaceDimension)>	InputVectorType

typedef Vector < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension)>	OutputVectorType

typedef OutputVectorType::ValueType	OutputVectorValueType

typedef CovariantVector < TParametersValueType, itkGetStaticConstMacro(InputSpaceDimension)>	InputCovariantVectorType

typedef CovariantVector < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension)>	OutputCovariantVectorType

typedef vnl_vector_fixed < TParametersValueType, itkGetStaticConstMacro(InputSpaceDimension)>	InputVnlVectorType

typedef vnl_vector_fixed < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension)>	OutputVnlVectorType

typedef Point < TParametersValueType, itkGetStaticConstMacro(InputSpaceDimension)>	InputPointType

typedef InputPointType::ValueType	InputPointValueType

typedef Point < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension)>	OutputPointType

typedef OutputPointType::ValueType	OutputPointValueType

typedef Matrix < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	MatrixType

typedef MatrixType::ValueType	MatrixValueType

Public Types inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
typedef SmartPointer< const Self >	ConstPointer

typedef Array < ParametersValueType >	DerivativeType

typedef Matrix< double, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	DirectionChangeMatrix

typedef Superclass::FixedParametersType	FixedParametersType

typedef Superclass::FixedParametersValueType	FixedParametersValueType

typedef CovariantVector < TParametersValueType, NInputDimensions >	InputCovariantVectorType

typedef DiffusionTensor3D < TParametersValueType >	InputDiffusionTensor3DType

typedef Matrix< double, itkGetStaticConstMacro(InputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	InputDirectionMatrix

typedef Point < TParametersValueType, NInputDimensions >	InputPointType

typedef SymmetricSecondRankTensor < TParametersValueType, NInputDimensions >	InputSymmetricSecondRankTensorType

typedef VariableLengthVector < TParametersValueType >	InputVectorPixelType

typedef Vector < TParametersValueType, NInputDimensions >	InputVectorType

typedef vnl_vector_fixed < TParametersValueType, NInputDimensions >	InputVnlVectorType

typedef InverseTransformBaseType::Pointer	InverseTransformBasePointer

typedef Transform < TParametersValueType, NOutputDimensions, NInputDimensions >	InverseTransformBaseType

typedef Array2D < ParametersValueType >	JacobianType

typedef Matrix < TParametersValueType, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(InputSpaceDimension)>	MatrixType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef CovariantVector < TParametersValueType, NOutputDimensions >	OutputCovariantVectorType

typedef DiffusionTensor3D < TParametersValueType >	OutputDiffusionTensor3DType

typedef Matrix< double, itkGetStaticConstMacro(OutputSpaceDimension), itkGetStaticConstMacro(OutputSpaceDimension)>	OutputDirectionMatrix

typedef Point < TParametersValueType, NOutputDimensions >	OutputPointType

typedef SymmetricSecondRankTensor < TParametersValueType, NOutputDimensions >	OutputSymmetricSecondRankTensorType

typedef VariableLengthVector < TParametersValueType >	OutputVectorPixelType

typedef Vector < TParametersValueType, NOutputDimensions >	OutputVectorType

typedef vnl_vector_fixed < TParametersValueType, NOutputDimensions >	OutputVnlVectorType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef ParametersValueType	ScalarType

typedef Transform	Self

typedef TransformBaseTemplate < TParametersValueType >	Superclass

typedef Superclass::TransformCategoryType	TransformCategoryType

Public Types inherited from itk::TransformBaseTemplate< TParametersValueType >
typedef SmartPointer< const Self >	ConstPointer

typedef OptimizerParameters < FixedParametersValueType >	FixedParametersType

typedef double	FixedParametersValueType

typedef IdentifierType	NumberOfParametersType

typedef OptimizerParameters < ParametersValueType >	ParametersType

typedef TParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef TransformBaseTemplate	Self

typedef Object	Superclass

enum	TransformCategoryType { UnknownTransformCategory =0, Linear =1, BSpline =2, Spline =3, DisplacementField =4, VelocityField =5 }

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual void	ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const override

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

const ParametersType &	GetParameters (void) const override

virtual const VersorType &	GetVersor () const

virtual void	SetIdentity (void) override

void	SetParameters (const ParametersType &parameters) override

void	SetRotation (const VersorType &versor)

void	SetRotation (const AxisType &axis, AngleType angle)

Public Member Functions inherited from itk::Rigid3DTransform< TParametersValueType >
bool	MatrixIsOrthogonal (const MatrixType &matrix, const TParametersValueType tolerance=MatrixOrthogonalityTolerance< TParametersValueType >::GetTolerance())

virtual void	SetMatrix (const MatrixType &matrix) override

virtual void	SetMatrix (const MatrixType &matrix, const TParametersValueType tolerance)

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< TParametersValueType, 3, 3 >
void	Compose (const Self *other, bool pre=0)

virtual void	ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, JacobianType &jac) const override

virtual void	ComputeJacobianWithRespectToParameters (const InputPointType &x, JacobianType &j) const override

virtual void	ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianType &jac) const override

virtual ::itk::LightObject::Pointer	CreateAnother () const

const InputPointType &	GetCenter () const

virtual const FixedParametersType &	GetFixedParameters () const override

virtual InverseTransformBasePointer	GetInverseTransform () const override

virtual const MatrixType &	GetMatrix () const

const OutputVectorType &	GetOffset () const

const ParametersType &	GetParameters () const override

virtual TransformCategoryType	GetTransformCategory () const override

const OutputVectorType &	GetTranslation () const

virtual bool	IsLinear () const override

virtual void	SetFixedParameters (const FixedParametersType &) override

void	SetParameters (const ParametersType &parameters) override

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector) const override

OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector) const override

OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const override

OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const override

OutputPointType	TransformPoint (const InputPointType &point) const override

OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor) const override

OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor) const override

OutputVectorType	TransformVector (const InputVectorType &vector) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector) const override

OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector) const override

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< TParametersValueType, NInputDimensions, NOutputDimensions >
virtual void	ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const

virtual void	CopyInFixedParameters (const FixedParametersValueType const begin, const FixedParametersValueType const end) override

virtual void	CopyInParameters (const ParametersValueType const begin, const ParametersValueType const end) override

unsigned int	GetInputSpaceDimension (void) const override

bool	GetInverse (Self *) const

virtual NumberOfParametersType	GetNumberOfFixedParameters () const

virtual NumberOfParametersType	GetNumberOfLocalParameters (void) const

virtual NumberOfParametersType	GetNumberOfParameters (void) const override

unsigned int	GetOutputSpaceDimension (void) const override

virtual std::string	GetTransformTypeAsString () const override

	itkCloneMacro (Self)

virtual void	SetParametersByValue (const ParametersType &p) override

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, ParametersValueType factor=1.0)

Public Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
virtual void	CopyInFixedParameters (const FixedParametersValueType const begin, const FixedParametersValueType const end)=0

virtual void	CopyInParameters (const ParametersValueType const begin, const ParametersValueType const end)=0

virtual void	SetFixedParameters (const FixedParametersType &)=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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

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< TParametersValueType >
static const unsigned int	SpaceDimension = 3

static const unsigned int	InputSpaceDimension = 3

static const unsigned int	OutputSpaceDimension = 3

static const unsigned int	ParametersDimension = 12

Static Public Attributes inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >
static const unsigned int	InputSpaceDimension

static const unsigned int	OutputSpaceDimension

static const unsigned int	ParametersDimension

Static Public Attributes inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
static const unsigned int	InputSpaceDimension = NInputDimensions

static const unsigned int	OutputSpaceDimension = NOutputDimensions

Protected Member Functions
void	ComputeMatrix (void) override

void	ComputeMatrixParameters (void) override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	SetVarVersor (const VersorType &newVersor)

	~VersorTransform () override


	VersorTransform (const MatrixType &matrix, const OutputVectorType &offset)

	VersorTransform (unsigned int paramDims)

	VersorTransform ()

Protected Member Functions inherited from itk::Rigid3DTransform< TParametersValueType >
	Rigid3DTransform (const MatrixType &matrix, const OutputVectorType &offset)

	Rigid3DTransform (unsigned int paramDim)

	Rigid3DTransform ()

	~Rigid3DTransform () override

Protected Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >
virtual void	ComputeOffset ()

virtual void	ComputeTranslation ()

const InverseMatrixType &	GetInverseMatrix () const

virtual bool	GetSingular () const

const InverseMatrixType &	GetVarInverseMatrix () const

bool	InverseMatrixIsOld () 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 () override

	MatrixOffsetTransformBase (const MatrixType &matrix, const OutputVectorType &offset)

	MatrixOffsetTransformBase (unsigned int paramDims)

	MatrixOffsetTransformBase ()

Protected Member Functions inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
virtual LightObject::Pointer	InternalClone () const override

OutputDiffusionTensor3DType	PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType, const JacobianType) const

	Transform ()

	Transform (NumberOfParametersType NumberOfParameters)

virtual	~Transform () override

Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
	TransformBaseTemplate ()

virtual	~TransformBaseTemplate () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object () override

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 Self &	operator= (const Self &)

	VersorTransform (const Self &other)

Private Attributes
VersorType	m_Versor

Additional Inherited Members
Protected Attributes inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
DirectionChangeMatrix	m_DirectionChange

FixedParametersType	m_FixedParameters

ParametersType	m_Parameters

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount