iRoCS Toolbox  1.1.0
Public Member Functions | Static Public Member Functions | Protected Attributes
svt::Kernel_RBF Class Reference

The Kernel_RBF class specifies a radial basis function kernel exp(-gamma*|u-v|^2) More...

#include <Kernel_RBF.hh>

Collaboration diagram for svt::Kernel_RBF:

Public Member Functions

 Kernel_RBF (double gamma=1.)
 
 ~Kernel_RBF ()
 
void clearCache () const
 
double gamma () const
 
template<typename FV , typename FVGradient >
void gradient_of_k_function (const FV &x, const FV &y, FVGradient &gradient) const
 
template<typename FV >
double k_function (const FV &x, const FV &y) const
 
template<typename STDATA >
void loadParameters (STDATA &stData)
 
template<typename STDATA >
void saveParameters (STDATA &stData) const
 
void setGamma (double gamma)
 
template<typename ForwardIter , typename Accessor >
void updateCache (const ForwardIter &, const ForwardIter &, Accessor, ProgressReporter *) const
 
template<typename ForwardIter1 , typename Accessor1 , typename ForwardIter2 , typename Accessor2 >
void updateCache (const ForwardIter1 &, const ForwardIter1 &, Accessor1, const ForwardIter2 &, const ForwardIter2 &, Accessor2, ProgressReporter *=0) const
 

Static Public Member Functions

static const char * description ()
 
static void getParamInfos (std::vector< ParamInfo > &p)
 get information about the parameters, that are used in loadParameters() and saveParameters(). More...
 
static const char * name ()
 

Protected Attributes

double p_gamma
 

Detailed Description

The Kernel_RBF class specifies a radial basis function kernel exp(-gamma*|u-v|^2)

Definition at line 118 of file Kernel_RBF.hh.

Constructor & Destructor Documentation

◆ Kernel_RBF()

svt::Kernel_RBF::Kernel_RBF ( double  gamma = 1.)
inline

Definition at line 121 of file Kernel_RBF.hh.

◆ ~Kernel_RBF()

svt::Kernel_RBF::~Kernel_RBF ( )
inline

Definition at line 125 of file Kernel_RBF.hh.

Member Function Documentation

◆ setGamma()

void svt::Kernel_RBF::setGamma ( double  gamma)
inline

Definition at line 128 of file Kernel_RBF.hh.

◆ gamma()

double svt::Kernel_RBF::gamma ( ) const
inline

Definition at line 129 of file Kernel_RBF.hh.

Referenced by setGamma().

◆ updateCache() [1/2]

template<typename ForwardIter , typename Accessor >
void svt::Kernel_RBF::updateCache ( const ForwardIter &  ,
const ForwardIter &  ,
Accessor  ,
ProgressReporter  
) const
inline

Definition at line 133 of file Kernel_RBF.hh.

◆ updateCache() [2/2]

template<typename ForwardIter1 , typename Accessor1 , typename ForwardIter2 , typename Accessor2 >
void svt::Kernel_RBF::updateCache ( const ForwardIter1 &  ,
const ForwardIter1 &  ,
Accessor1  ,
const ForwardIter2 &  ,
const ForwardIter2 &  ,
Accessor2  ,
ProgressReporter = 0 
) const
inline

Definition at line 144 of file Kernel_RBF.hh.

◆ clearCache()

void svt::Kernel_RBF::clearCache ( ) const
inline

Definition at line 155 of file Kernel_RBF.hh.

◆ k_function()

template<typename FV >
double svt::Kernel_RBF::k_function ( const FV &  x,
const FV &  y 
) const
inline

Definition at line 161 of file Kernel_RBF.hh.

Referenced by gradient_of_k_function().

◆ gradient_of_k_function()

template<typename FV , typename FVGradient >
void svt::Kernel_RBF::gradient_of_k_function ( const FV &  x,
const FV &  y,
FVGradient &  gradient 
) const
inline

Definition at line 167 of file Kernel_RBF.hh.

◆ loadParameters()

template<typename STDATA >
void svt::Kernel_RBF::loadParameters ( STDATA &  stData)
inline

Definition at line 175 of file Kernel_RBF.hh.

◆ saveParameters()

template<typename STDATA >
void svt::Kernel_RBF::saveParameters ( STDATA &  stData) const
inline

Definition at line 191 of file Kernel_RBF.hh.

◆ name()

static const char* svt::Kernel_RBF::name ( )
inlinestatic

Definition at line 198 of file Kernel_RBF.hh.

Referenced by saveParameters().

◆ description()

static const char* svt::Kernel_RBF::description ( )
inlinestatic

Definition at line 203 of file Kernel_RBF.hh.

◆ getParamInfos()

static void svt::Kernel_RBF::getParamInfos ( std::vector< ParamInfo > &  p)
inlinestatic

get information about the parameters, that are used in loadParameters() and saveParameters().

The Infos are appended to the passed array

Parameters
parray of ParamInfos. The Infos will be appended to this array

Definition at line 218 of file Kernel_RBF.hh.

Field Documentation

◆ p_gamma

double svt::Kernel_RBF::p_gamma
protected

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