#include <itkMultiTransform.h>

Detailed Description

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>
class itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >

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 63 of file itkMultiTransform.h.

Inheritance diagram for itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >:

Collaboration diagram for itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = Array< ParametersValueType >

using	InputCovariantVectorType = CovariantVector< TParametersValueType, VInputDimension >

using	InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >

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	JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >

using	JacobianType = Array2D< ParametersValueType >

using	OutputCovariantVectorType = CovariantVector< TParametersValueType, VOutputDimension >

using	OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >

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 = MultiTransform

using	SubTransformInverseTransformBasePointer = typename TransformType::InverseTransformBasePointer

using	Superclass = Transform< TParametersValueType, VDimension, VSubDimensions >

using	TransformQueueType = std::deque< TransformTypePointer >

using	TransformType = Transform< TParametersValueType, VSubDimensions, VSubDimensions >

using	TransformTypePointer = typename TransformType::Pointer

Public Types inherited from itk::Transform< double, 3, 3 >
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = Array< ParametersValueType >

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

using	FixedParametersType = OptimizerParameters< FixedParametersValueType >

using	FixedParametersValueType = double

using	InputCovariantVectorType = CovariantVector< double, VInputDimension >

using	InputDiffusionTensor3DType = DiffusionTensor3D< double >

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

using	InputPointType = Point< double, VInputDimension >

using	InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< double, VInputDimension >

using	InputVectorPixelType = VariableLengthVector< double >

using	InputVectorType = Vector< double, VInputDimension >

using	InputVnlVectorType = vnl_vector_fixed< double, VInputDimension >

using	InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >

using	InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

using	InverseTransformBaseType = Transform< double, VOutputDimension, VInputDimension >

using	JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >

using	JacobianType = Array2D< ParametersValueType >

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

using	NumberOfParametersType = IdentifierType

using	OutputCovariantVectorType = CovariantVector< double, VOutputDimension >

using	OutputDiffusionTensor3DType = DiffusionTensor3D< double >

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

using	OutputPointType = Point< double, VOutputDimension >

using	OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< double, VOutputDimension >

using	OutputVectorPixelType = VariableLengthVector< double >

using	OutputVectorType = Vector< double, VOutputDimension >

using	OutputVnlVectorType = vnl_vector_fixed< double, VOutputDimension >

using	ParametersType = OptimizerParameters< ParametersValueType >

using	ParametersValueType = double

using	Pointer = SmartPointer< Self >

using	ScalarType = ParametersValueType

using	Self = Transform

using	Superclass = TransformBaseTemplate< double >

using	TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory

Public Types inherited from TransformBaseTemplate< double >
using	ConstPointer = SmartPointer< const Self >

using	FixedParametersType = OptimizerParameters< FixedParametersValueType >

using	FixedParametersValueType = double

using	NumberOfParametersType = IdentifierType

using	ParametersType = OptimizerParameters< ParametersValueType >

using	ParametersValueType = double

using	Pointer = SmartPointer< Self >

using	Self = TransformBaseTemplate

using	Superclass = Object

using	TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory

using	TransformCategoryType = TransformCategoryEnum

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

const char *	GetNameOfClass () const override

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

TransformCategoryEnum	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 &inputParameters) override

void	SetParameters (const ParametersType &inputParameters) override

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


virtual void	ClearTransformQueue ()

Public Member Functions inherited from itk::Transform< double, 3, 3 >
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

const char *	GetNameOfClass () const override

virtual NumberOfParametersType	GetNumberOfFixedParameters () const

virtual NumberOfParametersType	GetNumberOfLocalParameters () const

NumberOfParametersType	GetNumberOfParameters () const override

unsigned int	GetOutputSpaceDimension () const override

const ParametersType &	GetParameters () const override

TransformCategoryEnum	GetTransformCategory () const override

std::string	GetTransformTypeAsString () const override

virtual bool	IsLinear () const

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

virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &) const

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

virtual OutputPointType	TransformPoint (const InputPointType &) const=0

virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const

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

virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const

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

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &) const

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

virtual void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const=0

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

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

Public Member Functions inherited from TransformBaseTemplate< double >
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 const FixedParametersType &	GetFixedParameters () const=0

virtual unsigned int	GetInputSpaceDimension () const=0

virtual NumberOfParametersType	GetNumberOfParameters () const=0

virtual unsigned int	GetOutputSpaceDimension () const=0

virtual const ParametersType &	GetParameters () const=0

virtual TransformCategoryEnum	GetTransformCategory () const=0

virtual std::string	GetTransformTypeAsString () const=0

	ITK_DISALLOW_COPY_AND_MOVE (TransformBaseTemplate)

	itkGetConstReferenceMacro (InputSpaceName, std::string)

	itkGetConstReferenceMacro (OutputSpaceName, std::string)

	itkOverrideGetNameOfClassMacro (TransformBaseTemplate)

	itkSetMacro (InputSpaceName, std::string)

	itkSetMacro (OutputSpaceName, std::string)

virtual void	SetFixedParameters (const FixedParametersType &)=0

virtual void	SetParameters (const ParametersType &)=0

virtual void	SetParametersByValue (const ParametersType &p)=0

Static Public Attributes
static constexpr unsigned int	InputDimension = VDimension

static constexpr unsigned int	OutputDimension = VDimension

static constexpr unsigned int	SubInputDimension = VSubDimensions

static constexpr unsigned int	SubOutputDimension = VSubDimensions

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

static constexpr unsigned int	OutputSpaceDimension

Static Public Attributes inherited from TransformBaseTemplate< double >
static constexpr TransformCategoryEnum	BSpline

static constexpr TransformCategoryEnum	DisplacementField

static constexpr TransformCategoryEnum	Linear

static constexpr TransformCategoryEnum	Spline

static constexpr TransformCategoryEnum	UnknownTransformCategory

static constexpr TransformCategoryEnum	VelocityField

Protected Member Functions
	MultiTransform ()=default

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< double, 3, 3 >
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 TransformBaseTemplate< double >
	TransformBaseTemplate ()=default

	~TransformBaseTemplate () override=default

Protected Attributes
ModifiedTimeType	m_LocalParametersUpdateTime {}

NumberOfParametersType	m_NumberOfLocalParameters {}

TransformQueueType	m_TransformQueue {}

Protected Attributes inherited from itk::Transform< double, 3, 3 >
FixedParametersType	m_FixedParameters

ParametersType	m_Parameters

Additional Inherited Members
Public Attributes inherited from itk::Transform< double, 3, 3 >
InverseJacobianPositionType &jacobian	const

Static Protected Member Functions inherited from itk::Transform< double, 3, 3 >
static InverseTransformBasePointer	InvertTransform (const TTransform &transform)

Member Typedef Documentation

◆ ConstPointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::ConstPointer = SmartPointer<const Self>

Definition at line 72 of file itkMultiTransform.h.

◆ DerivativeType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::DerivativeType = Array<ParametersValueType>

Definition at line 124 of file itkTransform.h.

◆ InputCovariantVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InputCovariantVectorType = CovariantVector<TParametersValueType, VInputDimension>

Standard covariant vector type for this class

Definition at line 152 of file itkTransform.h.

◆ InputDiffusionTensor3DType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InputDiffusionTensor3DType = DiffusionTensor3D<TParametersValueType>

Definition at line 148 of file itkTransform.h.

◆ InputPointType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InputPointType = Point<TParametersValueType, VInputDimension>

Standard coordinate point type for this class

Definition at line 160 of file itkTransform.h.

◆ InputSymmetricSecondRankTensorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor<TParametersValueType, VInputDimension>

Definition at line 144 of file itkTransform.h.

◆ InputVectorPixelType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InputVectorPixelType = VariableLengthVector<TParametersValueType>

Standard variable length vector type for this class this provides an interface for the VectorImage class

Definition at line 140 of file itkTransform.h.

◆ InputVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InputVectorType = Vector<TParametersValueType, VInputDimension>

Standard vector type for this class.

Definition at line 135 of file itkTransform.h.

◆ InputVnlVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InputVnlVectorType = vnl_vector_fixed<TParametersValueType, VInputDimension>

Standard vnl_vector type for this class.

Definition at line 156 of file itkTransform.h.

◆ InverseJacobianPositionType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InverseJacobianPositionType = vnl_matrix_fixed<ParametersValueType, VInputDimension, VOutputDimension>

Definition at line 132 of file itkTransform.h.

◆ InverseTransformBasePointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

Definition at line 167 of file itkTransform.h.

◆ JacobianPositionType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::JacobianPositionType = vnl_matrix_fixed<ParametersValueType, VOutputDimension, VInputDimension>

Definition at line 131 of file itkTransform.h.

◆ JacobianType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::JacobianType = Array2D<ParametersValueType>

Type of the Jacobian matrix.

Definition at line 130 of file itkTransform.h.

◆ OutputCovariantVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::OutputCovariantVectorType = CovariantVector<TParametersValueType, VOutputDimension>

Definition at line 153 of file itkTransform.h.

◆ OutputDiffusionTensor3DType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::OutputDiffusionTensor3DType = DiffusionTensor3D<TParametersValueType>

Definition at line 149 of file itkTransform.h.

◆ OutputPointType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::OutputPointType = Point<TParametersValueType, VOutputDimension>

Definition at line 161 of file itkTransform.h.

◆ OutputSymmetricSecondRankTensorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor<TParametersValueType, VOutputDimension>

Definition at line 145 of file itkTransform.h.

◆ OutputVectorPixelType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::OutputVectorPixelType = VariableLengthVector<TParametersValueType>

Definition at line 141 of file itkTransform.h.

◆ OutputVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::OutputVectorType = Vector<TParametersValueType, VOutputDimension>

Definition at line 136 of file itkTransform.h.

◆ OutputVnlVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::OutputVnlVectorType = vnl_vector_fixed<TParametersValueType, VOutputDimension>

Definition at line 157 of file itkTransform.h.

◆ Pointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::Pointer = SmartPointer<Self>

Definition at line 71 of file itkMultiTransform.h.

◆ ScalarType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::ScalarType = ParametersValueType

Definition at line 88 of file itkMultiTransform.h.

◆ Self

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::Self = MultiTransform

Standard class type aliases.

Definition at line 69 of file itkMultiTransform.h.

◆ SubTransformInverseTransformBasePointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::SubTransformInverseTransformBasePointer = typename TransformType::InverseTransformBasePointer

InverseTransform type.

Definition at line 137 of file itkMultiTransform.h.

◆ Superclass

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::Superclass = Transform<TParametersValueType, VDimension, VSubDimensions>

Definition at line 70 of file itkMultiTransform.h.

◆ TransformQueueType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::TransformQueueType = std::deque<TransformTypePointer>

Transform queue type

Definition at line 140 of file itkMultiTransform.h.

◆ TransformType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::TransformType = Transform<TParametersValueType, VSubDimensions, VSubDimensions>

Sub transform type

Definition at line 78 of file itkMultiTransform.h.

◆ TransformTypePointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

using itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::TransformTypePointer = typename TransformType::Pointer

Definition at line 79 of file itkMultiTransform.h.

Constructor & Destructor Documentation

◆ MultiTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::MultiTransform ( )

protecteddefault

Flatten the transform queue such that there are no nested composite transforms.

◆ ~MultiTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::~MultiTransform ( )

overrideprotecteddefault

Member Function Documentation

◆ AddTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::AddTransform ( TransformType * t )

inlinevirtual

Functionality for sub transforms Add transforms to the queue, as stack. Most-recently added transform is always at back of queue, index N-1.

Definition at line 158 of file itkMultiTransform.h.

◆ AppendTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::AppendTransform ( TransformType * t )

inlinevirtual

Same as AddTransform

Definition at line 165 of file itkMultiTransform.h.

◆ ClearTransformQueue()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::ClearTransformQueue ( )

inlinevirtual

Clear the transform queue.

Reimplemented in itk::CompositeTransform< TParametersValueType, VDimension >.

Definition at line 242 of file itkMultiTransform.h.

◆ GetBackTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual const TransformType * itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetBackTransform ( ) const

inlinevirtual

Definition at line 192 of file itkMultiTransform.h.

◆ GetFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

const FixedParametersType & itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetFixedParameters ( ) const

overridevirtual

Get the fixed parameters.

Implements TransformBaseTemplate< double >.

◆ GetFrontTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual const TransformType * itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetFrontTransform ( ) const

inlinevirtual

Get transforms at the front and the back of the queue

Definition at line 186 of file itkMultiTransform.h.

◆ GetInverse()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

bool itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetInverse ( Self * inverse ) const

Returns a boolean indicating whether it is possible or not to compute the inverse of this current Transform. If it is possible, then the inverse of the transform is returned in the inverseTransform variable passed by the user. The inverse consists of the inverse of each sub-transform, in the same order as the forward transforms.

◆ GetNameOfClass()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

const char * itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetNameOfClass ( ) const

override

See also: LightObject::GetNameOfClass()

◆ GetNthTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual const TransformTypePointer itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetNthTransform ( SizeValueType n ) const

inlinevirtual

Definition at line 198 of file itkMultiTransform.h.

◆ GetNthTransformConstPointer()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual const TransformType * itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetNthTransformConstPointer ( const SizeValueType n ) const

inlinevirtual

Definition at line 214 of file itkMultiTransform.h.

◆ GetNthTransformModifiablePointer()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual TransformType * itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetNthTransformModifiablePointer ( const SizeValueType n ) const

inlinevirtual

Get the Nth transform.

Warning: No bounds checking is performed.

Definition at line 208 of file itkMultiTransform.h.

◆ GetNumberOfFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

NumberOfParametersType itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetNumberOfFixedParameters ( ) const

overridevirtual

Return the number of parameters that define the constant elements of a Transform

Reimplemented from itk::Transform< double, 3, 3 >.

◆ GetNumberOfLocalParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

NumberOfParametersType itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetNumberOfLocalParameters ( ) const

overridevirtual

Return the number of local parameters that completely defines the Transform at an individual voxel. For transforms with local support, this will enable downstream computation of the jacobian wrt only the local support region. For instance, in the case of a deformation field, this will be equal to the number of image dimensions. If it is an affine transform, this will be the same as the GetNumberOfParameters().

Reimplemented from itk::Transform< double, 3, 3 >.

◆ GetNumberOfParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

NumberOfParametersType itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetNumberOfParameters ( ) const

overridevirtual

Return the number of parameters that completely define the Transform

Implements TransformBaseTemplate< double >.

◆ GetNumberOfTransforms()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual SizeValueType itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetNumberOfTransforms ( ) const

inlinevirtual

Return the number of sub-transforms.

Definition at line 235 of file itkMultiTransform.h.

◆ GetParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

const ParametersType & itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetParameters ( ) const

overridevirtual

Get/Set Parameter functions work on all sub-transforms. The parameter data from each sub-transform is concatenated into a single ParametersType object.

Note: The sub-transforms are read in forward queue order, so the returned array is ordered in the same way. That is, first sub-transform to be added is returned first in the parameter array.

Implements TransformBaseTemplate< double >.

◆ GetTransformCategory()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

TransformCategoryEnum itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetTransformCategory ( ) const

overridevirtual

If all sub-transforms are of the same category, return that category. Otherwise return UnknownTransformCategory.

Implements TransformBaseTemplate< double >.

◆ GetTransformQueue()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual const TransformQueueType & itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::GetTransformQueue ( ) const

inlinevirtual

Access transform queue

Definition at line 221 of file itkMultiTransform.h.

◆ IsLinear()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

bool itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::IsLinear ( ) const

overridevirtual

If all sub-transforms are linear, then the multi-transform is linear.

Reimplemented from itk::Transform< double, 3, 3 >.

◆ IsTransformQueueEmpty()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual bool itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::IsTransformQueueEmpty ( ) const

inlinevirtual

Misc. functionality

Definition at line 228 of file itkMultiTransform.h.

◆ PopBackTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::PopBackTransform ( )

inlineprotectedvirtual

Reimplemented in itk::CompositeTransform< TParametersValueType, VDimension >.

Definition at line 340 of file itkMultiTransform.h.

◆ PopFrontTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::PopFrontTransform ( )

inlineprotectedvirtual

Reimplemented in itk::CompositeTransform< TParametersValueType, VDimension >.

Definition at line 333 of file itkMultiTransform.h.

◆ PrependTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::PrependTransform ( TransformType * t )

inlinevirtual

Add transform to the front of the stack

Definition at line 172 of file itkMultiTransform.h.

◆ PrintSelf()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

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

overrideprotected

◆ PushBackTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::PushBackTransform ( TransformTypePointer t )

inlineprotectedvirtual

Definition at line 326 of file itkMultiTransform.h.

◆ PushFrontTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::PushFrontTransform ( TransformTypePointer t )

inlineprotectedvirtual

Definition at line 319 of file itkMultiTransform.h.

◆ RemoveTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::RemoveTransform ( )

inlinevirtual

Remove transform from the back of the queue, index N-1

Definition at line 179 of file itkMultiTransform.h.

◆ SetFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::SetFixedParameters ( const FixedParametersType & )

overridevirtual

Set the fixed parameters and update internal transformation.

Implements itk::Transform< double, 3, 3 >.

◆ SetParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::SetParameters ( const ParametersType & )

overridevirtual

Set the transformation parameters and update internal transformation. SetParameters gives the transform the option to set it's parameters by keeping a reference to the parameters, or by copying. To force the transform to copy its parameters call SetParametersByValue.

See also: SetParametersByValue

Implements itk::Transform< double, 3, 3 >.

◆ UpdateTransformParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::UpdateTransformParameters	(	const DerivativeType &	update,
		ScalarType	factor = `1.0`
	)

overridevirtual

Update the transform's parameters by the values in update. See GetParameters() for parameter ordering.

Reimplemented from itk::Transform< double, 3, 3 >.

Member Data Documentation

◆ InputDimension

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

constexpr unsigned int itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::InputDimension = VDimension

staticconstexpr

Dimension of the domain spaces.

Definition at line 146 of file itkMultiTransform.h.

◆ m_LocalParametersUpdateTime

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

ModifiedTimeType itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::m_LocalParametersUpdateTime {}

mutableprotected

Definition at line 351 of file itkMultiTransform.h.

◆ m_NumberOfLocalParameters

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

NumberOfParametersType itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::m_NumberOfLocalParameters {}

mutableprotected

Cache to save time returning the number of local parameters

Definition at line 350 of file itkMultiTransform.h.

◆ m_TransformQueue

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

TransformQueueType itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::m_TransformQueue {}

mutableprotected

Transform container object.

Definition at line 347 of file itkMultiTransform.h.

◆ OutputDimension

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

constexpr unsigned int itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::OutputDimension = VDimension

staticconstexpr

Definition at line 147 of file itkMultiTransform.h.

◆ SubInputDimension

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

constexpr unsigned int itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::SubInputDimension = VSubDimensions

staticconstexpr

Definition at line 149 of file itkMultiTransform.h.

◆ SubOutputDimension

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>

constexpr unsigned int itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::SubOutputDimension = VSubDimensions

staticconstexpr

Definition at line 150 of file itkMultiTransform.h.

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

itkMultiTransform.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DerivativeType

◆ InputCovariantVectorType

◆ InputDiffusionTensor3DType

◆ InputPointType

◆ InputSymmetricSecondRankTensorType

◆ InputVectorPixelType

◆ InputVectorType

◆ InputVnlVectorType

◆ InverseJacobianPositionType

◆ InverseTransformBasePointer

◆ JacobianPositionType

◆ JacobianType

◆ OutputCovariantVectorType

◆ OutputDiffusionTensor3DType

◆ OutputPointType

◆ OutputSymmetricSecondRankTensorType

◆ OutputVectorPixelType

◆ OutputVectorType

◆ OutputVnlVectorType

◆ Pointer

◆ ScalarType

◆ Self

◆ SubTransformInverseTransformBasePointer

◆ Superclass

◆ TransformQueueType

◆ TransformType

◆ TransformTypePointer

Constructor & Destructor Documentation

◆ MultiTransform()

◆ ~MultiTransform()

Member Function Documentation

◆ AddTransform()

◆ AppendTransform()

◆ ClearTransformQueue()

◆ GetBackTransform()

◆ GetFixedParameters()

◆ GetFrontTransform()

◆ GetInverse()

◆ GetNameOfClass()

◆ GetNthTransform()

◆ GetNthTransformConstPointer()

◆ GetNthTransformModifiablePointer()

◆ GetNumberOfFixedParameters()

◆ GetNumberOfLocalParameters()

◆ GetNumberOfParameters()

◆ GetNumberOfTransforms()

◆ GetParameters()

◆ GetTransformCategory()

◆ GetTransformQueue()

◆ IsLinear()

◆ IsTransformQueueEmpty()

◆ PopBackTransform()

◆ PopFrontTransform()

◆ PrependTransform()

◆ PrintSelf()

◆ PushBackTransform()

◆ PushFrontTransform()

◆ RemoveTransform()

◆ SetFixedParameters()

◆ SetParameters()

◆ UpdateTransformParameters()

Member Data Documentation

◆ InputDimension

◆ m_LocalParametersUpdateTime

◆ m_NumberOfLocalParameters

◆ m_TransformQueue

◆ OutputDimension

◆ SubInputDimension

◆ SubOutputDimension