Structure allowing to encapsulate robust estimation results. More...

#include <EstimationResults.h>

Inheritance diagram for ipsdk::math::EstimationResults:

Public Member Functions
bool	isInit () const
	check whether objet has been initialized

void	initFailed (const EstimationConfig &config, const ipUInt32 nbEstimParams, const ipUInt32 inputDataSize, const ipUInt32 nbMinDataForEstimation, const ipUInt32 nbMinDataForRobustEstimation, const ipUInt32 nbInputData, const std::string &failureMessage)
	initialize object to a failed status

void	initRobustSuccess (const EstimationConfig &config, const ipUInt32 nbEstimParams, const ipUInt32 inputDataSize, const ipUInt32 nbMinDataForEstimation, const ipUInt32 nbMinDataForRobustEstimation, const ipUInt32 nbInputData, const ParameterType &estimParams, const ResidualsSet &residualsSet, const OutlierFlags &outlierFlags, const ipReal64 estimOutlierThreshold)
	initialize object to a success status with robust estimation

void	initSimpleSuccess (const EstimationConfig &config, const ipUInt32 nbEstimParams, const ipUInt32 inputDataSize, const ipUInt32 nbMinDataForEstimation, const ipUInt32 nbMinDataForRobustEstimation, const ipUInt32 nbInputData, const ParameterType &estimParams, const ResidualsSet &residualsSet)
	initialize object to a success status with simple estimation

const EstimationConfig &	getEstimationConfig () const
	retrieve input configuration for estimation More...

ipUInt32	getNbEstimParams () const
	retrieve number of estimated parameters More...

ipUInt32	getInputDataSize () const
	retrieve input data size (size of each input data in data set) More...

ipUInt32	getNbMinDataForEstimation () const
	retrieve minimum number of input data for a simple estimation More...

ipUInt32	getNbMinDataForRobustEstimation () const
	retrieve minimum number of input data for a robust estimation More...

ipUInt32	getNbInputData () const
	retrieve number of input data available for estimation More...

const BoolResult &	getEstimationStatus () const
	retrieve estimation status More...

bool	hasRobustEstimationDone () const
	retrieve flag indicating whether a robust estimation has been proceeded More...

const ParameterType &	getEstimParams () const
	retrieve estimated parameters More...

const ResidualsSet &	getResidualsSet () const
	retrieve estimation residuals More...

const OutlierFlags &	getOutlierFlags () const
	retrieve estimated outlier flags More...

ipReal64	getEstimOutlierThreshold () const
	retrieve outlier threshold estimated during processing More...

ipReal64	getGlobalRms () const
	retrieve global root mean square over all input data set More...

ipReal64	getInliersRms () const
	retrieve root mean square over inliers sub data set More...

ipUInt32	getNbOutliers () const
	retrieve number of outliers More...

ipUInt32	getNbInliers () const
	retrieve number of inliers More...

ipReal64	getOutlierRatio () const
	retrieve estimated oulier ratio More...

ipReal64	getInlierRatio () const
	retrieve estimated inlier ratio More...

ipUInt32	getNbNonLinearIteration () const
	retrieve number of retrieve non linear iteration proceeded (0 stands for no non linear processings) More...

void	clear ()
	clear of estimation results

Constructors and destructor
	EstimationResults ()

	~EstimationResults ()


void	updateNonLinearFailed (const std::string &failureMessage)
	methods allowing to update estimation results with non linear results More...

void	updateNonLinearSuccess (const ParameterType &estimParams, const ResidualsSet &residualsSet, const ipUInt32 nbNonLinearIteration, const std::string &warnMessage="")
	methods allowing to update estimation results with non linear results More...

Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.

virtual	~BaseSerializationObject ()=0
	destructor

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name

virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type

virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type

virtual bool	hasCopySupport () const =0
	check whether objet has copy support

virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...

virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...

	BaseDynamicObject ()

virtual	~BaseDynamicObject ()=0

Protected Attributes
bool	_bInit
	flag indicating whether object has been initialized

EstimationConfig	_config
	configuration object for processings

ipUInt32	_nbEstimParams
	number of estimated parameters

ipUInt32	_inputDataSize

ipUInt32	_nbMinDataForEstimation
	minimum number of input data for a simple estimation

ipUInt32	_nbMinDataForRobustEstimation
	minimum number of input data for a robust estimation

ipUInt32	_nbInputData
	number of input data available for estimation

BoolResult	_estimationStatus
	estimation status

bool	_bRobustEstimationDone

ParameterType	_estimParams
	estimated parameters

ResidualsSet	_residualsSet
	estimation residuals

OutlierFlags	_outlierFlags
	estimated outlier flags

ipReal64	_estimOutlierThreshold
	outlier threshold estimated during processing

ipUInt32	_nbNonLinearIteration

Additional Inherited Members
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object

virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Detailed Description

Structure allowing to encapsulate robust estimation results.

Author: E.Noirfalise

Date: 2017/05/30

Copyright: 2017 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getEstimationConfig()

const EstimationConfig& ipsdk::math::EstimationResults::getEstimationConfig ( ) const

retrieve input configuration for estimation

Exceptions

ipsdk::math::IPSDKMathException if isInit() == false

◆ getNbEstimParams()

ipUInt32 ipsdk::math::EstimationResults::getNbEstimParams ( ) const

retrieve number of estimated parameters

Exceptions

ipsdk::math::IPSDKMathException if isInit() == false

◆ getInputDataSize()

ipUInt32 ipsdk::math::EstimationResults::getInputDataSize ( ) const

retrieve input data size (size of each input data in data set)

Exceptions

ipsdk::math::IPSDKMathException if isInit() == false

◆ getNbMinDataForEstimation()

ipUInt32 ipsdk::math::EstimationResults::getNbMinDataForEstimation ( ) const

retrieve minimum number of input data for a simple estimation

Exceptions

ipsdk::math::IPSDKMathException if isInit() == false

◆ getNbMinDataForRobustEstimation()

ipUInt32 ipsdk::math::EstimationResults::getNbMinDataForRobustEstimation ( ) const

retrieve minimum number of input data for a robust estimation

Exceptions

ipsdk::math::IPSDKMathException if isInit() == false

◆ getNbInputData()

ipUInt32 ipsdk::math::EstimationResults::getNbInputData ( ) const

retrieve number of input data available for estimation

Exceptions

ipsdk::math::IPSDKMathException if isInit() == false

◆ getEstimationStatus()

const BoolResult& ipsdk::math::EstimationResults::getEstimationStatus ( ) const

retrieve estimation status

Exceptions

ipsdk::math::IPSDKMathException if isInit() == false