#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 [88] that is based on the papers [87] and [86].

Definition at line 44 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

typedef float	InputType

using	InputType

typedef double	OutputType

using	OutputType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::FunctionBase< float, double >
using	ConstPointer

using	InputType

using	OutputType

using	Pointer

using	Self

using	Superclass

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::itk::LightObject::Pointer	CreateAnother () const

OutputType	Evaluate (const InputType &input) const override

OutputType	EvaluateDerivative (const InputType &input) const override

virtual const char *	GetNameOfClass () const

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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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 void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

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	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 52 of file itkHeavisideStepFunction.h.

◆ Pointer

template<typename TInput = float, typename TOutput = double>

using itk::HeavisideStepFunction< TInput, TOutput >::Pointer = SmartPointer<Self>

Definition at line 51 of file itkHeavisideStepFunction.h.

◆ Self

template<typename TInput = float, typename TOutput = double>

using itk::HeavisideStepFunction< TInput, TOutput >::Self = HeavisideStepFunction

Definition at line 49 of file itkHeavisideStepFunction.h.

◆ Superclass

template<typename TInput = float, typename TOutput = double>

using itk::HeavisideStepFunction< TInput, TOutput >::Superclass = HeavisideStepFunctionBase<TInput, TOutput>

Definition at line 50 of file itkHeavisideStepFunction.h.

Constructor & Destructor Documentation

◆ HeavisideStepFunction()

template<typename TInput = float, typename TOutput = double>

itk::HeavisideStepFunction< TInput, TOutput >::HeavisideStepFunction ( )

protecteddefault

Referenced by GetNameOfClass().

◆ ~HeavisideStepFunction()

template<typename TInput = float, typename TOutput = double>

itk::HeavisideStepFunction< TInput, TOutput >::~HeavisideStepFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInput = float, typename TOutput = double>

virtual::itk::LightObject::Pointer itk::HeavisideStepFunction< TInput, TOutput >::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.

◆ 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>

virtual const char * itk::HeavisideStepFunction< TInput, TOutput >::GetNameOfClass ( ) const

virtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::HeavisideStepFunctionBase< float, double >.

References HeavisideStepFunction().

◆ 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:

itkHeavisideStepFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ HeavisideStepFunction()

◆ ~HeavisideStepFunction()

Member Function Documentation

◆ CreateAnother()

◆ Evaluate()

◆ EvaluateDerivative()

◆ GetNameOfClass()

◆ New()