ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions > Class Template Reference

#include <itkMultiTransform.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = typename Superclass::DerivativeType
 
using FixedParametersType = typename Superclass::FixedParametersType
 
using FixedParametersValueType = typename Superclass::FixedParametersValueType
 
using InputCovariantVectorType = typename Superclass::InputCovariantVectorType
 
using InputDiffusionTensor3DType = typename Superclass::InputDiffusionTensor3DType
 
using InputPointType = typename Superclass::InputPointType
 
using InputSymmetricSecondRankTensorType = typename Superclass::InputSymmetricSecondRankTensorType
 
using InputVectorPixelType = typename Superclass::InputVectorPixelType
 
using InputVectorType = typename Superclass::InputVectorType
 
using InputVnlVectorType = typename Superclass::InputVnlVectorType
 
using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType
 
using InverseTransformBasePointer = typename Superclass::InverseTransformBasePointer
 
using JacobianPositionType = typename Superclass::JacobianPositionType
 
using JacobianType = typename Superclass::JacobianType
 
using NumberOfParametersType = typename Superclass::NumberOfParametersType
 
using OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType
 
using OutputDiffusionTensor3DType = typename Superclass::OutputDiffusionTensor3DType
 
using OutputPointType = typename Superclass::OutputPointType
 
using OutputSymmetricSecondRankTensorType = typename Superclass::OutputSymmetricSecondRankTensorType
 
using OutputVectorPixelType = typename Superclass::OutputVectorPixelType
 
using OutputVectorType = typename Superclass::OutputVectorType
 
using OutputVnlVectorType = typename Superclass::OutputVnlVectorType
 
using ParametersType = typename Superclass::ParametersType
 
using ParametersValueType = typename Superclass::ParametersValueType
 
using Pointer = SmartPointer< Self >
 
using ScalarType = ParametersValueType
 
using Self = MultiTransform
 
using SubTransformInverseTransformBasePointer = typename TransformType::InverseTransformBasePointer
 
using Superclass = Transform< TParametersValueType, NDimensions, NSubDimensions >
 
using 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

virtual void AddTransform (TransformType *t)
 
virtual void AppendTransform (TransformType *t)
 
virtual const TransformTypeGetBackTransform () const
 
virtual const TransformTypeGetFrontTransform () const
 
virtual const char * GetNameOfClass () const
 
virtual const TransformTypePointer GetNthTransform (SizeValueType n) const
 
virtual const TransformTypeGetNthTransformConstPointer (const SizeValueType n) const
 
virtual TransformTypeGetNthTransformModifiablePointer (const SizeValueType n) const
 
virtual SizeValueType GetNumberOfTransforms () const
 
virtual const TransformQueueTypeGetTransformQueue () const
 
virtual bool IsTransformQueueEmpty () const
 
virtual void PrependTransform (TransformType *t)
 
virtual void RemoveTransform ()
 
- 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 FixedParametersTypeGetFixedParameters () const override
 
unsigned int GetInputSpaceDimension () const override
 
bool GetInverse (Self *) const
 
virtual InverseTransformBasePointer GetInverseTransform () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
std::string GetTransformTypeAsString () const override
 
 itkCloneMacro (Self)
 
void SetFixedParameters (const FixedParametersType &) override=0
 
void SetParameters (const ParametersType &) override=0
 
void SetParametersByValue (const ParametersType &p) override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual OutputPointType TransformPoint (const InputPointType &) const=0
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor, 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 &x, InverseJacobianPositionType &jacobian) const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
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
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

static constexpr unsigned int InputDimension = NDimensions
 
static constexpr unsigned int OutputDimension = NDimensions
 
static constexpr unsigned int SubInputDimension = NSubDimensions
 
static constexpr unsigned int SubOutputDimension = NSubDimensions
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 
TransformQueueType m_TransformQueue
 
NumberOfParametersType m_NumberOfLocalParameters
 
ModifiedTimeType m_LocalParametersUpdateTime
 
virtual void ClearTransformQueue ()
 
bool IsLinear () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
const ParametersTypeGetParameters () const override
 
void SetParameters (const ParametersType &p) override
 
const FixedParametersTypeGetFixedParameters () const override
 
void SetFixedParameters (const FixedParametersType &fixedParameters) 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
 
 MultiTransform ()
 
 ~MultiTransform () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void PushFrontTransform (TransformTypePointer t)
 
virtual void PushBackTransform (TransformTypePointer t)
 
virtual void PopFrontTransform ()
 
virtual void PopBackTransform ()
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- 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 &time)
 
- 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::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, unsigned int NSubDimensions = NDimensions>
class itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >

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

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

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

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

Inverse todo

TODO

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

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

Definition at line 65 of file itkMultiTransform.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
using itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::ConstPointer = SmartPointer<const Self>

Definition at line 74 of file itkMultiTransform.h.

◆ DerivativeType

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

Derivative type

Definition at line 93 of file itkMultiTransform.h.

◆ FixedParametersType

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

Definition at line 88 of file itkMultiTransform.h.

◆ FixedParametersValueType

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

Definition at line 89 of file itkMultiTransform.h.

◆ InputCovariantVectorType

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

Standard covariant vector type for this class

Definition at line 117 of file itkMultiTransform.h.

◆ InputDiffusionTensor3DType

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

Standard DiffusionTensor3D type alias for this class

Definition at line 129 of file itkMultiTransform.h.

◆ InputPointType

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

Standard coordinate point type for this class.

Definition at line 109 of file itkMultiTransform.h.

◆ InputSymmetricSecondRankTensorType

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

Standard SymmetricSecondRankTensor type alias for this class

Definition at line 133 of file itkMultiTransform.h.

◆ InputVectorPixelType

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

Standard Vectorpixel type for this class

Definition at line 125 of file itkMultiTransform.h.

◆ InputVectorType

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

Standard vector type for this class.

Definition at line 113 of file itkMultiTransform.h.

◆ InputVnlVectorType

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

Standard vnl_vector type for this class.

Definition at line 121 of file itkMultiTransform.h.

◆ InverseJacobianPositionType

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

Definition at line 98 of file itkMultiTransform.h.

◆ InverseTransformBasePointer

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

InverseTransform type.

Definition at line 106 of file itkMultiTransform.h.

◆ JacobianPositionType

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

Definition at line 97 of file itkMultiTransform.h.

◆ JacobianType

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

Jacobian type.

Definition at line 96 of file itkMultiTransform.h.

◆ NumberOfParametersType

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

The number of parameters defining this transform.

Definition at line 145 of file itkMultiTransform.h.

◆ OutputCovariantVectorType

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

Definition at line 118 of file itkMultiTransform.h.

◆ OutputDiffusionTensor3DType

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

Definition at line 130 of file itkMultiTransform.h.

◆ OutputPointType

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

Definition at line 110 of file itkMultiTransform.h.

◆ OutputSymmetricSecondRankTensorType

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

Definition at line 134 of file itkMultiTransform.h.

◆ OutputVectorPixelType

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

Definition at line 126 of file itkMultiTransform.h.

◆ OutputVectorType

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

Definition at line 114 of file itkMultiTransform.h.

◆ OutputVnlVectorType

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

Definition at line 122 of file itkMultiTransform.h.

◆ ParametersType

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

Parameters type.

Definition at line 86 of file itkMultiTransform.h.

◆ ParametersValueType

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

Definition at line 87 of file itkMultiTransform.h.

◆ Pointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
using itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::Pointer = SmartPointer<Self>

Definition at line 73 of file itkMultiTransform.h.

◆ ScalarType

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

Definition at line 90 of file itkMultiTransform.h.

◆ Self

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

Standard class type aliases.

Definition at line 71 of file itkMultiTransform.h.

◆ SubTransformInverseTransformBasePointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
using itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::SubTransformInverseTransformBasePointer = typename TransformType::InverseTransformBasePointer

InverseTransform type.

Definition at line 139 of file itkMultiTransform.h.

◆ Superclass

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

Definition at line 72 of file itkMultiTransform.h.

◆ TransformCategoryEnum

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

Transform category type.

Definition at line 101 of file itkMultiTransform.h.

◆ TransformQueueType

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
using itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::TransformQueueType = std::deque<TransformTypePointer>

Transform queue type

Definition at line 142 of file itkMultiTransform.h.

◆ TransformType

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

Sub transform type

Definition at line 80 of file itkMultiTransform.h.

◆ TransformTypePointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
using itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::TransformTypePointer = typename TransformType::Pointer

Definition at line 81 of file itkMultiTransform.h.

Constructor & Destructor Documentation

◆ MultiTransform()

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

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

◆ ~MultiTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::~MultiTransform ( )
overrideprotecteddefault

Transform container object.

Member Function Documentation

◆ AddTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::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 160 of file itkMultiTransform.h.

◆ AppendTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::AppendTransform ( TransformType t)
inlinevirtual

Same as AddTransform

Definition at line 167 of file itkMultiTransform.h.

◆ ClearTransformQueue()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::ClearTransformQueue ( )
inlinevirtual

Clear the transform queue.

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

Definition at line 244 of file itkMultiTransform.h.

◆ GetBackTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual const TransformType* itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetBackTransform ( ) const
inlinevirtual

Definition at line 194 of file itkMultiTransform.h.

◆ GetFixedParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
const FixedParametersType& itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetFixedParameters ( ) const
overridevirtual

◆ GetFrontTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual const TransformType* itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetFrontTransform ( ) const
inlinevirtual

Get transforms at the front and the back of the queue

Definition at line 188 of file itkMultiTransform.h.

◆ GetInverse()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
bool itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetInverse ( Self inverse) const

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

◆ GetNameOfClass()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual const char* itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

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

◆ GetNthTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual const TransformTypePointer itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetNthTransform ( SizeValueType  n) const
inlinevirtual

Definition at line 200 of file itkMultiTransform.h.

◆ GetNthTransformConstPointer()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual const TransformType* itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetNthTransformConstPointer ( const SizeValueType  n) const
inlinevirtual

Definition at line 216 of file itkMultiTransform.h.

◆ GetNthTransformModifiablePointer()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual TransformType* itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetNthTransformModifiablePointer ( const SizeValueType  n) const
inlinevirtual

Get the Nth transform.

Warning
No bounds checking is performed.

Definition at line 210 of file itkMultiTransform.h.

◆ GetNumberOfFixedParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
NumberOfParametersType itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetNumberOfFixedParameters ( ) const
overridevirtual

◆ GetNumberOfLocalParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
NumberOfParametersType itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetNumberOfLocalParameters ( ) const
overridevirtual

◆ GetNumberOfParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
NumberOfParametersType itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetNumberOfParameters ( ) const
overridevirtual

◆ GetNumberOfTransforms()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual SizeValueType itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetNumberOfTransforms ( ) const
inlinevirtual

Return the number of sub-transforms.

Definition at line 237 of file itkMultiTransform.h.

◆ GetParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
const ParametersType& itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::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 NDimensions = 3, unsigned int NSubDimensions = NDimensions>
TransformCategoryEnum itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::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 NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual const TransformQueueType& itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetTransformQueue ( ) const
inlinevirtual

Access transform queue

Definition at line 223 of file itkMultiTransform.h.

◆ IsLinear()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
bool itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::IsLinear ( ) const
overridevirtual

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

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

◆ IsTransformQueueEmpty()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual bool itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::IsTransformQueueEmpty ( ) const
inlinevirtual

Misc. functionality

Definition at line 230 of file itkMultiTransform.h.

◆ PopBackTransform()

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

Transform container object.

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

Definition at line 342 of file itkMultiTransform.h.

◆ PopFrontTransform()

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

Transform container object.

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

Definition at line 335 of file itkMultiTransform.h.

◆ PrependTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::PrependTransform ( TransformType t)
inlinevirtual

Add transform to the front of the stack

Definition at line 174 of file itkMultiTransform.h.

◆ PrintSelf()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Transform container object.

Reimplemented from itk::Object.

◆ PushBackTransform()

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

Transform container object.

Definition at line 328 of file itkMultiTransform.h.

◆ PushFrontTransform()

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

Transform container object.

Definition at line 321 of file itkMultiTransform.h.

◆ RemoveTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::RemoveTransform ( )
inlinevirtual

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

Definition at line 181 of file itkMultiTransform.h.

◆ SetFixedParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::SetFixedParameters ( const FixedParametersType fixedParameters)
override

Transform container object.

◆ SetParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::SetParameters ( const ParametersType p)
override

Transform container object.

◆ UpdateTransformParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::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, unsigned int NSubDimensions = NDimensions>
constexpr unsigned int itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::InputDimension = NDimensions
staticconstexpr

Dimension of the domain spaces.

Definition at line 148 of file itkMultiTransform.h.

◆ m_LocalParametersUpdateTime

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

Transform container object.

Definition at line 353 of file itkMultiTransform.h.

◆ m_NumberOfLocalParameters

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

Cache to save time returning the number of local parameters

Definition at line 352 of file itkMultiTransform.h.

◆ m_TransformQueue

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

Transform container object.

Definition at line 349 of file itkMultiTransform.h.

◆ OutputDimension

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

Definition at line 149 of file itkMultiTransform.h.

◆ SubInputDimension

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

Definition at line 151 of file itkMultiTransform.h.

◆ SubOutputDimension

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

Definition at line 152 of file itkMultiTransform.h.


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