ipsdk::imaproc::shape::analysis::GradientAngularityIndex2dMsrInfo Class Reference

Information object for measure GradientAngularityIndex2d. More...

#include <GradientAngularityIndex2dMsrInfo.h>

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

Public Types
typedef ipsdk::shape::analysis::ValueMeasureResult< ipsdk::ipReal64 >	MsrResultType

Public Member Functions
	~GradientAngularityIndex2dMsrInfo ()
	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_Geometry2d

Protected Member Functions
	GradientAngularityIndex2dMsrInfo ()
	constructor
std::string	computeCustomMsrUnitStr (const std::string &baseUnitStr) const

Detailed Description

Information object for measure GradientAngularityIndex2d.

Author

E.Noirfalise

Date

2017/07/18

Copyright

2017 Reactiv'IP, all right reserved.

measure allowing to compute average of the change in the angles of the gradient vectors around the particle circumference

Measure synthesis :

Measure Type	Measure Unit Type	Parameter Type	Result Type	Shape Requirements
Geometry 2d	Custom	None	Value (ipsdk::ipReal64)	Boundary Approximation

See Shape measurement for additional information on these pictograms

Measure Type :

This is a geometry 2d measure

• it use shape 2d 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 2d case

Measure Unit Type:

Measure GradientAngularityIndex2d is associated to a custom unit, please see definition of GradientAngularityIndex2dInfo::computeCustomMsrUnitStr function [ipsdk::shape::analysis::eMsrUnitFormat::eMUF_CustomUnit]

Measure Parameter Type :

Measure GradientAngularityIndex2d has no parameters

Measure Result Type :

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

Measure Shape Requirements :

Measure GradientAngularityIndex2d requires boundary approximation from shape data

Measure Dependencies :

Measure GradientAngularityIndex2d has no dependency

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, "EdgeAngularity2dMsr")
    
    #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("EdgeAngularity2dMsr")
    
    # 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>();
    IPSDK_REQUIRE(readFromXmlFile(inputShape2dCollPath, *pShape2dColl) == true);

    // define a measure info set
    MeasureInfoSetPtr pMeasureInfoSet = MeasureInfoSet::create2dInstance();
    createMeasureInfo(pMeasureInfoSet, "GradientAngularityIndex2dMsr");
    
    // compute measure on shape 2d collection
    MeasureSetPtr pOutMeasureSet = shapeAnalysis2d(pInGreyImg2d, pShape2dColl, pMeasureInfoSet);

    // retrieve associated results
    const MeasureConstPtr& pGradientAngularityIndex2dOutMsr = pOutMeasureSet->getMeasure("GradientAngularityIndex2dMsr");
    const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>& outResults = static_cast<const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>&>(pGradientAngularityIndex2dOutMsr->getMeasureResult());

Member Function Documentation

computeCustomMsrUnitStr()

std::string ipsdk::imaproc::shape::analysis::GradientAngularityIndex2dMsrInfo::computeCustomMsrUnitStr ( const std::string &  baseUnitStr ) const

protected

function allowing to define measure unit string in case of a custom unit format (in this case length^-1)

---

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/FormFactor/Angularity/GradientAngularityIndex2d/GradientAngularityIndex2dMsrInfo.h