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

#include <itkHeavisideStepFunction.h>

Detailed Description

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

Implementation of the classical Heaviside step function.

The Heaviside Step function is a piece-wise function:

https://en.wikipedia.org/wiki/Heaviside_step_function
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 56 of file itkHeavisideStepFunction.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = HeavisideStepFunction
 
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

OutputType Evaluate (const InputType &input) const override
 
OutputType EvaluateDerivative (const InputType &input) const override
 
const char * GetNameOfClass () const override
 
- 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
 

Static Public Member Functions

static Pointer New ()
 
- 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 Member Functions

 HeavisideStepFunction ()=default
 
 ~HeavisideStepFunction () 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 ()
 

Additional Inherited Members

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

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 64 of file itkHeavisideStepFunction.h.

◆ Pointer

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

Definition at line 63 of file itkHeavisideStepFunction.h.

◆ Self

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

Definition at line 61 of file itkHeavisideStepFunction.h.

◆ Superclass

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

Definition at line 62 of file itkHeavisideStepFunction.h.

Constructor & Destructor Documentation

◆ HeavisideStepFunction()

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

◆ ~HeavisideStepFunction()

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

Member Function Documentation

◆ Evaluate()

template<typename TInput = float, typename TOutput = double>
OutputType itk::HeavisideStepFunction< TInput, TOutput >::Evaluate ( const InputType input) const
overridevirtual

Evaluate at the specified input position

Implements itk::HeavisideStepFunctionBase< float, double >.

◆ EvaluateDerivative()

template<typename TInput = float, typename TOutput = double>
OutputType itk::HeavisideStepFunction< TInput, TOutput >::EvaluateDerivative ( const InputType input) const
overridevirtual

Evaluate the derivative at the specified input position

Implements itk::HeavisideStepFunctionBase< float, double >.

◆ GetNameOfClass()

template<typename TInput = float, typename TOutput = double>
const char * itk::HeavisideStepFunction< TInput, TOutput >::GetNameOfClass ( ) const
overridevirtual

Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information.

Reimplemented from itk::LightObject.

◆ New()

template<typename TInput = float, typename TOutput = double>
static Pointer itk::HeavisideStepFunction< TInput, TOutput >::New ( )
static

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