Information object for measure NearestNeighbors3d. More...

#include <NearestNeighbors3dMsrInfo.h>

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

Public Types
typedef NearestNeighborsMsrResults	MsrResultType

typedef NearestNeighbors3dMsrParams	MsrParamsType
	Parameter type associated to measure.

typedef const NearestNeighbors3dMsrParams	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
	~NearestNeighbors3dMsrInfo ()
	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
	NearestNeighbors3dMsrInfo ()
	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 NearestNeighbors3d.

Author: E.Noirfalise

Date: 2017/07/27

Copyright: 2017 Reactiv'IP, all right reserved.

measure allowing to retrieve shapes at a given distance of measured shape

Measure synthesis :

Measure Type	Measure Unit Type	Parameter Type	Result Type	Shape Requirements
Geometry 3d	None	NearestNeighbors3dMsrParams	Custom	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 NearestNeighbors3d is not associated to any unit [ipsdk::shape::analysis::eMsrUnitFormat::eMUF_NoUnit]

Measure Parameter Type :

Measure NearestNeighbors3d is associated to NearestNeighbors3dMsrParams parameters

Measure Result Type :

Measure NearestNeighbors3d is associated to NearestNeighborsMsrResults results

Measure Shape Requirements :

Measure NearestNeighbors3d requires boundary approximation from shape data

Measure Dependencies :

Measure NearestNeighbors3d depends on following measures :

Measure Mode	Measure Name	Measure Type	Measure Parameters
eMVP_3d	Shape3dRTree	Shape3dRTree	createHolesBasicPolicyMsrParams(_pMsrParams->getValue<NeighborsDistanceMsrParams::ProcessHoles>())
eMVP_3d	Neighbors3dDistanceCollector	Neighbors3dDistanceCollector	boost::make_shared<NeighborsDistanceMsrParams>(*_pMsrParams)

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, "NearestNeighbors3dMsr")
    
    #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("NearestNeighbors3dMsr")
    
    # 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 pInGreyImg3d = loadTiffImageFile(inputGreyImgPath, eTiffDirectoryMode::eTDM_Volume);
    // read entity shape 3d collection used for processing
    Shape3dCollPtr pShape3dColl = boost::make_shared<Shape3dColl>();
    IPSDK_REQUIRE(readFromBinaryFile(inputShape3dCollPath, *pShape3dColl) == true);
    // define a measure info set
    MeasureInfoSetPtr pMeasureInfoSet = MeasureInfoSet::create3dInstance();
    createMeasureInfo(pMeasureInfoSet, "NearestNeighbors3dMsr", createNeighborsDistanceMsrParams(maxDist, bProcessHoles));
    
    // compute measure on shape 3d collection
    MeasureSetPtr pOutMeasureSet = shapeAnalysis3d(pInGreyImg3d, pShape3dColl, pMeasureInfoSet);
    // retrieve associated results
    const MeasureConstPtr& pNearestNeighbors3dOutMsr = pOutMeasureSet->getMeasure("NearestNeighbors3dMsr");
    const NearestNeighborsMsrResults& outResults = static_cast<const NearestNeighborsMsrResults&>(pNearestNeighbors3dOutMsr->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/NearestNeighbors3d/NearestNeighbors3dMsrInfo.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes