ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions > Class Template Reference
Module ITKTransform

#include <itkMultiTransform.h>

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

Detailed Description

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

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

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

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

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

Inverse todo

TODO

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

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

Definition at line 64 of file itkMultiTransform.h.

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
Superclass::FixedParametersType 		FixedParametersType
 
typedef
Superclass::FixedParametersValueType 		FixedParametersValueType
 
typedef
Superclass::InputCovariantVectorType 		InputCovariantVectorType
 
typedef
Superclass::InputDiffusionTensor3DType 		InputDiffusionTensor3DType
 
typedef Superclass::InputPointType InputPointType
 
typedef
Superclass::InputSymmetricSecondRankTensorType 		InputSymmetricSecondRankTensorType
 
typedef
Superclass::InputVectorPixelType 		InputVectorPixelType
 
typedef Superclass::InputVectorType InputVectorType
 
typedef
Superclass::InputVnlVectorType 		InputVnlVectorType
 
typedef
Superclass::InverseTransformBasePointer 		InverseTransformBasePointer
 
typedef Superclass::JacobianType JacobianType
 
typedef
Superclass::NumberOfParametersType 		NumberOfParametersType
 
typedef
Superclass::OutputCovariantVectorType 		OutputCovariantVectorType
 
typedef
Superclass::OutputDiffusionTensor3DType 		OutputDiffusionTensor3DType
 
typedef Superclass::OutputPointType OutputPointType
 
typedef
Superclass::OutputSymmetricSecondRankTensorType 		OutputSymmetricSecondRankTensorType
 
typedef
Superclass::OutputVectorPixelType 		OutputVectorPixelType
 
typedef
Superclass::OutputVectorType 		OutputVectorType
 
typedef
Superclass::OutputVnlVectorType 		OutputVnlVectorType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 		ParametersValueType
 
typedef SmartPointer< Self > Pointer
 
typedef ParametersValueType ScalarType
 
typedef MultiTransform Self
 
typedef
TransformType::InverseTransformBasePointer 		SubTransformInverseTransformBasePointer
 
typedef Transform
< TParametersValueType,
NDimensions, NSubDimensions > 		Superclass
 
typedef
Superclass::TransformCategoryType 		TransformCategoryType
 
typedef std::deque
< TransformTypePointer > 		TransformQueueType
 
typedef Transform
< TParametersValueType,
NSubDimensions, NSubDimensions > 		TransformType
 
typedef TransformType::Pointer TransformTypePointer
 
- Public Types inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
typedef SmartPointer< const Self > ConstPointer
 
typedef Array
< ParametersValueType > 		DerivativeType
 
typedef Matrix< double,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 		DirectionChangeMatrix
 
typedef
Superclass::FixedParametersType 		FixedParametersType
 
typedef
Superclass::FixedParametersValueType 		FixedParametersValueType
 
typedef CovariantVector
< TParametersValueType,
NInputDimensions > 		InputCovariantVectorType
 
typedef DiffusionTensor3D
< TParametersValueType > 		InputDiffusionTensor3DType
 
typedef Matrix< double,
itkGetStaticConstMacro(InputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 		InputDirectionMatrix
 
typedef Point
< TParametersValueType,
NInputDimensions > 		InputPointType
 
typedef
SymmetricSecondRankTensor
< TParametersValueType,
NInputDimensions > 		InputSymmetricSecondRankTensorType
 
typedef VariableLengthVector
< TParametersValueType > 		InputVectorPixelType
 
typedef Vector
< TParametersValueType,
NInputDimensions > 		InputVectorType
 
typedef vnl_vector_fixed
< TParametersValueType,
NInputDimensions > 		InputVnlVectorType
 
typedef
InverseTransformBaseType::Pointer 		InverseTransformBasePointer
 
typedef Transform
< TParametersValueType,
NOutputDimensions,
NInputDimensions > 		InverseTransformBaseType
 
typedef Array2D
< ParametersValueType > 		JacobianType
 
typedef Matrix
< TParametersValueType,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 		MatrixType
 
typedef
Superclass::NumberOfParametersType 		NumberOfParametersType
 
typedef CovariantVector
< TParametersValueType,
NOutputDimensions > 		OutputCovariantVectorType
 
typedef DiffusionTensor3D
< TParametersValueType > 		OutputDiffusionTensor3DType
 
typedef Matrix< double,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(OutputSpaceDimension)> 		OutputDirectionMatrix
 
typedef Point
< TParametersValueType,
NOutputDimensions > 		OutputPointType
 
typedef
SymmetricSecondRankTensor
< TParametersValueType,
NOutputDimensions > 		OutputSymmetricSecondRankTensorType
 
typedef VariableLengthVector
< TParametersValueType > 		OutputVectorPixelType
 
typedef Vector
< TParametersValueType,
NOutputDimensions > 		OutputVectorType
 
typedef vnl_vector_fixed
< TParametersValueType,
NOutputDimensions > 		OutputVnlVectorType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 		ParametersValueType
 
typedef SmartPointer< Self > Pointer
 
typedef ParametersValueType ScalarType
 
typedef Transform Self
 
typedef TransformBaseTemplate
< TParametersValueType > 		Superclass
 
typedef
Superclass::TransformCategoryType 		TransformCategoryType
 
- Public Types inherited from itk::TransformBaseTemplate< TParametersValueType >
typedef SmartPointer< const Self > ConstPointer
 
typedef OptimizerParameters
< FixedParametersValueType > 		FixedParametersType
 
typedef ParametersValueType FixedParametersValueType
 
typedef IdentifierType NumberOfParametersType
 
typedef OptimizerParameters
< ParametersValueType > 		ParametersType
 
typedef TParametersValueType ParametersValueType
 
typedef SmartPointer< Self > Pointer
 
typedef TransformBaseTemplate Self
 
typedef Object Superclass
 
enum  TransformCategoryType {
  UnknownTransformCategory =0,
  Linear =1,
  BSpline =2,
  Spline =3,
  DisplacementField =4,
  VelocityField =5
}
 
- Public Types inherited from itk::Object
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightObject Self
 

Public Member Functions

virtual void AddTransform (TransformType *t)
 
virtual void AppendTransform (TransformType *t)
 
virtual const TransformType * GetBackTransform () const
 
virtual const FixedParametersType & GetFixedParameters () const override
 
virtual const TransformType * GetFrontTransform () const
 
bool GetInverse (Self *inverse) const
 
virtual const char * GetNameOfClass () const
 
virtual const TransformTypePointer GetNthTransform (SizeValueType n) const
 
virtual const TransformType * GetNthTransformConstPointer (const SizeValueType n) const
 
virtual TransformType * GetNthTransformModifiablePointer (const SizeValueType n) const
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const override
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const override
 
virtual NumberOfParametersType GetNumberOfParameters () const override
 
virtual SizeValueType GetNumberOfTransforms () const
 
virtual const ParametersType & GetParameters () const override
 
virtual TransformCategoryType GetTransformCategory () const override
 
virtual const TransformQueueType & GetTransformQueue () const
 
virtual bool IsLinear () const override
 
virtual bool IsTransformQueueEmpty () const
 
virtual void PrependTransform (TransformType *t)
 
virtual void RemoveTransform ()
 
virtual void SetFixedParameters (const FixedParametersType &fixedParameters) override
 
virtual void SetParameters (const ParametersType &p) override
 
virtual void UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0) override
 
virtual void ClearTransformQueue ()
 
- Public Member Functions inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
virtual void ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, JacobianType &jacobian) const
 
virtual void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const =0
 
virtual void ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianType &) const
 
virtual void CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end) override
 
virtual void CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end) override
 
unsigned int GetInputSpaceDimension (void) const override
 
bool GetInverse (Self *) const
 
virtual InverseTransformBasePointer GetInverseTransform () const
 
unsigned int GetOutputSpaceDimension (void) const override
 
virtual std::string GetTransformTypeAsString () const override
 
 itkCloneMacro (Self)
 
virtual void SetFixedParameters (const FixedParametersType &) override=0
 
virtual void SetParameters (const ParametersType &) override=0
 
virtual void SetParametersByValue (const ParametersType &p) override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual OutputPointType TransformPoint (const InputPointType &) const =0
 
virtual
OutputSymmetricSecondRankTensorType 		TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor, const InputPointType &point) const
 
virtual
OutputSymmetricSecondRankTensorType 		TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual OutputVectorType TransformVector (const InputVectorType &) const
 
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual void UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 const unsigned int SubInputDimension = NSubDimensions
 
static const unsigned int SubOutputDimension = NSubDimensions
 
static const unsigned int InputDimension = NDimensions
 
static const unsigned int OutputDimension = NDimensions
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
static const unsigned int InputSpaceDimension
 
static const unsigned int OutputSpaceDimension
 

Protected Member Functions

 MultiTransform ()
 
virtual void PopBackTransform ()
 
virtual void PopFrontTransform ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void PushBackTransform (TransformTypePointer t)
 
virtual void PushFrontTransform (TransformTypePointer t)
 
virtual ~MultiTransform ()
 
- Protected Member Functions inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
virtual LightObject::Pointer InternalClone () const override
 
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType, const JacobianType) const
 
 Transform ()
 
 Transform (NumberOfParametersType NumberOfParameters)
 
virtual ~Transform ()
 
- Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
 TransformBaseTemplate ()
 
virtual ~TransformBaseTemplate ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

ModifiedTimeType m_LocalParametersUpdateTime
 
NumberOfParametersType m_NumberOfLocalParameters
 
TransformQueueType m_TransformQueue
 
- Protected Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NSubDimensions >
DirectionChangeMatrix m_DirectionChange
 
FixedParametersType m_FixedParameters
 
ParametersType m_Parameters
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

 MultiTransform (const Self &)
 
void operator= (const Self &)
 

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

Member Typedef Documentation

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

Definition at line 72 of file itkMultiTransform.h.

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

Derivative type

Definition at line 91 of file itkMultiTransform.h.

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

Definition at line 86 of file itkMultiTransform.h.

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

Definition at line 87 of file itkMultiTransform.h.

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

Standard covariant vector type for this class

Definition at line 113 of file itkMultiTransform.h.

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

Standard DiffusionTensor3D typedef for this class

Definition at line 125 of file itkMultiTransform.h.

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

Standard coordinate point type for this class.

Definition at line 105 of file itkMultiTransform.h.

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

Standard SymmetricSecondRankTensor typedef for this class

Definition at line 129 of file itkMultiTransform.h.

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

Standard Vectorpixel type for this class

Definition at line 121 of file itkMultiTransform.h.

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

Standard vector type for this class.

Definition at line 109 of file itkMultiTransform.h.

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

Standard vnl_vector type for this class.

Definition at line 117 of file itkMultiTransform.h.

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

InverseTransform type.

Definition at line 102 of file itkMultiTransform.h.

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

Jacobian type.

Definition at line 94 of file itkMultiTransform.h.

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

The number of parameters defininig this transform.

Definition at line 141 of file itkMultiTransform.h.

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

Definition at line 114 of file itkMultiTransform.h.

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

Definition at line 126 of file itkMultiTransform.h.

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

Definition at line 106 of file itkMultiTransform.h.

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

Definition at line 130 of file itkMultiTransform.h.

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

Definition at line 122 of file itkMultiTransform.h.

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

Definition at line 110 of file itkMultiTransform.h.

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

Definition at line 118 of file itkMultiTransform.h.

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

Parameters type.

Definition at line 84 of file itkMultiTransform.h.

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

Definition at line 85 of file itkMultiTransform.h.

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

Definition at line 71 of file itkMultiTransform.h.

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

Definition at line 88 of file itkMultiTransform.h.

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

Standard class typedefs.

Definition at line 69 of file itkMultiTransform.h.

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

InverseTransform type.

Definition at line 135 of file itkMultiTransform.h.

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

Definition at line 70 of file itkMultiTransform.h.

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

Transform category type.

Definition at line 97 of file itkMultiTransform.h.

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

Transform queue type

Definition at line 138 of file itkMultiTransform.h.

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

Sub transform type

Definition at line 75 of file itkMultiTransform.h.

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

Definition at line 79 of file itkMultiTransform.h.

Constructor & Destructor Documentation

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.

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::~MultiTransform ( )
protectedvirtual
template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::MultiTransform ( const Self &  )
private

Member Function Documentation

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

Referenced by itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::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 162 of file itkMultiTransform.h.

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

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

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

Get the Fixed Parameters.

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

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

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

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.

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

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

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

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

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

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

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

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

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual NumberOfParametersType itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::GetNumberOfLocalParameters ( void  ) 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 >.

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

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

Return the number of parameters that completely define the Transfom

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

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

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

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual 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.

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

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

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

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

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

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

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

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual 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 >.

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

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

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

Definition at line 315 of file itkMultiTransform.h.

Referenced by itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::RemoveTransform().

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

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

Definition at line 309 of file itkMultiTransform.h.

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

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

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

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

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

Definition at line 303 of file itkMultiTransform.h.

Referenced by itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::AddTransform().

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

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

Definition at line 297 of file itkMultiTransform.h.

Referenced by itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::PrependTransform().

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

template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::SetFixedParameters ( const FixedParametersType &  fixedParameters)
overridevirtual
template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::SetParameters ( const ParametersType &  p)
overridevirtual
template<typename TParametersValueType = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
virtual void itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >::UpdateTransformParameters ( const DerivativeType &  update,
ScalarType  factor = 1.0 
)
overridevirtual

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

Member Data Documentation

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

Dimension of the domain spaces.

Definition at line 144 of file itkMultiTransform.h.

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

Definition at line 326 of file itkMultiTransform.h.

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

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

Referenced by itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::ClearTransformQueue(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::GetBackTransform(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::GetFrontTransform(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::GetNthTransform(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::GetNthTransformConstPointer(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::GetNthTransformModifiablePointer(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::GetNumberOfTransforms(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::GetTransformQueue(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::IsTransformQueueEmpty(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::PopBackTransform(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::PopFrontTransform(), itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::PushBackTransform(), and itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >::PushFrontTransform().

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

Dimension of the domain spaces.

Definition at line 145 of file itkMultiTransform.h.

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

Definition at line 148 of file itkMultiTransform.h.

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

Definition at line 149 of file itkMultiTransform.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Fri Jul 3 2015 04:23:35 for ITK by   doxygen 1.8.5