#include <itkSymmetricForcesDemonsRegistrationFunction.h>

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

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

Detailed Description

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

This class encapsulate the PDE which drives the demons registration algorithm (formula (5) in J.-P. Thirions's paper "Fast Non-Rigid Matching of 3D Medical Images", May 1995). It is used by SymmetricForcesDemonsRegistrationFilter to compute the output displacement field which will map a moving image onto a a fixed image.

This class was contributed by Corinne Mattmann, ETH Zurich, Switzerland. based on a variation of the DemonsRegistrationFunction. The basic modification is to use equation (5) from Thirion's paper along with the modification for avoiding large displacements when gradients have small values.

Non-integer moving image values are obtained by using interpolation. The default interpolator is of type LinearInterpolateImageFunction. The user may set other interpolators via method SetMovingImageInterpolator. Note that the input interpolator must derive from baseclass InterpolateImageFunction.

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

Warning: This filter assumes that the fixed image type, moving image type and displacement field type all have the same number of dimensions.

See Also: SymmetricForcesDemonsRegistrationFilter; DemonsRegistrationFilter; DemonsRegistrationFunction

Definition at line 62 of file itkSymmetricForcesDemonsRegistrationFunction.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	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 >

using	IndexType = typename FixedImageType::IndexType

using	InterpolatorPointer = typename InterpolatorType::Pointer

using	InterpolatorType = InterpolateImageFunction< MovingImageType, CoordRepType >

using	MovingImagePointer = typename Superclass::MovingImagePointer

using	MovingImageType = typename Superclass::MovingImageType

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 = SymmetricForcesDemonsRegistrationFunction

using	SizeType = typename FixedImageType::SizeType

using	SpacingType = typename FixedImageType::SpacingType

using	Superclass = PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >

using	TimeStepType = typename Superclass::TimeStepType

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

void	SetMovingImageInterpolator (InterpolatorType *ptr)

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

	SymmetricForcesDemonsRegistrationFunction ()

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

Private Attributes
double	m_DenominatorThreshold

GradientCalculatorPointer	m_FixedImageGradientCalculator

PointType	m_FixedImageOrigin

SpacingType	m_FixedImageSpacing

double	m_IntensityDifferenceThreshold

double	m_Metric

std::mutex	m_MetricCalculationLock

InterpolatorPointer	m_MovingImageInterpolator

double	m_Normalizer

SizeValueType	m_NumberOfPixelsProcessed

double	m_RMSChange

double	m_SumOfSquaredChange

double	m_SumOfSquaredDifference

TimeStepType	m_TimeStep

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