robust estimation results More...

#include <RobustEstimationResults.h>

Inheritance diagram for ipsdk::imaproc::attr::RobustEstimationResults:

Public Member Functions
const std::string &	getObjectName () const
	method allowing to retrieve object name

const std::string &	getToolTip () const
	method allowing to retrieve object tooltip

const boost::filesystem::path	getHeaderPath () const
	retrieve relative header path associated to data item node

const std::string	getLibraryName () const
	retrieve library name associated data item node

const ipsdk::ItemNames &	getItemIds () const
	retrieve item associated to a given id More...

	~RobustEstimationResults ()
	public destructor

	RobustEstimationResults (const ipsdk::math::EstimationResults &results)
	additional constructor More...

	operator ipsdk::math::EstimationResults () const
	convertion to estimation results object

Methods associated to sub node Config
template<>
const ipsdk::imaproc::attr::RobustEstimationConfig &	getNode () const
	access to sub node Config

template<>
ipsdk::imaproc::attr::RobustEstimationConfig &	get ()
	access to sub node Config

Methods associated to sub node NbEstimParams
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	getNode () const
	access to sub node NbEstimParams

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	get ()
	access to sub node NbEstimParams

template<>
const ipsdk::ipUInt32 &	getValue () const
	access to value for sub node NbEstimParams

template<>
void	setValue (const ipsdk::ipUInt32 &value)
	access to value for sub node NbEstimParams

Methods associated to sub node InputDataSize
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	getNode () const
	access to sub node InputDataSize

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	get ()
	access to sub node InputDataSize

template<>
const ipsdk::ipUInt32 &	getValue () const
	access to value for sub node InputDataSize

template<>
void	setValue (const ipsdk::ipUInt32 &value)
	access to value for sub node InputDataSize

Methods associated to sub node NbMinDataForEstimation
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	getNode () const
	access to sub node NbMinDataForEstimation

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	get ()
	access to sub node NbMinDataForEstimation

template<>
const ipsdk::ipUInt32 &	getValue () const
	access to value for sub node NbMinDataForEstimation

template<>
void	setValue (const ipsdk::ipUInt32 &value)
	access to value for sub node NbMinDataForEstimation

Methods associated to sub node NbMinDataForRobustEstimation
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	getNode () const
	access to sub node NbMinDataForRobustEstimation

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	get ()
	access to sub node NbMinDataForRobustEstimation

template<>
const ipsdk::ipUInt32 &	getValue () const
	access to value for sub node NbMinDataForRobustEstimation

template<>
void	setValue (const ipsdk::ipUInt32 &value)
	access to value for sub node NbMinDataForRobustEstimation

Methods associated to sub node NbInputData
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	getNode () const
	access to sub node NbInputData

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	get ()
	access to sub node NbInputData

template<>
const ipsdk::ipUInt32 &	getValue () const
	access to value for sub node NbInputData

template<>
void	setValue (const ipsdk::ipUInt32 &value)
	access to value for sub node NbInputData

Methods associated to sub node EstimationStatusFlag
template<>
const ipsdk::DataItemLeaf< ipsdk::ipBool > &	getNode () const
	access to sub node EstimationStatusFlag

template<>
ipsdk::DataItemLeaf< ipsdk::ipBool > &	get ()
	access to sub node EstimationStatusFlag

template<>
const ipsdk::ipBool &	getValue () const
	access to value for sub node EstimationStatusFlag

template<>
void	setValue (const ipsdk::ipBool &value)
	access to value for sub node EstimationStatusFlag

Methods associated to sub node EstimationStatusMsg
template<>
const ipsdk::DataItemLeaf< std::string > &	getNode () const
	access to sub node EstimationStatusMsg

template<>
ipsdk::DataItemLeaf< std::string > &	get ()
	access to sub node EstimationStatusMsg

template<>
const std::string &	getValue () const
	access to value for sub node EstimationStatusMsg

template<>
void	setValue (const std::string &value)
	access to value for sub node EstimationStatusMsg

Methods associated to sub node RobustEstimationDone
template<>
const ipsdk::DataItemLeaf< ipsdk::ipBool > &	getNode () const
	access to sub node RobustEstimationDone

template<>
ipsdk::DataItemLeaf< ipsdk::ipBool > &	get ()
	access to sub node RobustEstimationDone

template<>
const ipsdk::ipBool &	getValue () const
	access to value for sub node RobustEstimationDone

template<>
void	setValue (const ipsdk::ipBool &value)
	access to value for sub node RobustEstimationDone

Methods associated to sub node EstimParams
template<>
const ipsdk::DataItemLeafColl< ipsdk::ipReal64 > &	getNode () const
	access to sub node EstimParams

template<>
ipsdk::DataItemLeafColl< ipsdk::ipReal64 > &	get ()
	access to sub node EstimParams

template<>
const std::vector< ipsdk::ipReal64 > &	getLeafColl () const
	access to value collection for sub node EstimParams

template<>
std::vector< ipsdk::ipReal64 > &	getLeafColl ()
	access to value collection for sub node EstimParams

template<>
bool	isEmpty () const
	check wether collection is empty for sub node EstimParams

template<>
ipsdk::ipUInt32	getSize () const
	retrieve collection size for sub node EstimParams

template<>
void	push_back (const ipsdk::ipReal64 &value)
	push back a new element into collection for sub node EstimParams

template<>
void	clear ()
	remove all items from collection for sub node EstimParams

Methods associated to sub node ResidualsSet
template<>
const ipsdk::DataItemLeafColl< ipsdk::ipReal64 > &	getNode () const
	access to sub node ResidualsSet

template<>
ipsdk::DataItemLeafColl< ipsdk::ipReal64 > &	get ()
	access to sub node ResidualsSet

template<>
const std::vector< ipsdk::ipReal64 > &	getLeafColl () const
	access to value collection for sub node ResidualsSet

template<>
std::vector< ipsdk::ipReal64 > &	getLeafColl ()
	access to value collection for sub node ResidualsSet

template<>
bool	isEmpty () const
	check wether collection is empty for sub node ResidualsSet

template<>
ipsdk::ipUInt32	getSize () const
	retrieve collection size for sub node ResidualsSet

template<>
void	push_back (const ipsdk::ipReal64 &value)
	push back a new element into collection for sub node ResidualsSet

template<>
void	clear ()
	remove all items from collection for sub node ResidualsSet

Methods associated to sub node OutlierFlags
template<>
const ipsdk::DataItemLeafColl< ipsdk::ipBool > &	getNode () const
	access to sub node OutlierFlags

template<>
ipsdk::DataItemLeafColl< ipsdk::ipBool > &	get ()
	access to sub node OutlierFlags

template<>
const std::vector< ipsdk::ipBool > &	getLeafColl () const
	access to value collection for sub node OutlierFlags

template<>
std::vector< ipsdk::ipBool > &	getLeafColl ()
	access to value collection for sub node OutlierFlags

template<>
bool	isEmpty () const
	check wether collection is empty for sub node OutlierFlags

template<>
ipsdk::ipUInt32	getSize () const
	retrieve collection size for sub node OutlierFlags

template<>
void	push_back (const ipsdk::ipBool &value)
	push back a new element into collection for sub node OutlierFlags

template<>
void	clear ()
	remove all items from collection for sub node OutlierFlags

Methods associated to sub node EstimOutlierThreshold
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	getNode () const
	access to sub node EstimOutlierThreshold

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	get ()
	access to sub node EstimOutlierThreshold

template<>
const ipsdk::ipReal64 &	getValue () const
	access to value for sub node EstimOutlierThreshold

template<>
void	setValue (const ipsdk::ipReal64 &value)
	access to value for sub node EstimOutlierThreshold

Methods associated to sub node NbNonLinearIteration
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	getNode () const
	access to sub node NbNonLinearIteration

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	get ()
	access to sub node NbNonLinearIteration

template<>
const ipsdk::ipUInt32 &	getValue () const
	access to value for sub node NbNonLinearIteration

template<>
void	setValue (const ipsdk::ipUInt32 &value)
	access to value for sub node NbNonLinearIteration

Public Member Functions inherited from ipsdk::BaseDataItemNode
eDataItemType	getDataItemType () const

bool	existsItem (const std::string &itemId) const

const BaseDataItem &	getItem (const std::string &itemId) const

const std::string &	getItemName (const std::string &itemId) const

const std::string &	getItemToolTip (const std::string &itemId) const

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const

virtual BaseDynamicObject *	createNew () const=0

virtual DynamicObjectPtr	createShared () const=0

virtual bool	hasCopySupport () const=0

virtual BaseDynamicObject *	duplicate () const=0

virtual DynamicObjectPtr	duplicateShared () const=0

Static Public Member Functions
static const std::string &	getObjectNameStr ()
	method allowing to retrieve object name

static const std::string &	getToolTipStr ()
	method allowing to retrieve object tooltip

static const boost::filesystem::path	getHeaderPathStr ()
	retrieve relative header path associated to data item node

static const std::string	getLibraryNameStr ()
	retrieve library name associated data item node

static boost::shared_ptr< RobustEstimationResults >	createNode ()
	node creation function

Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()

Static Public Attributes
static const ipsdk::ipUInt32	g_nbChildNodes
	number of child nodes associated to object

Static Public Attributes inherited from ipsdk::BaseDataItemNode
static const bool	g_bIsColl

static const bool	g_bNode

static const bool	g_bLeaf

static const eDataItemType::domain	g_itemType

Protected Member Functions
	RobustEstimationResults ()
	protected constructor

Protected Member Functions inherited from ipsdk::BaseDataItemNode
virtual ItemInfoPtr	getItemInfo (const std::string &itemId) const=0

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const

virtual BoolResult	read (BaseIArchive &ar)

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

virtual void	copy (const BaseDynamicObject &object)

Additional Inherited Members
Protected Types inherited from ipsdk::BaseDataItemNode
typedef boost::shared_ptr< ItemInfo >	ItemInfoPtr

Detailed Description

robust estimation results

Author: E.Noirfalise

Date: 2017/05/30

Copyright: 2017 Reactiv'IP, all right reserved.

Node associated library :

IPSDKIPLAttributes

SubNodes description

Name	ToolTip	Associated Class
Config	threshold on accumulation intensities for local maxima extraction	ipsdk::imaproc::attr::RobustEstimationConfig
NbEstimParams	number of estimated parameters	ipsdk::DataItemLeaf<ipsdk::ipUInt32>
InputDataSize	size of input data (size of each elements in input data set)	ipsdk::DataItemLeaf<ipsdk::ipUInt32>
NbMinDataForEstimation	minimum number of input data for a simple estimation	ipsdk::DataItemLeaf<ipsdk::ipUInt32>
NbMinDataForRobustEstimation	minimum number of input data for a robust estimation	ipsdk::DataItemLeaf<ipsdk::ipUInt32>
NbInputData	number of input data available for estimation	ipsdk::DataItemLeaf<ipsdk::ipUInt32>
EstimationStatusFlag	flag associated to estimation status	ipsdk::DataItemLeaf<ipsdk::ipBool>
EstimationStatusMsg	estimation status message	ipsdk::DataItemLeaf<std::string>
RobustEstimationDone	flag indicating whether a robust estimation has been proceeded	ipsdk::DataItemLeaf<ipsdk::ipBool>
EstimParams	estimated parameters	ipsdk::DataItemLeafColl<ipsdk::ipReal64>
ResidualsSet	estimation residuals	ipsdk::DataItemLeafColl<ipsdk::ipReal64>
OutlierFlags	estimated outlier flags	ipsdk::DataItemLeafColl<ipsdk::ipBool>
EstimOutlierThreshold	outlier threshold estimated during processing	ipsdk::DataItemLeaf<ipsdk::ipReal64>
NbNonLinearIteration	Number of non linear iteration proceeded, a null value stands for no non linear processing done.	ipsdk::DataItemLeaf<ipsdk::ipUInt32>

Constructor & Destructor Documentation

◆ RobustEstimationResults()

ipsdk::imaproc::attr::RobustEstimationResults::RobustEstimationResults ( const ipsdk::math::EstimationResults & results )

additional constructor

Exceptions

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

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::attr::RobustEstimationResults::getItemIds ( ) const

virtual

retrieve item associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException if existsItem(itemName) == false

Implements ipsdk::BaseDataItemNode.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLAttributes/DataItem/RobustEstimationResults.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions