itk::TransformParametersAdaptor< TTransform > Class Template Reference

#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
using	ConstPointer = SmartPointer< const Self >
using	FixedParametersType = typename Superclass::FixedParametersType
using	FixedParametersValueType = typename Superclass::FixedParametersValueType
using	ParametersType = typename Superclass::ParametersType
using	ParametersValueType = typename Superclass::ParametersValueType
using	Pointer = SmartPointer< Self >
using	Self = TransformParametersAdaptor
using	Superclass = TransformParametersAdaptorBase< Transform< typename TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
using	TransformBaseType = typename Superclass::TransformBaseType
using	TransformPointer = typename TransformType::Pointer
using	TransformType = TTransform
Public Types inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
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 = Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension >
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
void	AdaptTransformParameters () override
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const
const FixedParametersType &	GetRequiredFixedParameters () const override
virtual void	SetTransform (TransformType *_arg)
void	SetTransform (TransformBaseType *_arg, void *) override
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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public 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 ()=default
	~TransformParametersAdaptor () override=default
Protected Member Functions inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
void	PrintSelf (std::ostream &os, Indent indent) const override
	TransformParametersAdaptorBase ()=default
	~TransformParametersAdaptorBase () override=default
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::ConstPointer = SmartPointer<const Self>

Definition at line 65 of file itkTransformParametersAdaptor.h.

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::FixedParametersType = typename Superclass::FixedParametersType

Definition at line 78 of file itkTransformParametersAdaptor.h.

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::FixedParametersValueType = typename Superclass::FixedParametersValueType

Definition at line 77 of file itkTransformParametersAdaptor.h.

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::ParametersType = typename Superclass::ParametersType

Definition at line 75 of file itkTransformParametersAdaptor.h.

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::ParametersValueType = typename Superclass::ParametersValueType

Definition at line 76 of file itkTransformParametersAdaptor.h.

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::Pointer = SmartPointer<Self>

Definition at line 64 of file itkTransformParametersAdaptor.h.

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::Self = TransformParametersAdaptor

Standard class type aliases.

Definition at line 62 of file itkTransformParametersAdaptor.h.

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::Superclass = TransformParametersAdaptorBase<Transform<typename TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension> >

Definition at line 63 of file itkTransformParametersAdaptor.h.

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::TransformBaseType = typename Superclass::TransformBaseType

Typedefs associated with the transform

Definition at line 72 of file itkTransformParametersAdaptor.h.

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::TransformPointer = typename TransformType::Pointer

Definition at line 74 of file itkTransformParametersAdaptor.h.

template<typename TTransform >

using itk::TransformParametersAdaptor< TTransform >::TransformType = TTransform

Definition at line 73 of file itkTransformParametersAdaptor.h.

Constructor & Destructor Documentation

template<typename TTransform >

itk::TransformParametersAdaptor< TTransform >::TransformParametersAdaptor ( )

protecteddefault

template<typename TTransform >

itk::TransformParametersAdaptor< TTransform >::~TransformParametersAdaptor ( )

overrideprotecteddefault

Member Function Documentation

template<typename TTransform >

void itk::TransformParametersAdaptor< TTransform >::AdaptTransformParameters ( )

inlineoverridevirtual

Initialize the transform using the specified fixed parameters

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

Definition at line 112 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 >

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 106 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::Object.

Definition at line 118 of file itkTransformParametersAdaptor.h.

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

template<typename TTransform >

void itk::TransformParametersAdaptor< TTransform >::SetRequiredFixedParameters ( const FixedParametersType  fixedParameters )

inlineoverride

Set the fixed parameters

Definition at line 94 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 >

void itk::TransformParametersAdaptor< TTransform >::SetTransform ( TransformBaseType *  _arg, void *    )

inlineoverride

Definition at line 83 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 124 of file itkTransformParametersAdaptor.h.

---

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

• itkTransformParametersAdaptor.h