h o m e d o c u m e n t a t i o n c l a s s h i e r a r c h y

DensityF1D Class Reference

#include <AdvancedFunctions1D.h>

Inheritance diagram for DensityF1D:

UnaryFunction1D< double > List of all members.

Detailed Description

Returns the density evaluated for an Interface1D. The density is evaluated for a set of points along the Interface1D (using the DensityF0D functor) with a user-defined sampling and then integrated into a single value using a user-defined integration method.


Public Member Functions

 DensityF1D (double sigma=2, IntegrationType iType=MEAN, float sampling=2.f)
virtual ~DensityF1D ()
string getName () const
double operator() (Interface1D &inter)

Constructor & Destructor Documentation

DensityF1D (  double  sigma = 2,
IntegrationType  iType = MEAN,
float  sampling = 2.f
)  [inline]
 

Builds the functor.

Parameters:
sigma Thesigma used in DensityF0D and determining the window size used in each density query.
iType The integration method used to compute a single value from a set of values.
sampling The resolution used to sample the chain: the corresponding 0D function is evaluated at each sample point and the result is obtained by combining the resulting values into a single one, following the method specified by iType.

virtual ~DensityF1D (   )  [inline, virtual]
 

Destructor

Member Function Documentation

string getName (   )  const [inline, virtual]
 

Returns the string "DensityF1D"

Reimplemented from UnaryFunction1D< double >.

double operator() (  Interface1D &  inter  )  [inline, virtual]
 

the () operator.

Reimplemented from UnaryFunction1D< double >.

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