IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ipsdk::imaproc::registration::GreySignedFeatures2dRegistrationLvl1 Class Reference

Level 1 algorithm: algorithm allowing registration of features 2d associated to grey signature. More...

#include <GreySignedFeatures2dRegistrationLvl1.h>

Inheritance diagram for ipsdk::imaproc::registration::GreySignedFeatures2dRegistrationLvl1:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseSyncAction >

Public Member Functions

 ~GreySignedFeatures2dRegistrationLvl1 ()
 destructor
 
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 processor
 
const std::string getLibraryName () const
 retrieve library name associated processor
 
template<typename TAttribute >
TAttribute::StorageType getStorage ()
 retrieve storage associated to a given attribute More...
 
Attribute accessors

Setters and Getters for attributes

template<>
const ipsdk::imaproc::attr::InGreySignatures2d1get () const
 Getter for attribute InGreySignatures2d1.
 
template<>
void set (const typename ipsdk::imaproc::attr::InGreySignatures2d1::StorageType &value)
 Setter for attribute InGreySignatures2d1.
 
template<>
const ipsdk::imaproc::attr::InGreySignatures2d2get () const
 Getter for attribute InGreySignatures2d2.
 
template<>
void set (const typename ipsdk::imaproc::attr::InGreySignatures2d2::StorageType &value)
 Setter for attribute InGreySignatures2d2.
 
template<>
const ipsdk::imaproc::attr::InOptRegMotionModel2dget () const
 Getter for attribute InOptRegMotionModel2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptRegMotionModel2d::StorageType &value)
 Setter for attribute InOptRegMotionModel2d.
 
template<>
const ipsdk::imaproc::attr::InOptCorrelationThreshold2dget () const
 Getter for attribute InOptCorrelationThreshold2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptCorrelationThreshold2d::StorageType &value)
 Setter for attribute InOptCorrelationThreshold2d.
 
template<>
const ipsdk::imaproc::attr::InOptRegistrationEstimationConfigget () const
 Getter for attribute InOptRegistrationEstimationConfig.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptRegistrationEstimationConfig::StorageType &value)
 Setter for attribute InOptRegistrationEstimationConfig.
 
template<>
const ipsdk::imaproc::attr::OutFeatures2dRegistrationResultget () const
 Getter for attribute OutFeatures2dRegistrationResult.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutFeatures2dRegistrationResult::StorageType &value)
 Setter for attribute OutFeatures2dRegistrationResult.
 
- Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseSyncAction >
virtual eProcessorType getProcessorType () const =0
 
BoolResult init (const eProcessorRulePolicy rulePolicy=eProcessorRulePolicy::ePRP_DisableSubRules)
 
const eProcessorRulePolicygetProcessorRulePolicy () const
 
std::string getFullInfoStr () const
 
const BaseRulegetGlobalRule () const
 
const ProcessorDispatchPolicygetDispatchPolicy () const
 
void restrictDispatchPolicy (const ProcessorDispatchPolicy &policy)
 
bool isProgressAvailable () const
 
ipsdk::processor::eProcessorProgressAvailability getProgressAvailability () const
 
ipsdk::ipUInt64 getTotalNbIterations () const
 
bool existsHeaderKey (const std::string &key) const
 
bool existsHeaderKey (const std::string &key) const
 
ItemNames getHeaderKeys () const
 
ItemNames getHeaderKeys () const
 
const BaseDataItemgetHeaderItem (const std::string &key) const
 
BaseDataItemgetHeaderItem (const std::string &key)
 
const BaseDataItemgetHeaderItem (const std::string &key) const
 
BaseDataItemgetHeaderItem (const std::string &key)
 
void addHeaderItem (const std::string &key, const DataItemPtr &pItem)
 
void addHeaderItem (const std::string &key, const DataItemPtr &pItem)
 
void removeHeaderItem (const std::string &key)
 
void removeHeaderItem (const std::string &key)
 
void clearHeader ()
 
void clearHeader ()
 
ipUInt32 getNbAttributes () const
 
ipUInt32 getNbAttributes () const
 
const BaseAttributegetAttribute (ipUInt32 index) const
 
BaseAttributegetAttribute (ipUInt32 index)
 
const BaseAttributegetAttribute (const std::string &attributeName) const
 
BaseAttributegetAttribute (const std::string &attributeName)
 
const BaseAttributegetAttribute (ipUInt32 index) const
 
BaseAttributegetAttribute (ipUInt32 index)
 
const BaseAttributegetAttribute (const std::string &attributeName) const
 
BaseAttributegetAttribute (const std::string &attributeName)
 
bool existsAttribute (const std::string &attributeName) const
 
bool existsAttribute (const std::string &attributeName) const
 
StringVector getAttributeNameColl () const
 
StringVector getAttributeNameColl () const
 
bool hasOutputInitializer (const std::string &attributeName) const
 
bool hasOutputInitializer (const std::string &attributeName) const
 
const BaseOutputInitializergetOutputInitializer (const std::string &attributeName) const
 
const BaseOutputInitializergetOutputInitializer (const std::string &attributeName) const
 

Static Public Member Functions

static boost::shared_ptr< GreySignedFeatures2dRegistrationLvl1createProcessor ()
 processor creation function
 
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 processor
 
static const std::string getLibraryNameStr ()
 retrieve library name associated processor
 

Protected Member Functions

 GreySignedFeatures2dRegistrationLvl1 ()
 constructor
 
ExecResult mainProcess ()
 main processing method overloaded in derived class More...
 
- Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseSyncAction >
virtual BoolResult initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0
 

Protected Attributes

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InGreySignatures2d1_pInGreySignatures2d1
 
boost::shared_ptr< ipsdk::imaproc::attr::InGreySignatures2d2_pInGreySignatures2d2
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptRegMotionModel2d_pInOptRegMotionModel2d
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptCorrelationThreshold2d_pInOptCorrelationThreshold2d
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptRegistrationEstimationConfig_pInOptRegistrationEstimationConfig
 
boost::shared_ptr< ipsdk::imaproc::attr::OutFeatures2dRegistrationResult_pOutFeatures2dRegistrationResult
 
- Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseSyncAction >
eProcessorProgressAvailability _processorProgressAvailability
 
ipUInt32 _nbIter
 

Additional Inherited Members

- Protected Types inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseSyncAction >
typedef std::vector< AttributePtrAttributeColl
 
typedef std::map< std::string, OutputInitializerPtrOutputInitializerColl
 

Detailed Description

Level 1 algorithm: algorithm allowing registration of features 2d associated to grey signature.

See Registration of grey signed features 2d for a complete algorithm description.

Author
E.Noirfalise
Date
2016/10/28

Algorithm associated library :

IPSDKIPLRegistration

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InGreySignatures2d1 [Input] first collection of features 2d grey signature used during processing X
ipsdk::imaproc::attr::InGreySignatures2d2 [Input] second collection of features 2d grey signature used during processing X
ipsdk::imaproc::attr::InOptRegMotionModel2d [Input Optional] 2d motion model which should be used for computation X
ipsdk::imaproc::attr::InOptCorrelationThreshold2d [Input Optional] threshold on 2d correlation scores used during pairs matching X
ipsdk::imaproc::attr::InOptRegistrationEstimationConfig [Input Optional] configuration for robust estimation part of features registration X
ipsdk::imaproc::attr::OutFeatures2dRegistrationResult [Output] result of features 2d registration algorithm allocate (_pOutFeatures2dRegistrationResult)

Global attributes rule :

Global rule on attributes is given by
ipsdk::processor::none ()

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::registration::GreySignedFeatures2dRegistrationLvl1::getStorage ( )

retrieve storage associated to a given attribute

Note
This method is only available for Output and In/Out attributes
Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionif isInit() == false

◆ mainProcess()

ExecResult ipsdk::imaproc::registration::GreySignedFeatures2dRegistrationLvl1::mainProcess ( )
protected

main processing method overloaded in derived class

Returns
execution result

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