ipsdk::imaproc::shape::analysis::MaxFeretPt1ZMsrInfo Class Reference

Information object for measure MaxFeretPt1Z. More...

#include <MaxFeretPt1ZMsrInfo.h>

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

Public Types
typedef ipsdk::shape::analysis::ValueMeasureResult< ipsdk::ipReal64 >	MsrResultType
typedef MaxFeretPt1ZMsrParams	MsrParamsType
	Parameter type associated to measure.
typedef const MaxFeretPt1ZMsrParams	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
	~MaxFeretPt1ZMsrInfo ()
	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
	MaxFeretPt1ZMsrInfo ()
	constructor
void	createCustomDependencies (const bool b2dMsrMode)
virtual 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 MaxFeretPt1Z.

Author

R. Abbal

Date

2021/05/03

Copyright

2021 ReactivIP, all right reserved.

Returns the z coordinate of the second point used to compute the maximum Feret diameter

Measure synthesis :

Measure Type	Measure Unit Type	Parameter Type	Result Type	Shape Requirements
Generic	None	MaxFeretPt1ZMsrParams	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 MaxFeretPt1Z is not associated to any unit [ipsdk::shape::analysis::eMsrUnitFormat::eMUF_NoUnit]

Measure Parameter Type :

Measure MaxFeretPt1Z is associated to MaxFeretPt1ZMsrParams parameters

Measure Result Type :

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

Measure Shape Requirements :

Measure MaxFeretPt1Z requires boundary approximation from shape data

Measure Dependencies :

Measure MaxFeretPt1Z depends on following measures :

Measure Mode	Measure Name	Measure Type	Measure Parameters
eMVP_2d	ConvexHull2d	ConvexHull2d
eMVP_3d	ConvexHull3d	ConvexHull3d

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 :

Generic example in 3d case :

import PyIPSDK
import PyIPSDK.IPSDKIPLShapeAnalysis as shapeanalysis

    # Create the infoset
    inMeasureInfoSet3d = PyIPSDK.createMeasureInfoSet3d()
    PyIPSDK.createMeasureInfo(inMeasureInfoSet3d, "MaxFeretPt1ZMsr")
    
    #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("MaxFeretPt1ZMsr")
    
    # 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

    // define a measure info set
    MeasureInfoSetPtr pMeasureInfoSet = MeasureInfoSet::create3dInstance();
    createMeasureInfo(pMeasureInfoSet, "MaxFeretPt1ZMsr");

    // compute measure on shape 3d collection
    MeasureSetPtr pOutMeasureSet = labelAnalysis3d(pLabelImg, pLabelImg, pMeasureInfoSet);

    // retrieve associated results
    const MeasureConstPtr& pMaxFeretPt1ZOutMsr = pOutMeasureSet->getMeasure("MaxFeretPt1ZMsr");
    const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>& outResults = static_cast<const ipsdk::shape::analysis::ValueMeasureResult<ipsdk::ipReal64>&>(pMaxFeretPt1ZOutMsr->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/FormFactor/MaxFeretPt1Z/MaxFeretPt1ZMsrInfo.h