#include <itkBSplineKernelFunction.h>

Detailed Description

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
class itk::BSplineKernelFunction< VSplineOrder, TRealValueType >

BSpline kernel used for density estimation and nonparametric regression.

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

This class is templated over the spline order.

Warning: Evaluate is only implemented for spline order 0 to 3

See also: KernelFunctionBase

Definition at line 43 of file itkBSplineKernelFunction.h.

Inheritance diagram for itk::BSplineKernelFunction< VSplineOrder, TRealValueType >:

Collaboration diagram for itk::BSplineKernelFunction< VSplineOrder, TRealValueType >:

Classes
struct	Dispatch

struct	DispatchBase

Public Types
using	Pointer = SmartPointer< Self >

using	RealType = TRealValueType

using	Self = BSplineKernelFunction

using	Superclass = KernelFunctionBase< TRealValueType >

Public Types inherited from itk::KernelFunctionBase< TRealValueType >
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

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::KernelFunctionBase< TRealValueType >
const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::FunctionBase< TRealValueType, TRealValueType >
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

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 void	Delete ()

virtual int	GetReferenceCount () const

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

Static Public Member Functions
static TRealValueType	FastEvaluate (const TRealValueType u)

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

Static Public Attributes
static constexpr unsigned int	SplineOrder = VSplineOrder

Protected Member Functions
	BSplineKernelFunction ()=default

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

	~BSplineKernelFunction () override=default

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

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

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Static Private Member Functions

static TRealValueType	Evaluate (const Dispatch< 0 > &, const TRealValueType &u)


static TRealValueType	Evaluate (const Dispatch< 1 > &, const TRealValueType &u)


static TRealValueType	Evaluate (const Dispatch< 2 > &, const TRealValueType &u)


static TRealValueType	Evaluate (const Dispatch< 3 > &, const TRealValueType &u)


static TRealValueType	Evaluate (const DispatchBase &, const TRealValueType &)

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

Member Typedef Documentation

◆ Pointer

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

using itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Pointer = SmartPointer<Self>

Definition at line 51 of file itkBSplineKernelFunction.h.

◆ RealType

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

using itk::KernelFunctionBase< TRealValueType >::RealType = TRealValueType

Definition at line 52 of file itkKernelFunctionBase.h.

◆ Self

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

using itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Self = BSplineKernelFunction

Standard class type aliases.

Definition at line 49 of file itkBSplineKernelFunction.h.

◆ Superclass

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

using itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Superclass = KernelFunctionBase<TRealValueType>

Definition at line 50 of file itkBSplineKernelFunction.h.

Constructor & Destructor Documentation

◆ BSplineKernelFunction()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::BSplineKernelFunction ( )

protecteddefault

◆ ~BSplineKernelFunction()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::~BSplineKernelFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ Evaluate() [1/6]

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

static TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate	(	const Dispatch< 0 > &	,
		const TRealValueType &	u
	)

inlinestaticprivate

Zeroth order spline.

Definition at line 99 of file itkBSplineKernelFunction.h.

References itk::Math::abs(), and itk::Math::ExactlyEquals().

◆ Evaluate() [2/6]

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

static TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate	(	const Dispatch< 1 > &	,
		const TRealValueType &	u
	)

inlinestaticprivate

First order spline

Definition at line 119 of file itkBSplineKernelFunction.h.

References itk::Math::abs().

◆ Evaluate() [3/6]

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

static TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate	(	const Dispatch< 2 > &	,
		const TRealValueType &	u
	)

inlinestaticprivate

Second order spline.

Definition at line 135 of file itkBSplineKernelFunction.h.

References itk::Math::abs().

◆ Evaluate() [4/6]

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

static TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate	(	const Dispatch< 3 > &	,
		const TRealValueType &	u
	)

inlinestaticprivate

Third order spline.

Definition at line 159 of file itkBSplineKernelFunction.h.

References itk::Math::abs().

◆ Evaluate() [5/6]

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

static TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate	(	const DispatchBase &	,
		const TRealValueType &
	)

inlinestaticprivate

Unimplemented spline order

Definition at line 184 of file itkBSplineKernelFunction.h.

◆ Evaluate() [6/6]

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate ( const TRealValueType & u ) const

inlineoverridevirtual

Evaluate the function.

Implements itk::KernelFunctionBase< TRealValueType >.

Definition at line 73 of file itkBSplineKernelFunction.h.

◆ FastEvaluate()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

static TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::FastEvaluate ( const TRealValueType u )

inlinestatic

Evaluate the function. Faster than the Evaluate member function, because it is static (while Evaluate is virtual).

Definition at line 66 of file itkBSplineKernelFunction.h.

◆ GetNameOfClass()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

const char* itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

◆ New()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

static Pointer itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

void itk::BSplineKernelFunction< VSplineOrder, 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 82 of file itkBSplineKernelFunction.h.

Member Data Documentation

◆ SplineOrder

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>

constexpr unsigned int itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::SplineOrder = VSplineOrder

staticconstexpr

Enum of for spline order.

Definition at line 61 of file itkBSplineKernelFunction.h.

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

itkBSplineKernelFunction.h

Detailed Description

template<unsigned int VSplineOrder = 3, typename TRealValueType = double> class itk::BSplineKernelFunction< VSplineOrder, TRealValueType >

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Private Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ Pointer

◆ RealType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ BSplineKernelFunction()

◆ ~BSplineKernelFunction()

Member Function Documentation

◆ Evaluate() [1/6]

◆ Evaluate() [2/6]

◆ Evaluate() [3/6]

◆ Evaluate() [4/6]

◆ Evaluate() [5/6]

◆ Evaluate() [6/6]

◆ FastEvaluate()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

Member Data Documentation

◆ SplineOrder

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
class itk::BSplineKernelFunction< VSplineOrder, TRealValueType >