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::fd::HarrisCorner2dImgLvl2 Class Reference

Level 2 algorithm: Computes the Harris corner detection response. More...

#include <HarrisCorner2dImgLvl2.h>

Inheritance diagram for ipsdk::imaproc::fd::HarrisCorner2dImgLvl2:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >

Public Member Functions

 ~HarrisCorner2dImgLvl2 ()
 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::InSubImg2dget () const
 Getter for attribute InSubImg2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InSubImg2d::StorageType &value)
 Setter for attribute InSubImg2d.
 
template<>
const ipsdk::imaproc::attr::InGradStdDevget () const
 Getter for attribute InGradStdDev.
 
template<>
void set (const typename ipsdk::imaproc::attr::InGradStdDev::StorageType &value)
 Setter for attribute InGradStdDev.
 
template<>
const ipsdk::imaproc::attr::InGaussianCoverageget () const
 Getter for attribute InGaussianCoverage.
 
template<>
void set (const typename ipsdk::imaproc::attr::InGaussianCoverage::StorageType &value)
 Setter for attribute InGaussianCoverage.
 
template<>
const ipsdk::imaproc::attr::InCornerDetectionParamsget () const
 Getter for attribute InCornerDetectionParams.
 
template<>
void set (const typename ipsdk::imaproc::attr::InCornerDetectionParams::StorageType &value)
 Setter for attribute InCornerDetectionParams.
 
template<>
const ipsdk::imaproc::attr::OutWk1Imgget () const
 Getter for attribute OutWk1Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk1Img::StorageType &value)
 Setter for attribute OutWk1Img.
 
template<>
const ipsdk::imaproc::attr::OutWk2Imgget () const
 Getter for attribute OutWk2Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk2Img::StorageType &value)
 Setter for attribute OutWk2Img.
 
template<>
const ipsdk::imaproc::attr::OutWk3Imgget () const
 Getter for attribute OutWk3Img.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutWk3Img::StorageType &value)
 Setter for attribute OutWk3Img.
 
template<>
const ipsdk::imaproc::attr::OutImgget () const
 Getter for attribute OutImg.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutImg::StorageType &value)
 Setter for attribute OutImg.
 
- Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
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< HarrisCorner2dImgLvl2createProcessor ()
 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

 HarrisCorner2dImgLvl2 ()
 constructor
 
ipsdk::processor::RetrievalResult retrieveFirstProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
 method allowing to retrieve first provider associated to asynchronous processing in derived class More...
 
ipsdk::processor::RetrievalResult retrieveSecondProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
 method allowing to retrieve second provider associated to asynchronous processing in derived class More...
 
eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult retrieveThirdProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
 
- Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
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::InSubImg2d_pInSubImg2d
 
boost::shared_ptr< ipsdk::imaproc::attr::InGradStdDev_pInGradStdDev
 
boost::shared_ptr< ipsdk::imaproc::attr::InGaussianCoverage_pInGaussianCoverage
 
boost::shared_ptr< ipsdk::imaproc::attr::InCornerDetectionParams_pInCornerDetectionParams
 
boost::shared_ptr< ipsdk::imaproc::attr::OutWk1Img_pOutWk1Img
 
boost::shared_ptr< ipsdk::imaproc::attr::OutWk2Img_pOutWk2Img
 
boost::shared_ptr< ipsdk::imaproc::attr::OutWk3Img_pOutWk3Img
 
boost::shared_ptr< ipsdk::imaproc::attr::OutImg_pOutImg
 
- Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
eProcessorProgressAvailability _processorProgressAvailability
 
ipUInt32 _nbIter
 

Additional Inherited Members

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

Detailed Description

Level 2 algorithm: Computes the Harris corner detection response.

See Harris corner detection 2d image for a complete algorithm description.

Author
R. Abbal
Date
2016/07/21

Algorithm associated library :

IPSDKIPLFeatureDetection

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InSubImg2d [Input] grey level 2d sub image for operation X
ipsdk::imaproc::attr::InGradStdDev [Input] standard deviation used for gradient computation X
ipsdk::imaproc::attr::InGaussianCoverage [Input] Parameter allowing to specify a gaussian distribution coverage for processing X
ipsdk::imaproc::attr::InCornerDetectionParams [Input] parameters used during corner detection process X
ipsdk::imaproc::attr::OutWk1Img [Output] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutWk2Img [Output] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutWk3Img [Output] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutImg [Output] image for processing operation X

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (_pInSubImg2d,_pOutImg) && 
ipsdk::imaproc::matchSizeAndType (_pOutImg,_pOutWk1Img) && 
ipsdk::imaproc::matchSizeAndType (_pOutWk1Img,_pOutWk2Img) && 
ipsdk::imaproc::matchSizeAndType (_pOutWk1Img,_pOutWk3Img)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::fd::HarrisCorner2dImgLvl2::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

◆ retrieveFirstProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::fd::HarrisCorner2dImgLvl2::retrieveFirstProvider ( const ipsdk::core::BasePriority priority,
ipsdk::core::ActionProviderPtr pProvider 
)
protected

method allowing to retrieve first provider associated to asynchronous processing in derived class

Returns
provider retrieval result.
Note
On success provider pointer must not be null nor uninitialized

◆ retrieveSecondProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::fd::HarrisCorner2dImgLvl2::retrieveSecondProvider ( const ipsdk::core::BasePriority priority,
ipsdk::core::ActionProviderPtr pProvider 
)
protected

method allowing to retrieve second provider associated to asynchronous processing in derived class

Returns
provider retrieval result.
Note
On success provider pointer must not be null nor uninitialized

◆ retrieveThirdProvider()

eturn provider retrieval result ote On success provider pointer must not be null nor uninitialized ipsdk::processor::RetrievalResult ipsdk::imaproc::fd::HarrisCorner2dImgLvl2::retrieveThirdProvider ( const ipsdk::core::BasePriority priority,
ipsdk::core::ActionProviderPtr pProvider 
)
protected

rief method allowing to retrieve third provider associated to asynchronous processing in derived class


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