ITK  6.0.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Private Attributes | List of all members
itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > Class Template Reference
Data Processing Objects » Functions » Finite Difference Functions | Group Registration » Module ITKPDEDeformableRegistration

#include <itkLevelSetMotionRegistrationFunction.h>

Detailed Description

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

This class encapsulate the PDE which drives the demons registration algorithm. It is used by LevelSetMotionRegistrationFilter to compute the output deformation field which will map a moving image onto a a fixed image.

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 deformation field type.

Warning
This filter assumes that the fixed image type, moving image type and deformation field type all have the same number of dimensions.
See also
LevelSetMotionRegistrationFilter

Definition at line 55 of file itkLevelSetMotionRegistrationFunction.h.

+ Inheritance diagram for itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >:
+ Collaboration diagram for itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >:

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 IndexType = typename FixedImageType::IndexType
 
using InterpolatorPointer = typename InterpolatorType::Pointer
 
using InterpolatorType = InterpolateImageFunction< MovingImageType, CoordRepType >
 
using MovingImageSmoothingFilterPointer = typename MovingImageSmoothingFilterType::Pointer
 
using MovingImageSmoothingFilterType = SmoothingRecursiveGaussianImageFilter< MovingImageType >
 
using MovingSpacingType = typename MovingImageType::SpacingType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename InterpolatorType::PointType
 
using Self = LevelSetMotionRegistrationFunction
 
using SizeType = typename FixedImageType::SizeType
 
using SpacingType = typename FixedImageType::SpacingType
 
using Superclass = PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
 
using VectorType = Vector< double, Self::ImageDimension >
 
- 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 *GlobalData) const override
 
PixelType ComputeUpdate (const NeighborhoodType &it, void *gd, const FloatOffsetType &offset=FloatOffsetType(0.0)) override
 
virtual double GetAlpha () const
 
void * GetGlobalDataPointer () const override
 
virtual double GetGradientMagnitudeThreshold () const
 
virtual double GetGradientSmoothingStandardDeviations () const
 
virtual double GetIntensityDifferenceThreshold () const
 
virtual double GetMetric () const
 
InterpolatorType * GetMovingImageInterpolator ()
 
const char * GetNameOfClass () const override
 
virtual double GetRMSChange () const
 
bool GetUseImageSpacing () const
 
void InitializeIteration () override
 
void ReleaseGlobalDataPointer (void *gd) const override
 
virtual void SetAlpha (double)
 
virtual void SetGradientMagnitudeThreshold (double)
 
virtual void SetGradientSmoothingStandardDeviations (double)
 
virtual void SetIntensityDifferenceThreshold (double)
 
void SetMovingImageInterpolator (InterpolatorType *ptr)
 
void SetUseImageSpacing (bool)
 
- 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
 
const char * GetNameOfClass () const override
 
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 >
virtual TimeStepType ComputeGlobalTimeStep (void *GlobalData) const=0
 
const NeighborhoodScalesType ComputeNeighborhoodScales () const
 
virtual PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))=0
 
virtual void * GetGlobalDataPointer () const=0
 
const char * GetNameOfClass () const override
 
const RadiusType & GetRadius () const
 
void GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
 
virtual void InitializeIteration ()
 
virtual void ReleaseGlobalDataPointer (void *GlobalData) const=0
 
void SetRadius (const RadiusType &r)
 
void SetScaleCoefficients (const PixelRealType vals[ImageDimension])
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
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
 

Protected Types

using FixedImageNeighborhoodIteratorType = ConstNeighborhoodIterator< FixedImageType >
 

Protected Member Functions

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

Private Attributes

double m_Alpha {}
 
PointType m_FixedImageOrigin {}
 
SpacingType m_FixedImageSpacing {}
 
double m_GradientMagnitudeThreshold {}
 
double m_GradientSmoothingStandardDeviations {}
 
double m_IntensityDifferenceThreshold {}
 
double m_Metric {}
 
std::mutex m_MetricCalculationMutex {}
 
InterpolatorPointer m_MovingImageInterpolator {}
 
MovingImageSmoothingFilterPointer m_MovingImageSmoothingFilter {}
 
SizeValueType m_NumberOfPixelsProcessed {}
 
double m_RMSChange {}
 
InterpolatorPointer m_SmoothMovingImageInterpolator {}
 
double m_SumOfSquaredChange {}
 
double m_SumOfSquaredDifference {}
 
bool m_UseImageSpacing { true }
 

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 {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ConstPointer = SmartPointer<const Self>

Definition at line 66 of file itkLevelSetMotionRegistrationFunction.h.

◆ CoordRepType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::CoordRepType = double

Interpolator type.

Definition at line 101 of file itkLevelSetMotionRegistrationFunction.h.

◆ CovariantVectorType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::CovariantVectorType = CovariantVector<double, Self::ImageDimension>

Definition at line 109 of file itkLevelSetMotionRegistrationFunction.h.

◆ DefaultInterpolatorType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DefaultInterpolatorType = LinearInterpolateImageFunction<MovingImageType, CoordRepType>

Definition at line 105 of file itkLevelSetMotionRegistrationFunction.h.

◆ FixedImageNeighborhoodIteratorType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImageNeighborhoodIteratorType = ConstNeighborhoodIterator<FixedImageType>
protected

FixedImage image neighborhood iterator type.

Definition at line 238 of file itkLevelSetMotionRegistrationFunction.h.

◆ IndexType

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

Definition at line 82 of file itkLevelSetMotionRegistrationFunction.h.

◆ InterpolatorPointer

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

Definition at line 103 of file itkLevelSetMotionRegistrationFunction.h.

◆ InterpolatorType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InterpolatorType = InterpolateImageFunction<MovingImageType, CoordRepType>

Definition at line 102 of file itkLevelSetMotionRegistrationFunction.h.

◆ MovingImageSmoothingFilterPointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageSmoothingFilterPointer = typename MovingImageSmoothingFilterType::Pointer

Definition at line 113 of file itkLevelSetMotionRegistrationFunction.h.

◆ MovingImageSmoothingFilterType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageSmoothingFilterType = SmoothingRecursiveGaussianImageFilter<MovingImageType>

Moving image gradient calculator type.

Definition at line 112 of file itkLevelSetMotionRegistrationFunction.h.

◆ MovingSpacingType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingSpacingType = typename MovingImageType::SpacingType

Definition at line 77 of file itkLevelSetMotionRegistrationFunction.h.

◆ Pointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Pointer = SmartPointer<Self>

Definition at line 65 of file itkLevelSetMotionRegistrationFunction.h.

◆ PointType

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

Definition at line 104 of file itkLevelSetMotionRegistrationFunction.h.

◆ Self

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Self = LevelSetMotionRegistrationFunction

Standard class type aliases.

Definition at line 62 of file itkLevelSetMotionRegistrationFunction.h.

◆ SizeType

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

Definition at line 83 of file itkLevelSetMotionRegistrationFunction.h.

◆ SpacingType

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

Definition at line 84 of file itkLevelSetMotionRegistrationFunction.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Superclass = PDEDeformableRegistrationFunction<TFixedImage, TMovingImage, TDisplacementField>

Definition at line 63 of file itkLevelSetMotionRegistrationFunction.h.

◆ VectorType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::VectorType = Vector<double, Self::ImageDimension>

Vector types.

Definition at line 108 of file itkLevelSetMotionRegistrationFunction.h.

Constructor & Destructor Documentation

◆ LevelSetMotionRegistrationFunction()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::LevelSetMotionRegistrationFunction ( )
protected

◆ ~LevelSetMotionRegistrationFunction()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::~LevelSetMotionRegistrationFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ ComputeGlobalTimeStep()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
TimeStepType itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeGlobalTimeStep ( void *  GlobalData) const
overridevirtual

Compute the time global step that for this iteration.

In this context, the timestep is a function of the maximum gradients.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

◆ ComputeUpdate()

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

Compute update at the specified 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 >.

◆ GetAlpha()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetAlpha ( ) const
virtual

◆ GetGlobalDataPointer()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void * itk::LevelSetMotionRegistrationFunction< 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 139 of file itkLevelSetMotionRegistrationFunction.h.

References itk::NumericTraits< T >::NonpositiveMin().

◆ GetGradientMagnitudeThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetGradientMagnitudeThreshold ( ) const
virtual

◆ GetGradientSmoothingStandardDeviations()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetGradientSmoothingStandardDeviations ( ) const
virtual

◆ GetIntensityDifferenceThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetIntensityDifferenceThreshold ( ) const
virtual

◆ GetMetric()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::LevelSetMotionRegistrationFunction< 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 172 of file itkLevelSetMotionRegistrationFunction.h.

◆ GetMovingImageInterpolator()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
InterpolatorType * itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMovingImageInterpolator ( )
inline

Get the moving image interpolator.

Definition at line 124 of file itkLevelSetMotionRegistrationFunction.h.

◆ GetNameOfClass()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
const char * itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

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

◆ GetRMSChange()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetRMSChange ( ) const
inlinevirtual

Get the rms change in deformation field.

Definition at line 179 of file itkLevelSetMotionRegistrationFunction.h.

◆ GetUseImageSpacing()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
bool itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetUseImageSpacing ( ) const

◆ InitializeIteration()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::LevelSetMotionRegistrationFunction< 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::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::LevelSetMotionRegistrationFunction< 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 >.

◆ ReleaseGlobalDataPointer()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ReleaseGlobalDataPointer ( void *  gd) const
overridevirtual

Release memory for global data structure.

Updates the metric and releases the per-thread-global data.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

◆ SetAlpha()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetAlpha ( double  )
virtual

Set/Get the parameter alpha. Alpha is added to the calculated gradient magnitude prior to normalizing the gradient to protect against numerical instability as the gradient magnitude approaches zero. This should be set as a small fraction of the intensity dynamic range, for instance 0.04%. Default is the absolute (not percentage) value of 0.1.

◆ SetGradientMagnitudeThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetGradientMagnitudeThreshold ( double  )
virtual

Set/Get the threshold below which the gradient magnitude is considered the zero vector. Default is 1e-9.

◆ SetGradientSmoothingStandardDeviations()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetGradientSmoothingStandardDeviations ( double  )
virtual

Set/Get the standard deviation used for smoothing the moving image prior to calculating gradients.

◆ SetIntensityDifferenceThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::LevelSetMotionRegistrationFunction< 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.

◆ SetMovingImageInterpolator()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImageInterpolator ( InterpolatorType *  ptr)
inline

Set the moving image interpolator.

Definition at line 117 of file itkLevelSetMotionRegistrationFunction.h.

◆ SetUseImageSpacing()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetUseImageSpacing ( bool  )

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacing ON, due to a backward compatibility state.

Member Data Documentation

◆ ImageDimension

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
constexpr unsigned int itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Inherit some enums from the superclass.

Definition at line 91 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_Alpha

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Alpha {}
private

Stabilization factor for normalizing gradients to protect against small gradient magnitudes

Definition at line 264 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_FixedImageOrigin

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
PointType itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImageOrigin {}
private

Definition at line 253 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_FixedImageSpacing

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
SpacingType itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImageSpacing {}
private

Cache fixed image information.

Definition at line 252 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_GradientMagnitudeThreshold

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GradientMagnitudeThreshold {}
private

Threshold below which the gradient is considered zero.

Definition at line 267 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_GradientSmoothingStandardDeviations

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GradientSmoothingStandardDeviations {}
private

Smoothing parameter for gradient calculation

Definition at line 273 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_IntensityDifferenceThreshold

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_IntensityDifferenceThreshold {}
private

Threshold below which two intensity value are assumed to match.

Definition at line 270 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_Metric

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::LevelSetMotionRegistrationFunction< 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 278 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_MetricCalculationMutex

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
std::mutex itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MetricCalculationMutex {}
mutableprivate

Mutex lock to protect modification to metric.

Definition at line 285 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_MovingImageInterpolator

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
InterpolatorPointer itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageInterpolator {}
private

Function to interpolate the moving image.

Definition at line 259 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_MovingImageSmoothingFilter

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
MovingImageSmoothingFilterPointer itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageSmoothingFilter {}
private

Function to compute derivatives of the moving image.

Definition at line 256 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_NumberOfPixelsProcessed

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
SizeValueType itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_NumberOfPixelsProcessed {}
mutableprivate

Definition at line 280 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_RMSChange

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_RMSChange {}
mutableprivate

Definition at line 281 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_SmoothMovingImageInterpolator

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
InterpolatorPointer itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_SmoothMovingImageInterpolator {}
private

Definition at line 260 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_SumOfSquaredChange

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_SumOfSquaredChange {}
mutableprivate

Definition at line 282 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_SumOfSquaredDifference

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_SumOfSquaredDifference {}
mutableprivate

Definition at line 279 of file itkLevelSetMotionRegistrationFunction.h.

◆ m_UseImageSpacing

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
bool itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_UseImageSpacing { true }
private

Definition at line 287 of file itkLevelSetMotionRegistrationFunction.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3