#include <itkMultiTransform.h>

Inheritance diagram for itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >:

Collaboration diagram for itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >:

Detailed Description

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
class itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >

This abstract class contains a list of transforms and provides basic methods.

This abstract base class is used by classes that operate on a list of sub-transforms. The sub-transforms can have a different dimensionality than the container transform.

Transforms are stored in a container (queue), in the following order: $ T_0, T_1, ... , T_N-1 $

Transforms are added via a single method, AddTransform(). This adds the transforms to the back of the queue. A single method for adding transforms is meant to simplify the interface and prevent errors.

Inverse todo

TODO

Interface Issues/Comments x The PushFrontTransform and PushBackTransform methods are protected to force the user to use the AddTransform method, forcing the order of transforms. Are there use cases where the user would need to insert transforms at the front of the queue? Or at arbitrary positions?

GetParameters efficiency optimization Can we optimize this to only query the sub-transforms when the params in the sub transforms have changed since the previous call? Can't use Modified time b/c that will get updated in sub-transforms with every call to SetParameters. Is this worth worrying about? i.e. how much time will it take in the overall registration process? Probably very little.

Definition at line 64 of file itkMultiTransform.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename Superclass::DerivativeType

using	FixedParametersType = typename Superclass::FixedParametersType

using	FixedParametersValueType = typename Superclass::FixedParametersValueType

using	InputCovariantVectorType = typename Superclass::InputCovariantVectorType

using	InputDiffusionTensor3DType = typename Superclass::InputDiffusionTensor3DType

using	InputPointType = typename Superclass::InputPointType

using	InputSymmetricSecondRankTensorType = typename Superclass::InputSymmetricSecondRankTensorType

using	InputVectorPixelType = typename Superclass::InputVectorPixelType

using	InputVectorType = typename Superclass::InputVectorType

using	InputVnlVectorType = typename Superclass::InputVnlVectorType

using	InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType

using	InverseTransformBasePointer = typename Superclass::InverseTransformBasePointer

using	JacobianPositionType = typename Superclass::JacobianPositionType

using	JacobianType = typename Superclass::JacobianType

using	NumberOfParametersType = typename Superclass::NumberOfParametersType

using	OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType

using	OutputDiffusionTensor3DType = typename Superclass::OutputDiffusionTensor3DType

using	OutputPointType = typename Superclass::OutputPointType

using	OutputSymmetricSecondRankTensorType = typename Superclass::OutputSymmetricSecondRankTensorType

using	OutputVectorPixelType = typename Superclass::OutputVectorPixelType

using	OutputVectorType = typename Superclass::OutputVectorType

using	OutputVnlVectorType = typename Superclass::OutputVnlVectorType

using	ParametersType = typename Superclass::ParametersType

using	ParametersValueType = typename Superclass::ParametersValueType

using	Pointer = SmartPointer< Self >

using	ScalarType = ParametersValueType

using	Self = MultiTransform

using	SubTransformInverseTransformBasePointer = typename TransformType::InverseTransformBasePointer

using	Superclass = Transform< TParametersValueType, NDimensions, NSubDimensions >

using	TransformCategoryType = typename Superclass::TransformCategoryType

using	TransformQueueType = std::deque< TransformTypePointer >

using	TransformType = Transform< TParametersValueType, NSubDimensions, NSubDimensions >

using	TransformTypePointer = typename TransformType::Pointer

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

using	DerivativeType = Array< ParametersValueType >

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

using	FixedParametersType = typename Superclass::FixedParametersType

using	FixedParametersValueType = typename Superclass::FixedParametersValueType

using	InputCovariantVectorType = CovariantVector< TParametersValueType, NInputDimensions >

using	InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >

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

using	InputPointType = Point< TParametersValueType, NInputDimensions >

using	InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, NInputDimensions >

using	InputVectorPixelType = VariableLengthVector< TParametersValueType >

using	InputVectorType = Vector< TParametersValueType, NInputDimensions >

using	InputVnlVectorType = vnl_vector_fixed< TParametersValueType, NInputDimensions >

using	InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, NInputDimensions, NOutputDimensions >

using	InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

using	InverseTransformBaseType = Transform< TParametersValueType, NOutputDimensions, NInputDimensions >

using	JacobianPositionType = vnl_matrix_fixed< ParametersValueType, NOutputDimensions, NInputDimensions >

using	JacobianType = Array2D< ParametersValueType >

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

using	NumberOfParametersType = typename Superclass::NumberOfParametersType

using	OutputCovariantVectorType = CovariantVector< TParametersValueType, NOutputDimensions >

using	OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >

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

using	OutputPointType = Point< TParametersValueType, NOutputDimensions >

using	OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, NOutputDimensions >

using	OutputVectorPixelType = VariableLengthVector< TParametersValueType >

using	OutputVectorType = Vector< TParametersValueType, NOutputDimensions >

using	OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, NOutputDimensions >

using	ParametersType = typename Superclass::ParametersType

using	ParametersValueType = typename Superclass::ParametersValueType

using	Pointer = SmartPointer< Self >

using	ScalarType = ParametersValueType

using	Self = Transform

using	Superclass = TransformBaseTemplate< TParametersValueType >

using	TransformCategoryType = typename Superclass::TransformCategoryType

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

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

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
virtual void	AddTransform (TransformType *t)

virtual void	AppendTransform (TransformType *t)

virtual const TransformType *	GetBackTransform () const

const FixedParametersType &	GetFixedParameters () const override

virtual const TransformType *	GetFrontTransform () const

bool	GetInverse (Self *inverse) const

virtual const char *	GetNameOfClass () const

virtual const TransformTypePointer	GetNthTransform (SizeValueType n) const

virtual const TransformType *	GetNthTransformConstPointer (const SizeValueType n) const

virtual TransformType *	GetNthTransformModifiablePointer (const SizeValueType n) const

NumberOfParametersType	GetNumberOfFixedParameters () const override

NumberOfParametersType	GetNumberOfLocalParameters () const override

NumberOfParametersType	GetNumberOfParameters () const override

virtual SizeValueType	GetNumberOfTransforms () const

const ParametersType &	GetParameters () const override

TransformCategoryType	GetTransformCategory () const override

virtual const TransformQueueType &	GetTransformQueue () const

bool	IsLinear () const override

virtual bool	IsTransformQueueEmpty () const

virtual void	PrependTransform (TransformType *t)

virtual void	RemoveTransform ()

void	SetFixedParameters (const FixedParametersType &fixedParameters) override

void	SetParameters (const ParametersType &p) override

void	UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0) override


virtual void	ClearTransformQueue ()

Public Member Functions inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
virtual void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const =0

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

const FixedParametersType &	GetFixedParameters () const override

unsigned int	GetInputSpaceDimension () const override

bool	GetInverse (Self *) const

virtual InverseTransformBasePointer	GetInverseTransform () const

NumberOfParametersType	GetNumberOfParameters () const override

unsigned int	GetOutputSpaceDimension () const override

const ParametersType &	GetParameters () const override

TransformCategoryType	GetTransformCategory () const override

std::string	GetTransformTypeAsString () const override

	itkCloneMacro (Self)

void	SetFixedParameters (const FixedParametersType &) override=0

void	SetParameters (const ParametersType &) override=0

void	SetParametersByValue (const ParametersType &p) override

virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const

virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const

virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &) const

virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const

virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const

virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor, const InputPointType &point) const

virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &) const

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

virtual OutputPointType	TransformPoint (const InputPointType &) const =0

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

virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const

virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const

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

virtual OutputVectorType	TransformVector (const InputVectorType &) const

virtual OutputVectorType	TransformVector (const InputVectorType &vector, const InputPointType &point) const

virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const

virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &) const

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const

virtual void	UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)

virtual void	ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const

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

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

virtual void	ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, InverseJacobianPositionType &jacobian) const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) 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 noexceptoverride

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
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

Static Public Attributes
static constexpr unsigned int	InputDimension = NDimensions

static constexpr unsigned int	OutputDimension = NDimensions

static constexpr unsigned int	SubInputDimension = NSubDimensions

static constexpr unsigned int	SubOutputDimension = NSubDimensions

Static Public Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
static constexpr unsigned int	InputSpaceDimension

static constexpr unsigned int	OutputSpaceDimension

Protected Member Functions
	MultiTransform ()

virtual void	PopBackTransform ()

virtual void	PopFrontTransform ()

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

virtual void	PushBackTransform (TransformTypePointer t)

virtual void	PushFrontTransform (TransformTypePointer t)

	~MultiTransform () override=default

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

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

	Transform ()

	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 &time)

	~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 ()

Protected Attributes
ModifiedTimeType	m_LocalParametersUpdateTime

NumberOfParametersType	m_NumberOfLocalParameters

TransformQueueType	m_TransformQueue

Protected Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
DirectionChangeMatrix	m_DirectionChange

FixedParametersType	m_FixedParameters

ParametersType	m_Parameters

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

Additional Inherited Members
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 ()