#include <itkAdvancedEuler3DTransform.h>

Detailed Description

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

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

This transform applies a rotation and translation to the space given 3 euler angles and a 3D translation. Rotation is about a user specified center.

The parameters for this transform can be set either using individual Set methods or in serialized form using SetParameters() and SetFixedParameters().

The serialization of the optimizable parameters is an array of 6 elements. The first 3 represents three euler angle of rotation respectively about the X, Y and Z axis. The last 3 parameters defines the translation in each dimension.

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

Definition at line 64 of file itkAdvancedEuler3DTransform.h.

Inheritance diagram for itk::AdvancedEuler3DTransform< TScalarType >:

[legend]

Public Types
using	AngleType = typename Superclass::ScalarType

using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = AdvancedEuler3DTransform

using	Superclass = AdvancedRigid3DTransform< TScalarType >

Public Types inherited from itk::AdvancedRigid3DTransform< TScalarType >
using	CenterType = InputPointType

using	ConstPointer = SmartPointer< const Self >

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

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

using	OffsetType = OutputVectorType

using	Pointer = SmartPointer< Self >

using	Self = AdvancedRigid3DTransform

using	Superclass = AdvancedMatrixOffsetTransformBase< TScalarType, 3, 3 >

using	TranslationType = OutputVectorType

Public Types inherited from itk::AdvancedMatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >
using	CenterType = InputPointType

using	ConstPointer = SmartPointer< const Self >

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

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

using	OffsetType = OutputVectorType

using	Pointer = SmartPointer< Self >

using	Self = AdvancedMatrixOffsetTransformBase

using	Superclass = AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >

using	TranslationType = OutputVectorType

Public Types inherited from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >
using	ConstPointer = SmartPointer< const Self >

using	InternalMatrixType = typename SpatialJacobianType::InternalMatrixType

using	InverseTransformBaseType = typename Superclass::InverseTransformBaseType

using	JacobianOfSpatialHessianType = std::vector< SpatialHessianType >

using	JacobianOfSpatialJacobianType = std::vector< SpatialJacobianType >

using	MovingImageGradientType = OutputCovariantVectorType

using	MovingImageGradientValueType = typename MovingImageGradientType::ValueType

using	NonZeroJacobianIndicesType = std::vector< unsigned long >

using	Pointer = SmartPointer< Self >

using	Self = AdvancedTransform

using	SpatialHessianType = FixedArray< Matrix< ScalarType, InputSpaceDimension, InputSpaceDimension >, OutputSpaceDimension >

using	SpatialJacobianType = Matrix< ScalarType, OutputSpaceDimension, InputSpaceDimension >

using	Superclass = Transform< TScalarType, NInputDimensions, NOutputDimensions >

using	TransformType = Transform< TScalarType, NInputDimensions, NOutputDimensions >

using	TransformTypeConstPointer = typename TransformType::ConstPointer

using	TransformTypePointer = typename TransformType::Pointer

Public Member Functions
virtual ScalarType	GetAngleX () const

virtual ScalarType	GetAngleY () const

virtual ScalarType	GetAngleZ () const

virtual const char *	GetClassName () const

virtual bool	GetComputeZYX () const

void	GetJacobian (const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const override

const ParametersType &	GetParameters () const override

	ITK_DISALLOW_COPY_AND_MOVE (AdvancedEuler3DTransform)

	itkStaticConstMacro (InputSpaceDimension, unsigned int, 3)

	itkStaticConstMacro (OutputSpaceDimension, unsigned int, 3)

	itkStaticConstMacro (ParametersDimension, unsigned int, 6)

	itkStaticConstMacro (SpaceDimension, unsigned int, 3)

virtual void	SetComputeZYX (bool _arg)

void	SetIdentity () override

void	SetParameters (const ParametersType &parameters) override

void	SetRotation (ScalarType angleX, ScalarType angleY, ScalarType angleZ)

Public Member Functions inherited from itk::AdvancedRigid3DTransform< TScalarType >
virtual const char *	GetClassName () const

	ITK_DISALLOW_COPY_AND_MOVE (AdvancedRigid3DTransform)

	itkStaticConstMacro (InputSpaceDimension, unsigned int, 3)

	itkStaticConstMacro (OutputSpaceDimension, unsigned int, 3)

	itkStaticConstMacro (ParametersDimension, unsigned int, 12)

	itkStaticConstMacro (SpaceDimension, unsigned int, 3)

bool	MatrixIsOrthogonal (const MatrixType &matrix, double tol=1e-10)

void	SetMatrix (const MatrixType &matrix) override

void	SetParameters (const ParametersType &parameters) override

Public Member Functions inherited from itk::AdvancedMatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >
const InputPointType &	GetCenter () const

virtual const char *	GetClassName () const

const FixedParametersType &	GetFixedParameters () const override

void	GetJacobian (const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const override

void	GetJacobianOfSpatialHessian (const InputPointType &, JacobianOfSpatialHessianType &, NonZeroJacobianIndicesType &) const override

void	GetJacobianOfSpatialHessian (const InputPointType &inputPoint, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const override

void	GetJacobianOfSpatialJacobian (const InputPointType &, JacobianOfSpatialJacobianType &, NonZeroJacobianIndicesType &) const override

void	GetJacobianOfSpatialJacobian (const InputPointType &, SpatialJacobianType &, JacobianOfSpatialJacobianType &, NonZeroJacobianIndicesType &) const override

const MatrixType &	GetMatrix () const

const ParametersType &	GetParameters () const override

void	GetSpatialHessian (const InputPointType &, SpatialHessianType &) const override

void	GetSpatialJacobian (const InputPointType &, SpatialJacobianType &) const override

TransformCategoryEnum	GetTransformCategory () const override

const OutputVectorType &	GetTranslation () const

bool	IsLinear () const override

	itkStaticConstMacro (InputSpaceDimension, unsigned int, NInputDimensions)

	itkStaticConstMacro (OutputSpaceDimension, unsigned int, NOutputDimensions)

	itkStaticConstMacro (ParametersDimension, unsigned int, NOutputDimensions *(NInputDimensions+1))

void	SetCenter (const InputPointType &center)

void	SetFixedParameters (const FixedParametersType &) override

virtual void	SetIdentity ()

virtual void	SetMatrix (const MatrixType &matrix)

void	SetParameters (const ParametersType &parameters) override

void	SetTranslation (const OutputVectorType &translation)

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector) const override

OutputPointType	TransformPoint (const InputPointType &point) const override

OutputVectorType	TransformVector (const InputVectorType &vector) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector) const override

Public Member Functions inherited from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >
void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const override

virtual void	EvaluateJacobianWithImageGradientProduct (const InputPointType &inputPoint, const MovingImageGradientType &movingImageGradient, DerivativeType &imageJacobian, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const

virtual const char *	GetClassName () const

virtual bool	GetHasNonZeroJacobianOfSpatialHessian () const

virtual bool	GetHasNonZeroSpatialHessian () const

virtual void	GetJacobian (const InputPointType &inputPoint, JacobianType &j, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const =0

virtual void	GetJacobianOfSpatialHessian (const InputPointType &inputPoint, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const =0

virtual void	GetJacobianOfSpatialHessian (const InputPointType &inputPoint, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const =0

virtual void	GetJacobianOfSpatialJacobian (const InputPointType &inputPoint, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const =0

virtual void	GetJacobianOfSpatialJacobian (const InputPointType &inputPoint, SpatialJacobianType &sj, JacobianOfSpatialJacobianType &jsj, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const =0

virtual NumberOfParametersType	GetNumberOfNonZeroJacobianIndices () const

virtual void	GetSpatialHessian (const InputPointType &inputPoint, SpatialHessianType &sh) const =0

virtual void	GetSpatialJacobian (const InputPointType &inputPoint, SpatialJacobianType &sj) const =0

	ITK_DISALLOW_COPY_AND_MOVE (AdvancedTransform)

	itkStaticConstMacro (InputSpaceDimension, unsigned int, NInputDimensions)

	itkStaticConstMacro (OutputSpaceDimension, unsigned int, NOutputDimensions)

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::AdvancedRigid3DTransform< TScalarType >
static Pointer	New ()

Static Public Member Functions inherited from itk::AdvancedMatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >
static Pointer	New ()

Protected Member Functions
	AdvancedEuler3DTransform ()

void	ComputeMatrix () override

void	ComputeMatrixParameters () override

virtual void	PrecomputeJacobianOfSpatialJacobian ()

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

	~AdvancedEuler3DTransform () override=default

Protected Member Functions inherited from itk::AdvancedRigid3DTransform< TScalarType >
	AdvancedRigid3DTransform ()

	AdvancedRigid3DTransform (unsigned int paramDim)

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

	~AdvancedRigid3DTransform () override=default

Protected Member Functions inherited from itk::AdvancedMatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >
	AdvancedMatrixOffsetTransformBase (const unsigned int paramDims=ParametersDimension)

virtual void	ComputeMatrix ()

virtual void	ComputeMatrixParameters ()

virtual void	ComputeOffset ()

void	ComputeTranslation ()

const OutputVectorType &	GetOffset () const

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

void	SetVarMatrix (const MatrixType &matrix)

void	SetVarTranslation (const OutputVectorType &translation)

	~AdvancedMatrixOffsetTransformBase () override=default

Protected Member Functions inherited from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >
	AdvancedTransform ()=default

	~AdvancedTransform () override=default

Private Attributes
ScalarType	m_AngleX

ScalarType	m_AngleY

ScalarType	m_AngleZ

bool	m_ComputeZYX

Additional Inherited Members
Protected Attributes inherited from itk::AdvancedMatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >
JacobianOfSpatialHessianType	m_JacobianOfSpatialHessian

JacobianOfSpatialJacobianType	m_JacobianOfSpatialJacobian

NonZeroJacobianIndicesType	m_NonZeroJacobianIndices

SpatialHessianType	m_SpatialHessian

Protected Attributes inherited from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >
bool	m_HasNonZeroJacobianOfSpatialHessian { true }

bool	m_HasNonZeroSpatialHessian { true }

Member Typedef Documentation

◆ AngleType

template<class TScalarType = double>

using itk::AdvancedEuler3DTransform< TScalarType >::AngleType = typename Superclass::ScalarType

Definition at line 104 of file itkAdvancedEuler3DTransform.h.

◆ ConstPointer

template<class TScalarType = double>

using itk::AdvancedEuler3DTransform< TScalarType >::ConstPointer = SmartPointer<const Self>

Definition at line 73 of file itkAdvancedEuler3DTransform.h.

◆ Pointer

template<class TScalarType = double>

using itk::AdvancedEuler3DTransform< TScalarType >::Pointer = SmartPointer<Self>

Definition at line 72 of file itkAdvancedEuler3DTransform.h.

◆ Self

template<class TScalarType = double>

using itk::AdvancedEuler3DTransform< TScalarType >::Self = AdvancedEuler3DTransform

Standard class typedefs.

Definition at line 70 of file itkAdvancedEuler3DTransform.h.

◆ Superclass

template<class TScalarType = double>

using itk::AdvancedEuler3DTransform< TScalarType >::Superclass = AdvancedRigid3DTransform<TScalarType>

Definition at line 71 of file itkAdvancedEuler3DTransform.h.

Constructor & Destructor Documentation

◆ AdvancedEuler3DTransform()

template<class TScalarType = double>

itk::AdvancedEuler3DTransform< TScalarType >::AdvancedEuler3DTransform ( )

protected

◆ ~AdvancedEuler3DTransform()

template<class TScalarType = double>

itk::AdvancedEuler3DTransform< TScalarType >::~AdvancedEuler3DTransform ( )

overrideprotecteddefault

Member Function Documentation

◆ ComputeMatrix()

template<class TScalarType = double>

void itk::AdvancedEuler3DTransform< TScalarType >::ComputeMatrix ( )

overrideprotectedvirtual

Compute the components of the rotation matrix in the superclass.

Reimplemented from itk::AdvancedMatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >.

◆ ComputeMatrixParameters()

template<class TScalarType = double>

void itk::AdvancedEuler3DTransform< TScalarType >::ComputeMatrixParameters ( )

overrideprotectedvirtual

Reimplemented from itk::AdvancedMatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >.

◆ GetAngleX()

template<class TScalarType = double>

virtual ScalarType itk::AdvancedEuler3DTransform< TScalarType >::GetAngleX ( ) const

virtual

◆ GetAngleY()

template<class TScalarType = double>

virtual ScalarType itk::AdvancedEuler3DTransform< TScalarType >::GetAngleY ( ) const

virtual

◆ GetAngleZ()

template<class TScalarType = double>

virtual ScalarType itk::AdvancedEuler3DTransform< TScalarType >::GetAngleZ ( ) const

virtual

◆ GetClassName()

template<class TScalarType = double>

virtual const char * itk::AdvancedEuler3DTransform< TScalarType >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::AdvancedRigid3DTransform< TScalarType >.

Reimplemented in itk::GPUAdvancedEuler3DTransform< TScalarType, TParentTransform >.

◆ GetComputeZYX()

template<class TScalarType = double>

virtual bool itk::AdvancedEuler3DTransform< TScalarType >::GetComputeZYX ( ) const

virtual

◆ GetJacobian()

template<class TScalarType = double>

void itk::AdvancedEuler3DTransform< TScalarType >::GetJacobian	(	const InputPointType &	,
		JacobianType &	,
		NonZeroJacobianIndicesType &
	)		const

overridevirtual

Compute the Jacobian of the transformation.

Implements itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

◆ GetParameters()

template<class TScalarType = double>

const ParametersType & itk::AdvancedEuler3DTransform< TScalarType >::GetParameters ( ) const

override

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<class TScalarType = double>

itk::AdvancedEuler3DTransform< TScalarType >::ITK_DISALLOW_COPY_AND_MOVE ( AdvancedEuler3DTransform< TScalarType > )

◆ itkStaticConstMacro() [1/4]

template<class TScalarType = double>

itk::AdvancedEuler3DTransform< TScalarType >::itkStaticConstMacro	(	InputSpaceDimension	,
		unsigned int	,
		3
	)

◆ itkStaticConstMacro() [2/4]

template<class TScalarType = double>

itk::AdvancedEuler3DTransform< TScalarType >::itkStaticConstMacro	(	OutputSpaceDimension	,
		unsigned int	,
		3
	)

◆ itkStaticConstMacro() [3/4]

template<class TScalarType = double>

itk::AdvancedEuler3DTransform< TScalarType >::itkStaticConstMacro	(	ParametersDimension	,
		unsigned int	,
		6
	)

◆ itkStaticConstMacro() [4/4]

template<class TScalarType = double>

itk::AdvancedEuler3DTransform< TScalarType >::itkStaticConstMacro	(	SpaceDimension	,
		unsigned int	,
		3
	)

Dimension of the space.

◆ New()

template<class TScalarType = double>

static Pointer itk::AdvancedEuler3DTransform< TScalarType >::New ( )

static

New macro for creation of through a Smart Pointer.

◆ PrecomputeJacobianOfSpatialJacobian()

template<class TScalarType = double>

virtual void itk::AdvancedEuler3DTransform< TScalarType >::PrecomputeJacobianOfSpatialJacobian ( )

protectedvirtual

Update the m_JacobianOfSpatialJacobian.

◆ PrintSelf()

template<class TScalarType = double>

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

overrideprotected

◆ SetComputeZYX()

template<class TScalarType = double>

virtual void itk::AdvancedEuler3DTransform< TScalarType >::SetComputeZYX ( bool _arg )

virtual

Set/Get the order of the computation. Default ZXY

◆ SetIdentity()

template<class TScalarType = double>

void itk::AdvancedEuler3DTransform< TScalarType >::SetIdentity ( )

overridevirtual

Reimplemented from itk::AdvancedMatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >.

◆ SetParameters()

template<class TScalarType = double>

void itk::AdvancedEuler3DTransform< TScalarType >::SetParameters ( const ParametersType & parameters )

override

Set/Get the transformation from a container of parameters This is typically used by optimizers. There are 6 parameters. The first three represent the angles to rotate around the coordinate axis, and the last three represents the offset.

◆ SetRotation()

template<class TScalarType = double>

void itk::AdvancedEuler3DTransform< TScalarType >::SetRotation	(	ScalarType	angleX,
		ScalarType	angleY,
		ScalarType	angleZ
	)

Set the rotational part of the transform.

Field Documentation

◆ m_AngleX

template<class TScalarType = double>

ScalarType itk::AdvancedEuler3DTransform< TScalarType >::m_AngleX

private

Definition at line 161 of file itkAdvancedEuler3DTransform.h.

◆ m_AngleY

template<class TScalarType = double>

ScalarType itk::AdvancedEuler3DTransform< TScalarType >::m_AngleY

private

Definition at line 162 of file itkAdvancedEuler3DTransform.h.

◆ m_AngleZ

template<class TScalarType = double>

ScalarType itk::AdvancedEuler3DTransform< TScalarType >::m_AngleZ

private

Definition at line 163 of file itkAdvancedEuler3DTransform.h.

◆ m_ComputeZYX

template<class TScalarType = double>

bool itk::AdvancedEuler3DTransform< TScalarType >::m_ComputeZYX

private

Definition at line 164 of file itkAdvancedEuler3DTransform.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AngleType

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ AdvancedEuler3DTransform()

◆ ~AdvancedEuler3DTransform()

Member Function Documentation

◆ ComputeMatrix()

◆ ComputeMatrixParameters()

◆ GetAngleX()

◆ GetAngleY()

◆ GetAngleZ()

◆ GetClassName()

◆ GetComputeZYX()

◆ GetJacobian()

◆ GetParameters()

◆ ITK_DISALLOW_COPY_AND_MOVE()

◆ itkStaticConstMacro() [1/4]

◆ itkStaticConstMacro() [2/4]

◆ itkStaticConstMacro() [3/4]

◆ itkStaticConstMacro() [4/4]

◆ New()

◆ PrecomputeJacobianOfSpatialJacobian()

◆ PrintSelf()

◆ SetComputeZYX()

◆ SetIdentity()

◆ SetParameters()

◆ SetRotation()

Field Documentation

◆ m_AngleX

◆ m_AngleY

◆ m_AngleZ

◆ m_ComputeZYX