ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::TransformParametersAdaptor< TTransform > Class Template Reference
Module ITKRegistrationCommon

#include <itkTransformParametersAdaptor.h>

+ Inheritance diagram for itk::TransformParametersAdaptor< TTransform >:
+ Collaboration diagram for itk::TransformParametersAdaptor< TTransform >:

Detailed Description

template<typename TTransform>
class itk::TransformParametersAdaptor< TTransform >

Base helper class intended for multi-resolution image registration.

During multi-resolution image registration, it is often useful to expand the number of parameters describing the transform when going from one level to the next. For example, in B-spline registration, one often wants to increase the mesh size (or, equivalently, the control point grid size) for increased flexibility in optimizing the transform. This requires the propagation of the current transform solution to the next level where the solution is identical but with an increase in the number of parameters. This base class and those derived classes are meant to handle these types of situations.

Basic usage will involve the user specifying the required fixed parameters, i.e.

* transformAdaptor->SetTransform( transform );
* transformAdaptor->SetRequiredFixedParameters( fixedParameters );
* transformAdaptor->AdaptTransformParameters();
*

which will adjust the transform based on the new fixed parameters.

Author
Nick Tustison
Marius Staring

Definition at line 55 of file itkTransformParametersAdaptor.h.

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef
Superclass::FixedParametersType 		FixedParametersType
 
typedef
Superclass::FixedParametersValueType 		FixedParametersValueType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 		ParametersValueType
 
typedef SmartPointer< Self > Pointer
 
typedef TransformParametersAdaptor Self
 
typedef
TransformParametersAdaptorBase
< Transform< typename
TTransform::ScalarType,
TTransform::InputSpaceDimension,
TTransform::OutputSpaceDimension > > 		Superclass
 
typedef
Superclass::TransformBaseType 		TransformBaseType
 
typedef TransformType::Pointer TransformPointer
 
typedef TTransform TransformType
 
- Public Types inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
typedef SmartPointer< const Self > ConstPointer
 
typedef
TransformBaseType::FixedParametersType 		FixedParametersType
 
typedef
TransformBaseType::FixedParametersValueType 		FixedParametersValueType
 
typedef
TransformBaseType::ParametersType 		ParametersType
 
typedef ParametersType::ValueType ParametersValueType
 
typedef SmartPointer< Self > Pointer
 
typedef
TransformParametersAdaptorBase 		Self
 
typedef Object Superclass
 
typedef TransformBaseType::Pointer TransformBasePointer
 
typedef Transform
< TTransform::ScalarType,
TTransform::InputSpaceDimension,
TTransform::OutputSpaceDimension > 		TransformBaseType
 
- 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 AdaptTransformParameters () override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual const FixedParametersType & GetRequiredFixedParameters () const override
 
virtual void SetTransform (TransformType *_arg)
 
virtual void SetTransform (TransformBaseType *_arg, void *) override
 
virtual void SetRequiredFixedParameters (const FixedParametersType fixedParameters) override
 
- Public Member Functions inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
virtual void SetRequiredFixedParameters (FixedParametersType _arg)
 
virtual void SetTransform (TransformBaseType *_arg, void *priorityLower=nullptr)=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
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 Member Functions

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

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 TransformParametersAdaptor ()
 
 ~TransformParametersAdaptor () override
 
- Protected Member Functions inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
 TransformParametersAdaptorBase ()
 
 ~TransformParametersAdaptorBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

TransformPointer m_Transform
 
- Protected Attributes inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
FixedParametersType m_RequiredFixedParameters
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TTransform >
typedef SmartPointer<const Self> itk::TransformParametersAdaptor< TTransform >::ConstPointer

Definition at line 64 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
typedef Superclass::FixedParametersType itk::TransformParametersAdaptor< TTransform >::FixedParametersType

Definition at line 77 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
typedef Superclass::FixedParametersValueType itk::TransformParametersAdaptor< TTransform >::FixedParametersValueType

Definition at line 76 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
typedef Superclass::ParametersType itk::TransformParametersAdaptor< TTransform >::ParametersType

Definition at line 74 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
typedef Superclass::ParametersValueType itk::TransformParametersAdaptor< TTransform >::ParametersValueType

Definition at line 75 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
typedef SmartPointer<Self> itk::TransformParametersAdaptor< TTransform >::Pointer

Definition at line 63 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
typedef TransformParametersAdaptor itk::TransformParametersAdaptor< TTransform >::Self

Standard class typedefs.

Definition at line 61 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
typedef TransformParametersAdaptorBase<Transform<typename TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension> > itk::TransformParametersAdaptor< TTransform >::Superclass

Definition at line 62 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
typedef Superclass::TransformBaseType itk::TransformParametersAdaptor< TTransform >::TransformBaseType

Typedefs associated with the transform

Definition at line 67 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
typedef TransformType::Pointer itk::TransformParametersAdaptor< TTransform >::TransformPointer

Definition at line 73 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
typedef TTransform itk::TransformParametersAdaptor< TTransform >::TransformType

Definition at line 72 of file itkTransformParametersAdaptor.h.

Constructor & Destructor Documentation

template<typename TTransform >
itk::TransformParametersAdaptor< TTransform >::TransformParametersAdaptor ( )
inlineprotected

Definition at line 114 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
itk::TransformParametersAdaptor< TTransform >::~TransformParametersAdaptor ( )
inlineoverrideprotected

Definition at line 115 of file itkTransformParametersAdaptor.h.

Member Function Documentation

template<typename TTransform >
virtual void itk::TransformParametersAdaptor< TTransform >::AdaptTransformParameters ( )
inlineoverridevirtual

Initialize the transform using the specified fixed parameters

Implements itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >.

Reimplemented in itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >, itk::BSplineTransformParametersAdaptor< TTransform >, itk::DisplacementFieldTransformParametersAdaptor< TTransform >, itk::TimeVaryingVelocityFieldTransformParametersAdaptor< TTransform >, itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >, itk::BSplineExponentialDiffeomorphicTransformParametersAdaptor< TTransform >, itk::BSplineSmoothingOnUpdateDisplacementFieldTransformParametersAdaptor< TTransform >, itk::GaussianExponentialDiffeomorphicTransformParametersAdaptor< TTransform >, and itk::GaussianSmoothingOnUpdateDisplacementFieldTransformParametersAdaptor< TTransform >.

Definition at line 111 of file itkTransformParametersAdaptor.h.

template<typename TTransform >
virtual::itk::LightObject::Pointer itk::TransformParametersAdaptor< TTransform >::CreateAnother ( ) const
virtual

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

Reimplemented from itk::Object.

template<typename TTransform >
virtual const char* itk::TransformParametersAdaptor< TTransform >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >.

Reimplemented in itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >, itk::BSplineTransformParametersAdaptor< TTransform >, itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >, itk::DisplacementFieldTransformParametersAdaptor< TTransform >, itk::TimeVaryingVelocityFieldTransformParametersAdaptor< TTransform >, itk::BSplineExponentialDiffeomorphicTransformParametersAdaptor< TTransform >, itk::BSplineSmoothingOnUpdateDisplacementFieldTransformParametersAdaptor< TTransform >, itk::GaussianExponentialDiffeomorphicTransformParametersAdaptor< TTransform >, and itk::GaussianSmoothingOnUpdateDisplacementFieldTransformParametersAdaptor< TTransform >.

template<typename TTransform >
virtual const FixedParametersType& itk::TransformParametersAdaptor< TTransform >::GetRequiredFixedParameters ( ) const
inlineoverridevirtual

Get the fixed parameters

Reimplemented from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >.

Definition at line 105 of file itkTransformParametersAdaptor.h.

References itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >::m_RequiredFixedParameters.

template<typename TTransform >
static Pointer itk::TransformParametersAdaptor< TTransform >::New ( )
static

New macro for creation of through the object factory.

template<typename TTransform >
void itk::TransformParametersAdaptor< TTransform >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual

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::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >.

Definition at line 117 of file itkTransformParametersAdaptor.h.

References itk::TransformParametersAdaptorBase< TTransform >::PrintSelf().

template<typename TTransform >
virtual void itk::TransformParametersAdaptor< TTransform >::SetRequiredFixedParameters ( const FixedParametersType  fixedParameters)
inlineoverridevirtual

Set the fixed parameters

Reimplemented in itk::BSplineTransformParametersAdaptor< TTransform >.

Definition at line 93 of file itkTransformParametersAdaptor.h.

References itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >::m_RequiredFixedParameters, and itk::Object::Modified().

template<typename TTransform >
virtual void itk::TransformParametersAdaptor< TTransform >::SetTransform ( TransformType *  _arg)
virtual

Set the transform to be adapted

Referenced by itk::TransformParametersAdaptor< TTransform >::SetTransform().

template<typename TTransform >
virtual void itk::TransformParametersAdaptor< TTransform >::SetTransform ( TransformBaseType *  _arg,
void *   
)
inlineoverridevirtual

Definition at line 82 of file itkTransformParametersAdaptor.h.

References itk::TransformParametersAdaptor< TTransform >::SetTransform().

Member Data Documentation

template<typename TTransform >
TransformPointer itk::TransformParametersAdaptor< TTransform >::m_Transform
protected

Definition at line 123 of file itkTransformParametersAdaptor.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 Tue Dec 19 2017 06:00:00 for ITK by   doxygen 1.8.5