#include <itkESMDemonsRegistrationFunction.h>

Inheritance diagram for itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >:

Collaboration diagram for itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >:

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >

Fast implementation of the symmetric demons registration force.

This class provides a substantially faster implementation of the symmetric demons registration force. Speed is improved by keeping a deformed copy of the moving image for gradient evaluation.

Symmetric forces simply means using the mean of the gradient of the fixed image and the gradient of the warped moving image.

Note that this class also enables the use of fixed, mapped moving and warped moving images forces by using a call to SetUseGradientType

The moving image should not be saturated. We indeed use NumericTraits<MovingPixelType>::Max() as a special value.

Author: Tom Vercauteren, INRIA & Mauna Kea Technologies

This implementation was taken from the Insight Journal paper: https://hdl.handle.net/1926/510

See Also: SymmetricForcesDemonsRegistrationFunction; SymmetricForcesDemonsRegistrationFilter; DemonsRegistrationFilter; DemonsRegistrationFunction

Definition at line 61 of file itkESMDemonsRegistrationFunction.h.

Classes
struct	GlobalDataStruct

Public Types
using	ConstPointer = SmartPointer< const Self >

using	CoordRepType = double

using	CovariantVectorType = CovariantVector< double, Self::ImageDimension >

using	DefaultInterpolatorType = LinearInterpolateImageFunction< MovingImageType, CoordRepType >

using	DirectionType = typename FixedImageType::DirectionType

using	DisplacementFieldType = typename Superclass::DisplacementFieldType

using	DisplacementFieldTypePointer = typename Superclass::DisplacementFieldTypePointer

using	FixedImagePointer = typename Superclass::FixedImagePointer

using	FixedImageType = typename Superclass::FixedImageType

using	FloatOffsetType = typename Superclass::FloatOffsetType

using	GradientCalculatorPointer = typename GradientCalculatorType::Pointer

using	GradientCalculatorType = CentralDifferenceImageFunction< FixedImageType >

enum	GradientType { Symmetric = 0, Fixed = 1, WarpedMoving = 2, MappedMoving = 3 }

using	IndexType = typename FixedImageType::IndexType

using	InterpolatorPointer = typename InterpolatorType::Pointer

using	InterpolatorType = InterpolateImageFunction< MovingImageType, CoordRepType >

using	MovingImageGradientCalculatorPointer = typename MovingImageGradientCalculatorType::Pointer

using	MovingImageGradientCalculatorType = CentralDifferenceImageFunction< MovingImageType, CoordRepType >

using	MovingImagePointer = typename Superclass::MovingImagePointer

using	MovingImageType = typename Superclass::MovingImageType

using	MovingPixelType = typename MovingImageType::PixelType

using	NeighborhoodType = typename Superclass::NeighborhoodType

using	PixelType = typename Superclass::PixelType

using	Pointer = SmartPointer< Self >

using	PointType = typename InterpolatorType::PointType

using	RadiusType = typename Superclass::RadiusType

using	Self = ESMDemonsRegistrationFunction

using	SizeType = typename FixedImageType::SizeType

using	SpacingType = typename FixedImageType::SpacingType

using	Superclass = PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >

using	TimeStepType = typename Superclass::TimeStepType

using	WarperPointer = typename WarperType::Pointer

using	WarperType = WarpImageFilter< MovingImageType, MovingImageType, DisplacementFieldType >

Public Types inherited from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
using	ConstPointer = SmartPointer< const Self >

using	DisplacementFieldType = TDisplacementField

using	DisplacementFieldTypePointer = typename DisplacementFieldType::Pointer

using	FixedImagePointer = typename FixedImageType::ConstPointer

using	FixedImageType = TFixedImage

using	MovingImagePointer = typename MovingImageType::ConstPointer

using	MovingImageType = TMovingImage

using	Pointer = SmartPointer< Self >

using	Self = PDEDeformableRegistrationFunction

using	Superclass = FiniteDifferenceFunction< TDisplacementField >

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

using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< ImageType >

using	FloatOffsetType = Vector< float, Self::ImageDimension >

using	ImageType = TDisplacementField

using	NeighborhoodScalesType = Vector< PixelRealType, Self::ImageDimension >

using	NeighborhoodType = ConstNeighborhoodIterator< TDisplacementField, DefaultBoundaryConditionType >

using	PixelRealType = double

using	PixelType = typename ImageType::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename ConstNeighborhoodIterator< TDisplacementField >::RadiusType

using	Self = FiniteDifferenceFunction

using	Superclass = LightObject

using	TimeStepType = double

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
TimeStepType	ComputeGlobalTimeStep (void *) const override

PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override

virtual ::itk::LightObject::Pointer	CreateAnother () const

void *	GetGlobalDataPointer () const override

virtual double	GetIntensityDifferenceThreshold () const

virtual double	GetMaximumUpdateStepLength () const

virtual double	GetMetric () const

InterpolatorType *	GetMovingImageInterpolator ()

virtual const char *	GetNameOfClass () const

virtual const double &	GetRMSChange () const

void	InitializeIteration () override

void	ReleaseGlobalDataPointer (void *GlobalData) const override

virtual void	SetIntensityDifferenceThreshold (double)

virtual void	SetMaximumUpdateStepLength (double sm)

void	SetMovingImageInterpolator (InterpolatorType *ptr)


virtual void	SetUseGradientType (GradientType gtype)

virtual GradientType	GetUseGradientType () const

Public Member Functions inherited from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
DisplacementFieldType *	GetDisplacementField ()

double	GetEnergy () const

const FixedImageType *	GetFixedImage () const

double	GetGradientStep () const

const MovingImageType *	GetMovingImage () const

bool	GetNormalizeGradient () const

void	SetDisplacementField (DisplacementFieldTypePointer ptr)

void	SetEnergy (double e)

void	SetFixedImage (const FixedImageType *ptr)

void	SetGradientStep (double e)

void	SetMovingImage (const MovingImageType *ptr)

void	SetNormalizeGradient (bool e)

Public Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
const NeighborhoodScalesType	ComputeNeighborhoodScales () const

virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))=0

const RadiusType &	GetRadius () const

void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const

void	SetRadius (const RadiusType &r)

void	SetScaleCoefficients (PixelRealType vals[ImageDimension])

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

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::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField >
static constexpr unsigned int	ImageDimension

Protected Types
using	FixedImageNeighborhoodIteratorType = ConstNeighborhoodIterator< FixedImageType >

Protected Member Functions
	ESMDemonsRegistrationFunction ()

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

	~ESMDemonsRegistrationFunction () override=default

Protected Member Functions inherited from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
	PDEDeformableRegistrationFunction ()

	~PDEDeformableRegistrationFunction () override=default

Protected Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
	FiniteDifferenceFunction ()

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

	~FiniteDifferenceFunction () override=default

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

Additional Inherited Members
Protected Attributes inherited from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
DisplacementFieldTypePointer	m_DisplacementField

double	m_Energy

FixedImagePointer	m_FixedImage

double	m_GradientStep

MovingImagePointer	m_MovingImage

bool	m_NormalizeGradient

Protected Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField >
RadiusType	m_Radius

PixelRealType	m_ScaleCoefficients [ImageDimension]

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