#include <itkTransformParametersAdaptor.h>

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.

Inheritance diagram for itk::TransformParametersAdaptor< TTransform >:

Collaboration diagram for itk::TransformParametersAdaptor< TTransform >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = TransformParametersAdaptor

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

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

const char *	GetNameOfClass () const override

void	SetTransform (TransformBaseType _arg, void ) override

virtual void	SetTransform (TransformType *_arg)


void	SetRequiredFixedParameters (const FixedParametersType fixedParameters) override

Public Member Functions inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
const char *	GetNameOfClass () const override

virtual const FixedParametersType &	GetRequiredFixedParameters () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) 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) const

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

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

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 &timeStamp)

	~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

◆ ConstPointer

template<typename TTransform >

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

Definition at line 67 of file itkTransformParametersAdaptor.h.

◆ Pointer

template<typename TTransform >

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

Definition at line 66 of file itkTransformParametersAdaptor.h.

◆ Self

template<typename TTransform >

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

Standard class type aliases.

Definition at line 63 of file itkTransformParametersAdaptor.h.

◆ Superclass

template<typename TTransform >

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

Definition at line 65 of file itkTransformParametersAdaptor.h.

◆ TransformPointer

template<typename TTransform >

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

Definition at line 76 of file itkTransformParametersAdaptor.h.

◆ TransformType

template<typename TTransform >

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

Definition at line 75 of file itkTransformParametersAdaptor.h.

Constructor & Destructor Documentation

◆ TransformParametersAdaptor()

template<typename TTransform >

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

protecteddefault

◆ ~TransformParametersAdaptor()

template<typename TTransform >

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

overrideprotecteddefault

Member Function Documentation

◆ AdaptTransformParameters()

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 111 of file itkTransformParametersAdaptor.h.

◆ GetNameOfClass()

template<typename TTransform >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ New()

template<typename TTransform >

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

static

New macro for creation of through the object factory.

◆ PrintSelf()

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 119 of file itkTransformParametersAdaptor.h.

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