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

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

Classes

class  ipsdk::imaproc::shape::analysis::FeretDiameter3dMsr
 Measurement object for measure FeretDiameter3d. More...
 
class  ipsdk::imaproc::shape::analysis::FeretDiameter3dMsrInfo
 Information object for measure FeretDiameter3d. More...
 
class  ipsdk::imaproc::shape::analysis::FeretDiameter3dMsrParams
 Parameter object for measure FeretDiameter3d. More...
 

Functions

IPSDKIPLSHAPEANALYSIS_API FeretDiameter3dMsrParamsPtr ipsdk::imaproc::shape::analysis::createFeretDiameter3dMsrParams (ipReal64 phi, ipReal64 theta)
 function allowing to create a new parameter object for FeretDiameter3d measure
 

Detailed Description

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

The 3d 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 3d shape in a given direction (that will be described by 2 angles $\phi$ and $\theta$). The 2 angles $\phi$ and $\theta$ of the Feret diameter can be specified by the user. $\phi$ must belong to the range [0; $2*\pi$[, and $\theta$ must belong to the range [0; $\pi$]

For more information about the definition of the 2 angles, report to "ConventionsPoints3d" section in the Core documentation

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

feretDiameter3dMsr.png
See also
https://en.wikipedia.org/wiki/Feret_diameter
Author
H. Delestre
Date
2016/03/24

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
FeretDiameter3dMsrParams
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 3d case

Measure Unit Type:

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

Measure Parameter Type :

Measure FeretDiameter3d is associated to FeretDiameter3dMsrParams parameters

Measure Result Type :

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

Measure Shape Requirements :

Measure FeretDiameter3d requires boundary approximation from shape data

Measure Dependencies :

Measure FeretDiameter3d depends on following measures :

Measure Mode Measure Name Measure Type Measure Parameters
eMVP_3d ConvexHull3d ConvexHull3d
Note
See Shape Analysis 3d for more information on general shape 3d analysis and measurement usage.

Example of Python code :

Generic example in 3d case :

import PyIPSDK
import PyIPSDK.IPSDKIPLShapeAnalysis as shapeanalysis
# Create the infoset
inMeasureInfoSet3d = PyIPSDK.createMeasureInfoSet3d()
PyIPSDK.createMeasureInfo(inMeasureInfoSet3d, "FeretDiameter3dMsr")
#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("FeretDiameter3dMsr")
# 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 pInGreyImg3d = loadTiffImageFile(inputGreyImgPath, eTiffDirectoryMode::eTDM_Volume);
// read entity shape 3d collection used for processing
Shape3dCollPtr pShape3dColl = boost::make_shared<Shape3dColl>();
readFromBinaryFile(inputShape3dCollPath, *pShape3dColl);
// define a measure info set
MeasureInfoSetPtr pMeasureInfoSet = MeasureInfoSet::create3dInstance();
createMeasureInfo(pMeasureInfoSet, "FeretDiameter3dMsr", createFeretDiameter3dMsrParams(phi, theta));
// compute measure on shape 3d collection
MeasureSetPtr pOutMeasureSet = shapeAnalysis3d(pInGreyImg3d, pShape3dColl, pMeasureInfoSet);
// retrieve associated results
const MeasureConstPtr& pFeretDiameter3dOutMsr = pOutMeasureSet->getMeasure("FeretDiameter3dMsr");
const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>& outResults = static_cast<const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>&>(pFeretDiameter3dOutMsr->getMeasureResult());