IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Types | Static Public Attributes | List of all members
ipsdk::math::GaussianCurve2dEstimator Class Reference

Class allowing to estimate gaussian curve parameters from a set of input data. More...

#include <GaussianCurve2dEstimator.h>

Inheritance diagram for ipsdk::math::GaussianCurve2dEstimator:
ipsdk::math::BaseGaussianCurveEstimator ipsdk::math::BaseEstimator

Public Types

enum  eEstimParams { eEP_A, eEP_Mu, eEP_Sigma }
 
enum  eDataType { eDT_X, eDT_Y }
 

Public Member Functions

Constructors and destructor
 GaussianCurve2dEstimator ()
 
 ~GaussianCurve2dEstimator ()
 
- Public Member Functions inherited from ipsdk::math::BaseGaussianCurveEstimator
 BaseGaussianCurveEstimator (const ipUInt32 curveDomainSize)
 
virtual ~BaseGaussianCurveEstimator ()=0
 
- Public Member Functions inherited from ipsdk::math::BaseEstimator
bool isInit () const
 check for object initialization
 
ipUInt32 getNbMinRequestedData () const
 retrieve minimum data set size to ensure an estimation More...
 
ipUInt32 getNbEstimParams () const
 retrieve number of estimated parameters More...
 
ipUInt32 getDataSize () const
 unitary data size into data set collection More...
 
BoolResult computeEstimation (const DataSet &dataSet, ParameterType &estimParams)
 method allowing to estimate parameters from a given data set More...
 
BoolResult computeResiduals (const DataSet &dataSet, const ParameterType &estimParams, ResidualsSet &residualsSet) const
 method allowing to compute estimation residuals from a given data set and some estimated parameters More...
 
 BaseEstimator ()
 
virtual ~BaseEstimator ()=0
 

Static Public Attributes

static const ipUInt32 g_parameterSize = eEstimParams::size
 size of estimated parameters
 
static const ipUInt32 g_dataSize = eDataType::size
 size of data into data set
 

Additional Inherited Members

- Protected Member Functions inherited from ipsdk::math::BaseGaussianCurveEstimator
BoolResult processEstimation (const math::DataSet &dataSet, math::ParameterType &estimParams)
 method allowing to compute estimation into derived classes More...
 
BoolResult processResiduals (const math::DataSet &dataSet, const math::ParameterType &estimParams, math::ResidualsSet &residualsSet) const
 method allowing to compute residuals into derived classes More...
 
- Protected Member Functions inherited from ipsdk::math::BaseEstimator
void initBase (const ipUInt32 nbMinRequestedData, const ipUInt32 nbEstimParams, const ipUInt32 dataSize)
 base class initialization More...
 
BoolResult checkData (const DataSet &dataSet, const ParameterType &estimParams) const
 method allowing to check input data properties associated to estimation More...
 

Detailed Description

Class allowing to estimate gaussian curve parameters from a set of input data.

Author
E.Noirfalise
Date
2018/07/20

Fitted gaussian curve is defined as follow :

\[ \begin{cases} G:\Re \rightarrow \Re \\ y = G(X) = Ae^{-\frac{(x-\mu)^2}{2\sigma^2}} \end{cases} \]

Member Enumeration Documentation

◆ eEstimParams

description of estimated parameters

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eEP_A 

height of the curve's peak

eEP_Mu 

position of the center of the peak

eEP_Sigma 

width of the "bell" (the standard deviation)

◆ eDataType

description of data into data set

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eDT_X 

x coordinate for curve

eDT_Y 

y coordinate for curve


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