ipsdk::shape::analysis::ValueMeasureResult< T > Class Template Reference

Class associated to measure results agregating a single value for each shape. More...

#include <ValueMeasureResult.h>

Inheritance diagram for ipsdk::shape::analysis::ValueMeasureResult< T >:

Public Types
typedef T	ValueType
	measure type associated to object
typedef std::vector< ValueType >	CollType
	collection type associated to object
typedef std::vector< CollType >	ColorCollType
	color (by color plan) collection type associated to object

Public Member Functions
eDataType	getMsrResultDataType () const
	retrieve underlying data type associated to object
math::HistogramPtr	extractHistogram (const ipUInt64 nbClasses, const ipUInt64 cPlanIdx=0) const
	extract histogram from result collection for a given plan index More...
Constructors and destructors
	ValueMeasureResult ()
	~ValueMeasureResult ()
const ColorCollType &	getColorColl () const
	retrieve global (by color plan) result collection More...
ColorCollType &	getColorColl ()
	retrieve global (by color plan) result collection More...
const CollType &	getColl (const ipUInt64 cPlanIdx=0) const
	retrieve result collection for a given plan index More...
CollType &	getColl (const ipUInt64 cPlanIdx=0)
	retrieve result collection for a given plan index More...
Public Member Functions inherited from ipsdk::shape::analysis::BaseValueMeasureResult
eMsrResultType	getMsrResultType () const
	retrieve measure result type associated to object
	BaseValueMeasureResult ()
virtual	~BaseValueMeasureResult ()=0
Public Member Functions inherited from ipsdk::shape::analysis::BaseMeasureResult
bool	isInit () const
	retrieve object initialization flag
void	init (const ipUInt64 nbColorPlans, const ipUInt64 nbEntities)
	initialization of object
ipUInt64	getNbColorPlans () const
	retrieve number of color plans results associated to object More...
ipUInt64	getNbEntities () const
	retrieve number of shape entity results associated to object More...
bool	isValid (const ipUInt64 cPlanIdx) const
	check for color plan index validity More...
void	collectResults (const ipUInt64 resultStartIndex, const BaseMeasureResult &baseSubResults)
	merge of a sub result into object More...
void	collectResults (const UInt64Vector &subDataIdxColl, const BaseMeasureResult &baseSubResults)
	merge of a sub result into object More...
void	extractResults (const ipUInt64 resultStartIndex, const BaseMeasureResult &baseMainResults)
	extract of a sub result from another object More...
void	extractResults (const UInt64Vector &mainDataIdxColl, const BaseMeasureResult &baseMainResults)
	extract of a sub result from another object More...
void	clear ()
	clear of object data
	BaseMeasureResult ()
virtual	~BaseMeasureResult ()=0
Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzMode &	getSerializationMode () const
	retrieve serialization flag for object More...
void	setSerializationMode (const eSklSrzMode &sklSrzMode) const
	set serialization flag for object
	BaseObjectWithSkeleton ()
	~BaseObjectWithSkeleton ()
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 Member Functions
void	initDerived (const ipUInt64 nbColorPlans, const ipUInt64 nbEntities)
	initialization of object in derived class
void	clearDerived ()
	clear of object data in derived class
void	collectResultsDerived (const ipUInt64 resultStartIndex, const BaseMeasureResult &baseSubResults)
	merge of a sub result into object in derived class
void	collectResultsDerived (const UInt64Vector &subDataIdxColl, const BaseMeasureResult &baseSubResults)
	merge of a sub result into object in derived class
void	extractResultsDerived (const ipUInt64 resultStartIndex, const BaseMeasureResult &baseMainResults)
	extract of a sub result from another object
void	extractResultsDerived (const UInt64Vector &mainDataIdxColl, const BaseMeasureResult &baseMainResults)
	extract of a sub result from another object
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

Protected Attributes
ColorCollType	_coll
	result collection associated to object
Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode
	serialization flag for object More...

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

Detailed Description

template<typename T>
class ipsdk::shape::analysis::ValueMeasureResult< T >

Class associated to measure results agregating a single value for each shape.

Author

E. Noirfalise

Date

2015/06/23

Copyright

2015 Reactiv'IP, all right reserved.

Member Function Documentation

getColorColl() [1/2]

template<typename T >

const ColorCollType& ipsdk::shape::analysis::ValueMeasureResult< T >::getColorColl

(

)

const

retrieve global (by color plan) result collection

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

getColorColl() [2/2]

template<typename T >

ColorCollType& ipsdk::shape::analysis::ValueMeasureResult< T >::getColorColl

(

)

retrieve global (by color plan) result collection

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isInit() == false

getColl() [1/2]

template<typename T >

const CollType& ipsdk::shape::analysis::ValueMeasureResult< T >::getColl

(

const ipUInt64

cPlanIdx = 0

)

const

retrieve result collection for a given plan index

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isValid(cPlanIdx) == false

getColl() [2/2]

template<typename T >

CollType& ipsdk::shape::analysis::ValueMeasureResult< T >::getColl

(

const ipUInt64

cPlanIdx = 0

)

retrieve result collection for a given plan index

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isValid(cPlanIdx) == false

extractHistogram()

template<typename T >

math::HistogramPtr ipsdk::shape::analysis::ValueMeasureResult< T >::extractHistogram	(	const ipUInt64	nbClasses,
		const ipUInt64	cPlanIdx = 0
	)		const

extract histogram from result collection for a given plan index

Note

data associated to null index are ignored

Returns

an un initialized histogram if getNbEntities() == 0

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if isValid(cPlanIdx) == false

---

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

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseShapeAnalysis/Measure/Result/MeasureResultTypes.h
• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseShapeAnalysis/Measure/Result/ValueMeasureResult.h