ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType > Class Template Reference

#include <itkCoxDeBoorBSplineKernelFunction.h>

+ Inheritance diagram for itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >:
+ Collaboration diagram for itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using MatrixType = vnl_matrix< TRealValueType >
 
using Pointer = SmartPointer< Self >
 
using PolynomialType = vnl_real_polynomial
 
using RealType = typename Superclass::RealType
 
using Self = CoxDeBoorBSplineKernelFunction
 
using Superclass = KernelFunctionBase< TRealValueType >
 
using VectorType = vnl_vector< 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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
TRealValueType Evaluate (const TRealValueType &) const override
 
TRealValueType EvaluateDerivative (const TRealValueType &) const
 
TRealValueType EvaluateNthDerivative (const TRealValueType &, const unsigned int) const
 
virtual const char * GetNameOfClass () const
 
MatrixType GetShapeFunctions ()
 
MatrixType GetShapeFunctionsInZeroToOneInterval ()
 
virtual unsigned int GetSplineOrder () const
 
void SetSplineOrder (const unsigned int)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 

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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 CoxDeBoorBSplineKernelFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~CoxDeBoorBSplineKernelFunction () 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 ()
 
 ~Object () 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 ()
 

Private Member Functions

PolynomialType CoxDeBoor (const unsigned short, const VectorType, const unsigned int, const unsigned int)
 
void GenerateBSplineShapeFunctions (const unsigned int)
 

Private Attributes

MatrixType m_BSplineShapeFunctions
 
unsigned int m_SplineOrder
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
class itk::CoxDeBoorBSplineKernelFunction< 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 to cohere with the previous incarnation of this class. One can change the order during an instantiation's existence. Note that other authors have defined the B-spline order as being the degree of spline + 1. In the ITK context (e.g. in this class), the spline order is equivalent to the degree of the spline.

Author
Nicholas J. Tustison

This code was contributed in the Insight Journal paper: "N-D C^k B-Spline Scattered Data Approximation" by Nicholas J. Tustison, James C. Gee https://hdl.handle.net/1926/140 http://www.insight-journal.org/browse/publication/57

See also
KernelFunctionBase

Definition at line 58 of file itkCoxDeBoorBSplineKernelFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
using itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 67 of file itkCoxDeBoorBSplineKernelFunction.h.

◆ MatrixType

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
using itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::MatrixType = vnl_matrix<TRealValueType>

Definition at line 79 of file itkCoxDeBoorBSplineKernelFunction.h.

◆ Pointer

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
using itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::Pointer = SmartPointer<Self>

Definition at line 66 of file itkCoxDeBoorBSplineKernelFunction.h.

◆ PolynomialType

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
using itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::PolynomialType = vnl_real_polynomial

Definition at line 78 of file itkCoxDeBoorBSplineKernelFunction.h.

◆ RealType

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
using itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::RealType = typename Superclass::RealType

Definition at line 69 of file itkCoxDeBoorBSplineKernelFunction.h.

◆ Self

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
using itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::Self = CoxDeBoorBSplineKernelFunction

Standard class type aliases.

Definition at line 64 of file itkCoxDeBoorBSplineKernelFunction.h.

◆ Superclass

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
using itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::Superclass = KernelFunctionBase<TRealValueType>

Definition at line 65 of file itkCoxDeBoorBSplineKernelFunction.h.

◆ VectorType

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
using itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::VectorType = vnl_vector<TRealValueType>

Definition at line 77 of file itkCoxDeBoorBSplineKernelFunction.h.

Constructor & Destructor Documentation

◆ CoxDeBoorBSplineKernelFunction()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::CoxDeBoorBSplineKernelFunction ( )
protected

◆ ~CoxDeBoorBSplineKernelFunction()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::~CoxDeBoorBSplineKernelFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ CoxDeBoor()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
PolynomialType itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::CoxDeBoor ( const unsigned short  ,
const  VectorType,
const unsigned int  ,
const unsigned int   
)
private

Use the CoxDeBoor recursion relation to generate the piecewise polynomials which compose the basis function. See, for example, L. Piegl, L. Tiller, "The NURBS Book," Springer 1997, p. 50.

◆ CreateAnother()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
virtual::itk::LightObject::Pointer itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ Evaluate()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
TRealValueType itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate ( const TRealValueType &  ) const
overridevirtual

Evaluate the function.

Implements itk::KernelFunctionBase< TRealValueType >.

◆ EvaluateDerivative()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
TRealValueType itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::EvaluateDerivative ( const TRealValueType &  ) const

Evaluate the first derivative.

◆ EvaluateNthDerivative()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
TRealValueType itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::EvaluateNthDerivative ( const TRealValueType &  ,
const unsigned int   
) const

Evaluate the Nth derivative.

◆ GenerateBSplineShapeFunctions()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
void itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::GenerateBSplineShapeFunctions ( const unsigned int  )
private

For a specific order, generate the (this->m_SplineOrder+1) pieces of the single basis function centered at zero.

◆ GetNameOfClass()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
virtual const char* itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::KernelFunctionBase< TRealValueType >.

◆ GetShapeFunctions()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
MatrixType itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::GetShapeFunctions ( )

For a specific order, return the ceil( 0.5*(m_SplineOrder+1) ) pieces of the single basis function centered at zero for positive parametric values.

◆ GetShapeFunctionsInZeroToOneInterval()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
MatrixType itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::GetShapeFunctionsInZeroToOneInterval ( )

For a specific order, generate and return the (this->m_SplineOrder+1) pieces of the different basis functions in the [0, 1] interval.

◆ GetSplineOrder()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
virtual unsigned int itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::GetSplineOrder ( ) const
virtual

Get the spline order.

◆ New()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
static Pointer itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
void itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::KernelFunctionBase< TRealValueType >.

◆ SetSplineOrder()

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
void itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::SetSplineOrder ( const unsigned int  )

Set the spline order.

Member Data Documentation

◆ m_BSplineShapeFunctions

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
MatrixType itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::m_BSplineShapeFunctions
private

Definition at line 138 of file itkCoxDeBoorBSplineKernelFunction.h.

◆ m_SplineOrder

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
unsigned int itk::CoxDeBoorBSplineKernelFunction< VSplineOrder, TRealValueType >::m_SplineOrder
private

Definition at line 139 of file itkCoxDeBoorBSplineKernelFunction.h.


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