Measure result

Measure result. More...

Classes
class	ipsdk::shape::analysis::CollMeasureResult< T >
	Class associated to measure results agregating a collection of values for each shape. More...
class	ipsdk::shape::analysis::ValueMeasureResult< T >
	Class associated to measure results agregating a single value for each shape. More...

Enumerations
enum	ipsdk::shape::analysis::eMsrResultType { ipsdk::shape::analysis::eMRT_Value, ipsdk::shape::analysis::eMRT_Coll, ipsdk::shape::analysis::eMRT_Custom }
	Enumerate describing measure measure result type. More...

Functions
IPSDKBASESHAPEANALYSIS_API BoolResult	ipsdk::shape::analysis::saveCsvMeasureFile (const boost::filesystem::path &csvMeasureFilePath, const MeasureSet &measureSet, const eMsrResultCsvUnitFormat &msrResultCsvUnitFormat=eMsrResultCsvUnitFormat::eMRCUF_NextLine)
	function allowing to save a measure result to csv file More...
template<typename T >
IPSDKBASESHAPEANALYSIS_API const std::vector< T > &	ipsdk::shape::analysis::extractValueResults (const MeasureConstPtr &pMeasure, const ipUInt64 cPlanIdx=0)
	function allowing to extract measure results for measures associated to values More...
template<typename T >
IPSDKBASESHAPEANALYSIS_API const std::vector< std::vector< T > > &	ipsdk::shape::analysis::extractCollResults (const MeasureConstPtr &pMeasure, const ipUInt64 cPlanIdx=0)
	function allowing to extract measure results for measures associated to collections More...

Detailed Description

Measure result.

Description

Each measure is associated to a collection of results (one by shape). Measure result can take several forms, each shape can indeed be associated to :

• a single value which can be floating point, integer or boolean, see ipsdk::shape::analysis::ValueMeasureResult.
• a collection of values which can be floating point, integer or boolean, see ipsdk::shape::analysis::CollMeasureResult.
• a custom measure result which derived from ipsdk::shape::analysis::BaseCustomMeasureResult class.

Color management

Some measures work on input image intensities to compute a result (see 'Intensity' category of Main measure type). In this case, if input image has multiple color channels (ie. an RGB or a multispectral input image), each channel will be associated to a measurement result.

Working with measure results

Given a measure set (ipsdk::shape::analysis::MeasureSet) resulting from a shape analysis computation, the user can output associated measure results to a comma separator value file using function ipsdk::shape::analysis::saveCsvMeasureFile.

On the other hand, if a more detailed access to measure results is requested, the user can uses following functions :

• ipsdk::shape::analysis::extractValueResults to retrieve collection of values associated to a ipsdk::shape::analysis::ValueMeasureResult.
• ipsdk::shape::analysis::extractCollResults to retrieve collection of collection of values associated to a ipsdk::shape::analysis::CollMeasureResult.

These functions are redefined in python as follow :

• PyIPSDK.extract[TargetType]Results to retrieve collection of values associated to a ipsdk::shape::analysis::ValueMeasureResult (PyIPSDK.extractReal64Results(measure, planIdx=0) for example in case of a measure associated to a ipReal64 output result type)
• PyIPSDK.extract[TargetType]CollResults to retrieve collection of collection of values associated to a ipsdk::shape::analysis::CollMeasureResult (PyIPSDK.extractReal64CollResults(measure, planIdx=0) for example in case of a measure associated to a ipReal64 output result type)

Custom measure results will have to be acceded 'by hand' since associated result type is dedicated.

Enumeration Type Documentation

eMsrResultType

enum ipsdk::shape::analysis::eMsrResultType

Enumerate describing measure measure result type.

Note

This object is associated to a strong enumerate definition

See also

IPSDK_Enum

Enumerator
eMRT_Value	measure result is associated to a single typed value for each shape entity
eMRT_Coll	measure result is associated to a collection of typed value for each shape entity
eMRT_Custom	measure result is associated to a custom data type behavior, see associated measure for more informations

Function Documentation

saveCsvMeasureFile()

IPSDKBASESHAPEANALYSIS_API BoolResult ipsdk::shape::analysis::saveCsvMeasureFile	(	const boost::filesystem::path &	csvMeasureFilePath,
		const MeasureSet &	measureSet,
		const eMsrResultCsvUnitFormat &	msrResultCsvUnitFormat = eMsrResultCsvUnitFormat::eMRCUF_NextLine
	)

function allowing to save a measure result to csv file

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException

if measureSet.isProcessingStatus(eMsrProcessingStatus::eMPS_Ended) == false

Returns

false in case of failure

extractValueResults()

template<typename T >

IPSDKBASESHAPEANALYSIS_API const std::vector<T>& ipsdk::shape::analysis::extractValueResults	(	const MeasureConstPtr &	pMeasure,
		const ipUInt64	cPlanIdx = 0
	)

function allowing to extract measure results for measures associated to values

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if pMeasure.get() == 0
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if pMeasure->getMsrProcessingStatus() == eMsrProcessingStatus::eMPS_NotStarted
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if measure result is not of requested type
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if color plan index is not valid given measure

extractCollResults()

template<typename T >

IPSDKBASESHAPEANALYSIS_API const std::vector<std::vector<T> >& ipsdk::shape::analysis::extractCollResults	(	const MeasureConstPtr &	pMeasure,
		const ipUInt64	cPlanIdx = 0
	)

function allowing to extract measure results for measures associated to collections

Exceptions

ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if pMeasure.get() == 0
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if pMeasure->getMsrProcessingStatus() == eMsrProcessingStatus::eMPS_NotStarted
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if measure result is not of requested type
ipsdk::shape::analysis::IPSDKBaseShapeAnalysisException	if color plan index is not valid given measure