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

#include <itkExponentialLimiterFunction.h>

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

Collaboration diagram for itk::ExponentialLimiterFunction< TInput, NDimension >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::DerivativeValueType	DerivativeValueType
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef ExponentialLimiterFunction	Self
typedef LimiterFunctionBase < TInput, NDimension >	Superclass
Public Types inherited from itk::LimiterFunctionBase< TInput, NDimension >
typedef SmartPointer< const Self >	ConstPointer
typedef CovariantVector < DerivativeValueType, itkGetStaticConstMacro(Dimension)>	DerivativeType
typedef OutputType	DerivativeValueType
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef LimiterFunctionBase	Self
typedef FunctionBase< TInput, typename NumericTraits< TInput > ::RealType >	Superclass

Public Member Functions
virtual OutputType	Evaluate (const InputType &input) const
virtual OutputType	Evaluate (const InputType &input, DerivativeType &derivative) const
virtual const char *	GetClassName () const
virtual void	Initialize (void) throw (ExceptionObject)
	itkStaticConstMacro (Dimension, unsigned int, Superclass::Dimension)
Public Member Functions inherited from itk::LimiterFunctionBase< TInput, NDimension >
virtual OutputType	GetLowerBound () const
virtual InputType	GetLowerThreshold () const
virtual OutputType	GetUpperBound () const
virtual InputType	GetUpperThreshold () const
	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
virtual void	ComputeLimiterSettings (void)
	ExponentialLimiterFunction ()
	~ExponentialLimiterFunction ()
Protected Member Functions inherited from itk::LimiterFunctionBase< TInput, NDimension >
	LimiterFunctionBase ()
	~LimiterFunctionBase ()

Protected Attributes
double	m_LTminLB
double	m_LTminLBinv
double	m_UTminUB
double	m_UTminUBinv
Protected Attributes inherited from itk::LimiterFunctionBase< TInput, NDimension >
OutputType	m_LowerBound
InputType	m_LowerThreshold
OutputType	m_UpperBound
InputType	m_UpperThreshold

Private Member Functions
	ExponentialLimiterFunction (const Self &)
void	operator= (const Self &)

Detailed Description

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

A soft limiter.

If the input value exceeds the upper/lower threshold the output is diminished/increased, such that it never will exceed the UpperBound/LowerBound. It does this in a smooth manner, with an exponential function.

where is the upper/lower bound and the upper/lower threshold

See Also

LimiterFunctionBase, HardLimiterFunction

Definition at line 40 of file itkExponentialLimiterFunction.h.

Member Typedef Documentation

template<class TInput , unsigned int NDimension>

typedef SmartPointer<const Self> itk::ExponentialLimiterFunction< TInput, NDimension >::ConstPointer

Definition at line 48 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

typedef Superclass::DerivativeType itk::ExponentialLimiterFunction< TInput, NDimension >::DerivativeType

Definition at line 64 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

typedef Superclass::DerivativeValueType itk::ExponentialLimiterFunction< TInput, NDimension >::DerivativeValueType

Definition at line 63 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

typedef Superclass::InputType itk::ExponentialLimiterFunction< TInput, NDimension >::InputType

Superclass' typedefs

Definition at line 61 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

typedef Superclass::OutputType itk::ExponentialLimiterFunction< TInput, NDimension >::OutputType

Definition at line 62 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

typedef SmartPointer<Self> itk::ExponentialLimiterFunction< TInput, NDimension >::Pointer

Definition at line 47 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

typedef ExponentialLimiterFunction itk::ExponentialLimiterFunction< TInput, NDimension >::Self

Standard class typedefs.

Definition at line 45 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

typedef LimiterFunctionBase<TInput, NDimension> itk::ExponentialLimiterFunction< TInput, NDimension >::Superclass

Definition at line 46 of file itkExponentialLimiterFunction.h.

Constructor & Destructor Documentation

template<class TInput , unsigned int NDimension>

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

protected

template<class TInput , unsigned int NDimension>

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

inlineprotected

Definition at line 77 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

itk::ExponentialLimiterFunction< TInput, NDimension >::ExponentialLimiterFunction ( const Self &  )

private

Member Function Documentation

template<class TInput , unsigned int NDimension>

virtual void itk::ExponentialLimiterFunction< TInput, NDimension >::ComputeLimiterSettings ( void  )

protectedvirtual

template<class TInput , unsigned int NDimension>

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

virtual

Limit the input value

Implements itk::LimiterFunctionBase< TInput, NDimension >.

template<class TInput , unsigned int NDimension>

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

virtual

Limit the input value and change the input function derivative accordingly

Implements itk::LimiterFunctionBase< TInput, NDimension >.

template<class TInput , unsigned int NDimension>

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

virtual

Run-time type information (and related methods).

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

template<class TInput , unsigned int NDimension>

virtual void itk::ExponentialLimiterFunction< TInput, NDimension >::Initialize ( void  ) throw ( ExceptionObject )

virtual

Initialize the limiter; calls the ComputeLimiterSettings() function

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

template<class TInput , unsigned int NDimension>

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

Superclass' static consts

template<class TInput , unsigned int NDimension>

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

static

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

template<class TInput , unsigned int NDimension>

void itk::ExponentialLimiterFunction< TInput, NDimension >::operator= ( const Self &  )

private

Field Documentation

template<class TInput , unsigned int NDimension>

double itk::ExponentialLimiterFunction< TInput, NDimension >::m_LTminLB

protected

Definition at line 83 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

double itk::ExponentialLimiterFunction< TInput, NDimension >::m_LTminLBinv

protected

Definition at line 84 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

double itk::ExponentialLimiterFunction< TInput, NDimension >::m_UTminUB

protected

Definition at line 81 of file itkExponentialLimiterFunction.h.

template<class TInput , unsigned int NDimension>

double itk::ExponentialLimiterFunction< TInput, NDimension >::m_UTminUBinv

protected

Definition at line 82 of file itkExponentialLimiterFunction.h.