ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::BinaryMinMaxCurvatureFlowFunction< TImage > Class Template Reference

#include <itkBinaryMinMaxCurvatureFlowFunction.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FloatOffsetType = typename Superclass::FloatOffsetType
 
using ImageType = typename Superclass::ImageType
 
using NeighborhoodType = typename Superclass::NeighborhoodType
 
using PixelType = typename Superclass::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename Superclass::RadiusType
 
using Self = BinaryMinMaxCurvatureFlowFunction
 
using Superclass = MinMaxCurvatureFlowFunction< TImage >
 
- Public Types inherited from itk::MinMaxCurvatureFlowFunction< TImage >
using ConstPointer = SmartPointer< const Self >
 
using FloatOffsetType = typename Superclass::FloatOffsetType
 
using ImageType = typename Superclass::ImageType
 
using NeighborhoodType = typename Superclass::NeighborhoodType
 
using PixelType = typename Superclass::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename Superclass::RadiusType
 
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 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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::MinMaxCurvatureFlowFunction< TImage >
PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
const RadiusValueTypeGetRadiusValueType () const
 
const RadiusValueTypeGetStencilRadius () const
 
void SetStencilRadius (const RadiusValueType radius)
 
- Public Member Functions inherited from itk::CurvatureFlowFunction< TImage >
TimeStepType ComputeGlobalTimeStep (void *GlobalData) const override
 
PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override
 
void * GetGlobalDataPointer () const override
 
const TimeStepTypeGetTimeStep () 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 RadiusTypeGetRadius () 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::MinMaxCurvatureFlowFunction< TImage >
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::MinMaxCurvatureFlowFunction< TImage >
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
 
double m_Threshold
 
void SetThreshold (const double thresh)
 
const double & GetThreshold () const
 
PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override
 
 BinaryMinMaxCurvatureFlowFunction ()
 
 ~BinaryMinMaxCurvatureFlowFunction () override=default
 

Additional Inherited Members

- Protected Types inherited from itk::MinMaxCurvatureFlowFunction< TImage >
using StencilOperatorType = Neighborhood< PixelType, Self::ImageDimension >
 
- Protected Member Functions inherited from itk::MinMaxCurvatureFlowFunction< TImage >
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 inherited from itk::MinMaxCurvatureFlowFunction< TImage >
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
 

Detailed Description

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

This class encapsulate the finite difference equation which drives a min/max curvature flow algorithm for denoising binary images.

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
BinaryMinMaxCurvatureFlowImageFilter
ZeroFluxNeumannBoundaryCondition

Definition at line 43 of file itkBinaryMinMaxCurvatureFlowFunction.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 52 of file itkBinaryMinMaxCurvatureFlowFunction.h.

◆ FloatOffsetType

template<typename TImage >
using itk::BinaryMinMaxCurvatureFlowFunction< TImage >::FloatOffsetType = typename Superclass::FloatOffsetType

Definition at line 64 of file itkBinaryMinMaxCurvatureFlowFunction.h.

◆ ImageType

template<typename TImage >
using itk::BinaryMinMaxCurvatureFlowFunction< TImage >::ImageType = typename Superclass::ImageType

Definition at line 65 of file itkBinaryMinMaxCurvatureFlowFunction.h.

◆ NeighborhoodType

template<typename TImage >
using itk::BinaryMinMaxCurvatureFlowFunction< TImage >::NeighborhoodType = typename Superclass::NeighborhoodType

Definition at line 63 of file itkBinaryMinMaxCurvatureFlowFunction.h.

◆ PixelType

template<typename TImage >
using itk::BinaryMinMaxCurvatureFlowFunction< TImage >::PixelType = typename Superclass::PixelType

Inherit some parameters from the superclass type.

Definition at line 61 of file itkBinaryMinMaxCurvatureFlowFunction.h.

◆ Pointer

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

Definition at line 51 of file itkBinaryMinMaxCurvatureFlowFunction.h.

◆ RadiusType

template<typename TImage >
using itk::BinaryMinMaxCurvatureFlowFunction< TImage >::RadiusType = typename Superclass::RadiusType

Definition at line 62 of file itkBinaryMinMaxCurvatureFlowFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 49 of file itkBinaryMinMaxCurvatureFlowFunction.h.

◆ Superclass

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

Definition at line 50 of file itkBinaryMinMaxCurvatureFlowFunction.h.

Constructor & Destructor Documentation

◆ BinaryMinMaxCurvatureFlowFunction()

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

Set/Get the threshold value.

◆ ~BinaryMinMaxCurvatureFlowFunction()

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

Set/Get the threshold value.

Member Function Documentation

◆ ComputeUpdate()

template<typename TImage >
PixelType itk::BinaryMinMaxCurvatureFlowFunction< 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.

◆ CreateAnother()

template<typename TImage >
virtual::itk::LightObject::Pointer itk::BinaryMinMaxCurvatureFlowFunction< 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.

◆ GetNameOfClass()

template<typename TImage >
virtual const char* itk::BinaryMinMaxCurvatureFlowFunction< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

Reimplemented from itk::MinMaxCurvatureFlowFunction< TImage >.

◆ GetThreshold()

template<typename TImage >
const double& itk::BinaryMinMaxCurvatureFlowFunction< TImage >::GetThreshold ( ) const
inline

Set/Get the threshold value.

Definition at line 77 of file itkBinaryMinMaxCurvatureFlowFunction.h.

◆ New()

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

Method for creation through the object factory.

◆ SetThreshold()

template<typename TImage >
void itk::BinaryMinMaxCurvatureFlowFunction< TImage >::SetThreshold ( const double  thresh)
inline

Set/Get the threshold value.

Definition at line 72 of file itkBinaryMinMaxCurvatureFlowFunction.h.

Member Data Documentation

◆ ImageDimension

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

Extract superclass dimension.

Definition at line 68 of file itkBinaryMinMaxCurvatureFlowFunction.h.

◆ m_Threshold

template<typename TImage >
double itk::BinaryMinMaxCurvatureFlowFunction< TImage >::m_Threshold
private

Set/Get the threshold value.

Definition at line 95 of file itkBinaryMinMaxCurvatureFlowFunction.h.


The documentation for this class was generated from the following file: