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::glbmsr::LocatePixels2dLvl2 Class Reference

Level 2 algorithm: Build the list of the coordinates of the pixels with a value of True in the input binary image. More...

#include <LocatePixels2dLvl2.h>

Inheritance diagram for ipsdk::imaproc::glbmsr::LocatePixels2dLvl2:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >

Public Member Functions

 ~LocatePixels2dLvl2 ()
 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...
 
core::ExecResult postProcess ()
 method called after processing More...
 
void clearIntermediateData ()
 method allowing to clear intermediate data for object
 
Attribute accessors

Setters and Getters for attributes

template<>
const ipsdk::imaproc::attr::InSubBinImg2dget () const
 Getter for attribute InSubBinImg2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InSubBinImg2d::StorageType &value)
 Setter for attribute InSubBinImg2d.
 
template<>
const ipsdk::imaproc::attr::InNbFeaturesget () const
 Getter for attribute InNbFeatures.
 
template<>
void set (const typename ipsdk::imaproc::attr::InNbFeatures::StorageType &value)
 Setter for attribute InNbFeatures.
 
template<>
const ipsdk::imaproc::attr::OutPixels2dget () const
 Getter for attribute OutPixels2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutPixels2d::StorageType &value)
 Setter for attribute OutPixels2d.
 
- Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >
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< LocatePixels2dLvl2createProcessor ()
 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

 LocatePixels2dLvl2 ()
 constructor
 
ipsdk::processor::RetrievalResult retrieveProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
 method allowing to retrieve provider associated to asynchronous processing in derived class More...
 
 IPSDK_DECLARE_DYNAMIC_RESULT_COLL (OutPixels2d, OutPixels2dColl)
 
- Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >
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::InSubBinImg2d_pInSubBinImg2d
 
boost::shared_ptr< ipsdk::imaproc::attr::InNbFeatures_pInNbFeatures
 
boost::shared_ptr< ipsdk::imaproc::attr::OutPixels2d_pOutPixels2d
 
- Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >
eProcessorProgressAvailability _processorProgressAvailability
 
ipUInt32 _nbIter
 

Additional Inherited Members

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

Detailed Description

Level 2 algorithm: Build the list of the coordinates of the pixels with a value of True in the input binary image.

See Pixel localization 2d for a complete algorithm description.

Author
R. Abbal
Date
2021/09/30

Algorithm associated library :

IPSDKIPLGlobalMeasure

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InSubBinImg2d [Input] binary 2d single sub image for processing operation X
ipsdk::imaproc::attr::InNbFeatures [Input] target number of features to be detected by algorithm X
ipsdk::imaproc::attr::OutPixels2d [Output] positions and intensities of 2d pixels X

Global attributes rule :

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

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::glbmsr::LocatePixels2dLvl2::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

◆ retrieveProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::glbmsr::LocatePixels2dLvl2::retrieveProvider ( const ipsdk::core::BasePriority priority,
ipsdk::core::ActionProviderPtr pProvider 
)
protected

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

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

◆ postProcess()

core::ExecResult ipsdk::imaproc::glbmsr::LocatePixels2dLvl2::postProcess ( )

method called after processing

Returns
execution result

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