go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
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 >:
Inheritance graph
[legend]

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
typedef Superclass::DerivativeValueType DerivativeValueType
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef HardLimiterFunction Self
 
typedef LimiterFunctionBase< TInput, NDimension > Superclass
 
- Public Types inherited from itk::LimiterFunctionBase< TInput, NDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef CovariantVector< DerivativeValueType, itkGetStaticConstMacro(Dimension) > DerivativeType
 
typedef OutputType DerivativeValueType
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
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
 
 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
 
virtual void Initialize (void) throw ( ExceptionObject )
 
 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 ()
 
 ~HardLimiterFunction ()
 
- Protected Member Functions inherited from itk::LimiterFunctionBase< TInput, NDimension >
 LimiterFunctionBase ()
 
 ~LimiterFunctionBase ()
 

Private Member Functions

 HardLimiterFunction (const Self &)
 
void operator= (const Self &)
 

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

template<class TInput , unsigned int NDimension>
typedef SmartPointer< const Self > itk::HardLimiterFunction< TInput, NDimension >::ConstPointer

Definition at line 48 of file itkHardLimiterFunction.h.

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

Definition at line 63 of file itkHardLimiterFunction.h.

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

Definition at line 62 of file itkHardLimiterFunction.h.

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

Superclass' typedefs

Definition at line 60 of file itkHardLimiterFunction.h.

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

Definition at line 61 of file itkHardLimiterFunction.h.

template<class TInput , unsigned int NDimension>
typedef SmartPointer< Self > itk::HardLimiterFunction< TInput, NDimension >::Pointer

Definition at line 47 of file itkHardLimiterFunction.h.

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

Standard class typedefs.

Definition at line 45 of file itkHardLimiterFunction.h.

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

Definition at line 46 of file itkHardLimiterFunction.h.

Constructor & Destructor Documentation

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

Definition at line 73 of file itkHardLimiterFunction.h.

template<class TInput , unsigned int NDimension>
itk::HardLimiterFunction< TInput, NDimension >::~HardLimiterFunction ( )
inlineprotected

Definition at line 74 of file itkHardLimiterFunction.h.

template<class TInput , unsigned int NDimension>
itk::HardLimiterFunction< TInput, NDimension >::HardLimiterFunction ( const Self )
private

Member Function Documentation

template<class TInput , unsigned int NDimension>
virtual OutputType itk::HardLimiterFunction< 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::HardLimiterFunction< 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::HardLimiterFunction< TInput, NDimension >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

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

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

Superclass' static consts

template<class TInput , unsigned int NDimension>
static Pointer itk::HardLimiterFunction< TInput, NDimension >::New ( )
static

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

template<class TInput , unsigned int NDimension>
void itk::HardLimiterFunction< TInput, NDimension >::operator= ( const Self )
private


Generated on 04-09-2015 for elastix by doxygen 1.8.9.1 elastix logo