ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
itk::GPUAnisotropicDiffusionFunction< TImage > Class Template Referenceabstract

#include <itkGPUAnisotropicDiffusionFunction.h>

Detailed Description

template<typename TImage>
class itk::GPUAnisotropicDiffusionFunction< TImage >

This is the GPU version of AnisotropicDiffusionFunction class.

How to use this class
This class must be subclassed to provide the GPUCalculateUpdate() methods of GPUFiniteDifferenceFunction and the function CalculateAverageGradientMagnitudeSquared(), which is called before each iteration to recalibrate the conductance term.

Definition at line 38 of file itkGPUAnisotropicDiffusionFunction.h.

+ Inheritance diagram for itk::GPUAnisotropicDiffusionFunction< TImage >:
+ Collaboration diagram for itk::GPUAnisotropicDiffusionFunction< TImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using PixelrealType = typename Superclass::PixelRealType
 
using Pointer = SmartPointer< Self >
 
using Self = GPUAnisotropicDiffusionFunction
 
using Superclass = GPUFiniteDifferenceFunction< TImage >
 
- Public Types inherited from itk::GPUFiniteDifferenceFunction< TImage >
using ConstPointer = SmartPointer< const Self >
 
using DifferenceFunctionType = Superclass
 
using Pointer = SmartPointer< Self >
 
using Self = GPUFiniteDifferenceFunction
 
using Superclass = FiniteDifferenceFunction< TImage >
 
- Public Types inherited from itk::FiniteDifferenceFunction< TImage >
using ConstPointer = SmartPointer< const Self >
 
using DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< ImageType >
 
using FloatOffsetType = Vector< float, Self::ImageDimension >
 
using ImageType = TImage
 
using NeighborhoodScalesType = Vector< PixelRealType, Self::ImageDimension >
 
using NeighborhoodType = ConstNeighborhoodIterator< TImage, DefaultBoundaryConditionType >
 
using PixelRealType = double
 
using PixelType = typename ImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename ConstNeighborhoodIterator< TImage >::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
 
const double & GetAverageGradientMagnitudeSquared () const
 
const double & GetConductanceParameter () const
 
void * GetGlobalDataPointer () const override
 
const TimeStepTypeGetTimeStep () const
 
virtual void GPUCalculateAverageGradientMagnitudeSquared (ImageType *)=0
 
 itkOverrideGetNameOfClassMacro (GPUAnisotropicDiffusionFunction)
 
void ReleaseGlobalDataPointer (void *) const override
 
void SetAverageGradientMagnitudeSquared (const double c)
 
void SetConductanceParameter (const double c)
 
void SetTimeStep (const TimeStepType &t)
 
- Public Member Functions inherited from itk::GPUFiniteDifferenceFunction< TImage >
virtual void GPUAllocateMetricData (unsigned int)
 
virtual void GPUComputeUpdate (const typename TImage ::Pointer output, typename TImage ::Pointer update, void *gd)=0
 
virtual void GPUReleaseMetricData ()
 
 itkOverrideGetNameOfClassMacro (GPUFiniteDifferenceFunction)
 
PixelType ComputeUpdate (const NeighborhoodType &, void *, const FloatOffsetType &) override
 
- Public Member Functions inherited from itk::FiniteDifferenceFunction< TImage >
const NeighborhoodScalesType ComputeNeighborhoodScales () const
 
const RadiusTypeGetRadius () const
 
void GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
 
virtual void InitializeIteration ()
 
 itkOverrideGetNameOfClassMacro (FiniteDifferenceFunction)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Attributes

static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::GPUFiniteDifferenceFunction< TImage >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceFunction< TImage >
static constexpr unsigned int ImageDimension
 

Protected Member Functions

 GPUAnisotropicDiffusionFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GPUAnisotropicDiffusionFunction () override=default
 
- Protected Member Functions inherited from itk::GPUFiniteDifferenceFunction< TImage >
 GPUFiniteDifferenceFunction ()
 
 ~GPUFiniteDifferenceFunction () override=default
 
- Protected Member Functions inherited from itk::FiniteDifferenceFunction< TImage >
 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

GPUDataManager::Pointer m_AnisotropicDiffusionFunctionGPUBuffer {}
 
GPUKernelManager::Pointer m_AnisotropicDiffusionFunctionGPUKernelManager {}
 
int m_AverageGradientMagnitudeSquaredGPUKernelHandle {}
 
- Protected Attributes inherited from itk::GPUFiniteDifferenceFunction< TImage >
int m_ComputeUpdateGPUKernelHandle
 
GPUKernelManager::Pointer m_GPUKernelManager
 
- Protected Attributes inherited from itk::FiniteDifferenceFunction< TImage >
RadiusType m_Radius
 
PixelRealType m_ScaleCoefficients [ImageDimension]
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Private Attributes

double m_AverageGradientMagnitudeSquared {}
 
double m_ConductanceParameter {}
 
TimeStepType m_TimeStep {}
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Member Typedef Documentation

◆ ConstPointer

template<typename TImage >
using itk::GPUAnisotropicDiffusionFunction< TImage >::ConstPointer = SmartPointer<const Self>

Definition at line 47 of file itkGPUAnisotropicDiffusionFunction.h.

◆ PixelrealType

template<typename TImage >
using itk::GPUAnisotropicDiffusionFunction< TImage >::PixelrealType = typename Superclass::PixelRealType

Definition at line 55 of file itkGPUAnisotropicDiffusionFunction.h.

◆ Pointer

template<typename TImage >
using itk::GPUAnisotropicDiffusionFunction< TImage >::Pointer = SmartPointer<Self>

Definition at line 46 of file itkGPUAnisotropicDiffusionFunction.h.

◆ Self

template<typename TImage >
using itk::GPUAnisotropicDiffusionFunction< TImage >::Self = GPUAnisotropicDiffusionFunction

Standard class type aliases.

Definition at line 44 of file itkGPUAnisotropicDiffusionFunction.h.

◆ Superclass

template<typename TImage >
using itk::GPUAnisotropicDiffusionFunction< TImage >::Superclass = GPUFiniteDifferenceFunction<TImage>

Definition at line 45 of file itkGPUAnisotropicDiffusionFunction.h.

Constructor & Destructor Documentation

◆ GPUAnisotropicDiffusionFunction()

template<typename TImage >
itk::GPUAnisotropicDiffusionFunction< TImage >::GPUAnisotropicDiffusionFunction ( )
inlineprotected

Definition at line 137 of file itkGPUAnisotropicDiffusionFunction.h.

◆ ~GPUAnisotropicDiffusionFunction()

template<typename TImage >
itk::GPUAnisotropicDiffusionFunction< TImage >::~GPUAnisotropicDiffusionFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ ComputeGlobalTimeStep()

template<typename TImage >
TimeStepType itk::GPUAnisotropicDiffusionFunction< TImage >::ComputeGlobalTimeStep ( void *  ) const
inlineoverridevirtual

Returns the time step supplied by the user. We don't need to use the global data supplied since we are returning a fixed value.

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 116 of file itkGPUAnisotropicDiffusionFunction.h.

◆ GetAverageGradientMagnitudeSquared()

template<typename TImage >
const double& itk::GPUAnisotropicDiffusionFunction< TImage >::GetAverageGradientMagnitudeSquared ( ) const
inline

Set/Get the average gradient magnitude squared.

Definition at line 102 of file itkGPUAnisotropicDiffusionFunction.h.

◆ GetConductanceParameter()

template<typename TImage >
const double& itk::GPUAnisotropicDiffusionFunction< TImage >::GetConductanceParameter ( ) const
inline

Definition at line 95 of file itkGPUAnisotropicDiffusionFunction.h.

◆ GetGlobalDataPointer()

template<typename TImage >
void* itk::GPUAnisotropicDiffusionFunction< TImage >::GetGlobalDataPointer ( ) const
inlineoverridevirtual

The anisotropic diffusion classes don't use this particular parameter so it's safe to return a null value.

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 124 of file itkGPUAnisotropicDiffusionFunction.h.

◆ GetTimeStep()

template<typename TImage >
const TimeStepType& itk::GPUAnisotropicDiffusionFunction< TImage >::GetTimeStep ( ) const
inline

Definition at line 82 of file itkGPUAnisotropicDiffusionFunction.h.

◆ GPUCalculateAverageGradientMagnitudeSquared()

template<typename TImage >
virtual void itk::GPUAnisotropicDiffusionFunction< TImage >::GPUCalculateAverageGradientMagnitudeSquared ( ImageType )
pure virtual

This method is called before each iteration. It calculates a scalar value that is the average of the gradient magnitude squared at each pixel in the output image (intermediate solution). The average gradient magnitude value is typically used in the anisotropic diffusion equations to calibrate the conductance term.

Implemented in itk::GPUScalarAnisotropicDiffusionFunction< TImage >.

◆ itkOverrideGetNameOfClassMacro()

template<typename TImage >
itk::GPUAnisotropicDiffusionFunction< TImage >::itkOverrideGetNameOfClassMacro ( GPUAnisotropicDiffusionFunction< TImage >  )

Run-time type information (and related methods)

◆ PrintSelf()

template<typename TImage >
void itk::GPUAnisotropicDiffusionFunction< TImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::LightObject.

Definition at line 147 of file itkGPUAnisotropicDiffusionFunction.h.

◆ ReleaseGlobalDataPointer()

template<typename TImage >
void itk::GPUAnisotropicDiffusionFunction< TImage >::ReleaseGlobalDataPointer ( void *  ) const
inlineoverridevirtual

Does nothing. No global data is used in this class of equations.

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 131 of file itkGPUAnisotropicDiffusionFunction.h.

◆ SetAverageGradientMagnitudeSquared()

template<typename TImage >
void itk::GPUAnisotropicDiffusionFunction< TImage >::SetAverageGradientMagnitudeSquared ( const double  c)
inline

Definition at line 108 of file itkGPUAnisotropicDiffusionFunction.h.

◆ SetConductanceParameter()

template<typename TImage >
void itk::GPUAnisotropicDiffusionFunction< TImage >::SetConductanceParameter ( const double  c)
inline

Set/Get the conductance parameter. The conductance parameter.

Definition at line 89 of file itkGPUAnisotropicDiffusionFunction.h.

◆ SetTimeStep()

template<typename TImage >
void itk::GPUAnisotropicDiffusionFunction< TImage >::SetTimeStep ( const TimeStepType t)
inline

Set/Get the time step. For this class of anisotropic diffusion filters, the time-step is supplied by the user and remains fixed for all updates.

Definition at line 76 of file itkGPUAnisotropicDiffusionFunction.h.

Member Data Documentation

◆ ImageDimension

template<typename TImage >
constexpr unsigned int itk::GPUAnisotropicDiffusionFunction< TImage >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Inherit some parameters from the superclass type

Definition at line 62 of file itkGPUAnisotropicDiffusionFunction.h.

◆ m_AnisotropicDiffusionFunctionGPUBuffer

template<typename TImage >
GPUDataManager::Pointer itk::GPUAnisotropicDiffusionFunction< TImage >::m_AnisotropicDiffusionFunctionGPUBuffer {}
protected

Definition at line 155 of file itkGPUAnisotropicDiffusionFunction.h.

◆ m_AnisotropicDiffusionFunctionGPUKernelManager

template<typename TImage >
GPUKernelManager::Pointer itk::GPUAnisotropicDiffusionFunction< TImage >::m_AnisotropicDiffusionFunctionGPUKernelManager {}
protected

Definition at line 156 of file itkGPUAnisotropicDiffusionFunction.h.

◆ m_AverageGradientMagnitudeSquared

template<typename TImage >
double itk::GPUAnisotropicDiffusionFunction< TImage >::m_AverageGradientMagnitudeSquared {}
private

Definition at line 162 of file itkGPUAnisotropicDiffusionFunction.h.

◆ m_AverageGradientMagnitudeSquaredGPUKernelHandle

template<typename TImage >
int itk::GPUAnisotropicDiffusionFunction< TImage >::m_AverageGradientMagnitudeSquaredGPUKernelHandle {}
protected

Definition at line 159 of file itkGPUAnisotropicDiffusionFunction.h.

◆ m_ConductanceParameter

template<typename TImage >
double itk::GPUAnisotropicDiffusionFunction< TImage >::m_ConductanceParameter {}
private

Definition at line 163 of file itkGPUAnisotropicDiffusionFunction.h.

◆ m_TimeStep

template<typename TImage >
TimeStepType itk::GPUAnisotropicDiffusionFunction< TImage >::m_TimeStep {}
private

Definition at line 164 of file itkGPUAnisotropicDiffusionFunction.h.


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