FlatnessTotal

out of flatness expressed as difference between highest peak and lowest valley given measure reference hyper plan More...

Classes
class	ipsdk::imaproc::shape::analysis::FlatnessTotalMsr
	Measurement object for measure FlatnessTotal. More...
class	ipsdk::imaproc::shape::analysis::FlatnessTotalMsrInfo
	Information object for measure FlatnessTotal. More...

Typedefs
typedef attr::RobustEstimationConfig	ipsdk::imaproc::shape::analysis::FlatnessTotalMsrParams
	parameters type associated to measure

Detailed Description

out of flatness expressed as difference between highest peak and lowest valley given measure reference hyper plan

This measure allows to retrieve flatness total which is the sum of FlatnessPeak and of FlatnessValley.

Here is an example of flatness total computation in 2d case :

Author

E.Noirfalise

Date

2017/06/15

Copyright

2017 Reactiv'IP, all right reserved.

out of flatness expressed as difference between highest peak and lowest valley given measure reference hyper plan

Measure synthesis :

Measure Type	Measure Unit Type	Parameter Type	Result Type	Shape Requirements
Generic	Length	FlatnessTotalMsrParams	Value (ipsdk::ipReal64)	Boundary Approximation

See Shape measurement for additional information on these pictograms

Measure Type :

This is a generic measure

• it does not directly use shape or image data
• it can use dependencies to other measures to compute a result (see Measure Dependencies section)

This measure can be used in 2d and 3d case

Measure Unit Type:

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

Measure Parameter Type :

Measure FlatnessTotal is associated to FlatnessTotalMsrParams parameters

Measure Result Type :

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

Measure Shape Requirements :

Measure FlatnessTotal requires boundary approximation from shape data

Measure Dependencies :

Measure FlatnessTotal depends on following measures :

Measure Mode	Measure Name	Measure Type	Measure Parameters
eMVP_2d3d	FlatnessPeak	FlatnessPeak	boost::make_shared<attr::RobustEstimationConfig>(*_pMsrParams)
eMVP_2d3d	FlatnessValley	FlatnessValley	boost::make_shared<attr::RobustEstimationConfig>(*_pMsrParams)

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, "FlatnessTotalMsr")
    
    #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("FlatnessTotalMsr")
    
    # 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, "FlatnessTotalMsr")
    
    #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("FlatnessTotalMsr")
    
    # 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, "FlatnessTotalMsr");
    
    // compute measure on shape 2d collection
    MeasureSetPtr pOutMeasureSet = shapeAnalysis2d(pInGreyImg2d, pShape2dColl, pMeasureInfoSet);

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