#include <itkMultiResolutionImageRegistrationMethod.h>

Detailed Description

template<typename TFixedImage, typename TMovingImage>
class itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >

Base class for multi-resolution image registration methods.

This class provides a generic interface for multi-resolution registration using components of the registration framework. See documentation for ImageRegistrationMethod for a description of the registration framework components.

The registration process is initiated by method Update(). The user must set the parameters of each component before calling this method.

The number of resolution level to process can be set via SetNumberOfLevels(). At each resolution level, the user specified registration components are used to register downsampled version of the images by computing the transform parameters that will map one image onto the other image.

A user can specify schedules for the fixed and moving image using SetSchedules() method. However, SetNumberOfLevels() and SetSchedules() should not be used together. An exception will be thrown if that happens.

The downsampled images are provided by user specified MultiResolutionPyramidImageFilters. User must specify the schedule for each pyramid externally prior to calling Update().

Warning: If there is discrepancy between the number of level requested and a pyramid schedule. The pyramid schedule will be overridden with a default one.

Before each resolution level an IterationEvent is invoked providing an opportunity for a user interface to change any of the components, change component parameters, or stop the registration.

This class is templated over the fixed image type and the moving image type.

See also: ImageRegistrationMethod

Definition at line 72 of file itkMultiResolutionImageRegistrationMethod.h.

Inheritance diagram for itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >:

Collaboration diagram for itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DataObjectPointer = typename DataObject::Pointer

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

using	FixedImageConstPointer = typename FixedImageType::ConstPointer

using	FixedImagePyramidPointer = typename FixedImagePyramidType::Pointer

using	FixedImagePyramidType = MultiResolutionPyramidImageFilter< FixedImageType, FixedImageType >

using	FixedImageRegionType = typename FixedImageType::RegionType

using	FixedImageType = TFixedImage

using	InterpolatorPointer = typename InterpolatorType::Pointer

using	InterpolatorType = typename MetricType::InterpolatorType

using	MetricPointer = typename MetricType::Pointer

using	MetricType = ImageToImageMetric< FixedImageType, MovingImageType >

using	MovingImageConstPointer = typename MovingImageType::ConstPointer

using	MovingImagePyramidPointer = typename MovingImagePyramidType::Pointer

using	MovingImagePyramidType = MultiResolutionPyramidImageFilter< MovingImageType, MovingImageType >

using	MovingImageType = TMovingImage

using	OptimizerType = SingleValuedNonLinearOptimizer

using	ParametersType = typename MetricType::TransformParametersType

using	Pointer = SmartPointer< Self >

using	ScheduleType = typename FixedImagePyramidType::ScheduleType

using	Self = MultiResolutionImageRegistrationMethod

using	Superclass = ProcessObject

using	TransformOutputConstPointer = typename TransformOutputType::ConstPointer

using	TransformOutputPointer = typename TransformOutputType::Pointer

using	TransformOutputType = DataObjectDecorator< TransformType >

using	TransformPointer = typename TransformType::Pointer

using	TransformType = typename MetricType::TransformType

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

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 SizeValueType	GetCurrentLevel () const

virtual ScheduleType	GetFixedImagePyramidSchedule () const

virtual const ParametersType &	GetLastTransformParameters () const

virtual ScheduleType	GetMovingImagePyramidSchedule () const

ModifiedTimeType	GetMTime () const override

const char *	GetNameOfClass () const override

virtual SizeValueType	GetNumberOfLevels () const

const TransformOutputType *	GetOutput () const

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType output) override

void	SetNumberOfLevels (SizeValueType numberOfLevels)

void	SetSchedules (const ScheduleType &fixedImagePyramidSchedule, const ScheduleType &movingImagePyramidSchedule)

void	StopRegistration ()


virtual void	SetFixedImage (const FixedImageType *_arg)

virtual const FixedImageType *	GetFixedImage () const


virtual void	SetMovingImage (const MovingImageType *_arg)

virtual const MovingImageType *	GetMovingImage () const


virtual void	SetOptimizer (OptimizerType *_arg)

virtual OptimizerType *	GetModifiableOptimizer ()


virtual void	SetMetric (MetricType *_arg)

virtual MetricType *	GetModifiableMetric ()


virtual void	SetFixedImageRegion (FixedImageRegionType _arg)

virtual const FixedImageRegionType &	GetFixedImageRegion () const


virtual void	SetTransform (TransformType *_arg)

virtual TransformType *	GetModifiableTransform ()


virtual void	SetInterpolator (InterpolatorType *_arg)

virtual InterpolatorType *	GetModifiableInterpolator ()


virtual void	SetFixedImagePyramid (FixedImagePyramidType *_arg)

virtual FixedImagePyramidType *	GetModifiableFixedImagePyramid ()


virtual void	SetMovingImagePyramid (MovingImagePyramidType *_arg)

virtual MovingImagePyramidType *	GetModifiableMovingImagePyramid ()


virtual void	SetInitialTransformParameters (ParametersType _arg)

virtual const ParametersType &	GetInitialTransformParameters () const


virtual void	SetInitialTransformParametersOfNextLevel (ParametersType _arg)

virtual const ParametersType &	GetInitialTransformParametersOfNextLevel () const

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () 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

const char *	GetNameOfClass () const override

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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	GenerateData () override

void	Initialize ()

	MultiResolutionImageRegistrationMethod ()

void	PreparePyramids ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetCurrentLevel (SizeValueType _arg)

	~MultiResolutionImageRegistrationMethod () override=default

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
SizeValueType	m_CurrentLevel {}

FixedImageConstPointer	m_FixedImage {}

FixedImagePyramidPointer	m_FixedImagePyramid {}

ScheduleType	m_FixedImagePyramidSchedule {}

FixedImageRegionType	m_FixedImageRegion {}

std::vector< FixedImageRegionType >	m_FixedImageRegionPyramid {}

ParametersType	m_InitialTransformParameters {}

ParametersType	m_InitialTransformParametersOfNextLevel {}

InterpolatorPointer	m_Interpolator {}

ParametersType	m_LastTransformParameters {}

MetricPointer	m_Metric {}

MovingImageConstPointer	m_MovingImage {}

MovingImagePyramidPointer	m_MovingImagePyramid {}

ScheduleType	m_MovingImagePyramidSchedule {}

SizeValueType	m_NumberOfLevels {}

bool	m_NumberOfLevelsSpecified {}

OptimizerType::Pointer	m_Optimizer {}

bool	m_ScheduleSpecified {}

bool	m_Stop {}

TransformPointer	m_Transform {}

Additional Inherited Members
Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self>

Definition at line 81 of file itkMultiResolutionImageRegistrationMethod.h.

◆ DataObjectPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::DataObjectPointer = typename DataObject::Pointer

Smart Pointer type to a DataObject.

Definition at line 135 of file itkMultiResolutionImageRegistrationMethod.h.

◆ DataObjectPointerArraySizeType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

Make a DataObject of the correct type to be used as the specified output.

Definition at line 224 of file itkMultiResolutionImageRegistrationMethod.h.

◆ FixedImageConstPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageConstPointer = typename FixedImageType::ConstPointer

Definition at line 91 of file itkMultiResolutionImageRegistrationMethod.h.

◆ FixedImagePyramidPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImagePyramidPointer = typename FixedImagePyramidType::Pointer

Definition at line 121 of file itkMultiResolutionImageRegistrationMethod.h.

◆ FixedImagePyramidType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImagePyramidType = MultiResolutionPyramidImageFilter<FixedImageType, FixedImageType>

Type of the Fixed image multiresolution pyramid.

Definition at line 120 of file itkMultiResolutionImageRegistrationMethod.h.

◆ FixedImageRegionType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageRegionType = typename FixedImageType::RegionType

Definition at line 92 of file itkMultiResolutionImageRegistrationMethod.h.

◆ FixedImageType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageType = TFixedImage

Type of the Fixed image.

Definition at line 90 of file itkMultiResolutionImageRegistrationMethod.h.

◆ InterpolatorPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::InterpolatorPointer = typename InterpolatorType::Pointer

Definition at line 114 of file itkMultiResolutionImageRegistrationMethod.h.

◆ InterpolatorType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::InterpolatorType = typename MetricType::InterpolatorType

Type of the Interpolator.

Definition at line 113 of file itkMultiResolutionImageRegistrationMethod.h.

◆ MetricPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MetricPointer = typename MetricType::Pointer

Definition at line 100 of file itkMultiResolutionImageRegistrationMethod.h.

◆ MetricType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MetricType = ImageToImageMetric<FixedImageType, MovingImageType>

Type of the metric.

Definition at line 99 of file itkMultiResolutionImageRegistrationMethod.h.

◆ MovingImageConstPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MovingImageConstPointer = typename MovingImageType::ConstPointer

Definition at line 96 of file itkMultiResolutionImageRegistrationMethod.h.

◆ MovingImagePyramidPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MovingImagePyramidPointer = typename MovingImagePyramidType::Pointer

Definition at line 128 of file itkMultiResolutionImageRegistrationMethod.h.

◆ MovingImagePyramidType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MovingImagePyramidType = MultiResolutionPyramidImageFilter<MovingImageType, MovingImageType>

Type of the moving image multiresolution pyramid.

Definition at line 127 of file itkMultiResolutionImageRegistrationMethod.h.

◆ MovingImageType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MovingImageType = TMovingImage

Type of the Moving image.

Definition at line 95 of file itkMultiResolutionImageRegistrationMethod.h.

◆ OptimizerType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::OptimizerType = SingleValuedNonLinearOptimizer

Type of the optimizer.

Definition at line 117 of file itkMultiResolutionImageRegistrationMethod.h.

◆ ParametersType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::ParametersType = typename MetricType::TransformParametersType

Type of the Transformation parameters This is the same type used to represent the search space of the optimization algorithm

Definition at line 132 of file itkMultiResolutionImageRegistrationMethod.h.

◆ Pointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>

Definition at line 80 of file itkMultiResolutionImageRegistrationMethod.h.

◆ ScheduleType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::ScheduleType = typename FixedImagePyramidType::ScheduleType

Type of pyramid schedule type

Definition at line 124 of file itkMultiResolutionImageRegistrationMethod.h.

◆ Self

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::Self = MultiResolutionImageRegistrationMethod

Standard class type aliases.

Definition at line 78 of file itkMultiResolutionImageRegistrationMethod.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::Superclass = ProcessObject

Definition at line 79 of file itkMultiResolutionImageRegistrationMethod.h.

◆ TransformOutputConstPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputConstPointer = typename TransformOutputType::ConstPointer

Definition at line 110 of file itkMultiResolutionImageRegistrationMethod.h.

◆ TransformOutputPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputPointer = typename TransformOutputType::Pointer

Definition at line 109 of file itkMultiResolutionImageRegistrationMethod.h.

◆ TransformOutputType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputType = DataObjectDecorator<TransformType>

Type for the output: Using Decorator pattern for enabling the Transform to be passed in the data pipeline

Definition at line 108 of file itkMultiResolutionImageRegistrationMethod.h.

◆ TransformPointer

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::TransformPointer = typename TransformType::Pointer

Definition at line 104 of file itkMultiResolutionImageRegistrationMethod.h.

◆ TransformType

template<typename TFixedImage , typename TMovingImage >

using itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::TransformType = typename MetricType::TransformType

Type of the Transform .

Definition at line 103 of file itkMultiResolutionImageRegistrationMethod.h.

Constructor & Destructor Documentation

◆ MultiResolutionImageRegistrationMethod()

template<typename TFixedImage , typename TMovingImage >

itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MultiResolutionImageRegistrationMethod ( )

protected

◆ ~MultiResolutionImageRegistrationMethod()

template<typename TFixedImage , typename TMovingImage >

itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::~MultiResolutionImageRegistrationMethod ( )

overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TFixedImage , typename TMovingImage >

void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GenerateData ( )

overrideprotectedvirtual

Method invoked by the pipeline in order to trigger the computation of the registration.

Reimplemented from itk::ProcessObject.

◆ GetCurrentLevel()

template<typename TFixedImage , typename TMovingImage >

virtual SizeValueType itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetCurrentLevel ( ) const

virtual

Get the current resolution level being processed.

◆ GetFixedImage()

template<typename TFixedImage , typename TMovingImage >

virtual const FixedImageType * itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImage ( ) const

virtual

Set/Get the Fixed image.

◆ GetFixedImagePyramidSchedule()

template<typename TFixedImage , typename TMovingImage >

virtual ScheduleType itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImagePyramidSchedule ( ) const

virtual

◆ GetFixedImageRegion()

template<typename TFixedImage , typename TMovingImage >

virtual const FixedImageRegionType & itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImageRegion ( ) const

virtual

Set/Get the Metric.

◆ GetInitialTransformParameters()

template<typename TFixedImage , typename TMovingImage >

virtual const ParametersType & itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetInitialTransformParameters ( ) const

virtual

Set/Get the initial transformation parameters.

◆ GetInitialTransformParametersOfNextLevel()

template<typename TFixedImage , typename TMovingImage >

virtual const ParametersType & itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetInitialTransformParametersOfNextLevel ( ) const

virtual

Set/Get the initial transformation parameters of the next resolution level to be processed. The default is the last set of parameters of the last resolution level.

◆ GetLastTransformParameters()

template<typename TFixedImage , typename TMovingImage >

virtual const ParametersType & itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetLastTransformParameters ( ) const

virtual

Get the last transformation parameters visited by the optimizer.

◆ GetModifiableFixedImagePyramid()

template<typename TFixedImage , typename TMovingImage >

virtual FixedImagePyramidType * itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetModifiableFixedImagePyramid ( )

virtual

Set/Get the Fixed image pyramid.

◆ GetModifiableInterpolator()

template<typename TFixedImage , typename TMovingImage >

virtual InterpolatorType * itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetModifiableInterpolator ( )

virtual

Set/Get the Interpolator.

◆ GetModifiableMetric()

template<typename TFixedImage , typename TMovingImage >

virtual MetricType * itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetModifiableMetric ( )

virtual

Set/Get the Metric.

◆ GetModifiableMovingImagePyramid()

template<typename TFixedImage , typename TMovingImage >

virtual MovingImagePyramidType * itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetModifiableMovingImagePyramid ( )

virtual

Set/Get the Moving image pyramid.

◆ GetModifiableOptimizer()

template<typename TFixedImage , typename TMovingImage >

virtual OptimizerType * itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetModifiableOptimizer ( )

virtual

Set/Get the Optimizer.

◆ GetModifiableTransform()

template<typename TFixedImage , typename TMovingImage >

virtual TransformType * itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetModifiableTransform ( )

virtual

Set/Get the Transform.

◆ GetMovingImage()

template<typename TFixedImage , typename TMovingImage >

virtual const MovingImageType * itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetMovingImage ( ) const

virtual

Set/Get the Moving image.

◆ GetMovingImagePyramidSchedule()

template<typename TFixedImage , typename TMovingImage >

virtual ScheduleType itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetMovingImagePyramidSchedule ( ) const

virtual

◆ GetMTime()

template<typename TFixedImage , typename TMovingImage >

ModifiedTimeType itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetMTime ( ) const

overridevirtual

Method to return the latest modified time of this object or any of its cached ivars

Reimplemented from itk::Object.

◆ GetNameOfClass()

template<typename TFixedImage , typename TMovingImage >

const char * itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetNumberOfLevels()

template<typename TFixedImage , typename TMovingImage >

virtual SizeValueType itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetNumberOfLevels ( ) const

virtual

◆ GetOutput()

template<typename TFixedImage , typename TMovingImage >

const TransformOutputType * itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::GetOutput ( ) const

Returns the transform resulting from the registration process

◆ Initialize()

template<typename TFixedImage , typename TMovingImage >

void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::Initialize ( )

protected

Initialize by setting the interconnects between the components. This method is executed at every level of the pyramid with the values corresponding to this resolution

◆ MakeOutput()

template<typename TFixedImage , typename TMovingImage >

DataObjectPointer itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MakeOutput ( DataObjectPointerArraySizeType idx )

overridevirtual

Make a DataObject of the correct type to used as the specified output.

Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

◆ New()

template<typename TFixedImage , typename TMovingImage >

static Pointer itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::New ( )

static

Method for creation through the object factory.

◆ PreparePyramids()

template<typename TFixedImage , typename TMovingImage >

void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::PreparePyramids ( )

protected

Compute the size of the fixed region for each level of the pyramid.

◆ PrintSelf()

template<typename TFixedImage , typename TMovingImage >

void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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::ProcessObject.

◆ SetCurrentLevel()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetCurrentLevel ( SizeValueType _arg )

protectedvirtual

Set the current level to be processed

◆ SetFixedImage()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImage ( const FixedImageType * _arg )

virtual

Set/Get the Fixed image.

◆ SetFixedImagePyramid()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImagePyramid ( FixedImagePyramidType * _arg )

virtual

Set/Get the Fixed image pyramid.

◆ SetFixedImageRegion()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImageRegion ( FixedImageRegionType _arg )

virtual

Set/Get the Metric.

◆ SetInitialTransformParameters()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetInitialTransformParameters ( ParametersType _arg )

virtual

Set/Get the initial transformation parameters.

◆ SetInitialTransformParametersOfNextLevel()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetInitialTransformParametersOfNextLevel ( ParametersType _arg )

virtual

Set/Get the initial transformation parameters of the next resolution level to be processed. The default is the last set of parameters of the last resolution level.

◆ SetInterpolator()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetInterpolator ( InterpolatorType * _arg )

virtual

Set/Get the Interpolator.

◆ SetMetric()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetMetric ( MetricType * _arg )

virtual

Set/Get the Metric.

◆ SetMovingImage()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetMovingImage ( const MovingImageType * _arg )

virtual

Set/Get the Moving image.

◆ SetMovingImagePyramid()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetMovingImagePyramid ( MovingImagePyramidType * _arg )

virtual

Set/Get the Moving image pyramid.

◆ SetNumberOfLevels()

template<typename TFixedImage , typename TMovingImage >

void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetNumberOfLevels ( SizeValueType numberOfLevels )

Set/Get the number of multi-resolution levels.

◆ SetOptimizer()

template<typename TFixedImage , typename TMovingImage >

virtual void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetOptimizer ( OptimizerType * _arg )

virtual

Set/Get the Optimizer.

◆ SetSchedules()

template<typename TFixedImage , typename TMovingImage >

void itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::SetSchedules	(	const ScheduleType &	fixedImagePyramidSchedule,
		const ScheduleType &	movingImagePyramidSchedule
	)