ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::TransformParametersAdaptorBase< TTransform > Class Template Referenceabstract
Group Registration » Module ITKRegistrationCommon

#include <itkTransformParametersAdaptorBase.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = typename TransformBaseType::FixedParametersType
 
using FixedParametersValueType = typename TransformBaseType::FixedParametersValueType
 
using ParametersType = typename TransformBaseType::ParametersType
 
using ParametersValueType = typename ParametersType::ValueType
 
using Pointer = SmartPointer< Self >
 
using Self = TransformParametersAdaptorBase
 
using Superclass = Object
 
using TransformBasePointer = typename TransformBaseType::Pointer
 
using TransformBaseType = TTransform
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual void AdaptTransformParameters ()=0
 
virtual const char * GetNameOfClass () const
 
virtual const FixedParametersType & GetRequiredFixedParameters () const
 
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
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 TransformParametersAdaptorBase ()=default
 
 ~TransformParametersAdaptorBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- 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

FixedParametersType m_RequiredFixedParameters
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Additional Inherited Members

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

Detailed Description

template<typename TTransform>
class itk::TransformParametersAdaptorBase< 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 itkTransformParametersAdaptorBase.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TTransform>
using itk::TransformParametersAdaptorBase< TTransform >::ConstPointer = SmartPointer<const Self>

Definition at line 64 of file itkTransformParametersAdaptorBase.h.

◆ FixedParametersType

template<typename TTransform>
using itk::TransformParametersAdaptorBase< TTransform >::FixedParametersType = typename TransformBaseType::FixedParametersType

Definition at line 74 of file itkTransformParametersAdaptorBase.h.

◆ FixedParametersValueType

template<typename TTransform>
using itk::TransformParametersAdaptorBase< TTransform >::FixedParametersValueType = typename TransformBaseType::FixedParametersValueType

Definition at line 75 of file itkTransformParametersAdaptorBase.h.

◆ ParametersType

template<typename TTransform>
using itk::TransformParametersAdaptorBase< TTransform >::ParametersType = typename TransformBaseType::ParametersType

Definition at line 72 of file itkTransformParametersAdaptorBase.h.

◆ ParametersValueType

template<typename TTransform>
using itk::TransformParametersAdaptorBase< TTransform >::ParametersValueType = typename ParametersType::ValueType

Definition at line 73 of file itkTransformParametersAdaptorBase.h.

◆ Pointer

template<typename TTransform>
using itk::TransformParametersAdaptorBase< TTransform >::Pointer = SmartPointer<Self>

Definition at line 63 of file itkTransformParametersAdaptorBase.h.

◆ Self

template<typename TTransform>
using itk::TransformParametersAdaptorBase< TTransform >::Self = TransformParametersAdaptorBase

Standard class type aliases.

Definition at line 61 of file itkTransformParametersAdaptorBase.h.

◆ Superclass

template<typename TTransform>
using itk::TransformParametersAdaptorBase< TTransform >::Superclass = Object

Definition at line 62 of file itkTransformParametersAdaptorBase.h.

◆ TransformBasePointer

template<typename TTransform>
using itk::TransformParametersAdaptorBase< TTransform >::TransformBasePointer = typename TransformBaseType::Pointer

Definition at line 71 of file itkTransformParametersAdaptorBase.h.

◆ TransformBaseType

template<typename TTransform>
using itk::TransformParametersAdaptorBase< TTransform >::TransformBaseType = TTransform

Typedefs associated with the transform

Definition at line 70 of file itkTransformParametersAdaptorBase.h.

Constructor & Destructor Documentation

◆ TransformParametersAdaptorBase()

template<typename TTransform>
itk::TransformParametersAdaptorBase< TTransform >::TransformParametersAdaptorBase ( )
protecteddefault

◆ ~TransformParametersAdaptorBase()

template<typename TTransform>
itk::TransformParametersAdaptorBase< TTransform >::~TransformParametersAdaptorBase ( )
overrideprotecteddefault

Member Function Documentation

◆ AdaptTransformParameters()

template<typename TTransform>
virtual void itk::TransformParametersAdaptorBase< TTransform >::AdaptTransformParameters ( )
pure virtual

Initialize the transform using the specified fixed parameters

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

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

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

◆ GetRequiredFixedParameters()

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

Get the fixed parameters

Reimplemented in itk::TransformParametersAdaptor< TTransform >.

◆ PrintSelf()

template<typename TTransform>
void itk::TransformParametersAdaptorBase< 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::Object.

Definition at line 97 of file itkTransformParametersAdaptorBase.h.

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

◆ SetRequiredFixedParameters()

template<typename TTransform>
virtual void itk::TransformParametersAdaptorBase< TTransform >::SetRequiredFixedParameters ( FixedParametersType  _arg)
virtual

Set the fixed parameters

◆ SetTransform()

template<typename TTransform>
virtual void itk::TransformParametersAdaptorBase< TTransform >::SetTransform ( TransformBaseType *  _arg,
void *  priorityLower = nullptr 
)
pure virtual

Member Data Documentation

◆ m_RequiredFixedParameters

template<typename TTransform>
FixedParametersType itk::TransformParametersAdaptorBase< TTransform >::m_RequiredFixedParameters
protected

Definition at line 103 of file itkTransformParametersAdaptorBase.h.

Referenced by itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >::PrintSelf().

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 Thu Apr 1 2021 02:34:49 for ITK by   doxygen 1.8.16