IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Classes

gives the quantile of the intensity histogram More...

Classes

class  ipsdk::imaproc::shape::analysis::HistogramQuantileMsr
 Measurement object for measure HistogramQuantile. More...
 
class  ipsdk::imaproc::shape::analysis::HistogramQuantileMsrInfo
 Information object for measure HistogramQuantile. More...
 
class  ipsdk::imaproc::shape::analysis::HistogramQuantileMsrParams
 Parameter object for measure HistogramQuantile. More...
 
IPSDKIPLSHAPEANALYSIS_API HistogramQuantileMsrParamsPtr ipsdk::imaproc::shape::analysis::createHistogramQuantileMsrParams (const HistogramMsrParams &histoMsrParams, const ipReal64 rate)
 function allowing to create a new parameter object for HistogramQuantile measure
 
IPSDKIPLSHAPEANALYSIS_API HistogramQuantileMsrParamsPtr ipsdk::imaproc::shape::analysis::createHistogramQuantileMsrParamsBinWidth (const ipReal64 binWidth, const ipReal64 rate)
 function allowing to create a new parameter object for HistogramQuantile measure
 
IPSDKIPLSHAPEANALYSIS_API HistogramQuantileMsrParamsPtr ipsdk::imaproc::shape::analysis::createHistogramQuantileMsrParamsBinWidth (const ipReal64 binWidth, const ipReal64 histoMin, const ipReal64 histoMax, const ipReal64 rate)
 function allowing to create a new parameter object for HistogramQuantile measure
 
IPSDKIPLSHAPEANALYSIS_API HistogramQuantileMsrParamsPtr ipsdk::imaproc::shape::analysis::createHistogramQuantileMsrParamsMinMaxShapeNbClasses (const ipUInt32 nbClasses, const ipReal64 rate)
 function allowing to create a new parameter object for HistogramQuantile measure
 
IPSDKIPLSHAPEANALYSIS_API HistogramQuantileMsrParamsPtr ipsdk::imaproc::shape::analysis::createHistogramQuantileMsrParamsMinMaxImgNbClasses (const ipUInt32 nbClasses, const ipReal64 rate)
 function allowing to create a new parameter object for HistogramQuantile measure
 
IPSDKIPLSHAPEANALYSIS_API HistogramQuantileMsrParamsPtr ipsdk::imaproc::shape::analysis::createHistogramQuantileMsrParamsNbClasses (const ipUInt32 nbClasses, const ipReal64 histoMin, const ipReal64 histoMax, const ipReal64 rate)
 function allowing to create a new parameter object for HistogramQuantile measure
 

Detailed Description

gives the quantile of the intensity histogram

HistogramQuantile measure computes, for a given rate (expressed in percent), the quantile on the intensity histogram of the shape.

For a given rate $r$, the quantile q is the minimal intensity value for which $ \sum_{i=histoMin}^{q}{histo[i]} \geq r * NbPixels$, with $NbPixels$ the number of pixels in the shape.

Here is an example of histogram quantile measurement (rate=25%) in 2d case :

histogramQuantileMsr.png
Author
H. Delestre
Date
2015/07/09

gives the quantile of the intensity histogram computed on shape for a given rate

Measure synthesis :

Measure Type Measure Unit Type Parameter Type Result Type Shape Requirements
Generic.png
Generic
none.png
None
parameter.png
HistogramQuantileMsrParams
Value.png
Value (ipsdk::ipReal64)
RowIntersections.png
Row Intersections
See Shape measurement for additional information on these pictograms

Measure Type :

This is a generic measure

This measure can be used in 2d and 3d case

Measure Unit Type:

Measure HistogramQuantile is not associated to any unit [ipsdk::shape::analysis::eMsrUnitFormat::eMUF_NoUnit]

Measure Parameter Type :

Measure HistogramQuantile is associated to HistogramQuantileMsrParams parameters

Measure Result Type :

Measure HistogramQuantile is associated to ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64> results

Measure Shape Requirements :

Measure HistogramQuantile requires row intersections from shape data

Measure Dependencies :

Measure HistogramQuantile depends on following measures :

Measure Mode Measure Name Measure Type Measure Parameters
eMVP_2d3d Histogram Histogram createHistogramMsrParams(_pMsrParams->getNode<HistogramQuantileMsrParams::HistoParams>())
eMVP_2d NbPixels NbPixels2d
eMVP_3d NbPixels NbPixels3d
Note
See Shape Analysis 2d for more information on general shape 2d analysis and measurement usage.
See Shape Analysis 3d for more information on general shape 3d analysis and measurement usage.

Example of Python code :

Generic example in 2d case :

import PyIPSDK
import PyIPSDK.IPSDKIPLShapeAnalysis as shapeanalysis
# Create the infoset
inMeasureInfoSet2d = PyIPSDK.createMeasureInfoSet2d()
PyIPSDK.createMeasureInfo(inMeasureInfoSet2d, "HistogramQuantileMsr")
#Perform the analysis
outMeasureSet = shapeanalysis.labelAnalysis2d(inGreyImg, inLabelImg2d, inMeasureInfoSet2d)
# save results to csv format
PyIPSDK.saveCsvMeasureFile(os.path.join(tmpPath, "shape_analysis_results.csv"), outMeasureSet)
# retrieve measure results
outMsr = outMeasureSet.getMeasure("HistogramQuantileMsr")
# retrieve measure values
outMsrValues = outMsr.getMeasureResult().getColl(0)
print("First label measurement equal " + str(outMsrValues[1]))

Generic example in 3d case :

import PyIPSDK
import PyIPSDK.IPSDKIPLShapeAnalysis as shapeanalysis
# Create the infoset
inMeasureInfoSet3d = PyIPSDK.createMeasureInfoSet3d()
PyIPSDK.createMeasureInfo(inMeasureInfoSet3d, "HistogramQuantileMsr")
#Perform the analysis
outMeasureSet = shapeanalysis.labelAnalysis3d(inGreyImg, inLabelImg, inMeasureInfoSet3d)
# save results to csv format
PyIPSDK.saveCsvMeasureFile(os.path.join(tmpPath, "shape_analysis_results.csv"), outMeasureSet)
# retrieve measure results
outMsr = outMeasureSet.getMeasure("HistogramQuantileMsr")
# retrieve measure values
outMsrValues = outMsr.getMeasureResult().getColl(0)
print("First label measurement equal " + str(outMsrValues[1]))

Example of C++ code :

Example informations

Associated library

IPSDKIPLShapeAnalysis

Code Example

// opening grey level input image
ImagePtr pInGreyImg2d = loadTiffImageFile(inputGreyImgPath);
// read entity shape 2d collection used for processing
Shape2dCollPtr pShape2dColl = boost::make_shared<Shape2dColl>();
readFromXmlFile(inputShape2dCollPath, *pShape2dColl);
// define a measure info set
MeasureInfoSetPtr pMeasureInfoSet = MeasureInfoSet::create2dInstance();
createMeasureInfo(pMeasureInfoSet, "HistogramQuantileMsr", createHistogramQuantileMsrParamsBinWidth(1.0, 25.0));
// compute measure on shape 2d collection
MeasureSetPtr pOutMeasureSet = shapeAnalysis2d(pInGreyImg2d, pShape2dColl, pMeasureInfoSet);
// retrieve associated results
const MeasureConstPtr& pHistogramQuantileOutMsr = pOutMeasureSet->getMeasure("HistogramQuantileMsr");
static_cast<const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>&>(pHistogramQuantileOutMsr->getMeasureResult());