ITK  6.0.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > Class Template Reference

#include <itkGPUDemonsRegistrationFunction.h>

Detailed Description

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

This class encapsulate the PDE which drives the demons registration algorithm. It is used by DemonsRegistrationFilter 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
DemonsRegistrationFilter

Definition at line 58 of file itkGPUDemonsRegistrationFunction.h.

+ Inheritance diagram for itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >:
+ Collaboration diagram for itk::GPUDemonsRegistrationFunction< 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 GPUDataPointer = GPUDataManager::Pointer
 
using GradientCalculatorPointer = typename GradientCalculatorType::Pointer
 
using GradientCalculatorType = CentralDifferenceImageFunction< FixedImageType >
 
using IndexType = typename FixedImageType::IndexType
 
using InterpolatorPointer = typename InterpolatorType::Pointer
 
using InterpolatorType = InterpolateImageFunction< MovingImageType, CoordRepType >
 
using MovingImageGradientCalculatorPointer = typename MovingImageGradientCalculatorType::Pointer
 
using MovingImageGradientCalculatorType = CentralDifferenceImageFunction< MovingImageType, CoordRepType >
 
using Pointer = SmartPointer< Self >
 
using PointType = typename InterpolatorType::PointType
 
using Self = GPUDemonsRegistrationFunction
 
using SizeType = typename FixedImageType::SizeType
 
using SpacingType = typename FixedImageType::SpacingType
 
using Superclass = GPUPDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
 
- Public Types inherited from itk::GPUPDEDeformableRegistrationFunction< 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 = GPUPDEDeformableRegistrationFunction
 
using Superclass = GPUFiniteDifferenceFunction< TDisplacementField >
 
- Public Types inherited from itk::GPUFiniteDifferenceFunction< TDisplacementField >
using ConstPointer = SmartPointer< const Self >
 
using DifferenceFunctionType = Superclass
 
using Pointer = SmartPointer< Self >
 
using Self = GPUFiniteDifferenceFunction
 
using Superclass = FiniteDifferenceFunction< TDisplacementField >
 
- Public Types inherited from itk::FiniteDifferenceFunction< TDisplacementField >
using ConstPointer = SmartPointer< const Self >
 
using DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< ImageType >
 
using FloatOffsetType = Vector< float, Self::ImageDimension >
 
using ImageType = TDisplacementField
 
using NeighborhoodScalesType = Vector< PixelRealType, Self::ImageDimension >
 
using NeighborhoodType = ConstNeighborhoodIterator< TDisplacementField, DefaultBoundaryConditionType >
 
using PixelRealType = double
 
using PixelType = typename ImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename ConstNeighborhoodIterator< TDisplacementField >::RadiusType
 
using Self = FiniteDifferenceFunction
 
using Superclass = LightObject
 
using TimeStepType = double
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

TimeStepType ComputeGlobalTimeStep (void *) const override
 
PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override
 
void * GetGlobalDataPointer () const override
 
virtual double GetIntensityDifferenceThreshold () const
 
virtual double GetMetric () const
 
InterpolatorTypeGetMovingImageInterpolator ()
 
const char * GetNameOfClass () const override
 
virtual double GetRMSChange () const
 
void GPUAllocateMetricData (unsigned int numPixels) override
 
void GPUComputeUpdate (const DisplacementFieldTypePointer output, DisplacementFieldTypePointer update, void *gd) override
 
void GPUReleaseMetricData () override
 
void InitializeIteration () override
 
 itkGetOpenCLSourceFromKernelMacro (GPUDemonsRegistrationFunctionKernel)
 
void ReleaseGlobalDataPointer (void *GlobalData) const override
 
virtual void SetIntensityDifferenceThreshold (double)
 
void SetMovingImageInterpolator (InterpolatorType *ptr)
 
virtual void SetUseMovingImageGradient (bool flag)
 
virtual bool GetUseMovingImageGradient () const
 
- Public Member Functions inherited from itk::GPUPDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
DisplacementFieldTypeGetDisplacementField ()
 
double GetEnergy () const
 
const FixedImageTypeGetFixedImage () const
 
double GetGradientStep () const
 
const MovingImageTypeGetMovingImage () 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::GPUFiniteDifferenceFunction< TDisplacementField >
const char * GetNameOfClass () const override
 
virtual void GPUComputeUpdate (const typename TDisplacementField ::Pointer output, typename TDisplacementField ::Pointer update, void *gd)=0
 
PixelType ComputeUpdate (const NeighborhoodType &, void *, const FloatOffsetType &=FloatOffsetType(0.0)) override
 
- Public Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
const NeighborhoodScalesType ComputeNeighborhoodScales () const
 
const RadiusTypeGetRadius () const
 
void GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
 
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 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::GPUFiniteDifferenceFunction< TDisplacementField >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField >
static constexpr unsigned int ImageDimension
 

Protected Types

using FixedImageNeighborhoodIteratorType = ConstNeighborhoodIterator< FixedImageType >
 

Protected Member Functions

 GPUDemonsRegistrationFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GPUDemonsRegistrationFunction () override=default
 
- Protected Member Functions inherited from itk::GPUPDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >
 GPUPDEDeformableRegistrationFunction ()
 
 ~GPUPDEDeformableRegistrationFunction () override=default
 
- Protected Member Functions inherited from itk::GPUFiniteDifferenceFunction< TDisplacementField >
 GPUFiniteDifferenceFunction ()
 
 ~GPUFiniteDifferenceFunction () override=default
 
- Protected Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
 FiniteDifferenceFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~FiniteDifferenceFunction () override=default
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

int m_ComputeUpdateGPUKernelHandle {}
 
- Protected Attributes inherited from itk::GPUPDEDeformableRegistrationFunction< 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::GPUFiniteDifferenceFunction< TDisplacementField >
int m_ComputeUpdateGPUKernelHandle
 
GPUKernelManager::Pointer m_GPUKernelManager
 
- 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 {}
 

Private Attributes

double m_DenominatorThreshold {}
 
GradientCalculatorPointer m_FixedImageGradientCalculator {}
 
GPUReduction< int >::Pointer m_GPUPixelCounter {}
 
GPUReduction< float >::Pointer m_GPUSquaredChange {}
 
GPUReduction< float >::Pointer m_GPUSquaredDifference {}
 
double m_IntensityDifferenceThreshold {}
 
double m_Metric {}
 
std::mutex m_MetricCalculationMutex {}
 
MovingImageGradientCalculatorPointer m_MovingImageGradientCalculator {}
 
InterpolatorPointer m_MovingImageInterpolator {}
 
double m_Normalizer {}
 
SizeValueType m_NumberOfPixelsProcessed {}
 
double m_RMSChange {}
 
double m_SumOfSquaredChange {}
 
double m_SumOfSquaredDifference {}
 
TimeStepType m_TimeStep {}
 
bool m_UseMovingImageGradient {}
 
PixelType m_ZeroUpdateReturn {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 68 of file itkGPUDemonsRegistrationFunction.h.

◆ CoordRepType

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

Interpolator type.

Definition at line 102 of file itkGPUDemonsRegistrationFunction.h.

◆ CovariantVectorType

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

Covariant vector type.

Definition at line 109 of file itkGPUDemonsRegistrationFunction.h.

◆ DefaultInterpolatorType

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

Definition at line 106 of file itkGPUDemonsRegistrationFunction.h.

◆ FixedImageNeighborhoodIteratorType

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

FixedImage image neighborhood iterator type.

Definition at line 243 of file itkGPUDemonsRegistrationFunction.h.

◆ GPUDataPointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GPUDataPointer = GPUDataManager::Pointer

GPU data pointer type.

Definition at line 120 of file itkGPUDemonsRegistrationFunction.h.

◆ GradientCalculatorPointer

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

Definition at line 113 of file itkGPUDemonsRegistrationFunction.h.

◆ GradientCalculatorType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GradientCalculatorType = CentralDifferenceImageFunction<FixedImageType>

Fixed image gradient calculator type.

Definition at line 112 of file itkGPUDemonsRegistrationFunction.h.

◆ IndexType

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

Definition at line 83 of file itkGPUDemonsRegistrationFunction.h.

◆ InterpolatorPointer

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

Definition at line 104 of file itkGPUDemonsRegistrationFunction.h.

◆ InterpolatorType

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

Definition at line 103 of file itkGPUDemonsRegistrationFunction.h.

◆ MovingImageGradientCalculatorPointer

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

Definition at line 117 of file itkGPUDemonsRegistrationFunction.h.

◆ MovingImageGradientCalculatorType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageGradientCalculatorType = CentralDifferenceImageFunction<MovingImageType, CoordRepType>

Moving image gradient calculator type.

Definition at line 116 of file itkGPUDemonsRegistrationFunction.h.

◆ Pointer

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

Definition at line 67 of file itkGPUDemonsRegistrationFunction.h.

◆ PointType

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

Definition at line 105 of file itkGPUDemonsRegistrationFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 65 of file itkGPUDemonsRegistrationFunction.h.

◆ SizeType

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

Definition at line 84 of file itkGPUDemonsRegistrationFunction.h.

◆ SpacingType

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

Definition at line 85 of file itkGPUDemonsRegistrationFunction.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Superclass = GPUPDEDeformableRegistrationFunction<TFixedImage, TMovingImage, TDisplacementField>

Definition at line 66 of file itkGPUDemonsRegistrationFunction.h.

Constructor & Destructor Documentation

◆ GPUDemonsRegistrationFunction()

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

◆ ~GPUDemonsRegistrationFunction()

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

Member Function Documentation

◆ ComputeGlobalTimeStep()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
TimeStepType itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeGlobalTimeStep ( void *  ) const
inlineoverridevirtual

This class uses a constant timestep of 1.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

Definition at line 141 of file itkGPUDemonsRegistrationFunction.h.

◆ ComputeUpdate()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
PixelType itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeUpdate ( const NeighborhoodType neighborhood,
void *  globalData,
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 >.

◆ GetGlobalDataPointer()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void* itk::GPUDemonsRegistrationFunction< 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 149 of file itkGPUDemonsRegistrationFunction.h.

◆ GetIntensityDifferenceThreshold()

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

◆ GetMetric()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::GPUDemonsRegistrationFunction< 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 198 of file itkGPUDemonsRegistrationFunction.h.

◆ GetMovingImageInterpolator()

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

Get the moving image interpolator.

Definition at line 134 of file itkGPUDemonsRegistrationFunction.h.

◆ GetNameOfClass()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
const char* itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetNameOfClass ( ) const
overridevirtual

◆ GetRMSChange()

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

Get the rms change in deformation field.

Definition at line 205 of file itkGPUDemonsRegistrationFunction.h.

◆ GetUseMovingImageGradient()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual bool itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetUseMovingImageGradient ( ) const
inlinevirtual

Select if the fixed image or moving image gradient is used for computing the demon forces. The fixed image gradient is used by default.

Definition at line 219 of file itkGPUDemonsRegistrationFunction.h.

◆ GPUAllocateMetricData()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GPUAllocateMetricData ( unsigned int  numPixels)
overridevirtual

Allocate GPU buffers for computing metric statistics

Reimplemented from itk::GPUFiniteDifferenceFunction< TDisplacementField >.

◆ GPUComputeUpdate()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GPUComputeUpdate ( const DisplacementFieldTypePointer  output,
DisplacementFieldTypePointer  update,
void *  gd 
)
override

Compute update at the specified neighbourhood.

◆ GPUReleaseMetricData()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GPUReleaseMetricData ( )
overridevirtual

Release GPU buffers for computing metric statistics.

Reimplemented from itk::GPUFiniteDifferenceFunction< TDisplacementField >.

◆ InitializeIteration()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InitializeIteration ( )
overridevirtual

Set the object's state before each iteration.

Reimplemented from itk::FiniteDifferenceFunction< TDisplacementField >.

◆ itkGetOpenCLSourceFromKernelMacro()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::itkGetOpenCLSourceFromKernelMacro ( GPUDemonsRegistrationFunctionKernel  )

Get OpenCL Kernel source as a string, creates a GetOpenCLSource method

◆ New()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
static Pointer itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

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

◆ ReleaseGlobalDataPointer()

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

Release memory for global data structure.

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

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

◆ SetIntensityDifferenceThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::GPUDemonsRegistrationFunction< 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::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImageInterpolator ( InterpolatorType ptr)
inline

Set the moving image interpolator.

Definition at line 127 of file itkGPUDemonsRegistrationFunction.h.

◆ SetUseMovingImageGradient()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetUseMovingImageGradient ( bool  flag)
inlinevirtual

Select if the fixed image or moving image gradient is used for computing the demon forces. The fixed image gradient is used by default.

Definition at line 214 of file itkGPUDemonsRegistrationFunction.h.

Member Data Documentation

◆ ImageDimension

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

Inherit some enums from the superclass.

Definition at line 92 of file itkGPUDemonsRegistrationFunction.h.

◆ m_ComputeUpdateGPUKernelHandle

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
int itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_ComputeUpdateGPUKernelHandle {}
protected

Definition at line 255 of file itkGPUDemonsRegistrationFunction.h.

◆ m_DenominatorThreshold

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_DenominatorThreshold {}
private

Threshold below which the denominator term is considered zero.

Definition at line 278 of file itkGPUDemonsRegistrationFunction.h.

◆ m_FixedImageGradientCalculator

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
GradientCalculatorPointer itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImageGradientCalculator {}
private

Function to compute derivatives of the fixed image.

Definition at line 265 of file itkGPUDemonsRegistrationFunction.h.

◆ m_GPUPixelCounter

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
GPUReduction<int>::Pointer itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GPUPixelCounter {}
mutableprivate

Definition at line 292 of file itkGPUDemonsRegistrationFunction.h.

◆ m_GPUSquaredChange

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
GPUReduction<float>::Pointer itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GPUSquaredChange {}
mutableprivate

Definition at line 293 of file itkGPUDemonsRegistrationFunction.h.

◆ m_GPUSquaredDifference

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
GPUReduction<float>::Pointer itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GPUSquaredDifference {}
mutableprivate

Definition at line 294 of file itkGPUDemonsRegistrationFunction.h.

◆ m_IntensityDifferenceThreshold

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

Threshold below which two intensity value are assumed to match.

Definition at line 281 of file itkGPUDemonsRegistrationFunction.h.

◆ m_Metric

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::GPUDemonsRegistrationFunction< 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 286 of file itkGPUDemonsRegistrationFunction.h.

◆ m_MetricCalculationMutex

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

Mutex lock to protect modification to metric.

Definition at line 297 of file itkGPUDemonsRegistrationFunction.h.

◆ m_MovingImageGradientCalculator

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
MovingImageGradientCalculatorPointer itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageGradientCalculator {}
private

Function to compute derivatives of the moving image.

Definition at line 268 of file itkGPUDemonsRegistrationFunction.h.

◆ m_MovingImageInterpolator

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

Function to interpolate the moving image.

Definition at line 272 of file itkGPUDemonsRegistrationFunction.h.

◆ m_Normalizer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Normalizer {}
private

Definition at line 262 of file itkGPUDemonsRegistrationFunction.h.

◆ m_NumberOfPixelsProcessed

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

Definition at line 288 of file itkGPUDemonsRegistrationFunction.h.

◆ m_RMSChange

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

Definition at line 289 of file itkGPUDemonsRegistrationFunction.h.

◆ m_SumOfSquaredChange

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

Definition at line 290 of file itkGPUDemonsRegistrationFunction.h.

◆ m_SumOfSquaredDifference

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

Definition at line 287 of file itkGPUDemonsRegistrationFunction.h.

◆ m_TimeStep

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
TimeStepType itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_TimeStep {}
private

The global timestep.

Definition at line 275 of file itkGPUDemonsRegistrationFunction.h.

◆ m_UseMovingImageGradient

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
bool itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_UseMovingImageGradient {}
private

Definition at line 269 of file itkGPUDemonsRegistrationFunction.h.

◆ m_ZeroUpdateReturn

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
PixelType itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_ZeroUpdateReturn {}
private

Cache fixed image information.

Definition at line 261 of file itkGPUDemonsRegistrationFunction.h.


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