#include <itkMultiResolutionImageRegistrationMethod.h>

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

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

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef FixedImageType::ConstPointer	FixedImageConstPointer
typedef FixedImagePyramidType::Pointer	FixedImagePyramidPointer
typedef MultiResolutionPyramidImageFilter < FixedImageType, FixedImageType >	FixedImagePyramidType
typedef FixedImageType::RegionType	FixedImageRegionType
typedef TFixedImage	FixedImageType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef MetricType::InterpolatorType	InterpolatorType
typedef MetricType::Pointer	MetricPointer
typedef ImageToImageMetric < FixedImageType, MovingImageType >	MetricType
typedef MovingImageType::ConstPointer	MovingImageConstPointer
typedef MovingImagePyramidType::Pointer	MovingImagePyramidPointer
typedef MultiResolutionPyramidImageFilter < MovingImageType, MovingImageType >	MovingImagePyramidType
typedef TMovingImage	MovingImageType
typedef SingleValuedNonLinearOptimizer	OptimizerType
typedef MetricType::TransformParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef FixedImagePyramidType::ScheduleType	ScheduleType
typedef MultiResolutionImageRegistrationMethod	Self
typedef ProcessObject	Superclass
typedef TransformOutputType::ConstPointer	TransformOutputConstPointer
typedef TransformOutputType::Pointer	TransformOutputPointer
typedef DataObjectDecorator < TransformType >	TransformOutputType
typedef TransformType::Pointer	TransformPointer
typedef MetricType::TransformType	TransformType
Public Types inherited from itk::ProcessObject
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual SizeValueType	GetCurrentLevel () const
virtual ScheduleType	GetFixedImagePyramidSchedule () const
virtual const ParametersType &	GetLastTransformParameters ()
virtual ScheduleType	GetMovingImagePyramidSchedule () const
unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual SizeValueType	GetNumberOfLevels () const
const TransformOutputType *	GetOutput () const
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
void	SetNumberOfLevels (SizeValueType numberOfLevels)
void	SetSchedules (const ScheduleType &fixedSchedule, const ScheduleType &movingSchedule)
void	StartRegistration ()
void	StopRegistration ()

virtual void	SetFixedImage (const FixedImageType *_arg)
virtual const FixedImageType *	GetFixedImage ()

virtual void	SetMovingImage (const MovingImageType *_arg)
virtual const MovingImageType *	GetMovingImage ()

virtual void	SetOptimizer (OptimizerType *_arg)
virtual OptimizerType *	GetOptimizer ()

virtual void	SetMetric (MetricType *_arg)
virtual MetricType *	GetMetric ()

virtual void	SetFixedImageRegion (FixedImageRegionType _arg)
virtual const FixedImageRegionType &	GetFixedImageRegion ()

virtual void	SetTransform (TransformType *_arg)
virtual TransformType *	GetTransform ()

virtual void	SetInterpolator (InterpolatorType *_arg)
virtual InterpolatorType *	GetInterpolator ()

virtual void	SetFixedImagePyramid (FixedImagePyramidType *_arg)
virtual FixedImagePyramidType *	GetFixedImagePyramid ()

virtual void	SetMovingImagePyramid (MovingImagePyramidType *_arg)
virtual MovingImagePyramidType *	GetMovingImagePyramid ()

virtual void	SetInitialTransformParameters (ParametersType _arg)
virtual const ParametersType &	GetInitialTransformParameters ()

virtual void	SetInitialTransformParametersOfNextLevel (ParametersType _arg)
virtual const ParametersType &	GetInitialTransformParametersOfNextLevel ()
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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 (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) 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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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 ()

Protected Member Functions
void	GenerateData ()
void	Initialize () throw ( ExceptionObject )
	MultiResolutionImageRegistrationMethod ()
void	PreparePyramids (void)
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~MultiResolutionImageRegistrationMethod ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
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 num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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 ()

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
virtual void	SetCurrentLevel (SizeValueType _arg)
	MultiResolutionImageRegistrationMethod (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Protected Attributes inherited from itk::ProcessObject
bool	m_Updating
TimeStamp	m_OutputInformationMTime

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 StartRegistration(). 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 StartRegistration().

Warning:: If there is discrepancy between the number of level requested and a pyramid schedule. The pyramid schedule will be overriden 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.