ipsdk::math::BaseEstimator Class Reference

Base class for parametric estimation from data set. More...

#include <BaseEstimator.h>

Inheritance diagram for ipsdk::math::BaseEstimator:

Public Member Functions
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...
Constructors and destructor
	BaseEstimator ()
virtual	~BaseEstimator ()=0

Protected Member Functions
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...
virtual BoolResult	processEstimation (const DataSet &dataSet, ParameterType &estimParams)=0
	method allowing to compute estimation into derived classes More...
virtual BoolResult	processResiduals (const DataSet &dataSet, const ParameterType &estimParams, ResidualsSet &residualsSet) const =0
	method allowing to compute residuals into derived classes More...

Friends
class	BaseRobustEstimator

Detailed Description

Base class for parametric estimation from data set.

Author

E. Noirfalise

Date

2016/02/12

Copyright

2016 Reactiv'IP, all right reserved.

Member Function Documentation

getNbMinRequestedData()

ipUInt32 ipsdk::math::BaseEstimator::getNbMinRequestedData

(

)

const

retrieve minimum data set size to ensure an estimation

Exceptions

ipsdk::math::IPSDKMathException

if isInit() == false

getNbEstimParams()

ipUInt32 ipsdk::math::BaseEstimator::getNbEstimParams

(

)

const

retrieve number of estimated parameters

Exceptions

ipsdk::math::IPSDKMathException

if isInit() == false

getDataSize()

ipUInt32 ipsdk::math::BaseEstimator::getDataSize

(

)

const

unitary data size into data set collection

Exceptions

ipsdk::math::IPSDKMathException

if isInit() == false

computeEstimation()

BoolResult ipsdk::math::BaseEstimator::computeEstimation	(	const DataSet &	dataSet,
		ParameterType &	estimParams
	)

method allowing to estimate parameters from a given data set

Exceptions

ipsdk::math::IPSDKMathException

if isInit() == false

Returns

false in case of failure

computeResiduals()

BoolResult ipsdk::math::BaseEstimator::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

Exceptions

ipsdk::math::IPSDKMathException	if isInit() == false
ipsdk::math::IPSDKMathException	if dataSet.size() != residualsSet.size()

Returns

false in case of failure

initBase()

void ipsdk::math::BaseEstimator::initBase ( const ipUInt32  nbMinRequestedData, const ipUInt32  nbEstimParams, const ipUInt32  dataSize  )

protected

base class initialization

Exceptions

ipsdk::math::IPSDKMathException	if nbMinRequestedData == 0
ipsdk::math::IPSDKMathException	if nbEstimParams == 0
ipsdk::math::IPSDKMathException	if dataSize == 0

checkData()

BoolResult ipsdk::math::BaseEstimator::checkData ( const DataSet &  dataSet, const ParameterType &  estimParams  ) const

protected

method allowing to check input data properties associated to estimation

Returns

false in case of failure

processEstimation()

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

protectedpure virtual

method allowing to compute estimation into derived classes

Returns

false in case of failure

Implemented in ipsdk::math::Polynomial2dSurfaceEstimator, and ipsdk::math::BaseGaussianCurveEstimator.

processResiduals()

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

protectedpure virtual

method allowing to compute residuals into derived classes

Returns

false in case of failure

Implemented in ipsdk::math::Polynomial2dSurfaceEstimator, and ipsdk::math::BaseGaussianCurveEstimator.

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKMath/Estimation/BaseEstimator.h