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

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

#include <GaussianCurve3dEstimator.h>

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

Public Types

enum  eEstimParams {
  eEP_A, eEP_Mu0, eEP_Sigma0, eEP_Mu1,
  eEP_Sigma1
}
 
enum  eDataType { eDT_X0, eDT_X1, eDT_Y }
 

Public Member Functions

Constructors and destructor
 GaussianCurve3dEstimator ()
 
 ~GaussianCurve3dEstimator ()
 
- 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^2 \rightarrow \Re \\ y = G(X) = Ae^{-(\frac{(x_0-\mu_0)^2}{2\sigma_0^2}+\frac{(x_1-\mu_1)^2}{2\sigma_1^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_Mu0 

position of the center of the peak along first domain dimension

eEP_Sigma0 

domain dimension

width of the "bell" (the standard deviation) along first

eEP_Mu1 

position of the center of the peak along second domain dimension

eEP_Sigma1 

domain dimension

width of the "bell" (the standard deviation) along second

◆ eDataType

description of data into data set

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

x coordinate for curve along first domain dimension

eDT_X1 

x coordinate for curve along second domain dimension

eDT_Y 

y coordinate for curve


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