ITK  6.0.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
itk::MinMaxCurvatureFlowFunction< TImage > Class Template Reference
Data Processing Objects » Functions » Finite Difference FunctionsGroup Filtering » | Module ITKCurvatureFlow

#include <itkMinMaxCurvatureFlowFunction.h>

Detailed Description

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

This class encapsulate the finite difference equation which drives a min/max 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
MinMaxCurvatureFlowImageFilter
ZeroFluxNeumannBoundaryCondition

Definition at line 43 of file itkMinMaxCurvatureFlowFunction.h.

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

Classes

struct  Dispatch
 
struct  DispatchBase
 

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using RadiusValueType = typename RadiusType::SizeValueType
 
using Self = MinMaxCurvatureFlowFunction
 
using Superclass = CurvatureFlowFunction< TImage >
 
- Public Types inherited from itk::CurvatureFlowFunction< TImage >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using ScalarValueType = PixelType
 
using Self = CurvatureFlowFunction
 
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

PixelType ComputeUpdate (const NeighborhoodType &it, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override
 
const char * GetNameOfClass () const override
 
const RadiusValueType & GetRadiusValueType () const
 
const RadiusValueType & GetStencilRadius () const
 
void SetStencilRadius (const RadiusValueType value)
 
- Public Member Functions inherited from itk::CurvatureFlowFunction< TImage >
TimeStepType ComputeGlobalTimeStep (void *GlobalData) const override
 
void * GetGlobalDataPointer () const override
 
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
 
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 Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::CurvatureFlowFunction< TImage >
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::CurvatureFlowFunction< TImage >
static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceFunction< TImage >
static constexpr unsigned int ImageDimension
 

Protected Types

using StencilOperatorType = Neighborhood< PixelType, Self::ImageDimension >
 

Protected Member Functions

void InitializeStencilOperator ()
 
 MinMaxCurvatureFlowFunction ()
 
 ~MinMaxCurvatureFlowFunction () override=default
 
- Protected Member Functions inherited from itk::CurvatureFlowFunction< TImage >
 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 ()
 

Protected Attributes

StencilOperatorType m_StencilOperator {}
 
- 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 Member Functions

PixelType ComputeThreshold (const Dispatch< 2 > &, const NeighborhoodType &it) const
 
PixelType ComputeThreshold (const Dispatch< 3 > &, const NeighborhoodType &it) const
 
PixelType ComputeThreshold (const DispatchBase &, const NeighborhoodType &it) const
 

Private Attributes

RadiusValueType m_StencilRadius {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 52 of file itkMinMaxCurvatureFlowFunction.h.

◆ Pointer

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

Definition at line 51 of file itkMinMaxCurvatureFlowFunction.h.

◆ RadiusValueType

template<typename TImage >
using itk::MinMaxCurvatureFlowFunction< TImage >::RadiusValueType = typename RadiusType::SizeValueType

Typedef support for the stencil radius.

Definition at line 71 of file itkMinMaxCurvatureFlowFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 49 of file itkMinMaxCurvatureFlowFunction.h.

◆ StencilOperatorType

template<typename TImage >
using itk::MinMaxCurvatureFlowFunction< TImage >::StencilOperatorType = Neighborhood<PixelType, Self::ImageDimension>
protected

Definition at line 100 of file itkMinMaxCurvatureFlowFunction.h.

◆ Superclass

template<typename TImage >
using itk::MinMaxCurvatureFlowFunction< TImage >::Superclass = CurvatureFlowFunction<TImage>

Definition at line 50 of file itkMinMaxCurvatureFlowFunction.h.

Constructor & Destructor Documentation

◆ MinMaxCurvatureFlowFunction()

template<typename TImage >
itk::MinMaxCurvatureFlowFunction< TImage >::MinMaxCurvatureFlowFunction ( )
protected

◆ ~MinMaxCurvatureFlowFunction()

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

Member Function Documentation

◆ ComputeThreshold() [1/3]

template<typename TImage >
PixelType itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold ( const Dispatch< 2 > &  ,
const NeighborhoodType &  it 
) const
private

Compute the threshold by averaging the intensity in direction perpendicular to the image gradient.

◆ ComputeThreshold() [2/3]

template<typename TImage >
PixelType itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold ( const Dispatch< 3 > &  ,
const NeighborhoodType &  it 
) const
private

◆ ComputeThreshold() [3/3]

template<typename TImage >
PixelType itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold ( const DispatchBase &  ,
const NeighborhoodType &  it 
) const
private

◆ ComputeUpdate()

template<typename TImage >
PixelType itk::MinMaxCurvatureFlowFunction< TImage >::ComputeUpdate ( const NeighborhoodType &  it,
void *  globalData,
const FloatOffsetType &  offset = FloatOffsetType(0.0) 
)
overridevirtual

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

Reimplemented from itk::CurvatureFlowFunction< TImage >.

◆ GetNameOfClass()

template<typename TImage >
const char* itk::MinMaxCurvatureFlowFunction< TImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::CurvatureFlowFunction< TImage >.

◆ GetRadiusValueType()

template<typename TImage >
const RadiusValueType& itk::MinMaxCurvatureFlowFunction< TImage >::GetRadiusValueType ( ) const
inline

Definition at line 78 of file itkMinMaxCurvatureFlowFunction.h.

◆ GetStencilRadius()

template<typename TImage >
const RadiusValueType& itk::MinMaxCurvatureFlowFunction< TImage >::GetStencilRadius ( ) const
inline

Convenience function for symmetry with SetStencilRadius.

Definition at line 85 of file itkMinMaxCurvatureFlowFunction.h.

◆ InitializeStencilOperator()

template<typename TImage >
void itk::MinMaxCurvatureFlowFunction< TImage >::InitializeStencilOperator ( )
protected

Initialize the stencil operator to be an N-Dimensional sphere of radius m_StencilRadius.

◆ New()

template<typename TImage >
static Pointer itk::MinMaxCurvatureFlowFunction< TImage >::New ( )
static

Method for creation through the object factory.

◆ SetStencilRadius()

template<typename TImage >
void itk::MinMaxCurvatureFlowFunction< TImage >::SetStencilRadius ( const RadiusValueType  value)

Set/Get the stencil radius.

Member Data Documentation

◆ ImageDimension

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

Extract superclass dimension.

Definition at line 68 of file itkMinMaxCurvatureFlowFunction.h.

◆ m_StencilOperator

template<typename TImage >
StencilOperatorType itk::MinMaxCurvatureFlowFunction< TImage >::m_StencilOperator {}
protected

Definition at line 101 of file itkMinMaxCurvatureFlowFunction.h.

◆ m_StencilRadius

template<typename TImage >
RadiusValueType itk::MinMaxCurvatureFlowFunction< TImage >::m_StencilRadius {}
private

Definition at line 109 of file itkMinMaxCurvatureFlowFunction.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16