ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::KernelFunctionBase< TRealValueType > Class Template Referenceabstract

#include <itkKernelFunctionBase.h>

+ Inheritance diagram for itk::KernelFunctionBase< TRealValueType >:
+ Collaboration diagram for itk::KernelFunctionBase< TRealValueType >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using RealType = TRealValueType
 
using Self = KernelFunctionBase
 
using Superclass = FunctionBase< TRealValueType, TRealValueType >
 
- Public Types inherited from itk::FunctionBase< TRealValueType, TRealValueType >
using ConstPointer = SmartPointer< const Self >
 
using InputType = TRealValueType
 
using OutputType = TRealValueType
 
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

TRealValueType Evaluate (const TRealValueType &u) const override=0
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
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)
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 KernelFunctionBase ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~KernelFunctionBase () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< TRealValueType, TRealValueType >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TRealValueType = double>
class itk::KernelFunctionBase< TRealValueType >

Kernel used for density estimation and nonparametric regression.

This class encapsulates the smoothing kernel used for statistical density estimation and nonparametric regression. The basic idea of the kernel approach is to weight observations by a smooth function (the kernel) to created a smoothed approximation.

Reference: Silverman, B. W. (1986) Density Estimation. London: Chapman and Hall.

Definition at line 43 of file itkKernelFunctionBase.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TRealValueType = double>
using itk::KernelFunctionBase< TRealValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 50 of file itkKernelFunctionBase.h.

◆ Pointer

template<typename TRealValueType = double>
using itk::KernelFunctionBase< TRealValueType >::Pointer = SmartPointer<Self>

Definition at line 49 of file itkKernelFunctionBase.h.

◆ RealType

template<typename TRealValueType = double>
using itk::KernelFunctionBase< TRealValueType >::RealType = TRealValueType

Definition at line 52 of file itkKernelFunctionBase.h.

◆ Self

template<typename TRealValueType = double>
using itk::KernelFunctionBase< TRealValueType >::Self = KernelFunctionBase

Standard class type aliases.

Definition at line 47 of file itkKernelFunctionBase.h.

◆ Superclass

template<typename TRealValueType = double>
using itk::KernelFunctionBase< TRealValueType >::Superclass = FunctionBase<TRealValueType, TRealValueType>

Definition at line 48 of file itkKernelFunctionBase.h.

Constructor & Destructor Documentation

◆ KernelFunctionBase()

template<typename TRealValueType = double>
itk::KernelFunctionBase< TRealValueType >::KernelFunctionBase ( )
protecteddefault

◆ ~KernelFunctionBase()

template<typename TRealValueType = double>
itk::KernelFunctionBase< TRealValueType >::~KernelFunctionBase ( )
overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TRealValueType = double>
TRealValueType itk::KernelFunctionBase< TRealValueType >::Evaluate ( const TRealValueType &  u) const
overridepure virtual

◆ GetNameOfClass()

template<typename TRealValueType = double>
virtual const char* itk::KernelFunctionBase< TRealValueType >::GetNameOfClass ( ) const
virtual

◆ PrintSelf()

template<typename TRealValueType = double>
void itk::KernelFunctionBase< TRealValueType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::LightObject.

Reimplemented in itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >, and itk::GaborKernelFunction< TRealValueType >.

Definition at line 71 of file itkKernelFunctionBase.h.

Referenced by itk::GaussianKernelFunction< double >::PrintSelf(), itk::BSplineDerivativeKernelFunction< VSplineOrder, TRealValueType >::PrintSelf(), and itk::GaborKernelFunction< TRealValueType >::PrintSelf().


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