ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions > Class Template Reference

#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 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< TParametersValueType, VDimension, VSubDimensions >
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array< ParametersValueType >
 
using DirectionChangeMatrix = Matrix< double, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, VInputDimension >
 
using InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using InputDirectionMatrix = Matrix< double, Self::InputSpaceDimension, Self::InputSpaceDimension >
 
using InputPointType = Point< TParametersValueType, VInputDimension >
 
using InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VInputDimension >
 
using InputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using InputVectorType = Vector< TParametersValueType, VInputDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, VInputDimension >
 
using InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = Transform< TParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianType = Array2D< ParametersValueType >
 
using MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, VOutputDimension >
 
using OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using OutputDirectionMatrix = Matrix< double, Self::OutputSpaceDimension, Self::OutputSpaceDimension >
 
using OutputPointType = Point< TParametersValueType, VOutputDimension >
 
using OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VOutputDimension >
 
using OutputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using OutputVectorType = Vector< TParametersValueType, VOutputDimension >
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, VOutputDimension >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = ParametersValueType
 
using Self = Transform
 
using Superclass = TransformBaseTemplate< TParametersValueType >
 
- Public Types inherited from itk::TransformBaseTemplate< TParametersValueType >
using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = OptimizerParameters< FixedParametersValueType >
 
using FixedParametersValueType = double
 
using NumberOfParametersType = IdentifierType
 
using ParametersType = OptimizerParameters< ParametersValueType >
 
using ParametersValueType = TParametersValueType
 
using Pointer = SmartPointer< Self >
 
using Self = TransformBaseTemplate
 
using Superclass = Object
 
using TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual void AddTransform (TransformType *t)
 
virtual void AppendTransform (TransformType *t)
 
virtual const TransformTypeGetBackTransform () const
 
const FixedParametersTypeGetFixedParameters () const override
 
virtual const TransformTypeGetFrontTransform () const
 
bool GetInverse (Self *inverse) const
 
virtual const TransformTypePointer GetNthTransform (SizeValueType n) const
 
virtual const TransformTypeGetNthTransformConstPointer (const SizeValueType n) const
 
virtual TransformTypeGetNthTransformModifiablePointer (const SizeValueType n) const
 
NumberOfParametersType GetNumberOfFixedParameters () const override
 
NumberOfParametersType GetNumberOfLocalParameters () const override
 
NumberOfParametersType GetNumberOfParameters () const override
 
virtual SizeValueType GetNumberOfTransforms () const
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
virtual const TransformQueueTypeGetTransformQueue () const
 
bool IsLinear () const override
 
virtual bool IsTransformQueueEmpty () const
 
 itkOverrideGetNameOfClassMacro (MultiTransform)
 
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< TParametersValueType, VDimension, VSubDimensions >
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 FixedParametersTypeGetFixedParameters () const override
 
unsigned int GetInputSpaceDimension () const override
 
virtual const std::string & GetInputSpaceName () const
 
bool GetInverse (Self *) const
 
virtual InverseTransformBasePointer GetInverseTransform () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
virtual const std::string & GetOutputSpaceName () const
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
std::string GetTransformTypeAsString () const override
 
 itkCloneMacro (Self)
 
 itkOverrideGetNameOfClassMacro (Transform)
 
void SetFixedParameters (const FixedParametersType &) override=0
 
virtual void SetInputSpaceName (std::string _arg)
 
virtual void SetOutputSpaceName (std::string _arg)
 
void SetParameters (const ParametersType &) override=0
 
void SetParametersByValue (const ParametersType &p) override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) 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 ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const=0
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const
 
 itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
 itkLegacyMacro (virtual void ComputeInverseJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
virtual void ComputeInverseJacobianWithRespectToPosition (const InputPointType &pnt, InverseJacobianPositionType &jacobian) const
 
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (TImage *image) const
 
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (SmartPointer< TImage > image) const
 
- Public Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
 itkOverrideGetNameOfClassMacro (TransformBaseTemplate)
 
virtual void SetParametersByValue (const ParametersType &p)=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

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< TParametersValueType, VDimension, VSubDimensions >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 

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< TParametersValueType, VDimension, VSubDimensions >
LightObject::Pointer InternalClone () const override
 
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
 
 Transform ()=default
 
 Transform (NumberOfParametersType numberOfParameters)
 
 ~Transform () override=default
 
- Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
 TransformBaseTemplate ()=default
 
 ~TransformBaseTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

ModifiedTimeType m_LocalParametersUpdateTime {}
 
NumberOfParametersType m_NumberOfLocalParameters {}
 
TransformQueueType m_TransformQueue {}
 
- Protected Attributes inherited from itk::Transform< TParametersValueType, VDimension, VSubDimensions >
FixedParametersType m_FixedParameters
 
ParametersType m_Parameters
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

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.

◆ 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 itk::TransformBaseTemplate< TParametersValueType >.

◆ 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.

◆ 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< TParametersValueType, VDimension, VSubDimensions >.

◆ 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< TParametersValueType, VDimension, VSubDimensions >.

◆ 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 itk::TransformBaseTemplate< TParametersValueType >.

◆ 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 itk::TransformBaseTemplate< TParametersValueType >.

◆ 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 itk::TransformBaseTemplate< TParametersValueType >.

◆ 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< TParametersValueType, VDimension, VSubDimensions >.

◆ 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.

◆ itkOverrideGetNameOfClassMacro()

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

Run-time type information (and related methods).

◆ PopBackTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>
virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::PopBackTransform ( )
inlineprotectedvirtual

◆ PopFrontTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>
virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::PopFrontTransform ( )
inlineprotectedvirtual

◆ 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
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

◆ PushBackTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>
virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::PushBackTransform ( TransformTypePointer  t)
inlineprotectedvirtual

◆ PushFrontTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>
virtual void itk::MultiTransform< TParametersValueType, VDimension, VSubDimensions >::PushFrontTransform ( TransformTypePointer  t)
inlineprotectedvirtual

◆ 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.

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ 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.

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ 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< TParametersValueType, VDimension, VSubDimensions >.

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: