ITK  4.8.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
itk::BSplineKernelFunction< VSplineOrder, TRealValueType > Class Template Reference

#include <itkBSplineKernelFunction.h>

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

Detailed Description

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

BSpline kernel used for density estimation and nonparameteric regression.

This class enscapsulates BSpline kernel for density estimation or nonparameteric 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 42 of file itkBSplineKernelFunction.h.

Classes

struct  Dispatch
 
struct  DispatchBase
 

Public Types

typedef SmartPointer< SelfPointer
 
typedef Superclass::RealType RealType
 
typedef BSplineKernelFunction Self
 
typedef KernelFunctionBase
< TRealValueType > 
Superclass
 
- Public Types inherited from itk::KernelFunctionBase< TRealValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef TRealValueType RealType
 
typedef KernelFunctionBase Self
 
typedef FunctionBase
< TRealValueType,
TRealValueType > 
Superclass
 
- Public Types inherited from itk::FunctionBase< TRealValueType, TRealValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef TRealValueType InputType
 
typedef TRealValueType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
TRealValueType Evaluate (const TRealValueType &u) const override
 
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
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 ()
 

Static Public Attributes

static const unsigned int SplineOrder = VSplineOrder
 

Protected Member Functions

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

 BSplineKernelFunction (const Self &)
 
void operator= (const Self &)
 
TRealValueType Evaluate (const Dispatch< 0 > &, const TRealValueType &u) const
 
TRealValueType Evaluate (const Dispatch< 1 > &, const TRealValueType &u) const
 
TRealValueType Evaluate (const Dispatch< 2 > &, const TRealValueType &u) const
 
TRealValueType Evaluate (const Dispatch< 3 > &, const TRealValueType &u) const
 
TRealValueType Evaluate (const DispatchBase &, const TRealValueType &) const
 

Additional Inherited Members

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

Member Typedef Documentation

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

Definition at line 48 of file itkBSplineKernelFunction.h.

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

Definition at line 50 of file itkBSplineKernelFunction.h.

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

Standard class typedefs.

Definition at line 46 of file itkBSplineKernelFunction.h.

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

Definition at line 47 of file itkBSplineKernelFunction.h.

Constructor & Destructor Documentation

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

Definition at line 67 of file itkBSplineKernelFunction.h.

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
virtual itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::~BSplineKernelFunction ( )
inlineprotectedvirtual

Definition at line 68 of file itkBSplineKernelFunction.h.

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::BSplineKernelFunction ( const Self )
private

Member Function Documentation

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
virtual::itk::LightObject::Pointer itk::BSplineKernelFunction< 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.

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 61 of file itkBSplineKernelFunction.h.

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate ( const Dispatch< 0 > &  ,
const TRealValueType &  u 
) const
inlineprivate

Zeroth order spline.

Definition at line 85 of file itkBSplineKernelFunction.h.

References itk::NumericTraits< T >::OneValue(), and itk::NumericTraits< T >::ZeroValue().

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate ( const Dispatch< 1 > &  ,
const TRealValueType &  u 
) const
inlineprivate

First order spline

Definition at line 104 of file itkBSplineKernelFunction.h.

References itk::NumericTraits< T >::OneValue(), and itk::NumericTraits< T >::ZeroValue().

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate ( const Dispatch< 2 > &  ,
const TRealValueType &  u 
) const
inlineprivate

Second order spline.

Definition at line 119 of file itkBSplineKernelFunction.h.

References itk::NumericTraits< T >::ZeroValue().

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate ( const Dispatch< 3 > &  ,
const TRealValueType &  u 
) const
inlineprivate

Third order spline.

Definition at line 142 of file itkBSplineKernelFunction.h.

References itk::NumericTraits< T >::ZeroValue().

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
TRealValueType itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::Evaluate ( const DispatchBase ,
const TRealValueType &   
) const
inlineprivate
template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
virtual const char* itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::KernelFunctionBase< TRealValueType >.

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

Method for creation through the object factory.

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
void itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::operator= ( const Self )
private
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::Object.

Definition at line 69 of file itkBSplineKernelFunction.h.

References itk::KernelFunctionBase< TRealValueType >::PrintSelf(), and itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::SplineOrder.

Member Data Documentation

template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
const unsigned int itk::BSplineKernelFunction< VSplineOrder, TRealValueType >::SplineOrder = VSplineOrder
static

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