Information object for measure NbNeighbors. More...

#include <NbNeighborsMsrInfo.h>

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

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

typedef NbNeighborsMsrParams	MsrParamsType
	Parameter type associated to measure.

typedef const NbNeighborsMsrParams	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
	~NbNeighborsMsrInfo ()
	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_Generic

Protected Member Functions
	NbNeighborsMsrInfo ()
	constructor

BoolResult	validateMsrParams (const bool b2dMsrMode, const DataItemConstPtr &pMeasureParams) const
	method allowing to validate measure parameters in derived class

Protected Attributes
MsrParamsConstStorageType	_pMsrParams
	Derived parameter associated to measure.

Detailed Description

Information object for measure NbNeighbors.

Author: E.Noirfalise

Date: 2017/07/27

Copyright: 2017 Reactiv'IP, all right reserved.

measure allowing to compute number of neighbors of shapes given a distance threshold

Measure synthesis :

Measure Type	Measure Unit Type	Parameter Type	Result Type	Shape Requirements
Generic	None	NbNeighborsMsrParams	Value (ipsdk::ipUInt32)	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 NbNeighbors is not associated to any unit [ipsdk::shape::analysis::eMsrUnitFormat::eMUF_NoUnit]

Measure Parameter Type :

Measure NbNeighbors is associated to NbNeighborsMsrParams parameters

Measure Result Type :

Measure NbNeighbors is associated to ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipUInt32> results

Measure Shape Requirements :

Measure NbNeighbors requires boundary approximation from shape data

Measure Dependencies :

Measure NbNeighbors depends on following measures :

Measure Mode	Measure Name	Measure Type	Measure Parameters
eMVP_2d	NearestNeighbors	NearestNeighbors2d	boost::make_shared<NeighborsDistanceMsrParams>(*_pMsrParams)
eMVP_3d	NearestNeighbors	NearestNeighbors3d	boost::make_shared<NeighborsDistanceMsrParams>(*_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, "NbNeighborsMsr")
    
    #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("NbNeighborsMsr")
    
    # 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, "NbNeighborsMsr")
    
    #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("NbNeighborsMsr")
    
    # 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, "NbNeighborsMsr", createNeighborsDistanceMsrParams(maxDist, bProcessHoles));
    
    // compute measure on shape 2d collection
    MeasureSetPtr pOutMeasureSet = shapeAnalysis2d(pInGreyImg2d, pShape2dColl, pMeasureInfoSet);
    // retrieve associated results
    const MeasureConstPtr& pNbNeighborsOutMsr = pOutMeasureSet->getMeasure("NbNeighborsMsr");
    const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipUInt32>& outResults = static_cast<const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipUInt32>&>(pNbNeighborsOutMsr->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/Neighborhood/NbNeighbors/NbNeighborsMsrInfo.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes