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

Level 2 algorithm: Connected component image 2d labeling algorithm. More...

#include <ConnectedComponent2dImgLvl2.h>

Inheritance diagram for ipsdk::imaproc::advmorpho::ConnectedComponent2dImgLvl2:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >

Public Member Functions

 ~ConnectedComponent2dImgLvl2 ()
 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::InSubBinLabImg2dget () const
 Getter for attribute InSubBinLabImg2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InSubBinLabImg2d::StorageType &value)
 Setter for attribute InSubBinLabImg2d.
 
template<>
const ipsdk::imaproc::attr::InNeighborhood2dget () const
 Getter for attribute InNeighborhood2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InNeighborhood2d::StorageType &value)
 Setter for attribute InNeighborhood2d.
 
template<>
const ipsdk::imaproc::attr::OutSubLabelImg2dget () const
 Getter for attribute OutSubLabelImg2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutSubLabelImg2d::StorageType &value)
 Setter for attribute OutSubLabelImg2d.
 
template<>
const ipsdk::imaproc::attr::OutLabelInfoget () const
 Getter for attribute OutLabelInfo.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutLabelInfo::StorageType &value)
 Setter for attribute OutLabelInfo.
 
- 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< ConnectedComponent2dImgLvl2createProcessor ()
 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

 ConnectedComponent2dImgLvl2 ()
 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)
 
void notifyFirstProviderCompletion (const core::ActionProviderPtr &pProvider)
 
processor::RetrievalResult retrieveLastProvider (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
void clearIntermediateData ()
 method allowing to clear intermediate data for object
 
 IPSDK_DECLARE_DYNAMIC_RESULT_COLL (attr::OutLabelConnectionTable, StripConnections)
 
 IPSDK_DECLARE_STATIC_RESULT_COLL (attr::OutInterStripLabelConnections, InterStripConnections)
 
- 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

processor::ElementsSplitInfoConstPtr _pElementsSplitInfo
 data split elements processing informations
 
boost::shared_ptr< attr::LabelConnectionTable_pGlobalLabelConnectionTable
 global label connection table
 
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InSubBinLabImg2d_pInSubBinLabImg2d
 
boost::shared_ptr< ipsdk::imaproc::attr::InNeighborhood2d_pInNeighborhood2d
 
boost::shared_ptr< ipsdk::imaproc::attr::OutSubLabelImg2d_pOutSubLabelImg2d
 
boost::shared_ptr< ipsdk::imaproc::attr::OutLabelInfo_pOutLabelInfo
 
- 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: Connected component image 2d labeling algorithm.

See Connected Component 2d for a complete algorithm description.

Author
E. Noirfalise
Date
2015/02/09

Algorithm associated library :

IPSDKIPLAdvancedMorphology

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InSubBinLabImg2d [Input] binary 2d single sub binary or label image for processing operation X
ipsdk::imaproc::attr::InNeighborhood2d [Input] neighborhood 2d type for operation X
ipsdk::imaproc::attr::OutSubLabelImg2d [Output] label 2d sub image for processing operation X
ipsdk::imaproc::attr::OutLabelInfo [Output] Image Label information X

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (_pInSubBinLabImg2d,_pOutSubLabelImg2d)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::advmorpho::ConnectedComponent2dImgLvl2::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::advmorpho::ConnectedComponent2dImgLvl2::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::advmorpho::ConnectedComponent2dImgLvl2::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::advmorpho::ConnectedComponent2dImgLvl2::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

◆ notifyFirstProviderCompletion()

void ipsdk::imaproc::advmorpho::ConnectedComponent2dImgLvl2::notifyFirstProviderCompletion ( const core::ActionProviderPtr pProvider)
protected

First provider (first pass for connected component processing) completion callback

◆ retrieveLastProvider()

processor::RetrievalResult ipsdk::imaproc::advmorpho::ConnectedComponent2dImgLvl2::retrieveLastProvider ( const core::BasePriority priority,
core::ActionProviderPtr pProvider 
)
protected

function allowing to retrieve Lut transform provider (last processing step)


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