#include <itkCurvatureFlowFunction.h>

Inheritance diagram for itk::CurvatureFlowFunction< TImage >:

Collaboration diagram for itk::CurvatureFlowFunction< TImage >:

Detailed Description

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

This class encapsulate the finite difference equation which drives a curvature flow denoising algorithm.

This class uses a zero flux Neumann boundary condition when computing derivatives near the data boundary.

This class operates as part of the finite difference solver hierarchy.

See Also: CurvatureFlowImageFilter; ZeroFluxNeumannBoundaryCondition

Definition at line 43 of file itkCurvatureFlowFunction.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	FloatOffsetType = typename Superclass::FloatOffsetType

using	ImageType = typename Superclass::ImageType

using	NeighborhoodScalesType = typename Superclass::NeighborhoodScalesType

using	NeighborhoodType = typename Superclass::NeighborhoodType

using	PixelRealType = typename Superclass::PixelRealType

using	PixelType = typename Superclass::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename Superclass::RadiusType

using	ScalarValueType = PixelType

using	Self = CurvatureFlowFunction

using	Superclass = FiniteDifferenceFunction< TImage >

using	TimeStepType = typename Superclass::TimeStepType

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 *GlobalData) const override

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

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

void *	GetGlobalDataPointer () const override

virtual const char *	GetNameOfClass () const

const TimeStepType &	GetTimeStep () const

void	ReleaseGlobalDataPointer (void *GlobalData) const override

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 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::FiniteDifferenceFunction< TImage >
static constexpr unsigned int	ImageDimension

Protected Member Functions
	CurvatureFlowFunction ()

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

Private Attributes
TimeStepType	m_TimeStep

Additional Inherited Members
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

template<typename TImage >

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

Definition at line 53 of file itkCurvatureFlowFunction.h.

template<typename TImage >

using itk::CurvatureFlowFunction< TImage >::FloatOffsetType = typename Superclass::FloatOffsetType

Definition at line 70 of file itkCurvatureFlowFunction.h.

template<typename TImage >

using itk::CurvatureFlowFunction< TImage >::ImageType = typename Superclass::ImageType

Inherit some parameters from the superclass type.

Definition at line 63 of file itkCurvatureFlowFunction.h.

template<typename TImage >

using itk::CurvatureFlowFunction< TImage >::NeighborhoodScalesType = typename Superclass::NeighborhoodScalesType

Definition at line 69 of file itkCurvatureFlowFunction.h.

template<typename TImage >

using itk::CurvatureFlowFunction< TImage >::NeighborhoodType = typename Superclass::NeighborhoodType

Definition at line 68 of file itkCurvatureFlowFunction.h.

template<typename TImage >

using itk::CurvatureFlowFunction< TImage >::PixelRealType = typename Superclass::PixelRealType

Definition at line 67 of file itkCurvatureFlowFunction.h.

template<typename TImage >

using itk::CurvatureFlowFunction< TImage >::PixelType = typename Superclass::PixelType

Definition at line 64 of file itkCurvatureFlowFunction.h.

template<typename TImage >

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

Definition at line 52 of file itkCurvatureFlowFunction.h.

template<typename TImage >

using itk::CurvatureFlowFunction< TImage >::RadiusType = typename Superclass::RadiusType

Definition at line 65 of file itkCurvatureFlowFunction.h.

template<typename TImage >

using itk::CurvatureFlowFunction< TImage >::ScalarValueType = PixelType

Definition at line 66 of file itkCurvatureFlowFunction.h.

template<typename TImage >

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

Standard class type aliases.

Definition at line 50 of file itkCurvatureFlowFunction.h.

template<typename TImage >

using itk::CurvatureFlowFunction< TImage >::Superclass = FiniteDifferenceFunction< TImage >

Definition at line 51 of file itkCurvatureFlowFunction.h.

template<typename TImage >

using itk::CurvatureFlowFunction< TImage >::TimeStepType = typename Superclass::TimeStepType

Definition at line 71 of file itkCurvatureFlowFunction.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::CurvatureFlowFunction< TImage >::CurvatureFlowFunction ( )

protected

template<typename TImage >

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

overrideprotecteddefault

Member Function Documentation

template<typename TImage >

TimeStepType itk::CurvatureFlowFunction< TImage >::ComputeGlobalTimeStep ( void * GlobalData ) const

overridevirtual

Computes the time step for an update given a global data structure. The data used in the computation may take different forms depending on the nature of the equations. This global data cannot be kept in the instance of the equation object itself since the equation object must remain stateless for thread safety. The global data is therefore managed for each thread by the finite difference solver filters.

Currently, this function returns the user specified constant time step.

Todo:: compute timestep based on CFL condition.

Implements itk::FiniteDifferenceFunction< TImage >.

template<typename TImage >

PixelType itk::CurvatureFlowFunction< TImage >::ComputeUpdate	(	const NeighborhoodType &	neighborhood,
		void *	globalData,
		const FloatOffsetType &	offset = `FloatOffsetType(0.0)`
	)

override

This method computes the solution update for each pixel that does not lie on a the data set boundary.

template<typename TImage >

virtual::itk::LightObject::Pointer itk::CurvatureFlowFunction< TImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

Reimplemented in itk::MinMaxCurvatureFlowFunction< TImage >.

template<typename TImage >

void* itk::CurvatureFlowFunction< TImage >::GetGlobalDataPointer ( ) const

inlineoverridevirtual

Returns a pointer to a global data structure that is passed to this object from the solver at each calculation. The idea is that the solver holds the state of any global values needed to calculate the time step, while the equation object performs the actual calculations. The global data should also be initialized in this method.

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 93 of file itkCurvatureFlowFunction.h.

template<typename TImage >

virtual const char* itk::CurvatureFlowFunction< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Reimplemented in itk::MinMaxCurvatureFlowFunction< TImage >.

template<typename TImage >

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

inline

Get the time step parameter

Definition at line 113 of file itkCurvatureFlowFunction.h.

template<typename TImage >

static Pointer itk::CurvatureFlowFunction< TImage >::New ( )

static

Method for creation through the object factory.

template<typename TImage >

void itk::CurvatureFlowFunction< TImage >::ReleaseGlobalDataPointer ( void * GlobalData ) const

inlineoverridevirtual

When the finite difference solver filter has finished using a global data pointer, it passes it to this method, which frees the memory. The solver cannot free the memory because it does not know the type to which the pointer points.

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 105 of file itkCurvatureFlowFunction.h.

template<typename TImage >

void itk::CurvatureFlowFunction< TImage >::SetTimeStep ( const TimeStepType & t )

inline

Set the time step parameter

Definition at line 109 of file itkCurvatureFlowFunction.h.