ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
itk::CompositeTransform< TScalar, NDimensions > Class Template Reference

#include <itkCompositeTransform.h>

+ Inheritance diagram for itk::CompositeTransform< TScalar, NDimensions >:
+ Collaboration diagram for itk::CompositeTransform< TScalar, NDimensions >:

Detailed Description

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

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

This class concatenates transforms in reverse queue order by means of composition: $ T_0 o T_1 = T_0(T_1(x)) $ Transforms are stored in a container (queue), in the following order: $ T_0, T_1, ... , T_N-1 $ Transforms are added via a single method, AddTransform(). This adds the transforms to the back of the queue. A single method for adding transforms is meant to simplify the interface and prevent errors. One use of the class is to optimize only a subset of included transforms.

The sub transforms are the same dimensionality as this class.

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

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

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

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

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

Definition at line 88 of file itkCompositeTransform.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
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< SelfPointer
 
typedef Superclass::ScalarType ScalarType
 
typedef CompositeTransform Self
 
typedef MultiTransform
< TScalar, NDimensions,
NDimensions > 
Superclass
 
typedef
Superclass::TransformCategoryType 
TransformCategoryType
 
typedef
Superclass::TransformQueueType 
TransformQueueType
 
typedef std::deque< bool > TransformsToOptimizeFlagsType
 
typedef Superclass::TransformType TransformType
 
typedef
Superclass::TransformTypePointer 
TransformTypePointer
 
- Public Types inherited from itk::MultiTransform< TScalar, NDimensions >
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
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< SelfPointer
 
typedef Superclass::ScalarType ScalarType
 
typedef MultiTransform Self
 
typedef
TransformType::InverseTransformBasePointer 
SubTransformInverseTransformBasePointer
 
typedef Transform< TScalar,
NDimensions, NDimensions > 
Superclass
 
typedef
Superclass::TransformCategoryType 
TransformCategoryType
 
typedef std::deque
< TransformTypePointer
TransformQueueType
 
typedef Transform< TScalar,
NDimensions, NDimensions > 
TransformType
 
typedef TransformType::Pointer TransformTypePointer
 
- Public Types inherited from itk::Transform< TScalar, NDimensions, NDimensions >
typedef SmartPointer< const SelfConstPointer
 
typedef Array
< ParametersValueType
DerivativeType
 
typedef Matrix< double,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 
DirectionChangeMatrix
 
typedef CovariantVector
< TScalar, NInputDimensions > 
InputCovariantVectorType
 
typedef DiffusionTensor3D
< TScalar > 
InputDiffusionTensor3DType
 
typedef Matrix< double,
itkGetStaticConstMacro(InputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 
InputDirectionMatrix
 
typedef Point< TScalar,
NInputDimensions > 
InputPointType
 
typedef
SymmetricSecondRankTensor
< TScalar, NInputDimensions > 
InputSymmetricSecondRankTensorType
 
typedef VariableLengthVector
< TScalar > 
InputVectorPixelType
 
typedef Vector< TScalar,
NInputDimensions > 
InputVectorType
 
typedef vnl_vector_fixed
< TScalar, NInputDimensions > 
InputVnlVectorType
 
typedef
InverseTransformBaseType::Pointer 
InverseTransformBasePointer
 
typedef Transform< TScalar,
NOutputDimensions,
NInputDimensions > 
InverseTransformBaseType
 
typedef Array2D
< ParametersValueType
JacobianType
 
typedef Matrix< TScalar,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 
MatrixType
 
typedef
Superclass::NumberOfParametersType 
NumberOfParametersType
 
typedef CovariantVector
< TScalar, NOutputDimensions > 
OutputCovariantVectorType
 
typedef DiffusionTensor3D
< TScalar > 
OutputDiffusionTensor3DType
 
typedef Matrix< double,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(OutputSpaceDimension)> 
OutputDirectionMatrix
 
typedef Point< TScalar,
NOutputDimensions > 
OutputPointType
 
typedef
SymmetricSecondRankTensor
< TScalar, NOutputDimensions > 
OutputSymmetricSecondRankTensorType
 
typedef VariableLengthVector
< TScalar > 
OutputVectorPixelType
 
typedef Vector< TScalar,
NOutputDimensions > 
OutputVectorType
 
typedef vnl_vector_fixed
< TScalar, NOutputDimensions > 
OutputVnlVectorType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef TScalar ScalarType
 
typedef Transform Self
 
typedef TransformBase Superclass
 
- Public Types inherited from itk::TransformBase
typedef SmartPointer< const SelfConstPointer
 
typedef IdentifierType NumberOfParametersType
 
typedef OptimizerParameters
< ParametersValueType
ParametersType
 
typedef double ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef TransformBase 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 SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual void ClearTransformQueue ()
 
virtual void ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &j) const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void FlattenTransformQueue ()
 
virtual const ParametersTypeGetFixedParameters (void) const
 
bool GetInverse (Self *inverse) const
 
virtual InverseTransformBasePointer GetInverseTransform () const
 
virtual const char * GetNameOfClass () const
 
virtual bool GetNthTransformToOptimize (SizeValueType i) const
 
virtual NumberOfParametersType GetNumberOfFixedParameters (void) const
 
virtual NumberOfParametersType GetNumberOfLocalParameters (void) const
 
virtual NumberOfParametersType GetNumberOfParameters (void) const
 
virtual const ParametersTypeGetParameters (void) const
 
virtual TransformCategoryType GetTransformCategory () const
 
virtual const
TransformsToOptimizeFlagsType
GetTransformsToOptimizeFlags () const
 
virtual void SetAllTransformsToOptimize (bool state)
 
virtual void SetAllTransformsToOptimizeOff ()
 
virtual void SetAllTransformsToOptimizeOn ()
 
virtual void SetFixedParameters (const ParametersType &fixedParameters)
 
virtual void SetNthTransformToOptimize (SizeValueType i, bool state)
 
virtual void SetNthTransformToOptimizeOff (SizeValueType i)
 
virtual void SetNthTransformToOptimizeOn (SizeValueType i)
 
virtual void SetOnlyMostRecentTransformToOptimizeOn ()
 
virtual void SetParameters (const ParametersType &p)
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &inputVector, const InputPointType &inputPoint) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &inputVector, const InputPointType &inputPoint) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &inputPoint) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &inputPoint) const
 
virtual OutputPointType TransformPoint (const InputPointType &inputPoint) const
 
virtual
OutputSymmetricSecondRankTensorType 
TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor) const
 
virtual
OutputSymmetricSecondRankTensorType 
TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &inputPoint) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &inputPoint) const
 
virtual OutputVectorType TransformVector (const InputVectorType &) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &inputVector) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &inputVector) const
 
virtual OutputVectorType TransformVector (const InputVectorType &inputVector, const InputPointType &inputPoint) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &inputVector, const InputPointType &inputPoint) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &inputVector, const InputPointType &inputPoint) const
 
virtual void UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0)
 
- Public Member Functions inherited from itk::MultiTransform< TScalar, NDimensions >
virtual void AddTransform (TransformType *t)
 
virtual void AppendTransform (TransformType *t)
 
virtual const TransformTypePointer GetBackTransform ()
 
virtual const TransformTypePointer GetFrontTransform ()
 
bool GetInverse (Self *inverse) const
 
virtual const TransformTypePointer GetNthTransform (SizeValueType n) const
 
virtual SizeValueType GetNumberOfTransforms () const
 
virtual const TransformQueueTypeGetTransformQueue () const
 
virtual bool IsLinear () const
 
virtual bool IsTransformQueueEmpty () const
 
virtual void PrependTransform (TransformType *t)
 
virtual void RemoveTransform ()
 
virtual void SetFixedParameters (const ParametersType &fixedParameters)
 
virtual void SetParameters (const ParametersType &p)
 
- Public Member Functions inherited from itk::Transform< TScalar, NDimensions, NDimensions >
virtual void ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, JacobianType &jacobian) const
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianType &) const
 
unsigned int GetInputSpaceDimension (void) const
 
bool GetInverse (Self *) const
 
unsigned int GetOutputSpaceDimension (void) const
 
virtual std::string GetTransformTypeAsString () const
 
 itkCloneMacro (Self)
 
virtual void SetParametersByValue (const ParametersType &p)
 
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, TScalarfactor=1.0)
 
virtual void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int InputDimension = NDimensions
 
static const unsigned int OutputDimension = NDimensions
 
- Static Public Attributes inherited from itk::MultiTransform< TScalar, NDimensions >
static const unsigned int SubInputDimension
 
static const unsigned int SubOutputDimension
 
static const unsigned int InputDimension
 
static const unsigned int OutputDimension
 
- Static Public Attributes inherited from itk::Transform< TScalar, NDimensions, NDimensions >
static const unsigned int InputSpaceDimension
 
static const unsigned int OutputSpaceDimension
 

Protected Member Functions

 CompositeTransform ()
 
TransformQueueTypeGetTransformsToOptimizeQueue () const
 
virtual LightObject::Pointer InternalClone () const
 
virtual void PopBackTransform ()
 
virtual void PopFrontTransform ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PushBackTransform (TransformTypePointer t)
 
virtual void PushFrontTransform (TransformTypePointer t)
 
virtual ~CompositeTransform ()
 
- Protected Member Functions inherited from itk::MultiTransform< TScalar, NDimensions >
 MultiTransform ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~MultiTransform ()
 
- Protected Member Functions inherited from itk::Transform< TScalar, NDimensions, NDimensions >
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType, const JacobianType) const
 
 Transform ()
 
 Transform (NumberOfParametersType NumberOfParameters)
 
virtual ~Transform ()
 
- Protected Member Functions inherited from itk::TransformBase
 TransformBase ()
 
virtual ~TransformBase ()
 
- 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

TransformsToOptimizeFlagsType m_TransformsToOptimizeFlags
 
TransformQueueType m_TransformsToOptimizeQueue
 
- Protected Attributes inherited from itk::MultiTransform< TScalar, NDimensions >
ModifiedTimeType m_LocalParametersUpdateTime
 
NumberOfParametersType m_NumberOfLocalParameters
 
TransformQueueType m_TransformQueue
 
- Protected Attributes inherited from itk::Transform< TScalar, NDimensions, NDimensions >
DirectionChangeMatrix m_DirectionChange
 
ParametersType m_FixedParameters
 
ParametersType m_Parameters
 

Private Member Functions

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

Private Attributes

ModifiedTimeType m_PreviousTransformsToOptimizeUpdateTime
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Member Typedef Documentation

template<class TScalar = double, unsigned int NDimensions = 3>
typedef SmartPointer<const Self> itk::CompositeTransform< TScalar, NDimensions >::ConstPointer

Definition at line 96 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::DerivativeType itk::CompositeTransform< TScalar, NDimensions >::DerivativeType

Derivative type

Definition at line 119 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::InputCovariantVectorType itk::CompositeTransform< TScalar, NDimensions >::InputCovariantVectorType

Standard covariant vector type for this class

Definition at line 136 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::InputDiffusionTensor3DType itk::CompositeTransform< TScalar, NDimensions >::InputDiffusionTensor3DType

Standard DiffusionTensor3D typedef for this class

Definition at line 148 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::InputPointType itk::CompositeTransform< TScalar, NDimensions >::InputPointType

Standard coordinate point type for this class.

Definition at line 128 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::InputSymmetricSecondRankTensorType itk::CompositeTransform< TScalar, NDimensions >::InputSymmetricSecondRankTensorType

Standard SymmetricSecondRankTensor typedef for this class

Definition at line 152 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::InputVectorPixelType itk::CompositeTransform< TScalar, NDimensions >::InputVectorPixelType

Standard Vectorpixel type for this class

Definition at line 144 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::InputVectorType itk::CompositeTransform< TScalar, NDimensions >::InputVectorType

Standard vector type for this class.

Definition at line 132 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::InputVnlVectorType itk::CompositeTransform< TScalar, NDimensions >::InputVnlVectorType

Standard vnl_vector type for this class.

Definition at line 140 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::InverseTransformBasePointer itk::CompositeTransform< TScalar, NDimensions >::InverseTransformBasePointer

InverseTransform type.

Definition at line 109 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::JacobianType itk::CompositeTransform< TScalar, NDimensions >::JacobianType

Jacobian type.

Definition at line 122 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::NumberOfParametersType itk::CompositeTransform< TScalar, NDimensions >::NumberOfParametersType

The number of parameters defininig this transform.

Definition at line 159 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::OutputCovariantVectorType itk::CompositeTransform< TScalar, NDimensions >::OutputCovariantVectorType

Definition at line 137 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::OutputDiffusionTensor3DType itk::CompositeTransform< TScalar, NDimensions >::OutputDiffusionTensor3DType

Definition at line 149 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::OutputPointType itk::CompositeTransform< TScalar, NDimensions >::OutputPointType

Definition at line 129 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::OutputSymmetricSecondRankTensorType itk::CompositeTransform< TScalar, NDimensions >::OutputSymmetricSecondRankTensorType

Definition at line 153 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::OutputVectorPixelType itk::CompositeTransform< TScalar, NDimensions >::OutputVectorPixelType

Definition at line 145 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::OutputVectorType itk::CompositeTransform< TScalar, NDimensions >::OutputVectorType

Definition at line 133 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::OutputVnlVectorType itk::CompositeTransform< TScalar, NDimensions >::OutputVnlVectorType

Definition at line 141 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::ParametersType itk::CompositeTransform< TScalar, NDimensions >::ParametersType

Parameters type.

Definition at line 115 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::ParametersValueType itk::CompositeTransform< TScalar, NDimensions >::ParametersValueType

Definition at line 116 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef SmartPointer<Self> itk::CompositeTransform< TScalar, NDimensions >::Pointer

Definition at line 95 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::ScalarType itk::CompositeTransform< TScalar, NDimensions >::ScalarType

Scalar type.

Definition at line 112 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef CompositeTransform itk::CompositeTransform< TScalar, NDimensions >::Self

Standard class typedefs.

Definition at line 93 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef MultiTransform<TScalar, NDimensions, NDimensions> itk::CompositeTransform< TScalar, NDimensions >::Superclass

Definition at line 94 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::TransformCategoryType itk::CompositeTransform< TScalar, NDimensions >::TransformCategoryType

Transform category type.

Definition at line 125 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::TransformQueueType itk::CompositeTransform< TScalar, NDimensions >::TransformQueueType

Transform queue type

Definition at line 156 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef std::deque<bool> itk::CompositeTransform< TScalar, NDimensions >::TransformsToOptimizeFlagsType

Optimization flags queue type

Definition at line 162 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::TransformType itk::CompositeTransform< TScalar, NDimensions >::TransformType

Sub transform type

Definition at line 102 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
typedef Superclass::TransformTypePointer itk::CompositeTransform< TScalar, NDimensions >::TransformTypePointer

Definition at line 106 of file itkCompositeTransform.h.

Constructor & Destructor Documentation

template<class TScalar = double, unsigned int NDimensions = 3>
itk::CompositeTransform< TScalar, NDimensions >::CompositeTransform ( )
protected
template<class TScalar = double, unsigned int NDimensions = 3>
virtual itk::CompositeTransform< TScalar, NDimensions >::~CompositeTransform ( )
protectedvirtual
template<class TScalar = double, unsigned int NDimensions = 3>
itk::CompositeTransform< TScalar, NDimensions >::CompositeTransform ( const Self )
private

Member Function Documentation

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::ClearTransformQueue ( )
inlinevirtual

Clear the transform queue.

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

Definition at line 228 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::ComputeJacobianWithRespectToParameters ( const InputPointType p,
JacobianType j 
) const
virtual

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

template<class TScalar = double, unsigned int NDimensions = 3>
virtual::itk::LightObject::Pointer itk::CompositeTransform< TScalar, NDimensions >::CreateAnother ( void  ) const
virtual

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

Reimplemented from itk::Object.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::FlattenTransformQueue ( )
virtual

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

template<class TScalar = double, unsigned int NDimensions = 3>
virtual const ParametersType& itk::CompositeTransform< TScalar, NDimensions >::GetFixedParameters ( void  ) const
virtual

Get the Fixed Parameters.

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

template<class TScalar = double, unsigned int NDimensions = 3>
bool itk::CompositeTransform< TScalar, NDimensions >::GetInverse ( Self inverse) const

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

template<class TScalar = double, unsigned int NDimensions = 3>
virtual InverseTransformBasePointer itk::CompositeTransform< TScalar, NDimensions >::GetInverseTransform ( ) const
virtual

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

Reimplemented from itk::Transform< TScalar, NDimensions, NDimensions >.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual const char* itk::CompositeTransform< TScalar, NDimensions >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

template<class TScalar = double, unsigned int NDimensions = 3>
virtual bool itk::CompositeTransform< TScalar, NDimensions >::GetNthTransformToOptimize ( SizeValueType  i) const
inlinevirtual

Definition at line 217 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual NumberOfParametersType itk::CompositeTransform< TScalar, NDimensions >::GetNumberOfFixedParameters ( void  ) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual NumberOfParametersType itk::CompositeTransform< TScalar, NDimensions >::GetNumberOfLocalParameters ( void  ) const
virtual

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::MultiTransform< TScalar, NDimensions >.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual NumberOfParametersType itk::CompositeTransform< TScalar, NDimensions >::GetNumberOfParameters ( void  ) const
virtual

Return the number of parameters that completely define the Transfom

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

template<class TScalar = double, unsigned int NDimensions = 3>
virtual const ParametersType& itk::CompositeTransform< TScalar, NDimensions >::GetParameters ( void  ) const
virtual

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

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

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

template<class TScalar = double, unsigned int NDimensions = 3>
virtual TransformCategoryType itk::CompositeTransform< TScalar, NDimensions >::GetTransformCategory ( ) const
virtual

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

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

template<class TScalar = double, unsigned int NDimensions = 3>
virtual const TransformsToOptimizeFlagsType& itk::CompositeTransform< TScalar, NDimensions >::GetTransformsToOptimizeFlags ( ) const
inlinevirtual

Access optimize flags

Definition at line 223 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
TransformQueueType& itk::CompositeTransform< TScalar, NDimensions >::GetTransformsToOptimizeQueue ( ) const
protected

Get a list of transforms to optimize. Helper function.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual LightObject::Pointer itk::CompositeTransform< TScalar, NDimensions >::InternalClone ( ) const
protectedvirtual

Clone the current transform

Reimplemented from itk::Transform< TScalar, NDimensions, NDimensions >.

template<class TScalar = double, unsigned int NDimensions = 3>
static Pointer itk::CompositeTransform< TScalar, NDimensions >::New ( )
static

New macro for creation of through a Smart Pointer

template<class TScalar = double, unsigned int NDimensions = 3>
void itk::CompositeTransform< TScalar, NDimensions >::operator= ( const Self )
private
template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::PopBackTransform ( )
inlineprotectedvirtual

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

Definition at line 405 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::PopFrontTransform ( )
inlineprotectedvirtual

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

Definition at line 399 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
void itk::CompositeTransform< TScalar, NDimensions >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::PushBackTransform ( TransformTypePointer  t)
inlineprotectedvirtual

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

Definition at line 392 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::PushFrontTransform ( TransformTypePointer  t)
inlineprotectedvirtual

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

Definition at line 385 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::SetAllTransformsToOptimize ( bool  state)
inlinevirtual

Definition at line 187 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::SetAllTransformsToOptimizeOff ( )
inlinevirtual

Definition at line 199 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::SetAllTransformsToOptimizeOn ( )
inlinevirtual

Definition at line 194 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::SetFixedParameters ( const ParametersType fixedParameters)
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::SetNthTransformToOptimize ( SizeValueType  i,
bool  state 
)
inlinevirtual

Active Transform state manipulation

Definition at line 171 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::SetNthTransformToOptimizeOff ( SizeValueType  i)
inlinevirtual

Definition at line 182 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::SetNthTransformToOptimizeOn ( SizeValueType  i)
inlinevirtual

Definition at line 177 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::SetOnlyMostRecentTransformToOptimizeOn ( )
inlinevirtual

Definition at line 207 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::SetParameters ( const ParametersType p)
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputCovariantVectorType itk::CompositeTransform< TScalar, NDimensions >::TransformCovariantVector ( const InputCovariantVectorType ) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVectorPixelType itk::CompositeTransform< TScalar, NDimensions >::TransformCovariantVector ( const InputVectorPixelType ) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputCovariantVectorType itk::CompositeTransform< TScalar, NDimensions >::TransformCovariantVector ( const InputCovariantVectorType inputVector,
const InputPointType inputPoint 
) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVectorPixelType itk::CompositeTransform< TScalar, NDimensions >::TransformCovariantVector ( const InputVectorPixelType inputVector,
const InputPointType inputPoint 
) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputDiffusionTensor3DType itk::CompositeTransform< TScalar, NDimensions >::TransformDiffusionTensor3D ( const InputDiffusionTensor3DType inputTensor) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVectorPixelType itk::CompositeTransform< TScalar, NDimensions >::TransformDiffusionTensor3D ( const InputVectorPixelType inputTensor) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputDiffusionTensor3DType itk::CompositeTransform< TScalar, NDimensions >::TransformDiffusionTensor3D ( const InputDiffusionTensor3DType inputTensor,
const InputPointType inputPoint 
) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVectorPixelType itk::CompositeTransform< TScalar, NDimensions >::TransformDiffusionTensor3D ( const InputVectorPixelType inputTensor,
const InputPointType inputPoint 
) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputPointType itk::CompositeTransform< TScalar, NDimensions >::TransformPoint ( const InputPointType inputPoint) const
virtual

Compute the position of point in the new space.

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

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

template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputSymmetricSecondRankTensorType itk::CompositeTransform< TScalar, NDimensions >::TransformSymmetricSecondRankTensor ( const InputSymmetricSecondRankTensorType inputTensor) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVectorPixelType itk::CompositeTransform< TScalar, NDimensions >::TransformSymmetricSecondRankTensor ( const InputVectorPixelType inputTensor) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputSymmetricSecondRankTensorType itk::CompositeTransform< TScalar, NDimensions >::TransformSymmetricSecondRankTensor ( const InputSymmetricSecondRankTensorType inputTensor,
const InputPointType inputPoint 
) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVectorPixelType itk::CompositeTransform< TScalar, NDimensions >::TransformSymmetricSecondRankTensor ( const InputVectorPixelType inputTensor,
const InputPointType inputPoint 
) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVectorType itk::CompositeTransform< TScalar, NDimensions >::TransformVector ( const InputVectorType ) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVnlVectorType itk::CompositeTransform< TScalar, NDimensions >::TransformVector ( const InputVnlVectorType inputVector) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVectorPixelType itk::CompositeTransform< TScalar, NDimensions >::TransformVector ( const InputVectorPixelType inputVector) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVectorType itk::CompositeTransform< TScalar, NDimensions >::TransformVector ( const InputVectorType inputVector,
const InputPointType inputPoint 
) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVnlVectorType itk::CompositeTransform< TScalar, NDimensions >::TransformVector ( const InputVnlVectorType inputVector,
const InputPointType inputPoint 
) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual OutputVectorPixelType itk::CompositeTransform< TScalar, NDimensions >::TransformVector ( const InputVectorPixelType inputVector,
const InputPointType inputPoint 
) const
virtual
template<class TScalar = double, unsigned int NDimensions = 3>
virtual void itk::CompositeTransform< TScalar, NDimensions >::UpdateTransformParameters ( const DerivativeType update,
ScalarType  factor = 1.0 
)
virtual

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

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

Member Data Documentation

template<class TScalar = double, unsigned int NDimensions = 3>
const unsigned int itk::CompositeTransform< TScalar, NDimensions >::InputDimension = NDimensions
static

Dimension of the domain spaces.

Definition at line 165 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
ModifiedTimeType itk::CompositeTransform< TScalar, NDimensions >::m_PreviousTransformsToOptimizeUpdateTime
mutableprivate

Definition at line 421 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
TransformsToOptimizeFlagsType itk::CompositeTransform< TScalar, NDimensions >::m_TransformsToOptimizeFlags
mutableprotected

Definition at line 415 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
TransformQueueType itk::CompositeTransform< TScalar, NDimensions >::m_TransformsToOptimizeQueue
mutableprotected

Definition at line 414 of file itkCompositeTransform.h.

template<class TScalar = double, unsigned int NDimensions = 3>
const unsigned int itk::CompositeTransform< TScalar, NDimensions >::OutputDimension = NDimensions
static

Dimension of the domain spaces.

Definition at line 166 of file itkCompositeTransform.h.


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