#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>

typedef Vector< float, Self::ImageDimension >	FloatOffsetType

typedef TImage	ImageType

typedef ConstNeighborhoodIterator< TImage, DefaultBoundaryConditionType >	NeighborhoodType

using	PixelrealType = typename Superclass::PixelRealType

typedef typename ImageType::PixelType	PixelType

using	Pointer = SmartPointer<Self>

typedef typename ConstNeighborhoodIterator< TImage >::RadiusType	RadiusType

using	Self = GPUAnisotropicDiffusionFunction

using	Superclass = GPUFiniteDifferenceFunction<TImage>

typedef double	TimeStepType

Public Types inherited from itk::GPUFiniteDifferenceFunction< TImage >
using	ConstPointer

typedef ZeroFluxNeumannBoundaryCondition< ImageType >	DefaultBoundaryConditionType

using	DefaultBoundaryConditionType

using	DifferenceFunctionType

typedef Vector< float, Self::ImageDimension >	FloatOffsetType

using	FloatOffsetType

typedef TImage	ImageType

using	ImageType

typedef ConstNeighborhoodIterator< TImage, DefaultBoundaryConditionType >	NeighborhoodType

using	NeighborhoodType

typedef double	PixelRealType

using	PixelRealType

typedef typename ImageType::PixelType	PixelType

using	PixelType

using	Pointer

typedef typename ConstNeighborhoodIterator< TImage >::RadiusType	RadiusType

using	RadiusType

using	Self

using	Superclass

typedef double	TimeStepType

using	TimeStepType

Public Types inherited from itk::FiniteDifferenceFunction< TImage >
using	ConstPointer

using	DefaultBoundaryConditionType

using	FloatOffsetType

using	ImageType

using	NeighborhoodScalesType

using	NeighborhoodType

using	PixelRealType

using	PixelType

using	Pointer

using	RadiusType

using	Self

using	Superclass

using	TimeStepType

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
TimeStepType	ComputeGlobalTimeStep (void *GlobalData) const override

const double &	GetAverageGradientMagnitudeSquared () const

const double &	GetConductanceParameter () const

void *	GetGlobalDataPointer () const override

const char *	GetNameOfClass () const override

const TimeStepType &	GetTimeStep () const

virtual void	GPUCalculateAverageGradientMagnitudeSquared (ImageType *)=0

void	ReleaseGlobalDataPointer (void *GlobalData) 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 >
const char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

virtual void	GPUAllocateMetricData (unsigned int numPixels)

virtual void	GPUAllocateMetricData (unsigned int numPixels)

virtual void	GPUComputeUpdate (const typename TImage::Pointer output, typename TImage::Pointer update, void *gd)=0

virtual void	GPUComputeUpdate (const typename TImage::Pointer output, typename TImage::Pointer update, void *gd)=0

virtual void	GPUReleaseMetricData ()

virtual void	GPUReleaseMetricData ()

PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override

PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override

Public Member Functions inherited from itk::FiniteDifferenceFunction< TImage >
const NeighborhoodScalesType	ComputeNeighborhoodScales () const

const NeighborhoodScalesType	ComputeNeighborhoodScales () const

const RadiusType &	GetRadius () const

const RadiusType &	GetRadius () const

void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const

void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const

virtual void	InitializeIteration ()

virtual void	InitializeIteration ()

void	SetRadius (const RadiusType &r)

void	SetRadius (const RadiusType &r)

void	SetScaleCoefficients (const PixelRealType vals[ImageDimension])

void	SetScaleCoefficients (const PixelRealType vals[ImageDimension])

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual 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 Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension

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

static constexpr unsigned int	ImageDimension

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

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 ()

	~GPUFiniteDifferenceFunction () override=default

	~GPUFiniteDifferenceFunction () override=default

Protected Member Functions inherited from itk::FiniteDifferenceFunction< TImage >
	FiniteDifferenceFunction ()

	FiniteDifferenceFunction ()

	~FiniteDifferenceFunction () override=default

	~FiniteDifferenceFunction () override=default

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
GPUDataManager::Pointer	m_AnisotropicDiffusionFunctionGPUBuffer {}

GPUKernelManager::Pointer	m_AnisotropicDiffusionFunctionGPUKernelManager {}

int	m_AverageGradientMagnitudeSquaredGPUKernelHandle {}

Protected Attributes inherited from itk::GPUFiniteDifferenceFunction< TImage >
int	m_ComputeUpdateGPUKernelHandle

int	m_ComputeUpdateGPUKernelHandle

GPUKernelManager::Pointer	m_GPUKernelManager

GPUKernelManager::Pointer	m_GPUKernelManager

Protected Attributes inherited from itk::FiniteDifferenceFunction< TImage >
RadiusType	m_Radius

RadiusType	m_Radius

PixelRealType	m_ScaleCoefficients [ImageDimension]

PixelRealType	m_ScaleCoefficients [ImageDimension]

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

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.

◆ FloatOffsetType

template<typename TImage>

A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.

◆ ImageType

template<typename TImage>

Extract some parameters from the image type

◆ NeighborhoodType

template<typename TImage>

The type of data structure that is passed to this function object to evaluate at a pixel that does not lie on a data set boundary.

◆ PixelrealType

template<typename TImage>

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

Definition at line 55 of file itkGPUAnisotropicDiffusionFunction.h.

◆ PixelType

template<typename TImage>

◆ Pointer

template<typename TImage>

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

Definition at line 46 of file itkGPUAnisotropicDiffusionFunction.h.

◆ RadiusType

template<typename TImage>

Neighborhood radius type

◆ 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.

◆ TimeStepType

template<typename TImage>

Define the TimeStepType to always be double.

Constructor & Destructor Documentation

◆ GPUAnisotropicDiffusionFunction()

template<typename TImage>

itk::GPUAnisotropicDiffusionFunction< TImage >::GPUAnisotropicDiffusionFunction ( )

inlineprotected

Definition at line 137 of file itkGPUAnisotropicDiffusionFunction.h.

References m_AverageGradientMagnitudeSquared, m_ConductanceParameter, and m_TimeStep.

Referenced by GetNameOfClass().

◆ ~GPUAnisotropicDiffusionFunction()

template<typename TImage>

itk::GPUAnisotropicDiffusionFunction< TImage >::~GPUAnisotropicDiffusionFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ ComputeGlobalTimeStep()

template<typename TImage>

TimeStepType itk::GPUAnisotropicDiffusionFunction< TImage >::ComputeGlobalTimeStep ( void * GlobalData ) 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.

References GetTimeStep().

◆ 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.

References m_AverageGradientMagnitudeSquared.

Referenced by itk::GPUGradientNDAnisotropicDiffusionFunction< TImage >::InitializeIteration().

◆ GetConductanceParameter()

template<typename TImage>

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

inline

Definition at line 95 of file itkGPUAnisotropicDiffusionFunction.h.

References m_ConductanceParameter.

Referenced by itk::GPUGradientNDAnisotropicDiffusionFunction< TImage >::InitializeIteration().

◆ 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.

◆ GetNameOfClass()

template<typename TImage>

const char * itk::GPUAnisotropicDiffusionFunction< TImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::GPUGradientNDAnisotropicDiffusionFunction< TImage >, and itk::GPUScalarAnisotropicDiffusionFunction< TImage >.

References GPUAnisotropicDiffusionFunction().

◆ GetTimeStep()

template<typename TImage>

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

inline

Definition at line 82 of file itkGPUAnisotropicDiffusionFunction.h.

References m_TimeStep.

Referenced by ComputeGlobalTimeStep().

◆ 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 >.

◆ 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::FiniteDifferenceFunction< TImage >.

Definition at line 147 of file itkGPUAnisotropicDiffusionFunction.h.

References m_ConductanceParameter, m_TimeStep, and itk::LightObject::PrintSelf().