ipsdk::imaproc::shape::analysis::ImageBordersContact3dMsrInfo Class Reference

Information object for measure ImageBordersContact3d. More...

#include <ImageBordersContact3dMsrInfo.h>

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

Public Types
typedef ImageBordersContactMsrResults	MsrResultType

Public Member Functions
	~ImageBordersContact3dMsrInfo ()
	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
bool	requiresInputImage () const
	check whether measure requires input image

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
	ImageBordersContact3dMsrInfo ()
	constructor

Detailed Description

Information object for measure ImageBordersContact3d.

Author

E. Noirfalise

Date

2017/10/26

Copyright

2017 Reactiv'IP, all right reserved.

Measure allowing to check whether a shape has contact with image borders

Measure synthesis :

Measure Type	Measure Unit Type	Parameter Type	Result Type	Shape Requirements
Geometry 3d	None	None	Custom	Row Intersections

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 ImageBordersContact3d is not associated to any unit [ipsdk::shape::analysis::eMsrUnitFormat::eMUF_NoUnit]

Measure Parameter Type :

Measure ImageBordersContact3d has no parameters

Measure Result Type :

Measure ImageBordersContact3d is associated to ImageBordersContactMsrResults results

Measure Shape Requirements :

Measure ImageBordersContact3d requires row intersections from shape data

Measure Dependencies :

Measure ImageBordersContact3d 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, "ImageBordersContact3dMsr")
    
    #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("ImageBordersContact3dMsr")
    
    # retrieve measure values
    outMsrValues = outMsr.getMeasureResult().getColl(0)
    print("First label measurement field bTouchXStart equal " + str(outMsrValues[1].bTouchXStart))

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(readFromXmlFile(inputShape3dCollPath, *pShape3dColl) == true);

    // define a measure info set
    MeasureInfoSetPtr pMeasureInfoSet = MeasureInfoSet::create3dInstance();
    createMeasureInfo(pMeasureInfoSet, "ImageBordersContact3dMsr");
    
    // compute measure on shape 3d collection
    MeasureSetPtr pOutMeasureSet = shapeAnalysis3d(pInGreyImg3d, pShape3dColl, pMeasureInfoSet);

    // retrieve associated results
    const MeasureConstPtr& pImageBordersContact3dOutMsr = pOutMeasureSet->getMeasure("ImageBordersContact3dMsr");
    const ImageBordersContactMsrResults& outResults = static_cast<const ImageBordersContactMsrResults&>(pImageBordersContact3dOutMsr->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/ImageBordersContact/ImageBordersContact3d/ImageBordersContact3dMsrInfo.h