itk::HardLimiterFunction< TInput, NDimension > Class Template Reference

#include <itkHardLimiterFunction.h>

Detailed Description

template<class TInput, unsigned int NDimension>
class itk::HardLimiterFunction< TInput, NDimension >

A hard limiter.

If the input value exceeds the upper/lower bound the output is set to the upper/lower bound and the derivative is filled with zeros.

See also

LimiterFunctionBase, ExponentialLimiterFunction

Definition at line 39 of file itkHardLimiterFunction.h.

Inheritance diagram for itk::HardLimiterFunction< TInput, NDimension >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	DerivativeType = CovariantVector< DerivativeValueType, Self::Dimension >
using	DerivativeValueType = OutputType
using	Pointer = SmartPointer< Self >
using	Self = HardLimiterFunction
using	Superclass = LimiterFunctionBase< TInput, NDimension >
Public Types inherited from itk::LimiterFunctionBase< TInput, NDimension >
using	ConstPointer = SmartPointer< const Self >
using	DerivativeType = CovariantVector< DerivativeValueType, Self::Dimension >
using	DerivativeValueType = OutputType
using	Pointer = SmartPointer< Self >
using	Self = LimiterFunctionBase
using	Superclass = FunctionBase< TInput, typename NumericTraits< TInput >::RealType >

Public Member Functions
OutputType	Evaluate (const InputType &input) const override
OutputType	Evaluate (const InputType &input, DerivativeType &derivative) const override
virtual const char *	GetClassName () const
	ITK_DISALLOW_COPY_AND_MOVE (HardLimiterFunction)
	itkStaticConstMacro (Dimension, unsigned int, Superclass::Dimension)
Public Member Functions inherited from itk::LimiterFunctionBase< TInput, NDimension >
OutputType	Evaluate (const InputType &input) const override=0
virtual OutputType	Evaluate (const InputType &input, DerivativeType &derivative) const =0
virtual const char *	GetClassName () const
virtual OutputType	GetLowerBound () const
virtual InputType	GetLowerThreshold () const
virtual OutputType	GetUpperBound () const
virtual InputType	GetUpperThreshold () const
virtual void	Initialize ()
	ITK_DISALLOW_COPY_AND_MOVE (LimiterFunctionBase)
	itkStaticConstMacro (Dimension, unsigned int, NDimension)
virtual void	SetLowerBound (OutputType _arg)
virtual void	SetLowerThreshold (InputType _arg)
virtual void	SetUpperBound (OutputType _arg)
virtual void	SetUpperThreshold (InputType _arg)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	HardLimiterFunction ()=default
	~HardLimiterFunction () override=default
Protected Member Functions inherited from itk::LimiterFunctionBase< TInput, NDimension >
	LimiterFunctionBase ()
	~LimiterFunctionBase () override=default

Additional Inherited Members
Protected Attributes inherited from itk::LimiterFunctionBase< TInput, NDimension >
OutputType	m_LowerBound
InputType	m_LowerThreshold
OutputType	m_UpperBound
InputType	m_UpperThreshold

Member Typedef Documentation

ConstPointer

template<class TInput , unsigned int NDimension>

using itk::HardLimiterFunction< TInput, NDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 48 of file itkHardLimiterFunction.h.

DerivativeType

template<class TInput , unsigned int NDimension>

using itk::LimiterFunctionBase< TInput, NDimension >::DerivativeType = CovariantVector<DerivativeValueType, Self::Dimension>

Definition at line 71 of file itkLimiterFunctionBase.h.

DerivativeValueType

template<class TInput , unsigned int NDimension>

using itk::LimiterFunctionBase< TInput, NDimension >::DerivativeValueType = OutputType

Definition at line 70 of file itkLimiterFunctionBase.h.

Pointer

template<class TInput , unsigned int NDimension>

using itk::HardLimiterFunction< TInput, NDimension >::Pointer = SmartPointer<Self>

Definition at line 47 of file itkHardLimiterFunction.h.

Self

template<class TInput , unsigned int NDimension>

using itk::HardLimiterFunction< TInput, NDimension >::Self = HardLimiterFunction

Standard class typedefs.

Definition at line 45 of file itkHardLimiterFunction.h.

Superclass

template<class TInput , unsigned int NDimension>

using itk::HardLimiterFunction< TInput, NDimension >::Superclass = LimiterFunctionBase<TInput, NDimension>

Definition at line 46 of file itkHardLimiterFunction.h.

Constructor & Destructor Documentation

HardLimiterFunction()

template<class TInput , unsigned int NDimension>

itk::HardLimiterFunction< TInput, NDimension >::HardLimiterFunction ( )

protecteddefault

~HardLimiterFunction()

template<class TInput , unsigned int NDimension>

itk::HardLimiterFunction< TInput, NDimension >::~HardLimiterFunction ( )

overrideprotecteddefault

Member Function Documentation

Evaluate() [1/2]

template<class TInput , unsigned int NDimension>

OutputType itk::HardLimiterFunction< TInput, NDimension >::Evaluate ( const InputType &  input ) const

overridevirtual

Limit the input value

Implements itk::LimiterFunctionBase< TInput, NDimension >.

Evaluate() [2/2]

template<class TInput , unsigned int NDimension>

OutputType itk::HardLimiterFunction< TInput, NDimension >::Evaluate ( const InputType &  input, DerivativeType &  derivative  ) const

overridevirtual

Limit the input value and change the input function derivative accordingly

Implements itk::LimiterFunctionBase< TInput, NDimension >.

GetClassName()

template<class TInput , unsigned int NDimension>

virtual const char * itk::HardLimiterFunction< TInput, NDimension >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::LimiterFunctionBase< TInput, NDimension >.

ITK_DISALLOW_COPY_AND_MOVE()

template<class TInput , unsigned int NDimension>

itk::HardLimiterFunction< TInput, NDimension >::ITK_DISALLOW_COPY_AND_MOVE

(

HardLimiterFunction< TInput, NDimension >

)

itkStaticConstMacro()

template<class TInput , unsigned int NDimension>

itk::HardLimiterFunction< TInput, NDimension >::itkStaticConstMacro	(	Dimension	,
		unsigned int	,
		Superclass::Dimension
	)

Superclass' static consts

New()

template<class TInput , unsigned int NDimension>

static Pointer itk::HardLimiterFunction< TInput, NDimension >::New ( )

static

Define the New() function, for creation via the ObjectFactory