itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > Class Template Reference

#include <itkESMDemonsRegistrationFunction.h>

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 WarpedMoving and MappedMoving gradients coincide wherever the displacement field is zero.

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://doi.org/10.54294/ux2obj

See also

SymmetricForcesDemonsRegistrationFunction

SymmetricForcesDemonsRegistrationFilter

DemonsRegistrationFilter

DemonsRegistrationFunction

Definition at line 86 of file itkESMDemonsRegistrationFunction.h.

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

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

Classes
struct	GlobalDataStruct

Public Types
using	ConstPointer = SmartPointer<const Self>
using	CoordinateType = double
using	CovariantVectorType = CovariantVector<double, Self::ImageDimension>
using	DefaultInterpolatorType = LinearInterpolateImageFunction<MovingImageType, CoordinateType>
using	DirectionType = typename FixedImageType::DirectionType
using	DisplacementFieldType
using	DisplacementFieldTypePointer
using	FixedImagePointer
using	FixedImageType
using	GradientCalculatorPointer = typename GradientCalculatorType::Pointer
using	GradientCalculatorType = CentralDifferenceImageFunction<FixedImageType>
using	GradientEnum = ESMDemonsRegistrationFunctionEnums::Gradient
using	IndexType = typename FixedImageType::IndexType
using	InterpolatorPointer = typename InterpolatorType::Pointer
using	InterpolatorType = InterpolateImageFunction<MovingImageType, CoordinateType>
using	MovingImageGradientCalculatorPointer = typename MovingImageGradientCalculatorType::Pointer
using	MovingImageGradientCalculatorType = CentralDifferenceImageFunction<MovingImageType, CoordinateType>
using	MovingImagePointer
using	MovingImageType
using	MovingPixelType = typename MovingImageType::PixelType
using	Pointer = SmartPointer<Self>
using	PointType = typename InterpolatorType::PointType
using	Self = ESMDemonsRegistrationFunction
using	SizeType = typename FixedImageType::SizeType
using	SpacingType = typename FixedImageType::SpacingType
using	Superclass = PDEDeformableRegistrationFunction<TFixedImage, TMovingImage, TDisplacementField>
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
using	DefaultBoundaryConditionType
using	FloatOffsetType
using	ImageType
using	NeighborhoodScalesType
using	NeighborhoodType
using	PixelRealType
using	PixelType
using	Pointer
using	RadiusType
using	Self
using	Superclass
using	TimeStepType
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>
using	Pointer = SmartPointer<Self>
using	Self = LightObject

Public Member Functions
TimeStepType	ComputeGlobalTimeStep (void *GlobalData) const override
PixelType	ComputeUpdate (const NeighborhoodType &it, void *gd, 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 *gd) const override
virtual void	SetIntensityDifferenceThreshold (double)
virtual void	SetMaximumUpdateStepLength (double sm)
void	SetMovingImageInterpolator (InterpolatorType *ptr)
virtual void	SetUseGradientType (GradientEnum gtype)
virtual GradientEnum	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
const NeighborhoodScalesType	ComputeNeighborhoodScales () const
const RadiusType &	GetRadius () const
const RadiusType &	GetRadius () const
void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
void	SetRadius (const RadiusType &r)
void	SetRadius (const RadiusType &r)
void	SetScaleCoefficients (const PixelRealType vals[ImageDimension])
void	SetScaleCoefficients (const PixelRealType vals[ImageDimension])
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual void	Delete ()
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::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
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 ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~PDEDeformableRegistrationFunction () override=default
Protected Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
	FiniteDifferenceFunction ()
	FiniteDifferenceFunction ()
	~FiniteDifferenceFunction () override=default
	~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 {}
DirectionType	m_FixedImageDirection {}
GradientCalculatorPointer	m_FixedImageGradientCalculator {}
PointType	m_FixedImageOrigin {}
SpacingType	m_FixedImageSpacing {}
double	m_IntensityDifferenceThreshold {}
MovingImageGradientCalculatorPointer	m_MappedMovingImageGradientCalculator {}
double	m_MaximumUpdateStepLength {}
double	m_Metric {}
std::mutex	m_MetricCalculationMutex {}
InterpolatorPointer	m_MovingImageInterpolator {}
WarperPointer	m_MovingImageWarper {}
MovingImageType *	m_MovingImageWarperOutput {}
double	m_Normalizer {}
SizeValueType	m_NumberOfPixelsProcessed {}
double	m_RMSChange {}
double	m_SumOfSquaredChange {}
double	m_SumOfSquaredDifference {}
TimeStepType	m_TimeStep {}
GradientEnum	m_UseGradientType {}

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
RadiusType	m_Radius
PixelRealType	m_ScaleCoefficients [ImageDimension]
PixelRealType	m_ScaleCoefficients [ImageDimension]
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

ConstPointer

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

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

Definition at line 97 of file itkESMDemonsRegistrationFunction.h.

CoordinateType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::CoordinateType = double

Interpolator type.

Definition at line 133 of file itkESMDemonsRegistrationFunction.h.

CovariantVectorType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::CovariantVectorType = CovariantVector<double, Self::ImageDimension>

Covariant vector type.

Definition at line 149 of file itkESMDemonsRegistrationFunction.h.

DefaultInterpolatorType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DefaultInterpolatorType = LinearInterpolateImageFunction<MovingImageType, CoordinateType>

Definition at line 141 of file itkESMDemonsRegistrationFunction.h.

DirectionType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DirectionType = typename FixedImageType::DirectionType

Definition at line 116 of file itkESMDemonsRegistrationFunction.h.

DisplacementFieldType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType

Deformation field type.

Definition at line 64 of file itkPDEDeformableRegistrationFunction.h.

DisplacementFieldTypePointer

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldTypePointer

Definition at line 65 of file itkPDEDeformableRegistrationFunction.h.

FixedImageNeighborhoodIteratorType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImageNeighborhoodIteratorType = ConstNeighborhoodIterator<FixedImageType>

protected

FixedImage image neighborhood iterator type.

Definition at line 278 of file itkESMDemonsRegistrationFunction.h.

FixedImagePointer

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer

Definition at line 61 of file itkPDEDeformableRegistrationFunction.h.

FixedImageType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType

FixedImage image type.

Definition at line 60 of file itkPDEDeformableRegistrationFunction.h.

GradientCalculatorPointer

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientCalculatorPointer = typename GradientCalculatorType::Pointer

Definition at line 153 of file itkESMDemonsRegistrationFunction.h.

GradientCalculatorType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientCalculatorType = CentralDifferenceImageFunction<FixedImageType>

Fixed image gradient calculator type.

Definition at line 152 of file itkESMDemonsRegistrationFunction.h.

GradientEnum

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientEnum = ESMDemonsRegistrationFunctionEnums::Gradient

Definition at line 248 of file itkESMDemonsRegistrationFunction.h.

IndexType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::IndexType = typename FixedImageType::IndexType

Definition at line 113 of file itkESMDemonsRegistrationFunction.h.

InterpolatorPointer

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

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

Definition at line 139 of file itkESMDemonsRegistrationFunction.h.

InterpolatorType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InterpolatorType = InterpolateImageFunction<MovingImageType, CoordinateType>

Definition at line 138 of file itkESMDemonsRegistrationFunction.h.

MovingImageGradientCalculatorPointer

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageGradientCalculatorPointer = typename MovingImageGradientCalculatorType::Pointer

Definition at line 157 of file itkESMDemonsRegistrationFunction.h.

MovingImageGradientCalculatorType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageGradientCalculatorType = CentralDifferenceImageFunction<MovingImageType, CoordinateType>

Moving image gradient (unwarped) calculator type.

Definition at line 156 of file itkESMDemonsRegistrationFunction.h.

MovingImagePointer

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer

Definition at line 57 of file itkPDEDeformableRegistrationFunction.h.

MovingImageType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType

MovingImage image type.

Definition at line 56 of file itkPDEDeformableRegistrationFunction.h.

MovingPixelType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingPixelType = typename MovingImageType::PixelType

Definition at line 108 of file itkESMDemonsRegistrationFunction.h.

Pointer

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

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

Definition at line 96 of file itkESMDemonsRegistrationFunction.h.

PointType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PointType = typename InterpolatorType::PointType

Definition at line 140 of file itkESMDemonsRegistrationFunction.h.

Self

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Self = ESMDemonsRegistrationFunction

Standard class type aliases.

Definition at line 93 of file itkESMDemonsRegistrationFunction.h.

SizeType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SizeType = typename FixedImageType::SizeType

Definition at line 114 of file itkESMDemonsRegistrationFunction.h.

SpacingType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SpacingType = typename FixedImageType::SpacingType

Definition at line 115 of file itkESMDemonsRegistrationFunction.h.

Superclass

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Superclass = PDEDeformableRegistrationFunction<TFixedImage, TMovingImage, TDisplacementField>

Definition at line 94 of file itkESMDemonsRegistrationFunction.h.

WarperPointer

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::WarperPointer = typename WarperType::Pointer

Definition at line 146 of file itkESMDemonsRegistrationFunction.h.

WarperType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

using itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::WarperType = WarpImageFilter<MovingImageType, MovingImageType, DisplacementFieldType>

Warper type

Definition at line 144 of file itkESMDemonsRegistrationFunction.h.

Constructor & Destructor Documentation

ESMDemonsRegistrationFunction()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ESMDemonsRegistrationFunction ( )

protected

~ESMDemonsRegistrationFunction()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::~ESMDemonsRegistrationFunction ( )

overrideprotecteddefault

Member Function Documentation

ComputeGlobalTimeStep()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

TimeStepType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeGlobalTimeStep ( void * GlobalData ) const

inlineoverridevirtual

This class uses a constant timestep of 1.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

Definition at line 176 of file itkESMDemonsRegistrationFunction.h.

ComputeUpdate()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

PixelType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeUpdate ( const NeighborhoodType & it, void * gd, const FloatOffsetType & offset = FloatOffsetType(0.0) )

overridevirtual

Compute update at a non-boundary neighbourhood. Called by a finite difference solver image filter at each pixel that does not lie on a data set boundary.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

CreateAnother()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

virtual::itk::LightObject::Pointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::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::LightObject.

GetGlobalDataPointer()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

void * itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetGlobalDataPointer ( ) const

inlineoverridevirtual

Return a pointer to a global data structure that is passed to this object from the solver at each calculation.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

Definition at line 184 of file itkESMDemonsRegistrationFunction.h.

GetIntensityDifferenceThreshold()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

virtual double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetIntensityDifferenceThreshold ( ) const

virtual

GetMaximumUpdateStepLength()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

virtual double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMaximumUpdateStepLength ( ) const

inlinevirtual

Definition at line 243 of file itkESMDemonsRegistrationFunction.h.

GetMetric()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

virtual double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMetric ( ) const

inlinevirtual

Get the metric value. The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the overlapping region between the two images.

Definition at line 211 of file itkESMDemonsRegistrationFunction.h.

GetMovingImageInterpolator()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

InterpolatorType * itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMovingImageInterpolator ( )

inline

Get the moving image interpolator.

Definition at line 169 of file itkESMDemonsRegistrationFunction.h.

GetNameOfClass()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

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

virtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.

GetRMSChange()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

virtual const double & itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetRMSChange ( ) const

inlinevirtual

Get the rms change in deformation field.

Definition at line 218 of file itkESMDemonsRegistrationFunction.h.

GetUseGradientType()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

virtual GradientEnum itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetUseGradientType ( ) const

inlinevirtual

Set/Get the type of used image forces

Definition at line 265 of file itkESMDemonsRegistrationFunction.h.

InitializeIteration()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

void itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InitializeIteration ( )

overridevirtual

Set the object's state before each iteration.

Reimplemented from itk::FiniteDifferenceFunction< TDisplacementField >.

New()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

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

static

Method for creation through the object factory.

PrintSelf()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

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

ReleaseGlobalDataPointer()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

void itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ReleaseGlobalDataPointer ( void * gd ) const

overridevirtual

Update the metric and release memory for the per-thread-global data structure.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

SetIntensityDifferenceThreshold()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

virtual void itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetIntensityDifferenceThreshold ( double )

virtual

Set/Get the threshold below which the absolute difference of intensity yields a match. When the intensities match between a moving and fixed image pixel, the update vector (for that iteration) will be the zero vector. Default is 0.001.

SetMaximumUpdateStepLength()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

virtual void itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMaximumUpdateStepLength ( double sm )

inlinevirtual

Set/Get the maximum update step length. In Thirion this is 0.5. Setting it to 0 implies no restriction (beware of numerical instability in this case.

Definition at line 237 of file itkESMDemonsRegistrationFunction.h.

SetMovingImageInterpolator()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

void itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImageInterpolator ( InterpolatorType * ptr )

inline

Set the moving image interpolator.

Definition at line 161 of file itkESMDemonsRegistrationFunction.h.

SetUseGradientType()

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

virtual void itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetUseGradientType ( GradientEnum gtype )

inlinevirtual

Set/Get the type of used image forces

Definition at line 260 of file itkESMDemonsRegistrationFunction.h.

Member Data Documentation

ImageDimension

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

unsigned int itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Inherit some enums from the superclass.

Definition at line 123 of file itkESMDemonsRegistrationFunction.h.

m_DenominatorThreshold

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_DenominatorThreshold {}

private

Threshold below which the denominator term is considered zero.

Definition at line 316 of file itkESMDemonsRegistrationFunction.h.

m_FixedImageDirection

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

DirectionType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImageDirection {}

private

Definition at line 293 of file itkESMDemonsRegistrationFunction.h.

m_FixedImageGradientCalculator

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

GradientCalculatorPointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImageGradientCalculator {}

private

Function to compute derivatives of the fixed image.

Definition at line 297 of file itkESMDemonsRegistrationFunction.h.

m_FixedImageOrigin

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

PointType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImageOrigin {}

private

Cache fixed image information.

Definition at line 291 of file itkESMDemonsRegistrationFunction.h.

m_FixedImageSpacing

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

SpacingType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImageSpacing {}

private

Definition at line 292 of file itkESMDemonsRegistrationFunction.h.

m_IntensityDifferenceThreshold

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_IntensityDifferenceThreshold {}

private

Threshold below which two intensity value are assumed to match.

Definition at line 319 of file itkESMDemonsRegistrationFunction.h.

m_MappedMovingImageGradientCalculator

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

MovingImageGradientCalculatorPointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MappedMovingImageGradientCalculator {}

private

Function to compute derivatives of the moving image (unwarped).

Definition at line 300 of file itkESMDemonsRegistrationFunction.h.

m_MaximumUpdateStepLength

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MaximumUpdateStepLength {}

private

Maximum update step length in pixels (default is 0.5 as in Thirion).

Definition at line 322 of file itkESMDemonsRegistrationFunction.h.

m_Metric

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Metric {}

mutableprivate

The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the the overlapping region between the two images.

Definition at line 327 of file itkESMDemonsRegistrationFunction.h.

m_MetricCalculationMutex

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

std::mutex itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MetricCalculationMutex {}

mutableprivate

Mutex lock to protect modification to metric.

Definition at line 334 of file itkESMDemonsRegistrationFunction.h.

m_MovingImageInterpolator

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

InterpolatorPointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageInterpolator {}

private

Function to interpolate the moving image.

Definition at line 305 of file itkESMDemonsRegistrationFunction.h.

m_MovingImageWarper

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

WarperPointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageWarper {}

private

Filter to warp moving image for fast gradient computation.

Definition at line 308 of file itkESMDemonsRegistrationFunction.h.

m_MovingImageWarperOutput

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

MovingImageType* itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageWarperOutput {}

private

Definition at line 310 of file itkESMDemonsRegistrationFunction.h.

m_Normalizer

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Normalizer {}

private

Definition at line 294 of file itkESMDemonsRegistrationFunction.h.

m_NumberOfPixelsProcessed

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

SizeValueType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_NumberOfPixelsProcessed {}

mutableprivate

Definition at line 329 of file itkESMDemonsRegistrationFunction.h.

m_RMSChange

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_RMSChange {}

mutableprivate

Definition at line 330 of file itkESMDemonsRegistrationFunction.h.

m_SumOfSquaredChange

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_SumOfSquaredChange {}

mutableprivate

Definition at line 331 of file itkESMDemonsRegistrationFunction.h.

m_SumOfSquaredDifference

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_SumOfSquaredDifference {}

mutableprivate

Definition at line 328 of file itkESMDemonsRegistrationFunction.h.

m_TimeStep

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

TimeStepType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_TimeStep {}

private

The global timestep.

Definition at line 313 of file itkESMDemonsRegistrationFunction.h.

m_UseGradientType

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>

GradientEnum itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_UseGradientType {}

private

Definition at line 302 of file itkESMDemonsRegistrationFunction.h.

---

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

• itkESMDemonsRegistrationFunction.h