#include <itkNormalVectorDiffusionFunction.h>

Inheritance diagram for itk::NormalVectorDiffusionFunction< TSparseImageType >:

Collaboration diagram for itk::NormalVectorDiffusionFunction< TSparseImageType >:

Detailed Description

template<typename TSparseImageType>
class itk::NormalVectorDiffusionFunction< TSparseImageType >

This class defines all the necessary functionality for performing isotropic and anisotropic diffusion operations on vector neighborhoods from a sparse image.

: This class implements the actual computations for performing isotropic and anisotropic diffusion operations on a neighborhood of unit length vectors. Moreover, this processing is intrinsic to a manifold as specified by the ManifoldNormal member variables in the nodes of the sparse image.

: Since the only difference between isotropic and anisotropic diffusion is the exectution of 1 extra line of code, we have implemented both in this class and made the choice between the two depend on a parameter (see below).

PARAMETERS: The choice between is isotropic/anisotropic diffusion is made by the parameter NormalProcessType. A value of 0 corresponds to isotropic diffusion whereas a value of 1 corresponds to anisotropic diffusion. If anisotropic diffusion is chosen, the parameter ConductanceParameter should be set. This conductance parameter determines the level of feature preservation.

IMPORTANT: This class works on SparseImage neighborhoods. Before using this class please read the documentation for SparseImage. Also the documentation for ImplicitManifoldNormalVectorField class will be helpful in understanding how to use this class as a function object.

Definition at line 60 of file itkNormalVectorDiffusionFunction.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	FloatOffsetType = typename Superclass::FloatOffsetType

using	IndexType = typename Superclass::IndexType

using	NeighborhoodScalesType = typename Superclass::NeighborhoodScalesType

using	NeighborhoodType = typename Superclass::NeighborhoodType

using	NodeType = typename Superclass::NodeType

using	NodeValueType = typename Superclass::NodeValueType

using	NormalVectorType = typename Superclass::NormalVectorType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename Superclass::RadiusType

using	Self = NormalVectorDiffusionFunction

using	SparseImageType = typename Superclass::SparseImageType

using	Superclass = NormalVectorFunctionBase< TSparseImageType >

using	TimeStepType = typename Superclass::TimeStepType

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

using	FloatOffsetType = typename Superclass::FloatOffsetType

using	IndexType = typename Superclass::IndexType

using	NeighborhoodType = typename Superclass::NeighborhoodType

using	NodeType = typename SparseImageType::NodeType

using	NodeValueType = typename NodeType::NodeValueType

using	NormalVectorType = typename NodeType::NodeDataType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename Superclass::RadiusType

using	Self = NormalVectorFunctionBase

using	SparseImageType = typename Superclass::SparseImageType

using	Superclass = FiniteDifferenceSparseImageFunction< TSparseImageType >

using	TimeStepType = typename Superclass::TimeStepType

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

using	FloatOffsetType = typename Superclass::FloatOffsetType

using	IndexType = typename SparseImageType::IndexType

using	NeighborhoodType = typename Superclass::NeighborhoodType

using	NodeDataType = typename NodeType::NodeDataType

using	NodeType = typename SparseImageType::NodeType

using	PixelType = typename Superclass::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename Superclass::RadiusType

using	Self = FiniteDifferenceSparseImageFunction

using	SparseImageType = typename Superclass::ImageType

using	Superclass = FiniteDifferenceFunction< TSparseImageType >

using	TimeStepType = typename Superclass::TimeStepType

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

using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< ImageType >

using	FloatOffsetType = Vector< float, Self::ImageDimension >

using	ImageType = TSparseImageType

using	NeighborhoodScalesType = Vector< PixelRealType, Self::ImageDimension >

using	NeighborhoodType = ConstNeighborhoodIterator< TSparseImageType, DefaultBoundaryConditionType >

using	PixelRealType = double

using	PixelType = typename ImageType::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename ConstNeighborhoodIterator< TSparseImageType >::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
NormalVectorType	ComputeSparseUpdate (NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset) const override

virtual ::itk::LightObject::Pointer	CreateAnother () const

NodeValueType	GetConductanceParameter () const

NodeValueType	GetFluxStopConstant () const

virtual const char *	GetNameOfClass () const

int	GetNormalProcessType () const

void	PrecomputeSparseUpdate (NeighborhoodType &it) const override

void	SetNormalProcessType (int npt)


void	SetConductanceParameter (NodeValueType cp)

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

TimeStepType	GetTimeStep () const

void	SetTimeStep (const TimeStepType &ts)

void *	GetGlobalDataPointer () const override

void	ReleaseGlobalDataPointer (void *) const override

Public Member Functions inherited from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >
PixelType	ComputeUpdate (const NeighborhoodType &, void *, const FloatOffsetType &) override

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

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

const RadiusType &	GetRadius () const

void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const

virtual void	InitializeIteration ()

void	SetRadius (const RadiusType &r)

void	SetScaleCoefficients (PixelRealType vals[ImageDimension])

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

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

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

Protected Member Functions
	NormalVectorDiffusionFunction ()

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

	~NormalVectorDiffusionFunction () override=default


NodeValueType	FluxStopFunction (const NodeValueType v) const

Protected Member Functions inherited from itk::NormalVectorFunctionBase< TSparseImageType >
	NormalVectorFunctionBase ()

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

	~NormalVectorFunctionBase () override=default

Protected Member Functions inherited from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >
	FiniteDifferenceSparseImageFunction ()=default

	~FiniteDifferenceSparseImageFunction () override=default

Protected Member Functions inherited from itk::FiniteDifferenceFunction< TSparseImageType >
	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 ()

Private Attributes
NodeValueType	m_ConductanceParameter

NodeValueType	m_FluxStopConstant

int	m_NormalProcessType

Additional Inherited Members
Protected Attributes inherited from itk::FiniteDifferenceFunction< TSparseImageType >
RadiusType	m_Radius

PixelRealType	m_ScaleCoefficients [ImageDimension]

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