#include <itkScalarAnisotropicDiffusionFunction.h>

Detailed Description

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

This class forms the base for any anisotropic diffusion function that operates on scalar data (see itkAnisotropicDiffusionFunction). It provides some common functionality used in classes like CurvatureNDAnisotropicDiffusionFunction and GradientNDAnisotropicDiffusionFunction.

See also: AnisotropicDiffusionFunction; AnisotropicDiffusionImageFilter; VectorAnisotropicDiffusionFunction

Definition at line 41 of file itkScalarAnisotropicDiffusionFunction.h.

Inheritance diagram for itk::ScalarAnisotropicDiffusionFunction< TImage >:

Collaboration diagram for itk::ScalarAnisotropicDiffusionFunction< TImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = ScalarAnisotropicDiffusionFunction

using	Superclass = AnisotropicDiffusionFunction< TImage >

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

using	PixelrealType = typename Superclass::PixelRealType

using	Pointer = SmartPointer< Self >

using	Self = AnisotropicDiffusionFunction

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
void	CalculateAverageGradientMagnitudeSquared (TImage *) override

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::AnisotropicDiffusionFunction< TImage >
TimeStepType	ComputeGlobalTimeStep (void *) const override

const double &	GetAverageGradientMagnitudeSquared () const

const double &	GetConductanceParameter () const

void *	GetGlobalDataPointer () const override

const TimeStepType &	GetTimeStep () const

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::FiniteDifferenceFunction< TImage >
const NeighborhoodScalesType	ComputeNeighborhoodScales () const

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

const char *	GetNameOfClass () const override

const RadiusType &	GetRadius () const

void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const

virtual void	InitializeIteration ()

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

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

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

Protected Member Functions
	ScalarAnisotropicDiffusionFunction ()=default

	~ScalarAnisotropicDiffusionFunction () override=default

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

void	PrintSelf (std::ostream &os, Indent indent) const override

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

Additional Inherited Members
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

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

Member Typedef Documentation

◆ ConstPointer

template<typename TImage >

using itk::ScalarAnisotropicDiffusionFunction< TImage >::ConstPointer = SmartPointer<const Self>

Definition at line 50 of file itkScalarAnisotropicDiffusionFunction.h.

◆ Pointer

template<typename TImage >

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

Definition at line 49 of file itkScalarAnisotropicDiffusionFunction.h.

◆ Self

template<typename TImage >

using itk::ScalarAnisotropicDiffusionFunction< TImage >::Self = ScalarAnisotropicDiffusionFunction

Standard class type aliases.

Definition at line 47 of file itkScalarAnisotropicDiffusionFunction.h.

◆ Superclass

template<typename TImage >

using itk::ScalarAnisotropicDiffusionFunction< TImage >::Superclass = AnisotropicDiffusionFunction<TImage>

Definition at line 48 of file itkScalarAnisotropicDiffusionFunction.h.

Constructor & Destructor Documentation

◆ ScalarAnisotropicDiffusionFunction()

template<typename TImage >

itk::ScalarAnisotropicDiffusionFunction< TImage >::ScalarAnisotropicDiffusionFunction ( )

protecteddefault

◆ ~ScalarAnisotropicDiffusionFunction()

template<typename TImage >

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

overrideprotecteddefault

Member Function Documentation

◆ CalculateAverageGradientMagnitudeSquared()

template<typename TImage >

void itk::ScalarAnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared ( TImage * )

overridevirtual

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.

Implements itk::AnisotropicDiffusionFunction< TImage >.