ipsdk::imaproc::shape::analysis::Area3dMsrInfo Class Reference

Information object for measure Area3d. More...

#include <Area3dMsrInfo.h>

Inheritance diagram for ipsdk::imaproc::shape::analysis::Area3dMsrInfo:

Public Types
typedef ipsdk::shape::analysis::ValueMeasureResult< ipReal64 >	MsrResultType
typedef Area3dMsrParams	MsrParamsType
	Parameter type associated to measure.
typedef const Area3dMsrParams	MsrParamsConstType
	Parameter const type associated to measure.
typedef boost::shared_ptr< MsrParamsType >	MsrParamsStorageType
	Shared pointer to parameter type associated to measure.
typedef boost::shared_ptr< MsrParamsConstType >	MsrParamsConstStorageType
	Shared pointer to const parameter type associated to measure.

Public Member Functions
	~Area3dMsrInfo ()
	destructor
const std::string &	getObjectName () const
	method allowing to retrieve object name
const std::string &	getToolTip () const
	method allowing to retrieve object tooltip
const std::string &	getDefaultName () const
ipsdk::shapeanalysis::eMsrProcessingPolicy	getMsrProcessingPolicy () const

Static Public Member Functions
static const std::string &	getObjectNameStr ()
	method allowing to retrieve object name
static const std::string &	getToolTipStr ()
	method allowing to retrieve object tooltip

Static Public Attributes
static const ipsdk::shapeanalysis::eMsrProcessingPolicy::domain	g_msrProcessingPolicy = ipsdk::shapeanalysis::eMsrProcessingPolicy::eMPP_Geometry3d

Protected Member Functions
	Area3dMsrInfo ()
	constructor

Protected Attributes
MsrParamsConstStorageType	_pMsrParams
	Derived parameter associated to measure.

Detailed Description

Information object for measure Area3d.

Author

H. Delestre

Date

2016/02/23

Copyright

2016 Reactiv'IP, all right reserved.

Shape 3d area measurement (measure based on polyhedral approximation)

Measure synthesis :

Measure Type	Measure Unit Type	Parameter Type	Result Type	Shape Requirements
Geometry 3d	Area	Area3dMsrParams	Value (ipReal64)	Boundary Approximation

See Shape measurement for additional information on these pictograms

Measure Type :

This is a geometry 3d measure

• it use shape 3d data to compute a result
• it optionally can use dependencies to other measures to compute a result (see Measure Dependencies section)

This measure can only be used in 3d case

Measure Unit Type:

Measure Area3d is associated to an area measurement unit [ipsdk::shape::analysis::eMsrUnitFormat::eMUF_AreaUnit]

Measure Parameter Type :

Measure Area3d is associated to Area3dMsrParams parameters

Measure Result Type :

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

Measure Shape Requirements :

Measure Area3d requires boundary approximation from shape data

Measure Dependencies :

Measure Area3d has no dependency

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, "AreaMinusHoles", "Area3dMsr", shapeanalysis.createHolesBasicPolicyMsrParams(True))
    PyIPSDK.createMeasureInfo(inMeasureInfoSet3d, "AreaWithHoles", "Area3dMsr", shapeanalysis.createHolesBasicPolicyMsrParams(False))
    
    #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
    outAreaMinusHolesMsr = outMeasureSet.getMeasure("AreaMinusHoles")
    outAreaWithHolesMsr = outMeasureSet.getMeasure("AreaWithHoles")
    
    # retrieve measure values
    outAreaWithHolesValues = outAreaWithHolesMsr.getMeasureResult().getColl(0)
    print("First label area with holes measurement equal " + str(outAreaWithHolesValues[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, "Area3dMsr", createHolesBasicPolicyMsrParams(bProcessHoles));

    // compute measure on shape 3d collection
    MeasureSetPtr pOutMeasureSet = shapeAnalysis3d(pInGreyImg3d, pShape3dColl, pMeasureInfoSet);

    // retrieve associated results
    const MeasureConstPtr& pArea3dOutMsr = pOutMeasureSet->getMeasure("Area3dMsr");
    const ValueMeasureResult<ipReal64>& outResults = static_cast<const ValueMeasureResult<ipReal64>&>(pArea3dOutMsr->getMeasureResult());

---

The documentation for this class was generated from the following file:

• /media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLShapeAnalysis/Measure/Geometry/Basic/Area3d/Area3dMsrInfo.h