IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
ipsdk::imaproc::shape::analysis::RoundnessMsrParams Class Reference

Parameter object for measure Roundness. More...

#include <RoundnessMsrParams.h>

Inheritance diagram for ipsdk::imaproc::shape::analysis::RoundnessMsrParams:
ipsdk::BaseDataItemNode ipsdk::BaseDataItem ipsdk::BaseToolTip ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject

Public Member Functions

const std::string & getObjectName () const
 method allowing to retrieve object name
 
const std::string & getToolTip () const
 method allowing to retrieve object tooltip
 
const boost::filesystem::path getHeaderPath () const
 retrieve relative header path associated to data item node
 
const std::string getLibraryName () const
 retrieve library name associated data item node
 
const ipsdk::ItemNamesgetItemIds () const
 retrieve item associated to a given id More...
 
 ~RoundnessMsrParams ()
 public destructor
 
Methods associated to sub node BallType
template<>
const ipsdk::DataItemLeaf< ipsdk::imaproc::shape::analysis::eBallType > & getNode () const
 access to sub node BallType
 
template<>
ipsdk::DataItemLeaf< ipsdk::imaproc::shape::analysis::eBallType > & get ()
 access to sub node BallType
 
template<>
const ipsdk::imaproc::shape::analysis::eBallTypegetValue () const
 access to value for sub node BallType
 
template<>
void setValue (const ipsdk::imaproc::shape::analysis::eBallType &value)
 access to value for sub node BallType
 
Methods associated to sub node ProcessHoles
template<>
const ipsdk::DataItemLeaf< ipsdk::ipBool > & getNode () const
 access to sub node ProcessHoles
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipBool > & get ()
 access to sub node ProcessHoles
 
template<>
const ipsdk::ipBoolgetValue () const
 access to value for sub node ProcessHoles
 
template<>
void setValue (const ipsdk::ipBool &value)
 access to value for sub node ProcessHoles
 
Methods associated to sub node EstimationConfig
template<>
const ipsdk::imaproc::attr::RobustEstimationConfiggetNode () const
 access to sub node EstimationConfig
 
template<>
ipsdk::imaproc::attr::RobustEstimationConfigget ()
 access to sub node EstimationConfig
 
- Public Member Functions inherited from ipsdk::BaseDataItemNode
eDataItemType getDataItemType () const
 
bool existsItem (const std::string &itemId) const
 
const BaseDataItemgetItem (const std::string &itemId) const
 
const std::string & getItemName (const std::string &itemId) const
 
const std::string & getItemToolTip (const std::string &itemId) const
 
- Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string & getClassName () const
 
virtual BaseDynamicObjectcreateNew () const=0
 
virtual DynamicObjectPtr createShared () const=0
 
virtual bool hasCopySupport () const=0
 
virtual BaseDynamicObjectduplicate () const=0
 
virtual DynamicObjectPtr duplicateShared () const=0
 

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 const boost::filesystem::path getHeaderPathStr ()
 retrieve relative header path associated to data item node
 
static const std::string getLibraryNameStr ()
 retrieve library name associated data item node
 
static boost::shared_ptr< RoundnessMsrParamscreateNode ()
 node creation function
 
- Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32 getVersion ()
 
- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 

Static Public Attributes

static const ipsdk::ipUInt32 g_nbChildNodes
 number of child nodes associated to object
 
- Static Public Attributes inherited from ipsdk::BaseDataItemNode
static const bool g_bIsColl
 
static const bool g_bNode
 
static const bool g_bLeaf
 
static const eDataItemType::domain g_itemType
 

Protected Member Functions

 RoundnessMsrParams ()
 protected constructor
 
- Protected Member Functions inherited from ipsdk::BaseDataItemNode
virtual ItemInfoPtr getItemInfo (const std::string &itemId) const=0
 
- Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult write (BaseOArchive &ar) const
 
virtual BoolResult read (BaseIArchive &ar)
 
- Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void initCtorCopy (const BaseDynamicObject &object)
 
virtual void copy (const BaseDynamicObject &object)
 

Additional Inherited Members

- Protected Types inherited from ipsdk::BaseDataItemNode
typedef boost::shared_ptr< ItemInfoItemInfoPtr
 

Detailed Description

Parameter object for measure Roundness.

Author
E.Noirfalise
Date
2017/06/13

computation of distance from shape tops to considered circle

Node associated library :

IPSDKIPLShapeAnalysis

SubNodes description

Name ToolTip Associated Class Default Value
BallType ball type used for roundness measurement ipsdk::DataItemEnumLeaf<ipsdk::imaproc::shape::analysis::eBallType> ipsdk::imaproc::shape::analysis::eBallType::eBT_MinEnclosing
ProcessHoles Flag indicating whether holes should be processed. ipsdk::DataItemLeaf<ipsdk::ipBool> false
EstimationConfig configuration parameters for robust estimation ipsdk::imaproc::attr::RobustEstimationConfig

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::shape::analysis::RoundnessMsrParams::getItemIds ( ) const
virtual

retrieve item associated to a given id

Exceptions
ipsdk::IPSDKBaseDataExceptionif existsItem(itemName) == false

Implements ipsdk::BaseDataItemNode.


The documentation for this class was generated from the following file: