#include <itkCompositeTransform.h>

Inheritance diagram for itk::CompositeTransform< TParametersValueType, NDimensions >:

Collaboration diagram for itk::CompositeTransform< TParametersValueType, NDimensions >:

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 = typename Superclass::ScalarType

using	Self = CompositeTransform

using	Superclass = MultiTransform< TParametersValueType, NDimensions, NDimensions >

using	TransformCategoryEnum = typename Superclass::TransformCategoryEnum

using	TransformQueueType = typename Superclass::TransformQueueType

using	TransformsToOptimizeFlagsType = std::deque< bool >

using	TransformType = typename Superclass::TransformType

using	TransformTypePointer = typename Superclass::TransformTypePointer

Public Types inherited from itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >
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	TransformCategoryEnum = typename Superclass::TransformCategoryEnum

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	TransformCategoryEnum = typename Superclass::TransformCategoryEnum

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	ClearTransformQueue () override

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

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

virtual void	FlattenTransformQueue ()

const FixedParametersType &	GetFixedParameters () const override

bool	GetInverse (Self *inverse) const

InverseTransformBasePointer	GetInverseTransform () const override

virtual const char *	GetNameOfClass () const

virtual bool	GetNthTransformToOptimize (SizeValueType i) const

NumberOfParametersType	GetNumberOfFixedParameters () const override

NumberOfParametersType	GetNumberOfLocalParameters () const override

NumberOfParametersType	GetNumberOfParameters () const override

const ParametersType &	GetParameters () const override

TransformCategoryEnum	GetTransformCategory () const override

virtual const TransformsToOptimizeFlagsType &	GetTransformsToOptimizeFlags () const

virtual void	SetAllTransformsToOptimize (bool state)

virtual void	SetAllTransformsToOptimizeOff ()

virtual void	SetAllTransformsToOptimizeOn ()

void	SetFixedParameters (const FixedParametersType &inputParameters) override

virtual void	SetNthTransformToOptimize (SizeValueType i, bool state)

virtual void	SetNthTransformToOptimizeOff (SizeValueType i)

virtual void	SetNthTransformToOptimizeOn (SizeValueType i)

virtual void	SetOnlyMostRecentTransformToOptimizeOn ()

void	SetParameters (const ParametersType &inputParameters) override

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const override

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &inputVector, const InputPointType &inputPoint) const override

OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &) const override

OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &inputVector, const InputPointType &inputPoint) const override

OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor) const override

OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &inputPoint) const override

OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor) const override

OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &inputPoint) const override

OutputPointType	TransformPoint (const InputPointType &inputPoint) const override

OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor) const override

OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &inputPoint) const override

OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor) const override

OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &inputPoint) const override

OutputVectorPixelType	TransformVector (const InputVectorPixelType &inputVector) const override

OutputVectorPixelType	TransformVector (const InputVectorPixelType &inputVector, const InputPointType &inputPoint) const override

OutputVectorType	TransformVector (const InputVectorType &) const override

OutputVectorType	TransformVector (const InputVectorType &inputVector, const InputPointType &inputPoint) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &inputVector) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &inputVector, const InputPointType &inputPoint) const override

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

Public Member Functions inherited from itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >
virtual void	AddTransform (TransformType *t)

virtual void	AppendTransform (TransformType *t)

virtual const TransformType *	GetBackTransform () const

virtual const TransformType *	GetFrontTransform () const

virtual const TransformTypePointer	GetNthTransform (SizeValueType n) const

virtual const TransformType *	GetNthTransformConstPointer (const SizeValueType n) const

virtual TransformType *	GetNthTransformModifiablePointer (const SizeValueType n) const

virtual SizeValueType	GetNumberOfTransforms () const

virtual const TransformQueueType &	GetTransformQueue () const

virtual bool	IsTransformQueueEmpty () const

virtual void	PrependTransform (TransformType *t)

virtual void	RemoveTransform ()

bool	IsLinear () const override

TransformCategoryEnum	GetTransformCategory () const override

const ParametersType &	GetParameters () const override

void	SetParameters (const ParametersType &inputParameters) override

const FixedParametersType &	GetFixedParameters () const override

void	SetFixedParameters (const FixedParametersType &inputParameters) override

NumberOfParametersType	GetNumberOfParameters () const override

NumberOfParametersType	GetNumberOfLocalParameters () const override

NumberOfParametersType	GetNumberOfFixedParameters () const override

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

bool	GetInverse (Self *inverse) const

Public Member Functions inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
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

NumberOfParametersType	GetNumberOfParameters () const override

unsigned int	GetOutputSpaceDimension () const override

const ParametersType &	GetParameters () const override

TransformCategoryEnum	GetTransformCategory () const override

std::string	GetTransformTypeAsString () const override

	itkCloneMacro (Self)

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	ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const

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 &pnt, 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

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

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

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::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	InputDimension = NDimensions

static constexpr unsigned int	OutputDimension = NDimensions

Static Public Attributes inherited from itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >
static constexpr unsigned int	InputDimension

static constexpr unsigned int	OutputDimension

static constexpr unsigned int	SubInputDimension

static constexpr unsigned int	SubOutputDimension

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

static constexpr unsigned int	OutputSpaceDimension

TransformQueueType	m_TransformsToOptimizeQueue

TransformsToOptimizeFlagsType	m_TransformsToOptimizeFlags

ModifiedTimeType	m_PreviousTransformsToOptimizeUpdateTime

void	ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &outJacobian, JacobianType &cacheJacobian) const override

	CompositeTransform ()

	~CompositeTransform () override=default

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

LightObject::Pointer	InternalClone () const override

void	PushFrontTransform (TransformTypePointer t) override

void	PushBackTransform (TransformTypePointer t) override

void	PopFrontTransform () override

void	PopBackTransform () override

TransformQueueType &	GetTransformsToOptimizeQueue () const

Additional Inherited Members
Protected Member Functions inherited from itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >
	MultiTransform ()

	~MultiTransform () override=default

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

virtual void	PushFrontTransform (TransformTypePointer t)

virtual void	PushBackTransform (TransformTypePointer t)

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

	Transform ()

	Transform (NumberOfParametersType numberOfParameters)

	~Transform () override=default

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

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

	~TransformBaseTemplate () override=default

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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 inherited from itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >
TransformQueueType	m_TransformQueue

NumberOfParametersType	m_NumberOfLocalParameters

ModifiedTimeType	m_LocalParametersUpdateTime

Protected Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
ParametersType	m_Parameters

FixedParametersType	m_FixedParameters

DirectionChangeMatrix	m_DirectionChange

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

Detailed Description

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

This class contains a list of transforms and concatenates them by composition.

This class concatenates transforms in reverse queue order by means of composition: $ T_0 o T_1 = T_0(T_1(x)) $ 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. One use of the class is to optimize only a subset of included transforms.

The sub transforms are the same dimensionality as this class.

Example: A user wants to optimize two Affine transforms together, then add a Deformation Field (DF) transform, and optimize it separately. He first adds the two Affines, then runs the optimization and both Affines transforms are optimized. Next, he adds the DF transform and calls SetOnlyMostRecentTransformToOptimizeOn, which clears the optimization flags for both of the affine transforms, and leaves the flag set only for the DF transform, since it was the last transform added. Now he runs the optimization and only the DF transform is optimized, but the affines are included in the transformation during the optimization.

Optimization Flags: The m_TransformsToOptimize flags hold one flag for each transform in the queue, designating if each transform is to be used for optimization. Note that all transforms in the queue are applied in TransformPoint, regardless of these flags states'. The methods GetParameters, SetParameters, ComputeJacobianWithRespectToParameters, GetTransformCategory, GetFixedParameters, and SetFixedParameters all query these flags and include only those transforms whose corresponding flag is set. Their input or output is a concatenated array of all transforms set for use in optimization. The goal is to be able to optimize multiple transforms at once, while leaving other transforms fixed. See the above example.

Setting Optimization Flags: A transform's optimization flag is set when it is added to the queue, and remains set as other transforms are added. The methods SetNthTransformToOptimize* and SetAllTransformToOptimize* are used to set and clear flags arbitrarily. SetOnlyMostRecentTransformToOptimizeOn is a convenience method for setting only the most recently added transform for optimization, with the idea that this will be a common practice.

Indexing: The index values used in GetNthTransform and SetNthTransformToOptimize* and SetAllTransformToOptimize* follow the order in which transforms were added. Thus, the first transform added is at index 0, the next at index 1, etc.

Inverse: The inverse transform is created by retrieving the inverse from each sub transform and adding them to a composite transform in reverse order. The m_TransformsToOptimizeFlags is copied in reverse for the inverse.

Examples: Examples/IO/TransformReadWrite.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx, SphinxExamples/src/Core/Transform/CopyACompositeTransform/Code.cxx, SphinxExamples/src/Registration/Common/Perform2DTranslationRegistrationWithMeanSquares/Code.cxx, and SphinxExamples/src/Registration/Metricsv4/PerformRegistrationOnVectorImages/Code.cxx.

Definition at line 87 of file itkCompositeTransform.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::ConstPointer = SmartPointer<const Self>

Definition at line 96 of file itkCompositeTransform.h.

◆ DerivativeType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::DerivativeType = typename Superclass::DerivativeType

Derivative type

Definition at line 121 of file itkCompositeTransform.h.

◆ FixedParametersType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::FixedParametersType = typename Superclass::FixedParametersType

Parameters type.

Definition at line 115 of file itkCompositeTransform.h.

◆ FixedParametersValueType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::FixedParametersValueType = typename Superclass::FixedParametersValueType

Definition at line 116 of file itkCompositeTransform.h.

◆ InputCovariantVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::InputCovariantVectorType = typename Superclass::InputCovariantVectorType

Standard covariant vector type for this class

Definition at line 140 of file itkCompositeTransform.h.

◆ InputDiffusionTensor3DType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::InputDiffusionTensor3DType = typename Superclass::InputDiffusionTensor3DType

Standard DiffusionTensor3D type alias for this class

Definition at line 152 of file itkCompositeTransform.h.

◆ InputPointType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::InputPointType = typename Superclass::InputPointType

Standard coordinate point type for this class.

Definition at line 132 of file itkCompositeTransform.h.

◆ InputSymmetricSecondRankTensorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::InputSymmetricSecondRankTensorType = typename Superclass::InputSymmetricSecondRankTensorType

Standard SymmetricSecondRankTensor type alias for this class

Definition at line 156 of file itkCompositeTransform.h.

◆ InputVectorPixelType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::InputVectorPixelType = typename Superclass::InputVectorPixelType

Standard Vectorpixel type for this class

Definition at line 148 of file itkCompositeTransform.h.

◆ InputVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::InputVectorType = typename Superclass::InputVectorType

Standard vector type for this class.

Definition at line 136 of file itkCompositeTransform.h.

◆ InputVnlVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::InputVnlVectorType = typename Superclass::InputVnlVectorType

Standard vnl_vector type for this class.

Definition at line 144 of file itkCompositeTransform.h.

◆ InverseJacobianPositionType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType

Definition at line 126 of file itkCompositeTransform.h.

◆ InverseTransformBasePointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::InverseTransformBasePointer = typename Superclass::InverseTransformBasePointer

InverseTransform type.

Definition at line 109 of file itkCompositeTransform.h.

◆ JacobianPositionType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::JacobianPositionType = typename Superclass::JacobianPositionType

Definition at line 125 of file itkCompositeTransform.h.

◆ JacobianType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::JacobianType = typename Superclass::JacobianType

Jacobian types.

Definition at line 124 of file itkCompositeTransform.h.

◆ NumberOfParametersType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::NumberOfParametersType = typename Superclass::NumberOfParametersType

The number of parameters defining this transform.

Definition at line 163 of file itkCompositeTransform.h.

◆ OutputCovariantVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType

Definition at line 141 of file itkCompositeTransform.h.

◆ OutputDiffusionTensor3DType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::OutputDiffusionTensor3DType = typename Superclass::OutputDiffusionTensor3DType

Definition at line 153 of file itkCompositeTransform.h.

◆ OutputPointType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::OutputPointType = typename Superclass::OutputPointType

Definition at line 133 of file itkCompositeTransform.h.

◆ OutputSymmetricSecondRankTensorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::OutputSymmetricSecondRankTensorType = typename Superclass::OutputSymmetricSecondRankTensorType

Definition at line 157 of file itkCompositeTransform.h.

◆ OutputVectorPixelType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::OutputVectorPixelType = typename Superclass::OutputVectorPixelType

Definition at line 149 of file itkCompositeTransform.h.

◆ OutputVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::OutputVectorType = typename Superclass::OutputVectorType

Definition at line 137 of file itkCompositeTransform.h.

◆ OutputVnlVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::OutputVnlVectorType = typename Superclass::OutputVnlVectorType

Definition at line 145 of file itkCompositeTransform.h.

◆ ParametersType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::ParametersType = typename Superclass::ParametersType

Definition at line 117 of file itkCompositeTransform.h.

◆ ParametersValueType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::ParametersValueType = typename Superclass::ParametersValueType

Definition at line 118 of file itkCompositeTransform.h.

◆ Pointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::Pointer = SmartPointer<Self>

Definition at line 95 of file itkCompositeTransform.h.

◆ ScalarType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::ScalarType = typename Superclass::ScalarType

Scalar type.

Definition at line 112 of file itkCompositeTransform.h.

◆ Self

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::Self = CompositeTransform

Standard class type aliases.

Definition at line 93 of file itkCompositeTransform.h.

◆ Superclass

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::Superclass = MultiTransform<TParametersValueType, NDimensions, NDimensions>

Definition at line 94 of file itkCompositeTransform.h.

◆ TransformCategoryEnum

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::TransformCategoryEnum = typename Superclass::TransformCategoryEnum

Transform category type.

Definition at line 129 of file itkCompositeTransform.h.

◆ TransformQueueType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::TransformQueueType = typename Superclass::TransformQueueType

Transform queue type

Definition at line 160 of file itkCompositeTransform.h.

◆ TransformsToOptimizeFlagsType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::TransformsToOptimizeFlagsType = std::deque<bool>

Optimization flags queue type

Definition at line 166 of file itkCompositeTransform.h.

◆ TransformType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::TransformType = typename Superclass::TransformType

Sub transform type

Definition at line 105 of file itkCompositeTransform.h.

◆ TransformTypePointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

using itk::CompositeTransform< TParametersValueType, NDimensions >::TransformTypePointer = typename Superclass::TransformTypePointer

Definition at line 106 of file itkCompositeTransform.h.

Constructor & Destructor Documentation

◆ CompositeTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

itk::CompositeTransform< TParametersValueType, NDimensions >::CompositeTransform ( )

protected

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

◆ ~CompositeTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

itk::CompositeTransform< TParametersValueType, NDimensions >::~CompositeTransform ( )

overrideprotecteddefault

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

Member Function Documentation

◆ ClearTransformQueue()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

void itk::CompositeTransform< TParametersValueType, NDimensions >::ClearTransformQueue ( )

inlineoverridevirtual

Clear the transform queue.

Reimplemented from itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >.

Definition at line 240 of file itkCompositeTransform.h.

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

void itk::CompositeTransform< TParametersValueType, NDimensions >::ComputeJacobianWithRespectToParameters	(	const InputPointType &	p,
		JacobianType &	outJacobian
	)		const

override

Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. See comments in the implementation.

◆ ComputeJacobianWithRespectToParametersCachedTemporaries()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

void itk::CompositeTransform< TParametersValueType, NDimensions >::ComputeJacobianWithRespectToParametersCachedTemporaries	(	const InputPointType &	p,
		JacobianType &	outJacobian,
		JacobianType &	cacheJacobian
	)		const

override

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

◆ CreateAnother()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual::itk::LightObject::Pointer itk::CompositeTransform< TParametersValueType, NDimensions >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ FlattenTransformQueue()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual void itk::CompositeTransform< TParametersValueType, NDimensions >::FlattenTransformQueue ( )

virtual

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

◆ GetFixedParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

const FixedParametersType& itk::CompositeTransform< TParametersValueType, NDimensions >::GetFixedParameters ( ) const

overridevirtual

Get the fixed parameters.

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ GetInverse()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

bool itk::CompositeTransform< TParametersValueType, NDimensions >::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 reverse order of the forward transforms.

◆ GetInverseTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

InverseTransformBasePointer itk::CompositeTransform< TParametersValueType, NDimensions >::GetInverseTransform ( ) const

overridevirtual

Return an inverse of this transform. If the inverse has not been implemented, return nullptr. The type of the inverse transform does not necessarily need to match the type of the forward transform. This allows one to return a numeric inverse transform instead.

Reimplemented from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >.

◆ GetNameOfClass()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual const char* itk::CompositeTransform< TParametersValueType, NDimensions >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >.

◆ GetNthTransformToOptimize()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual bool itk::CompositeTransform< TParametersValueType, NDimensions >::GetNthTransformToOptimize ( SizeValueType i ) const

inlinevirtual

Definition at line 227 of file itkCompositeTransform.h.

◆ GetNumberOfFixedParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

NumberOfParametersType itk::CompositeTransform< TParametersValueType, NDimensions >::GetNumberOfFixedParameters ( ) const

overridevirtual

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

Reimplemented from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >.

◆ GetNumberOfLocalParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

NumberOfParametersType itk::CompositeTransform< TParametersValueType, NDimensions >::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< TParametersValueType, NDimensions, NSubDimensions >.

◆ GetNumberOfParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

NumberOfParametersType itk::CompositeTransform< TParametersValueType, NDimensions >::GetNumberOfParameters ( ) const

overridevirtual

Return the number of parameters that completely define the Transfom

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ GetParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

const ParametersType& itk::CompositeTransform< TParametersValueType, NDimensions >::GetParameters ( ) const

overridevirtual

Get/Set Parameter functions work on the current list of transforms that are set to be optimized (active) using the 'Set[Nth|All]TransformToOptimze' routines. The parameter data from each active transform is concatenated into a single ParametersType object.

Note: The sub-transforms are read in reverse queue order, so the returned array is ordered in the same way. That is, the last sub-transform to be added is returned first in the parameter array. This is the opposite of what's done in the parent MultiTransform class.

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ GetTransformCategory()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

TransformCategoryEnum itk::CompositeTransform< TParametersValueType, NDimensions >::GetTransformCategory ( ) const

overridevirtual

Special handling for composite transform. If all transforms are linear, then return category Linear. Otherwise if all transforms set to optimize are DisplacementFields, then return DisplacementField category.

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ GetTransformsToOptimizeFlags()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual const TransformsToOptimizeFlagsType& itk::CompositeTransform< TParametersValueType, NDimensions >::GetTransformsToOptimizeFlags ( ) const

inlinevirtual

Access optimize flags

Definition at line 234 of file itkCompositeTransform.h.

◆ GetTransformsToOptimizeQueue()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

TransformQueueType& itk::CompositeTransform< TParametersValueType, NDimensions >::GetTransformsToOptimizeQueue ( ) const

protected

Get a list of transforms to optimize. Helper function.

◆ InternalClone()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

LightObject::Pointer itk::CompositeTransform< TParametersValueType, NDimensions >::InternalClone ( ) const

overrideprotectedvirtual

Clone the current transform

Reimplemented from itk::LightObject.

◆ New()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

static Pointer itk::CompositeTransform< TParametersValueType, NDimensions >::New ( )

static

New macro for creation of through a Smart Pointer

◆ PopBackTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

void itk::CompositeTransform< TParametersValueType, NDimensions >::PopBackTransform ( )

inlineoverrideprotectedvirtual

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

Reimplemented from itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >.

Definition at line 457 of file itkCompositeTransform.h.

◆ PopFrontTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

void itk::CompositeTransform< TParametersValueType, NDimensions >::PopFrontTransform ( )

inlineoverrideprotectedvirtual

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

Reimplemented from itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >.

Definition at line 450 of file itkCompositeTransform.h.

◆ PrintSelf()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

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

overrideprotectedvirtual

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

Reimplemented from itk::Object.

◆ PushBackTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

void itk::CompositeTransform< TParametersValueType, NDimensions >::PushBackTransform ( TransformTypePointer t )

inlineoverrideprotected

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

Definition at line 442 of file itkCompositeTransform.h.

◆ PushFrontTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

void itk::CompositeTransform< TParametersValueType, NDimensions >::PushFrontTransform ( TransformTypePointer t )

inlineoverrideprotected

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

Definition at line 434 of file itkCompositeTransform.h.

◆ SetAllTransformsToOptimize()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual void itk::CompositeTransform< TParametersValueType, NDimensions >::SetAllTransformsToOptimize ( bool state )

inlinevirtual

Definition at line 194 of file itkCompositeTransform.h.

◆ SetAllTransformsToOptimizeOff()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual void itk::CompositeTransform< TParametersValueType, NDimensions >::SetAllTransformsToOptimizeOff ( )

inlinevirtual

Definition at line 207 of file itkCompositeTransform.h.

◆ SetAllTransformsToOptimizeOn()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual void itk::CompositeTransform< TParametersValueType, NDimensions >::SetAllTransformsToOptimizeOn ( )

inlinevirtual

Definition at line 201 of file itkCompositeTransform.h.

◆ SetFixedParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

void itk::CompositeTransform< TParametersValueType, NDimensions >::SetFixedParameters ( const FixedParametersType & inputParameters )

override

◆ SetNthTransformToOptimize()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual void itk::CompositeTransform< TParametersValueType, NDimensions >::SetNthTransformToOptimize	(	SizeValueType	i,
		bool	state
	)

inlinevirtual

Active Transform state manipulation

Definition at line 175 of file itkCompositeTransform.h.

◆ SetNthTransformToOptimizeOff()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual void itk::CompositeTransform< TParametersValueType, NDimensions >::SetNthTransformToOptimizeOff ( SizeValueType i )

inlinevirtual

Definition at line 188 of file itkCompositeTransform.h.

◆ SetNthTransformToOptimizeOn()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual void itk::CompositeTransform< TParametersValueType, NDimensions >::SetNthTransformToOptimizeOn ( SizeValueType i )

inlinevirtual

Definition at line 182 of file itkCompositeTransform.h.

◆ SetOnlyMostRecentTransformToOptimizeOn()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

virtual void itk::CompositeTransform< TParametersValueType, NDimensions >::SetOnlyMostRecentTransformToOptimizeOn ( )

inlinevirtual

Definition at line 216 of file itkCompositeTransform.h.

◆ SetParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

void itk::CompositeTransform< TParametersValueType, NDimensions >::SetParameters ( const ParametersType & inputParameters )

override

◆ TransformCovariantVector() [1/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputCovariantVectorType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformCovariantVector ( const InputCovariantVectorType & ) const

override

◆ TransformCovariantVector() [2/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputCovariantVectorType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformCovariantVector	(	const InputCovariantVectorType &	inputVector,
		const InputPointType &	inputPoint
	)		const

override

◆ TransformCovariantVector() [3/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVectorPixelType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformCovariantVector ( const InputVectorPixelType & ) const

override

◆ TransformCovariantVector() [4/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVectorPixelType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformCovariantVector	(	const InputVectorPixelType &	inputVector,
		const InputPointType &	inputPoint
	)		const

override

◆ TransformDiffusionTensor3D() [1/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputDiffusionTensor3DType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformDiffusionTensor3D ( const InputDiffusionTensor3DType & inputTensor ) const

override

◆ TransformDiffusionTensor3D() [2/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputDiffusionTensor3DType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformDiffusionTensor3D	(	const InputDiffusionTensor3DType &	inputTensor,
		const InputPointType &	inputPoint
	)		const

override

◆ TransformDiffusionTensor3D() [3/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVectorPixelType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformDiffusionTensor3D ( const InputVectorPixelType & inputTensor ) const

override

◆ TransformDiffusionTensor3D() [4/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVectorPixelType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformDiffusionTensor3D	(	const InputVectorPixelType &	inputTensor,
		const InputPointType &	inputPoint
	)		const

override

◆ TransformPoint()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputPointType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformPoint ( const InputPointType & inputPoint ) const

override

Compute the position of point in the new space.

Transforms are applied starting from the back of the queue. That is, in reverse order of which they were added, in order to work properly with ResampleFilter.

Imagine a user wants to apply an Affine transform followed by a Deformation Field (DF) transform. He adds the Affine, then the DF. Because the user typically conceptualizes a transformation as being applied from the Moving image to the Fixed image, this makes intuitive sense. But since the ResampleFilter expects to transform from the Fixed image to the Moving image, the transforms are applied in reverse order of addition, i.e. from the back of the queue, and thus, DF then Affine.

◆ TransformSymmetricSecondRankTensor() [1/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputSymmetricSecondRankTensorType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformSymmetricSecondRankTensor ( const InputSymmetricSecondRankTensorType & inputTensor ) const

override

◆ TransformSymmetricSecondRankTensor() [2/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputSymmetricSecondRankTensorType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformSymmetricSecondRankTensor	(	const InputSymmetricSecondRankTensorType &	inputTensor,
		const InputPointType &	inputPoint
	)		const

override

◆ TransformSymmetricSecondRankTensor() [3/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVectorPixelType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformSymmetricSecondRankTensor ( const InputVectorPixelType & inputTensor ) const

override

◆ TransformSymmetricSecondRankTensor() [4/4]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVectorPixelType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformSymmetricSecondRankTensor	(	const InputVectorPixelType &	inputTensor,
		const InputPointType &	inputPoint
	)		const

override

◆ TransformVector() [1/6]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVectorPixelType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformVector ( const InputVectorPixelType & inputVector ) const

override

◆ TransformVector() [2/6]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVectorPixelType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformVector	(	const InputVectorPixelType &	inputVector,
		const InputPointType &	inputPoint
	)		const

override

◆ TransformVector() [3/6]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVectorType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformVector ( const InputVectorType & ) const

override

◆ TransformVector() [4/6]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVectorType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformVector	(	const InputVectorType &	inputVector,
		const InputPointType &	inputPoint
	)		const

override

◆ TransformVector() [5/6]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVnlVectorType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformVector ( const InputVnlVectorType & inputVector ) const

override

◆ TransformVector() [6/6]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

OutputVnlVectorType itk::CompositeTransform< TParametersValueType, NDimensions >::TransformVector	(	const InputVnlVectorType &	inputVector,
		const InputPointType &	inputPoint
	)		const

override

◆ UpdateTransformParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

void itk::CompositeTransform< TParametersValueType, NDimensions >::UpdateTransformParameters	(	const DerivativeType &	update,
		ScalarType	factor = `1.0`
	)

override

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

Member Data Documentation

◆ InputDimension

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

constexpr unsigned int itk::CompositeTransform< TParametersValueType, NDimensions >::InputDimension = NDimensions

staticconstexpr

Dimension of the domain spaces.

Definition at line 169 of file itkCompositeTransform.h.

◆ m_PreviousTransformsToOptimizeUpdateTime

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

ModifiedTimeType itk::CompositeTransform< TParametersValueType, NDimensions >::m_PreviousTransformsToOptimizeUpdateTime

mutableprivate

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

Definition at line 471 of file itkCompositeTransform.h.

◆ m_TransformsToOptimizeFlags

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

TransformsToOptimizeFlagsType itk::CompositeTransform< TParametersValueType, NDimensions >::m_TransformsToOptimizeFlags

mutableprotected

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

Definition at line 468 of file itkCompositeTransform.h.

◆ m_TransformsToOptimizeQueue

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

TransformQueueType itk::CompositeTransform< TParametersValueType, NDimensions >::m_TransformsToOptimizeQueue

mutableprotected

Expanded interface to Compute the Jacobian with respect to the parameters for the composite transform using Jacobian rule. This version takes in temporary variables to avoid excessive constructions and memory allocations. NOTE: outJacobian MUST be sized correctly prior to the call; outJacobian's size should be [NDimensions, this->GetNumberOfLocalParameters() ] jacobianCache may be resized internally and will be reused between calls

Definition at line 467 of file itkCompositeTransform.h.

◆ OutputDimension

template<typename TParametersValueType = double, unsigned int NDimensions = 3>

constexpr unsigned int itk::CompositeTransform< TParametersValueType, NDimensions >::OutputDimension = NDimensions

staticconstexpr

Definition at line 170 of file itkCompositeTransform.h.

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

itkCompositeTransform.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ DerivativeType

◆ FixedParametersType

◆ FixedParametersValueType

◆ InputCovariantVectorType

◆ InputDiffusionTensor3DType

◆ InputPointType

◆ InputSymmetricSecondRankTensorType

◆ InputVectorPixelType

◆ InputVectorType

◆ InputVnlVectorType

◆ InverseJacobianPositionType

◆ InverseTransformBasePointer

◆ JacobianPositionType

◆ JacobianType

◆ NumberOfParametersType

◆ OutputCovariantVectorType

◆ OutputDiffusionTensor3DType

◆ OutputPointType

◆ OutputSymmetricSecondRankTensorType

◆ OutputVectorPixelType

◆ OutputVectorType

◆ OutputVnlVectorType

◆ ParametersType

◆ ParametersValueType

◆ Pointer

◆ ScalarType

◆ Self

◆ Superclass

◆ TransformCategoryEnum

◆ TransformQueueType

◆ TransformsToOptimizeFlagsType

◆ TransformType

◆ TransformTypePointer

Constructor & Destructor Documentation

◆ CompositeTransform()

◆ ~CompositeTransform()

Member Function Documentation

◆ ClearTransformQueue()

◆ ComputeJacobianWithRespectToParameters()

◆ ComputeJacobianWithRespectToParametersCachedTemporaries()

◆ CreateAnother()

◆ FlattenTransformQueue()

◆ GetFixedParameters()

◆ GetInverse()

◆ GetInverseTransform()

◆ GetNameOfClass()

◆ GetNthTransformToOptimize()

◆ GetNumberOfFixedParameters()

◆ GetNumberOfLocalParameters()

◆ GetNumberOfParameters()

◆ GetParameters()

◆ GetTransformCategory()

◆ GetTransformsToOptimizeFlags()

◆ GetTransformsToOptimizeQueue()

◆ InternalClone()

◆ New()

◆ PopBackTransform()

◆ PopFrontTransform()

◆ PrintSelf()

◆ PushBackTransform()

◆ PushFrontTransform()

◆ SetAllTransformsToOptimize()

◆ SetAllTransformsToOptimizeOff()

◆ SetAllTransformsToOptimizeOn()

◆ SetFixedParameters()

◆ SetNthTransformToOptimize()

◆ SetNthTransformToOptimizeOff()

◆ SetNthTransformToOptimizeOn()

◆ SetOnlyMostRecentTransformToOptimizeOn()

◆ SetParameters()

◆ TransformCovariantVector() [1/4]

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