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

#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: http://hdl.handle.net/1926/510

See Also

SymmetricForcesDemonsRegistrationFunction

SymmetricForcesDemonsRegistrationFilter

DemonsRegistrationFilter

DemonsRegistrationFunction

Definition at line 60 of file itkESMDemonsRegistrationFunction.h.

Classes
struct	GlobalDataStruct

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef double	CoordRepType
typedef CovariantVector < double, itkGetStaticConstMacro(ImageDimension) >	CovariantVectorType
typedef LinearInterpolateImageFunction < MovingImageType, CoordRepType >	DefaultInterpolatorType
typedef FixedImageType::DirectionType	DirectionType
typedef Superclass::DisplacementFieldType	DisplacementFieldType
typedef Superclass::DisplacementFieldTypePointer	DisplacementFieldTypePointer
typedef Superclass::FixedImagePointer	FixedImagePointer
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::FloatOffsetType	FloatOffsetType
typedef GradientCalculatorType::Pointer	GradientCalculatorPointer
typedef CentralDifferenceImageFunction < FixedImageType >	GradientCalculatorType
enum	GradientType {   Symmetric = 0,   Fixed = 1,   WarpedMoving = 2,   MappedMoving = 3 }
typedef FixedImageType::IndexType	IndexType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef InterpolateImageFunction < MovingImageType, CoordRepType >	InterpolatorType
typedef MovingImageGradientCalculatorType::Pointer	MovingImageGradientCalculatorPointer
typedef CentralDifferenceImageFunction < MovingImageType, CoordRepType >	MovingImageGradientCalculatorType
typedef Superclass::MovingImagePointer	MovingImagePointer
typedef Superclass::MovingImageType	MovingImageType
typedef MovingImageType::PixelType	MovingPixelType
typedef Superclass::NeighborhoodType	NeighborhoodType
typedef Superclass::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef InterpolatorType::PointType	PointType
typedef Superclass::RadiusType	RadiusType
typedef ESMDemonsRegistrationFunction	Self
typedef FixedImageType::SizeType	SizeType
typedef FixedImageType::SpacingType	SpacingType
typedef PDEDeformableRegistrationFunction < TFixedImage, TMovingImage, TDisplacementField >	Superclass
typedef Superclass::TimeStepType	TimeStepType
typedef WarperType::Pointer	WarperPointer
typedef WarpImageFilter < MovingImageType, MovingImageType, DisplacementFieldType >	WarperType
Public Types inherited from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
typedef SmartPointer< const Self >	ConstPointer
typedef TDisplacementField	DisplacementFieldType
typedef DisplacementFieldType::Pointer	DisplacementFieldTypePointer
typedef FixedImageType::ConstPointer	FixedImagePointer
typedef TFixedImage	FixedImageType
typedef MovingImageType::ConstPointer	MovingImagePointer
typedef TMovingImage	MovingImageType
typedef SmartPointer< Self >	Pointer
typedef PDEDeformableRegistrationFunction	Self
typedef FiniteDifferenceFunction < TDisplacementField >	Superclass
Public Types inherited from itk::FiniteDifferenceFunction< TDisplacementField >
typedef SmartPointer< const Self >	ConstPointer
typedef ZeroFluxNeumannBoundaryCondition < ImageType >	DefaultBoundaryConditionType
typedef Vector< float, itkGetStaticConstMacro(ImageDimension) >	FloatOffsetType
typedef TDisplacementField	ImageType
typedef Vector< PixelRealType, itkGetStaticConstMacro(ImageDimension) >	NeighborhoodScalesType
typedef ConstNeighborhoodIterator < TDisplacementField, DefaultBoundaryConditionType >	NeighborhoodType
typedef double	PixelRealType
typedef ImageType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef ConstNeighborhoodIterator < TDisplacementField > ::RadiusType	RadiusType
typedef FiniteDifferenceFunction	Self
typedef LightObject	Superclass
typedef double	TimeStepType
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual TimeStepType	ComputeGlobalTimeStep (void *) const override
virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual void *	GetGlobalDataPointer () const override
virtual double	GetIntensityDifferenceThreshold () const
virtual double	GetMaximumUpdateStepLength () const
virtual double	GetMetric () const
InterpolatorType *	GetMovingImageInterpolator (void)
virtual const char *	GetNameOfClass () const
virtual const double &	GetRMSChange () const
virtual void	InitializeIteration () override
virtual 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 (void)
double	GetEnergy () const
const FixedImageType *	GetFixedImage (void) const
double	GetGradientStep () const
const MovingImageType *	GetMovingImage (void) 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 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 const unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField >
static const unsigned int	ImageDimension

Protected Types
typedef ConstNeighborhoodIterator < FixedImageType >	FixedImageNeighborhoodIteratorType

Protected Member Functions
	ESMDemonsRegistrationFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ESMDemonsRegistrationFunction ()
Protected Member Functions inherited from itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
	PDEDeformableRegistrationFunction ()
	~PDEDeformableRegistrationFunction ()
Protected Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
	FiniteDifferenceFunction ()
	~FiniteDifferenceFunction ()
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 Member Functions
	ESMDemonsRegistrationFunction (const Self &) ITK_DELETE_FUNCTION
void	operator= (const Self &) ITK_DELETE_FUNCTION

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
SimpleFastMutexLock	m_MetricCalculationLock
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
GradientType	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
PixelRealType	m_ScaleCoefficients [ImageDimension]
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 72 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef double itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::CoordRepType

Interpolator type.

Definition at line 110 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef CovariantVector< double, itkGetStaticConstMacro(ImageDimension) > itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::CovariantVectorType

Covariant vector type.

Definition at line 126 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef LinearInterpolateImageFunction< MovingImageType, CoordRepType > itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DefaultInterpolatorType

Definition at line 116 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef FixedImageType::DirectionType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DirectionType

Definition at line 92 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::DisplacementFieldType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType

Deformation field type.

Definition at line 95 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::DisplacementFieldTypePointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldTypePointer

Definition at line 97 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

protected

FixedImage image neighborhood iterator type.

Definition at line 226 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::FixedImagePointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer

Definition at line 88 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::FixedImageType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType

FixedImage image type.

Definition at line 87 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::FloatOffsetType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FloatOffsetType

Definition at line 106 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef GradientCalculatorType::Pointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientCalculatorPointer

Definition at line 130 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Fixed image gradient calculator type.

Definition at line 129 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef FixedImageType::IndexType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::IndexType

Definition at line 89 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef InterpolatorType::Pointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InterpolatorPointer

Definition at line 113 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef InterpolateImageFunction< MovingImageType, CoordRepType > itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InterpolatorType

Definition at line 112 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef MovingImageGradientCalculatorType::Pointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageGradientCalculatorPointer

Definition at line 136 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef CentralDifferenceImageFunction< MovingImageType, CoordRepType > itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageGradientCalculatorType

Moving image gradient (unwarped) calculator type.

Definition at line 134 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::MovingImagePointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer

Definition at line 83 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::MovingImageType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType

MovingImage image type.

Definition at line 79 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef MovingImageType::PixelType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingPixelType

Definition at line 84 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::NeighborhoodType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::NeighborhoodType

Definition at line 105 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::PixelType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PixelType

Inherit some enums from the superclass.

Definition at line 103 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 71 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef InterpolatorType::PointType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PointType

Definition at line 114 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::RadiusType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::RadiusType

Definition at line 104 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef ESMDemonsRegistrationFunction itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Self

Standard class typedefs.

Definition at line 67 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef FixedImageType::SizeType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SizeType

Definition at line 90 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef FixedImageType::SpacingType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SpacingType

Definition at line 91 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Superclass

Definition at line 69 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef Superclass::TimeStepType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::TimeStepType

Definition at line 107 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef WarperType::Pointer itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::WarperPointer

Definition at line 123 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Warper type

Definition at line 121 of file itkESMDemonsRegistrationFunction.h.

Member Enumeration Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

enum itk::ESMDemonsRegistrationFunction::GradientType

Type of available image forces

Enumerator
Symmetric
Fixed
WarpedMoving
MappedMoving

Definition at line 206 of file itkESMDemonsRegistrationFunction.h.

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

protected

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlineprotected

Definition at line 222 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ESMDemonsRegistrationFunction ( const Self &  )

private

Member Function Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlineoverridevirtual

This class uses a constant timestep of 1.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

Definition at line 147 of file itkESMDemonsRegistrationFunction.h.

References itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_TimeStep.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

overridevirtual

This method is called by a finite difference solver image filter at each pixel that does not lie on a data set boundary

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

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.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual 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 152 of file itkESMDemonsRegistrationFunction.h.

References itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GlobalDataStruct::m_NumberOfPixelsProcessed, itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GlobalDataStruct::m_SumOfSquaredChange, and itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GlobalDataStruct::m_SumOfSquaredDifference.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

virtual

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlinevirtual

Definition at line 200 of file itkESMDemonsRegistrationFunction.h.

References itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MaximumUpdateStepLength.

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 the overlapping region between the two images.

Definition at line 177 of file itkESMDemonsRegistrationFunction.h.

References itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Metric.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inline

Get the moving image interpolator.

Definition at line 143 of file itkESMDemonsRegistrationFunction.h.

References itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageInterpolator.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

virtual

Run-time type information (and related methods).

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

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 181 of file itkESMDemonsRegistrationFunction.h.

References itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_RMSChange.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlinevirtual

Set/Get the type of used image forces

Definition at line 216 of file itkESMDemonsRegistrationFunction.h.

References itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_UseGradientType.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

overridevirtual

Set the object's state before each iteration.

Reimplemented from itk::FiniteDifferenceFunction< TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

static

Method for creation through the object factory.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::operator= ( const Self &  )

private

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::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

overridevirtual

Release memory for global data structure.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

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.

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 195 of file itkESMDemonsRegistrationFunction.h.

References itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MaximumUpdateStepLength.

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 139 of file itkESMDemonsRegistrationFunction.h.

References itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageInterpolator, and itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageWarper.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlinevirtual

Set/Get the type of used image forces

Definition at line 214 of file itkESMDemonsRegistrationFunction.h.

References itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_UseGradientType.

Member Data Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

static

Inherit some enums from the superclass.

Definition at line 100 of file itkESMDemonsRegistrationFunction.h.

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 266 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

private

Definition at line 243 of file itkESMDemonsRegistrationFunction.h.

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 247 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

private

Cache fixed image information.

Definition at line 241 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

private

Definition at line 242 of file itkESMDemonsRegistrationFunction.h.

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 269 of file itkESMDemonsRegistrationFunction.h.

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 250 of file itkESMDemonsRegistrationFunction.h.

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 272 of file itkESMDemonsRegistrationFunction.h.

Referenced by itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMaximumUpdateStepLength(), and itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMaximumUpdateStepLength().

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 277 of file itkESMDemonsRegistrationFunction.h.

Referenced by itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMetric().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

SimpleFastMutexLock itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MetricCalculationLock

mutableprivate

Mutex lock to protect modification to metric.

Definition at line 284 of file itkESMDemonsRegistrationFunction.h.

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 255 of file itkESMDemonsRegistrationFunction.h.

Referenced by itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMovingImageInterpolator(), and itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImageInterpolator().

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 258 of file itkESMDemonsRegistrationFunction.h.

Referenced by itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImageInterpolator().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

private

Definition at line 260 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

private

Definition at line 244 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

mutableprivate

Definition at line 279 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

mutableprivate

Definition at line 280 of file itkESMDemonsRegistrationFunction.h.

Referenced by itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetRMSChange().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

mutableprivate

Definition at line 281 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

mutableprivate

Definition at line 278 of file itkESMDemonsRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

private

The global timestep.

Definition at line 263 of file itkESMDemonsRegistrationFunction.h.

Referenced by itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeGlobalTimeStep().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

GradientType itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_UseGradientType

private

Definition at line 252 of file itkESMDemonsRegistrationFunction.h.

Referenced by itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetUseGradientType(), and itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetUseGradientType().

---

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

• itkESMDemonsRegistrationFunction.h