IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Classes

Material porosity measurement : fraction of the volume of voids over the total volume. More...

Classes

class  ipsdk::imaproc::shape::analysis::PorosityMsr
 Measurement object for measure Porosity. More...
 
class  ipsdk::imaproc::shape::analysis::PorosityMsrInfo
 Information object for measure Porosity. More...
 

Detailed Description

Material porosity measurement : fraction of the volume of voids over the total volume.

Porosity or void fraction is a measure of the void spaces in a material.

Porosity measure values are included in $[0;1]$:

Porosity measure is given by :

Here is an example of porosity measurement in 2d case :

porosity2dMsr.png
See also
https://en.wikipedia.org/wiki/Porosity
Author
E. Noirfalise
Date
2015/07/10

Material porosity measurement : fraction of the volume of voids over the total volume

Measure synthesis :

Measure Type Measure Unit Type Parameter Type Result Type Shape Requirements
Generic.png
Generic
none.png
None
none.png
None
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 be used in 2d and 3d case

Measure Unit Type:

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

Measure Parameter Type :

Measure Porosity has no parameters

Measure Result Type :

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

Measure Shape Requirements :

Measure Porosity requires boundary approximation from shape data

Measure Dependencies :

Measure Porosity depends on following measures :

Measure Mode Measure Name Measure Type Measure Parameters
eMVP_2d TotalValue PolygonArea2d createHolesBasicPolicyMsrParams(false)
eMVP_3d TotalValue MeshVolume3d createHolesBasicPolicyMsrParams(false)
eMVP_2d ValueMinusVoids PolygonArea2d createHolesBasicPolicyMsrParams(true)
eMVP_3d ValueMinusVoids MeshVolume3d createHolesBasicPolicyMsrParams(true)
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, "PorosityMsr")
#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("PorosityMsr")
# 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, "PorosityMsr")
#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("PorosityMsr")
# 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, "PorosityMsr");
// compute measure on shape 2d collection
MeasureSetPtr pOutMeasureSet = shapeAnalysis2d(pInGreyImg2d, pShape2dColl, pMeasureInfoSet);
// retrieve associated results
const MeasureConstPtr& pPorosityOutMsr = pOutMeasureSet->getMeasure("PorosityMsr");
const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>& outResults = static_cast<const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>&>(pPorosityOutMsr->getMeasureResult());