ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::RegularizedHeavisideStepFunction< TInput, TOutput > Class Template Reference

#include <itkRegularizedHeavisideStepFunction.h>

Detailed Description

template<typename TInput = float, typename TOutput = double>
class itk::RegularizedHeavisideStepFunction< TInput, TOutput >

Base class of the Regularized (smoothed) Heaviside functions.

Author
Mosaliganti K., Smith B., Gelas A., Gouaillard A., Megason S.

This code was taken from the Insight Journal paper:

"Cell Tracking using Coupled Active Surfaces for Nuclei and Membranes"
https://doi.org/10.54294/wvwmf8

That is based on the papers:

"Level Set Segmentation: Active Contours without edge"
https://doi.org/10.54294/8jk6oy

and

"Level set segmentation using coupled active surfaces"
https://doi.org/10.54294/23ugmy

Definition at line 50 of file itkRegularizedHeavisideStepFunction.h.

+ Inheritance diagram for itk::RegularizedHeavisideStepFunction< TInput, TOutput >:
+ Collaboration diagram for itk::RegularizedHeavisideStepFunction< TInput, TOutput >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< InputType >::RealType
 
using Self = RegularizedHeavisideStepFunction
 
using Superclass = HeavisideStepFunctionBase< TInput, TOutput >
 
- Public Types inherited from itk::HeavisideStepFunctionBase< float, double >
using ConstPointer = SmartPointer< const Self >
 
using InputType = float
 
using OutputType = double
 
using Pointer = SmartPointer< Self >
 
using Self = HeavisideStepFunctionBase
 
using Superclass = FunctionBase< float, double >
 
- Public Types inherited from itk::FunctionBase< float, double >
using ConstPointer = SmartPointer< const Self >
 
using InputType = float
 
using OutputType = double
 
using Pointer = SmartPointer< Self >
 
using Self = FunctionBase
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual RealType GetEpsilon () const
 
virtual RealType GetOneOverEpsilon () const
 
void SetEpsilon (const RealType &ieps)
 
- Public Member Functions inherited from itk::HeavisideStepFunctionBase< float, double >
OutputType Evaluate (const InputType &input) const override=0
 
virtual OutputType EvaluateDerivative (const InputType &input) const=0
 
const char * GetNameOfClass () const override
 
virtual OutputType Evaluate (const InputType &input) const=0
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
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
 

Protected Member Functions

 RegularizedHeavisideStepFunction ()=default
 
 ~RegularizedHeavisideStepFunction () override=default
 
- Protected Member Functions inherited from itk::HeavisideStepFunctionBase< float, double >
 HeavisideStepFunctionBase ()
 
 ~HeavisideStepFunctionBase () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< float, double >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

RealType m_Epsilon { NumericTraits<RealType>::OneValue() }
 
RealType m_OneOverEpsilon { NumericTraits<RealType>::OneValue() }
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInput = float, typename TOutput = double>
using itk::RegularizedHeavisideStepFunction< TInput, TOutput >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkRegularizedHeavisideStepFunction.h.

◆ Pointer

template<typename TInput = float, typename TOutput = double>
using itk::RegularizedHeavisideStepFunction< TInput, TOutput >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkRegularizedHeavisideStepFunction.h.

◆ RealType

template<typename TInput = float, typename TOutput = double>
using itk::RegularizedHeavisideStepFunction< TInput, TOutput >::RealType = typename NumericTraits<InputType>::RealType

Definition at line 63 of file itkRegularizedHeavisideStepFunction.h.

◆ Self

template<typename TInput = float, typename TOutput = double>
using itk::RegularizedHeavisideStepFunction< TInput, TOutput >::Self = RegularizedHeavisideStepFunction

Definition at line 55 of file itkRegularizedHeavisideStepFunction.h.

◆ Superclass

template<typename TInput = float, typename TOutput = double>
using itk::RegularizedHeavisideStepFunction< TInput, TOutput >::Superclass = HeavisideStepFunctionBase<TInput, TOutput>

Definition at line 56 of file itkRegularizedHeavisideStepFunction.h.

Constructor & Destructor Documentation

◆ RegularizedHeavisideStepFunction()

template<typename TInput = float, typename TOutput = double>
itk::RegularizedHeavisideStepFunction< TInput, TOutput >::RegularizedHeavisideStepFunction ( )
protecteddefault

◆ ~RegularizedHeavisideStepFunction()

template<typename TInput = float, typename TOutput = double>
itk::RegularizedHeavisideStepFunction< TInput, TOutput >::~RegularizedHeavisideStepFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ GetEpsilon()

template<typename TInput = float, typename TOutput = double>
virtual RealType itk::RegularizedHeavisideStepFunction< TInput, TOutput >::GetEpsilon ( ) const
virtual

◆ GetOneOverEpsilon()

template<typename TInput = float, typename TOutput = double>
virtual RealType itk::RegularizedHeavisideStepFunction< TInput, TOutput >::GetOneOverEpsilon ( ) const
virtual

◆ SetEpsilon()

template<typename TInput = float, typename TOutput = double>
void itk::RegularizedHeavisideStepFunction< TInput, TOutput >::SetEpsilon ( const RealType ieps)

Member Data Documentation

◆ m_Epsilon

template<typename TInput = float, typename TOutput = double>
RealType itk::RegularizedHeavisideStepFunction< TInput, TOutput >::m_Epsilon { NumericTraits<RealType>::OneValue() }
private

Definition at line 76 of file itkRegularizedHeavisideStepFunction.h.

◆ m_OneOverEpsilon

template<typename TInput = float, typename TOutput = double>
RealType itk::RegularizedHeavisideStepFunction< TInput, TOutput >::m_OneOverEpsilon { NumericTraits<RealType>::OneValue() }
private

Definition at line 77 of file itkRegularizedHeavisideStepFunction.h.


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