IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Classes | Functions

Compute, for a given orientation, Feret diameter (measure based on polygonal approximation) More...

Classes

class  ipsdk::imaproc::shape::analysis::FeretDiameter2dMsr
 Measurement object for measure FeretDiameter2d. More...
 
class  ipsdk::imaproc::shape::analysis::FeretDiameter2dMsrInfo
 Information object for measure FeretDiameter2d. More...
 
class  ipsdk::imaproc::shape::analysis::FeretDiameter2dMsrParams
 Parameter object for measure FeretDiameter2d. More...
 

Functions

IPSDKIPLSHAPEANALYSIS_API FeretDiameter2dMsrParamsPtr ipsdk::imaproc::shape::analysis::createFeretDiameter2dMsrParams (ipReal64 orientation)
 function allowing to create a new parameter object for FeretDiameter2d measure
 

Detailed Description

Compute, for a given orientation, Feret diameter (measure based on polygonal approximation)

The 2d Feret diameter (also called "caliper diameter", referring to the measurement of an object size with a caliper) is a measure of the size of a 2d shape in a given direction (that will be noted $\theta$ within this document). It is equivalent to compute the width of the thinnest band of direction $\theta+\pi/2$, containing the whole 2d shape. The orientation $\theta$ of the Feret diameter can be specified by the user, and must belong to the range [0; $\pi$[.

Note
  • measuring the 2d Feret diameter of a shape with $\theta=0$ is equivalent to measure the x-size of the axis-aligned bounding box of the shape
  • measuring the 2d Feret diameter of a shape with $\theta=\pi/2$ is equivalent to measure the y-size of the axis-aligned bounding box of the shape

Here is an example of 2d Feret diameter measurement for $\theta=\pi/3$:

feretDiameter2dMsr.png
See also
https://en.wikipedia.org/wiki/Feret_diameter
Author
H. Delestre
Date
2015/07/16

computes, for a given orientation, Feret diameter

Measure synthesis :

Measure Type Measure Unit Type Parameter Type Result Type Shape Requirements
Generic.png
Generic
length.png
Length
parameter.png
FeretDiameter2dMsrParams
Value.png
Value (ipsdk::ipReal64)
BoundaryApproximation.png
Boundary Approximation
See Shape measurement for additional information on these pictograms

Measure Type :

This is a generic measure

This measure can only be used in 2d case

Measure Unit Type:

Measure FeretDiameter2d is associated to a length measurement unit [ipsdk::shape::analysis::eMsrUnitFormat::eMUF_LengthUnit]

Measure Parameter Type :

Measure FeretDiameter2d is associated to FeretDiameter2dMsrParams parameters

Measure Result Type :

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

Measure Shape Requirements :

Measure FeretDiameter2d requires boundary approximation from shape data

Measure Dependencies :

Measure FeretDiameter2d depends on following measures :

Measure Mode Measure Name Measure Type Measure Parameters
eMVP_2d ConvexHull2d ConvexHull2d
Note
See Shape Analysis 2d for more information on general shape 2d 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, "FeretDiameter2dMsr")
#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("FeretDiameter2dMsr")
# 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, "FeretDiameter2dMsr", createFeretDiameter2dMsrParams(orientation));
// compute measure on shape 2d collection
MeasureSetPtr pOutMeasureSet = shapeAnalysis2d(pInGreyImg2d, pShape2dColl, pMeasureInfoSet);
// retrieve associated results
const MeasureConstPtr& pFeretDiameter2dOutMsr = pOutMeasureSet->getMeasure("FeretDiameter2dMsr");
const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>& outResults = static_cast<const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>&>(pFeretDiameter2dOutMsr->getMeasureResult());