#include <itkVersorTransform.h>

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.

Inheritance diagram for itk::VersorTransform< TParametersValueType >:

Collaboration diagram for itk::VersorTransform< TParametersValueType >:

Public Types
using	AngleType = typename VersorType::ValueType

using	AxisType = typename VersorType::VectorType

using	AxisValueType = typename AxisType::ValueType

using	ConstPointer = SmartPointer< const Self >

using	ParametersValueType = typename ParametersType::ValueType

using	Pointer = SmartPointer< Self >

using	Self = VersorTransform

using	Superclass = Rigid3DTransform< TParametersValueType >

using	VersorType = Versor< TParametersValueType >

using	VnlQuaternionType = vnl_quaternion< TParametersValueType >

Public Types inherited from itk::Rigid3DTransform< TParametersValueType >
using	ConstPointer = SmartPointer< const Self >

using	InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

using	InverseTransformBaseType = typename Superclass::InverseTransformBaseType

using	Pointer = SmartPointer< Self >

using	Self = Rigid3DTransform

using	Superclass = MatrixOffsetTransformBase< TParametersValueType, 3, 3 >

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

using	ConstPointer = SmartPointer< const Self >

using	InputCovariantVectorType = CovariantVector< TParametersValueType, Self::InputSpaceDimension >

using	InputPointType = Point< TParametersValueType, Self::InputSpaceDimension >

using	InputPointValueType = typename InputPointType::ValueType

using	InputTensorEigenVectorType = CovariantVector< TParametersValueType, InputDiffusionTensor3DType::Dimension >

using	InputVectorType = Vector< TParametersValueType, Self::InputSpaceDimension >

using	InputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::InputSpaceDimension >

using	InverseMatrixType = Matrix< TParametersValueType, Self::InputSpaceDimension, Self::OutputSpaceDimension >

using	InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

using	InverseTransformBaseType = typename Superclass::InverseTransformBaseType

using	InverseTransformType = MatrixOffsetTransformBase< TParametersValueType, VOutputDimension, VInputDimension >

using	MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >

using	MatrixValueType = typename MatrixType::ValueType

using	OffsetType = OutputVectorType

using	OffsetValueType = typename OffsetType::ValueType

using	OutputCovariantVectorType = CovariantVector< TParametersValueType, Self::OutputSpaceDimension >

using	OutputPointType = Point< TParametersValueType, Self::OutputSpaceDimension >

using	OutputPointValueType = typename OutputPointType::ValueType

using	OutputVectorType = Vector< TParametersValueType, Self::OutputSpaceDimension >

using	OutputVectorValueType = typename OutputVectorType::ValueType

using	OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::OutputSpaceDimension >

using	Pointer = SmartPointer< Self >

using	Self = MatrixOffsetTransformBase

using	Superclass = Transform< TParametersValueType, VInputDimension, VOutputDimension >

using	TranslationType = OutputVectorType

using	TranslationValueType = typename TranslationType::ValueType

Public Types inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = Array< ParametersValueType >

using	DirectionChangeMatrix = Matrix< double, Self::OutputSpaceDimension, Self::InputSpaceDimension >

using	InputCovariantVectorType = CovariantVector< TParametersValueType, VInputDimension >

using	InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >

using	InputDirectionMatrix = Matrix< double, Self::InputSpaceDimension, Self::InputSpaceDimension >

using	InputPointType = Point< TParametersValueType, VInputDimension >

using	InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VInputDimension >

using	InputVectorPixelType = VariableLengthVector< TParametersValueType >

using	InputVectorType = Vector< TParametersValueType, VInputDimension >

using	InputVnlVectorType = vnl_vector_fixed< TParametersValueType, VInputDimension >

using	InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >

using	InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

using	InverseTransformBaseType = Transform< TParametersValueType, VOutputDimension, VInputDimension >

using	JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >

using	JacobianType = Array2D< ParametersValueType >

using	MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >

using	OutputCovariantVectorType = CovariantVector< TParametersValueType, VOutputDimension >

using	OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >

using	OutputDirectionMatrix = Matrix< double, Self::OutputSpaceDimension, Self::OutputSpaceDimension >

using	OutputPointType = Point< TParametersValueType, VOutputDimension >

using	OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VOutputDimension >

using	OutputVectorPixelType = VariableLengthVector< TParametersValueType >

using	OutputVectorType = Vector< TParametersValueType, VOutputDimension >

using	OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, VOutputDimension >

using	Pointer = SmartPointer< Self >

using	ScalarType = ParametersValueType

using	Self = Transform

using	Superclass = TransformBaseTemplate< TParametersValueType >

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

using	FixedParametersType = OptimizerParameters< FixedParametersValueType >

using	FixedParametersValueType = double

using	NumberOfParametersType = IdentifierType

using	ParametersType = OptimizerParameters< ParametersValueType >

using	ParametersValueType = TParametersValueType

using	Pointer = SmartPointer< Self >

using	Self = TransformBaseTemplate

using	Superclass = Object

using	TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

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

const char *	GetNameOfClass () const override

const ParametersType &	GetParameters () const override

virtual const VersorType &	GetVersor () const

void	SetIdentity () override

void	SetParameters (const ParametersType &parameters) override

void	SetRotation (const AxisType &axis, AngleType angle)

void	SetRotation (const VersorType &versor)

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

void	SetMatrix (const MatrixType &matrix) override

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

void	Translate (const OffsetType &offset, bool pre=false)

Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >
void	Compose (const Self *other, bool pre=false)

void	ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, InverseJacobianPositionType &jac) const override

void	ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const override

void	ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) const override

const InputPointType &	GetCenter () const

const FixedParametersType &	GetFixedParameters () const override

InverseTransformBasePointer	GetInverseTransform () const override

virtual const MatrixType &	GetMatrix () const

const char *	GetNameOfClass () const override

const OutputVectorType &	GetOffset () const

const ParametersType &	GetParameters () const override

TransformCategoryEnum	GetTransformCategory () const override

const OutputVectorType &	GetTranslation () const

bool	IsLinear () const override

void	SetFixedParameters (const FixedParametersType &) override

void	SetParameters (const ParametersType &parameters) override

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vec) const override

OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vect) 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 &inputTensor) const override

OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor) const override

OutputVectorPixelType	TransformVector (const InputVectorPixelType &vect) const override

OutputVectorType	TransformVector (const InputVectorType &vect) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &vect) const override

void	SetOffset (const OutputVectorType &offset)

void	SetCenter (const InputPointType &center)

void	SetTranslation (const OutputVectorType &translation)

bool	GetInverse (InverseTransformType *inverse) const

Public Member Functions inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
virtual void	ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const

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

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

unsigned int	GetInputSpaceDimension () const override

virtual const std::string &	GetInputSpaceName () const

bool	GetInverse (Self *) const

virtual NumberOfParametersType	GetNumberOfFixedParameters () const

virtual NumberOfParametersType	GetNumberOfLocalParameters () const

NumberOfParametersType	GetNumberOfParameters () const override

unsigned int	GetOutputSpaceDimension () const override

virtual const std::string &	GetOutputSpaceName () const

std::string	GetTransformTypeAsString () const override

	itkCloneMacro (Self)

void	SetFixedParameters (const FixedParametersType &) override=0

virtual void	SetInputSpaceName (std::string _arg)

virtual void	SetOutputSpaceName (std::string _arg)

void	SetParameters (const ParametersType &) override=0

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 &inputTensor, const InputPointType &point) const

virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const

virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const

virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector, 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 void	UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)

	itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)

	itkLegacyMacro (virtual void ComputeInverseJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)

template<typename TImage >
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void >	ApplyToImageMetadata (TImage *image) const

template<typename TImage >
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void >	ApplyToImageMetadata (SmartPointer< TImage > image) const

Public Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

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 Member Functions inherited from itk::Rigid3DTransform< TParametersValueType >
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 val)

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

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	InputSpaceDimension = 3

static constexpr unsigned int	OutputSpaceDimension = 3

static constexpr unsigned int	ParametersDimension = 3

static constexpr unsigned int	SpaceDimension = 3

Static Public Attributes inherited from itk::Rigid3DTransform< TParametersValueType >
static constexpr unsigned int	InputSpaceDimension = 3

static constexpr unsigned int	OutputSpaceDimension = 3

static constexpr unsigned int	ParametersDimension = 12

static constexpr unsigned int	SpaceDimension = 3

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

static constexpr unsigned int	OutputSpaceDimension

static constexpr unsigned int	ParametersDimension

Static Public Attributes inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
static constexpr unsigned int	InputSpaceDimension = VInputDimension

static constexpr unsigned int	OutputSpaceDimension = VOutputDimension

Protected Member Functions
void	ComputeMatrix () override

void	ComputeMatrixParameters () override

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

void	SetVarVersor (const VersorType &newVersor)

	~VersorTransform () override=default


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

	VersorTransform (unsigned int parametersDimension)

	VersorTransform ()

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

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

	Rigid3DTransform (unsigned int paramDim)

	~Rigid3DTransform () override=default

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	PrintSelf (std::ostream &os, Indent indent) const override

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)

	~MatrixOffsetTransformBase () override=default

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

	MatrixOffsetTransformBase (unsigned int paramDims=ParametersDimension)

Protected Member Functions inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
LightObject::Pointer	InternalClone () const override

OutputDiffusionTensor3DType	PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const

	Transform ()=default

	Transform (NumberOfParametersType numberOfParameters)

	~Transform () override=default

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

	~TransformBaseTemplate () override=default

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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 Attributes
VersorType	m_Versor {}

Additional Inherited Members
Static Protected Member Functions inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
template<typename TTransform >
static InverseTransformBasePointer	InvertTransform (const TTransform &transform)

Protected Attributes inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
FixedParametersType	m_FixedParameters {}

ParametersType	m_Parameters {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ AngleType

template<typename TParametersValueType = double>

using itk::VersorTransform< TParametersValueType >::AngleType = typename VersorType::ValueType

Definition at line 96 of file itkVersorTransform.h.

◆ AxisType

template<typename TParametersValueType = double>

using itk::VersorTransform< TParametersValueType >::AxisType = typename VersorType::VectorType

Definition at line 95 of file itkVersorTransform.h.

◆ AxisValueType

template<typename TParametersValueType = double>

using itk::VersorTransform< TParametersValueType >::AxisValueType = typename AxisType::ValueType

Definition at line 97 of file itkVersorTransform.h.

◆ ConstPointer

template<typename TParametersValueType = double>

using itk::VersorTransform< TParametersValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 56 of file itkVersorTransform.h.

◆ ParametersValueType

template<typename TParametersValueType = double>

using itk::VersorTransform< TParametersValueType >::ParametersValueType = typename ParametersType::ValueType

Definition at line 98 of file itkVersorTransform.h.

◆ Pointer

template<typename TParametersValueType = double>

using itk::VersorTransform< TParametersValueType >::Pointer = SmartPointer<Self>

Definition at line 55 of file itkVersorTransform.h.

◆ Self

template<typename TParametersValueType = double>

using itk::VersorTransform< TParametersValueType >::Self = VersorTransform

Standard Self Typedef

Definition at line 53 of file itkVersorTransform.h.

◆ Superclass

template<typename TParametersValueType = double>

using itk::VersorTransform< TParametersValueType >::Superclass = Rigid3DTransform<TParametersValueType>

Definition at line 54 of file itkVersorTransform.h.

◆ VersorType

template<typename TParametersValueType = double>

using itk::VersorTransform< TParametersValueType >::VersorType = Versor<TParametersValueType>

Versor Type

Definition at line 94 of file itkVersorTransform.h.

◆ VnlQuaternionType

template<typename TParametersValueType = double>

using itk::VersorTransform< TParametersValueType >::VnlQuaternionType = vnl_quaternion<TParametersValueType>

VnlQuaternion Type

Definition at line 91 of file itkVersorTransform.h.

Constructor & Destructor Documentation

◆ VersorTransform() [1/3]

template<typename TParametersValueType = double>

itk::VersorTransform< TParametersValueType >::VersorTransform	(	const MatrixType &	matrix,
		const OutputVectorType &	offset
	)

protected

Construct an VersorTransform object

◆ VersorTransform() [2/3]

template<typename TParametersValueType = double>

itk::VersorTransform< TParametersValueType >::VersorTransform ( unsigned int parametersDimension )

protected

Construct an VersorTransform object

◆ VersorTransform() [3/3]

template<typename TParametersValueType = double>

itk::VersorTransform< TParametersValueType >::VersorTransform ( )

protected

Construct an VersorTransform object

◆ ~VersorTransform()

template<typename TParametersValueType = double>

itk::VersorTransform< TParametersValueType >::~VersorTransform ( )

overrideprotecteddefault

Destroy an VersorTransform object

Member Function Documentation

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = double>

void itk::VersorTransform< TParametersValueType >::ComputeJacobianWithRespectToParameters	(	const InputPointType &	p,
		JacobianType &	jacobian
	)		const

overridevirtual

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.

Implements itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

◆ ComputeMatrix()

template<typename TParametersValueType = double>

void itk::VersorTransform< TParametersValueType >::ComputeMatrix ( )

overrideprotectedvirtual

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

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

◆ ComputeMatrixParameters()

template<typename TParametersValueType = double>

void itk::VersorTransform< TParametersValueType >::ComputeMatrixParameters ( )

overrideprotectedvirtual

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

◆ GetNameOfClass()

template<typename TParametersValueType = double>

const char* itk::VersorTransform< TParametersValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Rigid3DTransform< TParametersValueType >.

◆ GetParameters()

template<typename TParametersValueType = double>

const ParametersType& itk::VersorTransform< TParametersValueType >::GetParameters ( ) const

overridevirtual

Get the Transformation Parameters.

Reimplemented from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

◆ GetVersor()

template<typename TParametersValueType = double>

virtual const VersorType& itk::VersorTransform< TParametersValueType >::GetVersor ( ) const

virtual

◆ New()

template<typename TParametersValueType = double>

static Pointer itk::VersorTransform< TParametersValueType >::New ( )

static

New macro for creation of through a Smart Pointer

◆ PrintSelf()

template<typename TParametersValueType = double>

void itk::VersorTransform< TParametersValueType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Print contents of a VersorTransform

Reimplemented from itk::Rigid3DTransform< TParametersValueType >.

◆ SetIdentity()

template<typename TParametersValueType = double>

void itk::VersorTransform< TParametersValueType >::SetIdentity ( )

overridevirtual

Set the parameters to the IdentityTransform

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

◆ SetParameters()

template<typename TParametersValueType = double>

void itk::VersorTransform< TParametersValueType >::SetParameters ( const ParametersType & parameters )

overridevirtual

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 std::sin( angle / 2 ).

Reimplemented from itk::Rigid3DTransform< TParametersValueType >.

◆ SetRotation() [1/2]

template<typename TParametersValueType = double>

void itk::VersorTransform< TParametersValueType >::SetRotation	(	const AxisType &	axis,
		AngleType	angle
	)

◆ SetRotation() [2/2]

template<typename TParametersValueType = double>

void itk::VersorTransform< TParametersValueType >::SetRotation ( const VersorType & versor )

Set the rotational part of the transform.

◆ SetVarVersor()

template<typename TParametersValueType = double>

void itk::VersorTransform< TParametersValueType >::SetVarVersor ( const VersorType & newVersor )

inlineprotected

Definition at line 147 of file itkVersorTransform.h.

Member Data Documentation

◆ InputSpaceDimension

template<typename TParametersValueType = double>

constexpr unsigned int itk::VersorTransform< TParametersValueType >::InputSpaceDimension = 3

staticconstexpr

Definition at line 66 of file itkVersorTransform.h.

◆ m_Versor

template<typename TParametersValueType = double>

VersorType itk::VersorTransform< TParametersValueType >::m_Versor {}

private

Versor containing the rotation

Definition at line 166 of file itkVersorTransform.h.

◆ OutputSpaceDimension

template<typename TParametersValueType = double>

constexpr unsigned int itk::VersorTransform< TParametersValueType >::OutputSpaceDimension = 3

staticconstexpr

Definition at line 67 of file itkVersorTransform.h.

◆ ParametersDimension

template<typename TParametersValueType = double>

constexpr unsigned int itk::VersorTransform< TParametersValueType >::ParametersDimension = 3

staticconstexpr

Definition at line 68 of file itkVersorTransform.h.

◆ SpaceDimension

template<typename TParametersValueType = double>

constexpr unsigned int itk::VersorTransform< TParametersValueType >::SpaceDimension = 3

staticconstexpr

Dimension of parameters

Definition at line 65 of file itkVersorTransform.h.

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

itkVersorTransform.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AngleType

◆ AxisType

◆ AxisValueType

◆ ConstPointer

◆ ParametersValueType

◆ Pointer

◆ Self

◆ Superclass

◆ VersorType

◆ VnlQuaternionType

Constructor & Destructor Documentation

◆ VersorTransform() [1/3]

◆ VersorTransform() [2/3]

◆ VersorTransform() [3/3]

◆ ~VersorTransform()

Member Function Documentation

◆ ComputeJacobianWithRespectToParameters()

◆ ComputeMatrix()

◆ ComputeMatrixParameters()

◆ GetNameOfClass()

◆ GetParameters()

◆ GetVersor()

◆ New()

◆ PrintSelf()

◆ SetIdentity()

◆ SetParameters()

◆ SetRotation() [1/2]

◆ SetRotation() [2/2]

◆ SetVarVersor()

Member Data Documentation

◆ InputSpaceDimension

◆ m_Versor

◆ OutputSpaceDimension

◆ ParametersDimension

◆ SpaceDimension

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