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::FeaturesRegistrationIndicators Class Reference

Features registration quality result indicators. More...

#include <FeaturesRegistrationIndicators.h>

Inheritance diagram for ipsdk::imaproc::attr::FeaturesRegistrationIndicators:
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...
 
 ~FeaturesRegistrationIndicators ()
 public destructor
 
Methods associated to sub node NbFeatures1
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > & getNode () const
 access to sub node NbFeatures1
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > & get ()
 access to sub node NbFeatures1
 
template<>
const ipsdk::ipUInt32getValue () const
 access to value for sub node NbFeatures1
 
template<>
void setValue (const ipsdk::ipUInt32 &value)
 access to value for sub node NbFeatures1
 
Methods associated to sub node NbFeatures2
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > & getNode () const
 access to sub node NbFeatures2
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > & get ()
 access to sub node NbFeatures2
 
template<>
const ipsdk::ipUInt32getValue () const
 access to value for sub node NbFeatures2
 
template<>
void setValue (const ipsdk::ipUInt32 &value)
 access to value for sub node NbFeatures2
 
Methods associated to sub node NbPairs
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > & getNode () const
 access to sub node NbPairs
 
template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > & get ()
 access to sub node NbPairs
 
template<>
const ipsdk::ipUInt32getValue () const
 access to value for sub node NbPairs
 
template<>
void setValue (const ipsdk::ipUInt32 &value)
 access to value for sub node NbPairs
 
Methods associated to sub node EstimationResults
template<>
const ipsdk::imaproc::attr::RobustEstimationResultsgetNode () const
 access to sub node EstimationResults
 
template<>
ipsdk::imaproc::attr::RobustEstimationResultsget ()
 access to sub node EstimationResults
 
Methods associated to sub node Assignments
template<>
const ipsdk::DataItemNodeColl< FeatureAssignmentInfo > & getNode () const
 access to sub node Assignments
 
template<>
ipsdk::DataItemNodeColl< FeatureAssignmentInfo > & get ()
 access to sub node Assignments
 
template<>
const std::vector< FeatureAssignmentInfo > & getNodeColl () const
 access to node collection for sub node Assignments
 
template<>
bool isEmpty () const
 check wether collection is empty for sub node Assignments
 
template<>
ipsdk::ipUInt32 getSize () const
 retrieve collection size for sub node Assignments
 
const FeatureAssignmentInfogetNode (const ipsdk::ipUInt32 nodeIdx) const
 retrieve node associated to given index for sub node Assignments More...
 
FeatureAssignmentInfogetNode (const ipsdk::ipUInt32 nodeIdx)
 retrieve node associated to given index for sub node Assignments More...
 
template<>
void push_back (const boost::shared_ptr< FeatureAssignmentInfo > &pItemNode)
 push back a new element into collection for sub node Assignments More...
 
template<>
void clear ()
 remove all items from collection for sub node Assignments
 
- 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< FeaturesRegistrationIndicatorscreateNode ()
 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

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

Features registration quality result indicators.

Author
E.Noirfalise
Date
2016/10/28

Node associated library :

IPSDKIPLAttributes

SubNodes description

Name ToolTip Associated Class Default Value
NbFeatures1 number of featrues in first collection ipsdk::DataItemLeaf<ipsdk::ipUInt32>
NbFeatures2 number of featrues in second collection ipsdk::DataItemLeaf<ipsdk::ipUInt32>
NbPairs number of matched pairs of feature ipsdk::DataItemLeaf<ipsdk::ipUInt32>
EstimationResults results of robust transformation estimation ipsdk::imaproc::attr::RobustEstimationResults
Assignments feature assignment informations ipsdk::DataItemNodeColl<FeatureAssignmentInfo>

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::attr::FeaturesRegistrationIndicators::getItemIds ( ) const
virtual

retrieve item associated to a given id

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

Implements ipsdk::BaseDataItemNode.

◆ getNode() [1/2]

const FeatureAssignmentInfo& ipsdk::imaproc::attr::FeaturesRegistrationIndicators::getNode ( const ipsdk::ipUInt32  nodeIdx) const

retrieve node associated to given index for sub node Assignments

Exceptions
ipsdk::IPSDKBaseDataExceptionif nodeIdx >= getSize()

◆ getNode() [2/2]

FeatureAssignmentInfo& ipsdk::imaproc::attr::FeaturesRegistrationIndicators::getNode ( const ipsdk::ipUInt32  nodeIdx)

retrieve node associated to given index for sub node Assignments

Exceptions
ipsdk::IPSDKBaseDataExceptionif nodeIdx >= getSize()

◆ push_back()

template<>
void ipsdk::imaproc::attr::FeaturesRegistrationIndicators::push_back ( const boost::shared_ptr< FeatureAssignmentInfo > &  pItemNode)

push back a new element into collection for sub node Assignments

Exceptions
ipsdk::IPSDKBaseDataExceptionif pItemNode->get() == 0

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