Class allowing to estimate a second order polynomial 2d surface from a set of data such as $\left\{x_i, y_i, value_i=f(x_i, y_i)\right\}$ . More...

#include <Polynomial2dSurfaceEstimator.h>

Inheritance diagram for ipsdk::math::Polynomial2dSurfaceEstimator:

Public Types
enum	eEstimParams { eEP_FactorX2, eEP_FactorXY, eEP_FactorY2, eEP_FactorX, eEP_FactorY, eEP_Cste }

enum	eDataType { eDT_X, eDT_Y, eDT_Value }

Public Member Functions
Constructors and destructor
	Polynomial2dSurfaceEstimator ()

	~Polynomial2dSurfaceEstimator ()

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

Protected Member Functions
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 a second order polynomial 2d surface from a set of data such as $\left\{x_i, y_i, value_i=f(x_i, y_i)\right\}$ .

Author: E.Noirfalise

Date: 2018/10/04

Copyright: 2018 Reactiv'IP, all right reserved.

Associated equation is given by :

$value_i = ax_i^2 + bx_iy_i + cy_i^2 + dx_i + ey_i + f$

Member Enumeration Documentation

◆ eEstimParams

enum ipsdk::math::Polynomial2dSurfaceEstimator::eEstimParams

description of estimated parameters

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eEP_FactorX2	factor associated to x^2 term
eEP_FactorXY	factor associated to xy term
eEP_FactorY2	factor associated to y^2 term
eEP_FactorX	factor associated to x term
eEP_FactorY	factor associated to y term
eEP_Cste	constant term

◆ eDataType

enum ipsdk::math::Polynomial2dSurfaceEstimator::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 of input point
eDT_Y	y coordinate of input point
eDT_Value	function value at (x, y) point

Member Function Documentation

◆ processEstimation()

BoolResult ipsdk::math::Polynomial2dSurfaceEstimator::processEstimation	(	const math::DataSet &	dataSet,
		math::ParameterType &	estimParams
	)

protectedvirtual

method allowing to compute estimation into derived classes

Returns: false in case of failure

Implements ipsdk::math::BaseEstimator.

◆ processResiduals()

BoolResult ipsdk::math::Polynomial2dSurfaceEstimator::processResiduals	(	const math::DataSet &	dataSet,
		const math::ParameterType &	estimParams,
		math::ResidualsSet &	residualsSet
	)		const

protectedvirtual

method allowing to compute residuals into derived classes

Returns: false in case of failure

Implements ipsdk::math::BaseEstimator.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKMath/Tools/Polynomial2dSurfaceEstimator.h

Public Types

Public Member Functions

Static Public Attributes