itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType > Class Template Reference

#include <itkMultiResolutionPDEDeformableRegistration.h>

Inheritance diagram for itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >:

Collaboration diagram for itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >:

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField, typename TRealType = float>
class itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >

Framework for performing multi-resolution PDE deformable registration.

MultiResolutionPDEDeformableRegistration provides a generic framework to perform multi-resolution deformable registration.

At each resolution level a PDEDeformableRegistrationFilter is used to register two images by computing the deformation field which will map a moving image onto a fixed image.

A deformation field is represented as an image whose pixel type is some vector type with at least N elements, where N is the dimension of the fixed image. The vector type must support element access via operator []. It is assumed that the vector elements behave like floating point scalars.

The internal PDEDeformationRegistrationFilter can be set using SetRegistrationFilter. By default a DemonsRegistrationFilter is used.

The input fixed and moving images are set via methods SetFixedImage and SetMovingImage respectively. An initial deformation field maybe set via SetInitialDisplacementField if is matches the characteristics of the coarsest pyramid level. If no such assumption can be made (e.g. the deformation field has the same characteristics as the input images), an initial deformation field can still be set via SetArbitraryInitialDisplacementField or SetInput. The filter will then take care of matching the coarsest level characteristics. If no initial field is set a zero field is used as the initial condition.

MultiResolutionPyramidImageFilters are used to downsample the fixed and moving images. A VectorExpandImageFilter is used to upsample the deformation as we move from a coarse to fine solution.

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

Warning

This class assumes that the fixed, moving and deformation field image types all have the same number of dimensions.

See Also

PDEDeformableRegistrationFilter

DemonsRegistrationFilter

MultiResolutionPyramidImageFilter

VectorExpandImageFilter

The current implementation of this class does not support streaming.

Examples:

Examples/RegistrationITKv3/DeformableRegistration10.cxx, Examples/RegistrationITKv3/DeformableRegistration16.cxx, Examples/RegistrationITKv3/DeformableRegistration17.cxx, Examples/RegistrationITKv4/DeformableRegistration10.cxx, Examples/RegistrationITKv4/DeformableRegistration16.cxx, and Examples/RegistrationITKv4/DeformableRegistration17.cxx.

Definition at line 81 of file itkMultiResolutionPDEDeformableRegistration.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	DefaultRegistrationType = DemonsRegistrationFilter< FloatImageType, FloatImageType, DisplacementFieldType >
using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer
using	DisplacementFieldType = TDisplacementField
using	FieldExpanderPointer = typename FieldExpanderType::Pointer
using	FieldExpanderType = VectorResampleImageFilter< DisplacementFieldType, DisplacementFieldType >
using	FixedImageConstPointer = typename FixedImageType::ConstPointer
using	FixedImagePointer = typename FixedImageType::Pointer
using	FixedImagePyramidPointer = typename FixedImagePyramidType::Pointer
using	FixedImagePyramidType = MultiResolutionPyramidImageFilter< FixedImageType, FloatImageType >
using	FixedImageType = TFixedImage
using	FloatImageType = Image< TRealType, Self::ImageDimension >
using	MovingImageConstPointer = typename MovingImageType::ConstPointer
using	MovingImagePointer = typename MovingImageType::Pointer
using	MovingImagePyramidPointer = typename MovingImagePyramidType::Pointer
using	MovingImagePyramidType = MultiResolutionPyramidImageFilter< MovingImageType, FloatImageType >
using	MovingImageType = TMovingImage
using	NumberOfIterationsType = Array< unsigned int >
using	Pointer = SmartPointer< Self >
using	RegistrationPointer = typename RegistrationType::Pointer
using	RegistrationType = PDEDeformableRegistrationFilter< FloatImageType, FloatImageType, DisplacementFieldType >
using	Self = MultiResolutionPDEDeformableRegistration
using	Superclass = ImageToImageFilter< TDisplacementField, TDisplacementField >
Public Types inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
using	ConstPointer = SmartPointer< const Self >
using	InputImageConstPointer = typename InputImageType::ConstPointer
using	InputImagePixelType = typename InputImageType::PixelType
using	InputImagePointer = typename InputImageType::Pointer
using	InputImageRegionType = typename InputImageType::RegionType
using	InputImageType = TDisplacementField
using	OutputImagePixelType = typename Superclass::OutputImagePixelType
using	OutputImageRegionType = typename Superclass::OutputImageRegionType
using	Pointer = SmartPointer< Self >
using	Self = ImageToImageFilter
using	Superclass = ImageSource< TDisplacementField >
Public Types inherited from itk::ImageSource< TDisplacementField >
using	ConstPointer = SmartPointer< const Self >
using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType
using	DataObjectPointer = DataObject::Pointer
using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
using	OutputImagePixelType = typename OutputImageType::PixelType
using	OutputImagePointer = typename OutputImageType::Pointer
using	OutputImageRegionType = typename OutputImageType::RegionType
using	OutputImageType = TDisplacementField
using	Pointer = SmartPointer< Self >
using	Self = ImageSource
using	Superclass = ProcessObject
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 ::itk::LightObject::Pointer	CreateAnother () const
virtual const unsigned int &	GetCurrentLevel () const
const DisplacementFieldType *	GetDisplacementField ()
const FixedImageType *	GetFixedImage () const
const MovingImageType *	GetMovingImage () const
virtual const char *	GetNameOfClass () const
virtual const NumberOfIterationsType &	GetNumberOfIterations () const
virtual const unsigned int &	GetNumberOfLevels () const
std::vector< SmartPointer < DataObject > >::size_type	GetNumberOfValidRequiredInputs () const override
virtual void	SetArbitraryInitialDisplacementField (DisplacementFieldType *ptr)
virtual void	SetFixedImage (const FixedImageType *ptr)
virtual void	SetInitialDisplacementField (DisplacementFieldType *ptr)
virtual void	SetMovingImage (const MovingImageType *ptr)
virtual void	SetNumberOfLevels (unsigned int num)
virtual void	StopRegistration ()
virtual void	SetRegistrationFilter (RegistrationType *_arg)
virtual RegistrationType *	GetModifiableRegistrationFilter ()
virtual const RegistrationType *	GetRegistrationFilter () const
virtual void	SetFixedImagePyramid (FixedImagePyramidType *_arg)
virtual FixedImagePyramidType *	GetModifiableFixedImagePyramid ()
virtual const FixedImagePyramidType *	GetFixedImagePyramid () const
virtual void	SetMovingImagePyramid (MovingImagePyramidType *_arg)
virtual MovingImagePyramidType *	GetModifiableMovingImagePyramid ()
virtual const MovingImagePyramidType *	GetMovingImagePyramid () const
virtual void	SetFieldExpander (FieldExpanderType *_arg)
virtual FieldExpanderType *	GetModifiableFieldExpander ()
virtual const FieldExpanderType *	GetFieldExpander () const
virtual void	SetNumberOfIterations (NumberOfIterationsType _arg)
virtual void	SetNumberOfIterations (unsigned int data[])
Public Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
void	PopBackInput () override
void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TDisplacementField *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::ImageSource< TDisplacementField >
OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual const float &	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
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 flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfWorkUnits () const
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 ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = FixedImageType::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
static constexpr unsigned int	InputImageDimension
static constexpr unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageSource< TDisplacementField >
static constexpr unsigned int	OutputImageDimension

Protected Member Functions
void	EnlargeOutputRequestedRegion (DataObject *ptr) override
void	GenerateData () override
void	GenerateInputRequestedRegion () override
void	GenerateOutputInformation () override
virtual bool	Halt ()
	MultiResolutionPDEDeformableRegistration ()
void	PrintSelf (std::ostream &os, Indent indent) const override
void	VerifyInputInformation () ITKv5_CONST override
	~MultiResolutionPDEDeformableRegistration () override=default
Protected Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
void	GenerateInputRequestedRegion () override
	ImageToImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override
void	VerifyInputInformation () ITKv5_CONST override
	~ImageToImageFilter () override
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
Protected Member Functions inherited from itk::ImageSource< TDisplacementField >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
void	GenerateData () override
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
	~ImageSource () override=default
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
virtual void	DynamicMultiThreadingOff ()
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	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
	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	VerifyPreconditions () ITKv5_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 idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
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 ()

Private Attributes
unsigned int	m_CurrentLevel
FieldExpanderPointer	m_FieldExpander
FixedImagePyramidPointer	m_FixedImagePyramid
DisplacementFieldPointer	m_InitialDisplacementField
MovingImagePyramidPointer	m_MovingImagePyramid
NumberOfIterationsType	m_NumberOfIterations
unsigned int	m_NumberOfLevels
RegistrationPointer	m_RegistrationFilter
bool	m_StopRegistrationFlag

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
Static Protected Member Functions inherited from itk::ImageSource< TDisplacementField >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)
Protected Attributes inherited from itk::ImageSource< TDisplacementField >
bool	m_DynamicMultiThreading
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

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::ConstPointer = SmartPointer< const Self >

Definition at line 92 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::DefaultRegistrationType = DemonsRegistrationFilter< FloatImageType, FloatImageType, DisplacementFieldType >

The default registration type.

Definition at line 126 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::DisplacementFieldPointer = typename DisplacementFieldType::Pointer

Definition at line 113 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::DisplacementFieldType = TDisplacementField

Deformation field image type.

Definition at line 112 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::FieldExpanderPointer = typename FieldExpanderType::Pointer

Definition at line 138 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::FieldExpanderType = VectorResampleImageFilter< DisplacementFieldType, DisplacementFieldType >

The deformation field expander type.

Definition at line 137 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::FixedImageConstPointer = typename FixedImageType::ConstPointer

Definition at line 104 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::FixedImagePointer = typename FixedImageType::Pointer

Definition at line 103 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::FixedImagePyramidPointer = typename FixedImagePyramidType::Pointer

Definition at line 130 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::FixedImagePyramidType = MultiResolutionPyramidImageFilter< FixedImageType, FloatImageType >

The fixed multi-resolution image pyramid type.

Definition at line 129 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::FixedImageType = TFixedImage

Fixed image type.

Definition at line 102 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::FloatImageType = Image< TRealType, Self::ImageDimension >

Internal float image type.

Definition at line 119 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::MovingImageConstPointer = typename MovingImageType::ConstPointer

Definition at line 109 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::MovingImagePointer = typename MovingImageType::Pointer

Definition at line 108 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::MovingImagePyramidPointer = typename MovingImagePyramidType::Pointer

Definition at line 134 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::MovingImagePyramidType = MultiResolutionPyramidImageFilter< MovingImageType, FloatImageType >

The moving multi-resolution image pyramid type.

Definition at line 133 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::MovingImageType = TMovingImage

Moving image type.

Definition at line 107 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::NumberOfIterationsType = Array< unsigned int >

Definition at line 140 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::Pointer = SmartPointer< Self >

Definition at line 91 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::RegistrationPointer = typename RegistrationType::Pointer

Definition at line 123 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::RegistrationType = PDEDeformableRegistrationFilter< FloatImageType, FloatImageType, DisplacementFieldType >

The internal registration type.

Definition at line 122 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::Self = MultiResolutionPDEDeformableRegistration

Standard class type aliases

Definition at line 88 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

using itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::Superclass = ImageToImageFilter< TDisplacementField, TDisplacementField >

Definition at line 90 of file itkMultiResolutionPDEDeformableRegistration.h.

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::MultiResolutionPDEDeformableRegistration ( )

protected

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::~MultiResolutionPDEDeformableRegistration ( )

overrideprotecteddefault

Member Function Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual::itk::LightObject::Pointer itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::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 TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::EnlargeOutputRequestedRegion ( DataObject *  ptr )

overrideprotectedvirtual

The current implementation of this class does not supprot streaming. As such it produces the output for the largest possible region.

Reimplemented from itk::ProcessObject.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GenerateData ( )

overrideprotectedvirtual

Generate output data by performing the registration at each resolution level.

Reimplemented from itk::ProcessObject.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

The current implementation of this class does not support streaming. As such it requires the largest possible region for the moving, fixed and input deformation field.

Reimplemented from itk::ProcessObject.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GenerateOutputInformation ( )

overrideprotectedvirtual

By default, the output deformation field has the same spacing, origin and LargestPossibleRegion as the input/initial deformation field.

If the initial deformation field is not set, the output information is copied from the fixed image.

Reimplemented from itk::ProcessObject.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual const unsigned int& itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetCurrentLevel ( ) const

virtual

Get the current resolution level being processed.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

const DisplacementFieldType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetDisplacementField ( )

inline

Get output deformation field.

Definition at line 170 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual const FieldExpanderType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetFieldExpander ( ) const

virtual

Get/Set the moving image pyramid.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

const FixedImageType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetFixedImage

(

)

const

Get the fixed image.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual const FixedImagePyramidType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetFixedImagePyramid ( ) const

virtual

Get/Set the fixed image pyramid.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual FieldExpanderType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetModifiableFieldExpander ( )

virtual

Get/Set the moving image pyramid.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual FixedImagePyramidType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetModifiableFixedImagePyramid ( )

virtual

Get/Set the fixed image pyramid.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual MovingImagePyramidType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetModifiableMovingImagePyramid ( )

virtual

Get/Set the moving image pyramid.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual RegistrationType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetModifiableRegistrationFilter ( )

virtual

Get/Set the internal registrator.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

const MovingImageType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetMovingImage

(

)

const

Get the moving image.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual const MovingImagePyramidType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetMovingImagePyramid ( ) const

virtual

Get/Set the moving image pyramid.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual const char* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual const NumberOfIterationsType& itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetNumberOfIterations ( ) const

virtual

Get number of iterations per multi-resolution levels.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual const unsigned int& itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetNumberOfLevels ( ) const

virtual

Get number of multi-resolution levels.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

std::vector< SmartPointer< DataObject > >::size_type itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetNumberOfValidRequiredInputs ( ) const

overridevirtual

Get the number of valid inputs. For MultiResolutionPDEDeformableRegistration, this checks whether the fixed and moving images have been set. While MultiResolutionPDEDeformableRegistration can take a third input as an initial deformation field, this input is not a required input.

Reimplemented from itk::ProcessObject.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual const RegistrationType* itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::GetRegistrationFilter ( ) const

virtual

Get/Set the internal registrator.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual bool itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::Halt ( )

protectedvirtual

This method returns true to indicate that the registration should terminate at the current resolution level.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

static Pointer itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::New ( )

static

Method for creation through the object factory.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::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.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetArbitraryInitialDisplacementField ( DisplacementFieldType *  ptr )

inlinevirtual

Set initial deformation field. No assumption is made on the input. It will therefore be smoothed and resampled to match the images characteristics at the coarsest level of the pyramid.

Definition at line 164 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetFieldExpander ( FieldExpanderType *  _arg )

virtual

Get/Set the moving image pyramid.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetFixedImage ( const FixedImageType *  ptr )

virtual

Set the fixed image.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetFixedImagePyramid ( FixedImagePyramidType *  _arg )

virtual

Get/Set the fixed image pyramid.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetInitialDisplacementField ( DisplacementFieldType *  ptr )

inlinevirtual

Set initial deformation field to be used as is (no smoothing, no subsampling at the coarsest level of the pyramid.

Definition at line 156 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetMovingImage ( const MovingImageType *  ptr )

virtual

Set the moving image.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetMovingImagePyramid ( MovingImagePyramidType *  _arg )

virtual

Get/Set the moving image pyramid.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetNumberOfIterations ( NumberOfIterationsType  _arg )

virtual

Set number of iterations per multi-resolution levels.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetNumberOfIterations ( unsigned int  data[] )

virtual

Set number of iterations per multi-resolution levels.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetNumberOfLevels ( unsigned int  num )

virtual

Set number of multi-resolution levels.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::SetRegistrationFilter ( RegistrationType *  _arg )

virtual

Get/Set the internal registrator.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

virtual void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::StopRegistration ( )

virtual

Stop the registration after the current iteration.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

void itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::VerifyInputInformation ( )

inlineoverrideprotectedvirtual

Override VeriyInputInformation() since this filter's inputs do not need to occoupy the same physical space.

See Also

ProcessObject::VerifyInputInformation

Reimplemented from itk::ProcessObject.

Definition at line 258 of file itkMultiResolutionPDEDeformableRegistration.h.

Member Data Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

constexpr unsigned int itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::ImageDimension = FixedImageType::ImageDimension

static

ImageDimension.

Definition at line 116 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

unsigned int itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::m_CurrentLevel

private

Definition at line 268 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

FieldExpanderPointer itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::m_FieldExpander

private

Definition at line 264 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

FixedImagePyramidPointer itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::m_FixedImagePyramid

private

Definition at line 262 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

DisplacementFieldPointer itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::m_InitialDisplacementField

private

Definition at line 265 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

MovingImagePyramidPointer itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::m_MovingImagePyramid

private

Definition at line 263 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

NumberOfIterationsType itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::m_NumberOfIterations

private

Definition at line 269 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

unsigned int itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::m_NumberOfLevels

private

Definition at line 267 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

RegistrationPointer itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::m_RegistrationFilter

private

Definition at line 261 of file itkMultiResolutionPDEDeformableRegistration.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField , typename TRealType = float>

bool itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType >::m_StopRegistrationFlag

private

Flag to indicate user stop registration request.

Definition at line 272 of file itkMultiResolutionPDEDeformableRegistration.h.

---

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

• itkMultiResolutionPDEDeformableRegistration.h