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::attr::RobustEstimationConfig Class Reference

configuration parameters for robust estimation More...

#include <RobustEstimationConfig.h>

Inheritance diagram for ipsdk::imaproc::attr::RobustEstimationConfig:
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...
 
 ~RobustEstimationConfig ()
 public destructor
 
 RobustEstimationConfig (const ipsdk::math::EstimationConfig &config)
 additional constructor More...
 
 operator ipsdk::math::EstimationConfig () const
 convertion to estimation configuration object
 
Methods associated to sub node Type
template<>
const ipsdk::DataItemLeaf< ipsdk::math::eRobustEstimationType > & getNode () const
 access to sub node Type
 
template<>
ipsdk::DataItemLeaf< ipsdk::math::eRobustEstimationType > & get ()
 access to sub node Type
 
template<>
const ipsdk::math::eRobustEstimationTypegetValue () const
 access to value for sub node Type
 
template<>
void setValue (const ipsdk::math::eRobustEstimationType &value)
 access to value for sub node Type
 
Methods associated to sub node OutlierThreshold
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > & getNode () const
 access to sub node OutlierThreshold
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > & get ()
 access to sub node OutlierThreshold
 
template<>
const ipsdk::ipReal64getValue () const
 access to value for sub node OutlierThreshold
 
template<>
void setValue (const ipsdk::ipReal64 &value)
 access to value for sub node OutlierThreshold
 
Methods associated to sub node GaussianSigma
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > & getNode () const
 access to sub node GaussianSigma
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > & get ()
 access to sub node GaussianSigma
 
template<>
const ipsdk::ipReal64getValue () const
 access to value for sub node GaussianSigma
 
template<>
void setValue (const ipsdk::ipReal64 &value)
 access to value for sub node GaussianSigma
 
Methods associated to sub node OutlierRangeFactor
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > & getNode () const
 access to sub node OutlierRangeFactor
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > & get ()
 access to sub node OutlierRangeFactor
 
template<>
const ipsdk::ipReal64getValue () const
 access to value for sub node OutlierRangeFactor
 
template<>
void setValue (const ipsdk::ipReal64 &value)
 access to value for sub node OutlierRangeFactor
 
Methods associated to sub node ExpectedOutlierRatio
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > & getNode () const
 access to sub node ExpectedOutlierRatio
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > & get ()
 access to sub node ExpectedOutlierRatio
 
template<>
const ipsdk::ipReal64getValue () const
 access to value for sub node ExpectedOutlierRatio
 
template<>
void setValue (const ipsdk::ipReal64 &value)
 access to value for sub node ExpectedOutlierRatio
 
Methods associated to sub node AllowSimpleEstimation
template<>
const ipsdk::DataItemLeaf< ipsdk::ipBool > & getNode () const
 access to sub node AllowSimpleEstimation
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipBool > & get ()
 access to sub node AllowSimpleEstimation
 
template<>
const ipsdk::ipBoolgetValue () const
 access to value for sub node AllowSimpleEstimation
 
template<>
void setValue (const ipsdk::ipBool &value)
 access to value for sub node AllowSimpleEstimation
 
Methods associated to sub node SuccessRatio
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > & getNode () const
 access to sub node SuccessRatio
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > & get ()
 access to sub node SuccessRatio
 
template<>
const ipsdk::ipReal64getValue () const
 access to value for sub node SuccessRatio
 
template<>
void setValue (const ipsdk::ipReal64 &value)
 access to value for sub node SuccessRatio
 
Methods associated to sub node DataPartitionConfig
template<>
const ipsdk::imaproc::attr::RobustDataPartitionConfiggetNode () const
 access to sub node DataPartitionConfig
 
template<>
ipsdk::imaproc::attr::RobustDataPartitionConfigget ()
 access to sub node DataPartitionConfig
 
Methods associated to sub node TranslationThetaThreshold
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > & getNode () const
 access to sub node TranslationThetaThreshold
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > & get ()
 access to sub node TranslationThetaThreshold
 
template<>
const ipsdk::ipReal64getValue () const
 access to value for sub node TranslationThetaThreshold
 
template<>
void setValue (const ipsdk::ipReal64 &value)
 access to value for sub node TranslationThetaThreshold
 
Methods associated to sub node TranslationAbsMax
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > & getNode () const
 access to sub node TranslationAbsMax
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > & get ()
 access to sub node TranslationAbsMax
 
template<>
const ipsdk::ipReal64getValue () const
 access to value for sub node TranslationAbsMax
 
template<>
void setValue (const ipsdk::ipReal64 &value)
 access to value for sub node TranslationAbsMax
 
Methods associated to sub node TranslationMatchRatio
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > & getNode () const
 access to sub node TranslationMatchRatio
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > & get ()
 access to sub node TranslationMatchRatio
 
template<>
const ipsdk::ipReal64getValue () const
 access to value for sub node TranslationMatchRatio
 
template<>
void setValue (const ipsdk::ipReal64 &value)
 access to value for sub node TranslationMatchRatio
 
- 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< RobustEstimationConfigcreateNode ()
 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

 RobustEstimationConfig ()
 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

configuration parameters for robust estimation

Author
E.Noirfalise
Date
2017/05/30

Node associated library :

IPSDKIPLAttributes

SubNodes description

Name ToolTip Associated Class Default Value
Type algorithm type associated to robust estimation ipsdk::DataItemEnumLeaf<ipsdk::math::eRobustEstimationType> ipsdk::math::eRobustEstimationType::eRET_NonRobust
OutlierThreshold threshold for outliers detection ipsdk::DataItemLeaf<ipsdk::ipReal64>
GaussianSigma used sigma for gaussian noise estimation ipsdk::DataItemLeaf<ipsdk::ipReal64>
OutlierRangeFactor used outlier range factor for processing ipsdk::DataItemLeaf<ipsdk::ipReal64>
ExpectedOutlierRatio expected outlier ratio over population ipsdk::DataItemLeaf<ipsdk::ipReal64>
AllowSimpleEstimation flag indicating whether simple estimation is allowed in case of small dataset without enough data to ensure robust processing ipsdk::DataItemLeaf<ipsdk::ipBool> true
SuccessRatio algorithm statistical success ratio parameter ipsdk::DataItemLeaf<ipsdk::ipReal64> 0.99
DataPartitionConfig configuration for data partition algorithm associated to robust estimation ipsdk::imaproc::attr::RobustDataPartitionConfig *ipsdkimaproc::attr::createDefaultRobustDataPartitionConfig()
TranslationThetaThreshold Angle tolerance to filter the matches for pure translation estimation. ipsdk::DataItemLeaf<ipsdk::ipReal64> 0.05
TranslationAbsMax Maximum translation constraint (in absolute values) for pure translation estimation (ignored if equals -1) ipsdk::DataItemLeaf<ipsdk::ipReal64> -1.
TranslationMatchRatio Minimum matches validated by TranslationThetaThreshold for pure translation estimation. ipsdk::DataItemLeaf<ipsdk::ipReal64> 0.1

Constructor & Destructor Documentation

◆ RobustEstimationConfig()

ipsdk::imaproc::attr::RobustEstimationConfig::RobustEstimationConfig ( const ipsdk::math::EstimationConfig config)

additional constructor

Exceptions
ipsdk::math::IPSDKMathExceptionif config.isInit() == false

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::attr::RobustEstimationConfig::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: