#include <itkGaussianKernelFunction.h>

Detailed Description

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

Gaussian kernel used for density estimation and nonparametric regression.

This class encapsulates a Gaussian smoothing kernel for density estimation or nonparametric regression. See documentation for KernelFunctionBase for more details.

See also: KernelFunctionBase

Definition at line 41 of file itkGaussianKernelFunction.h.

Inheritance diagram for itk::GaussianKernelFunction< TRealValueType >:

Collaboration diagram for itk::GaussianKernelFunction< TRealValueType >:

Public Types
using	Pointer = SmartPointer< Self >

using	Self = GaussianKernelFunction

using	Superclass = KernelFunctionBase< TRealValueType >

Public Types inherited from itk::KernelFunctionBase< double >
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	RealType = double

using	Self = KernelFunctionBase

using	Superclass = FunctionBase< double, double >

Public Types inherited from itk::FunctionBase< double, double >
using	ConstPointer = SmartPointer< const Self >

using	InputType = double

using	OutputType = double

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
const char *	GetNameOfClass () const override


TRealValueType	Evaluate (const TRealValueType &u) const override

Public Member Functions inherited from itk::KernelFunctionBase< double >
double	Evaluate (const double &u) const override=0

const char *	GetNameOfClass () const override

virtual OutputType	Evaluate (const InputType &input) const=0

const char *	GetNameOfClass () const override

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

const char *	GetNameOfClass () const override

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

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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
	GaussianKernelFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~GaussianKernelFunction () override=default

Protected Member Functions inherited from itk::KernelFunctionBase< double >
	KernelFunctionBase ()=default

	~KernelFunctionBase () override=default

Protected Member Functions inherited from itk::FunctionBase< double, 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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
const TRealValueType	m_Factor {}

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ Pointer

template<typename TRealValueType = double>

using itk::GaussianKernelFunction< TRealValueType >::Pointer = SmartPointer<Self>

Definition at line 49 of file itkGaussianKernelFunction.h.

◆ Self

template<typename TRealValueType = double>

using itk::GaussianKernelFunction< TRealValueType >::Self = GaussianKernelFunction

Standard class type aliases.

Definition at line 47 of file itkGaussianKernelFunction.h.

◆ Superclass

template<typename TRealValueType = double>

using itk::GaussianKernelFunction< TRealValueType >::Superclass = KernelFunctionBase<TRealValueType>

Definition at line 48 of file itkGaussianKernelFunction.h.

Constructor & Destructor Documentation

◆ GaussianKernelFunction()

template<typename TRealValueType = double>

itk::GaussianKernelFunction< TRealValueType >::GaussianKernelFunction ( )

inlineprotected

Definition at line 67 of file itkGaussianKernelFunction.h.

◆ ~GaussianKernelFunction()

template<typename TRealValueType = double>

itk::GaussianKernelFunction< TRealValueType >::~GaussianKernelFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TRealValueType = double>

TRealValueType itk::GaussianKernelFunction< TRealValueType >::Evaluate ( const TRealValueType & u ) const

inlineoverride

Evaluate the function.

Definition at line 60 of file itkGaussianKernelFunction.h.

◆ GetNameOfClass()

template<typename TRealValueType = double>

const char * itk::GaussianKernelFunction< TRealValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

◆ New()

template<typename TRealValueType = double>

static Pointer itk::GaussianKernelFunction< TRealValueType >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TRealValueType = double>

void itk::GaussianKernelFunction< 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.

Definition at line 72 of file itkGaussianKernelFunction.h.

Member Data Documentation

◆ m_Factor

template<typename TRealValueType = double>

const TRealValueType itk::GaussianKernelFunction< TRealValueType >::m_Factor {}

private

Definition at line 78 of file itkGaussianKernelFunction.h.

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

itkGaussianKernelFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ GaussianKernelFunction()

◆ ~GaussianKernelFunction()

Member Function Documentation

◆ Evaluate()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

Member Data Documentation

◆ m_Factor