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::advmorpho::GenericSeededDistanceMap2dImgLvl1 Class Reference

Level 1 algorithm: generic seeded distance map transform of an input binary image according to a seeded image. More...

#include <GenericSeededDistanceMap2dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::advmorpho::GenericSeededDistanceMap2dImgLvl1:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >

Public Member Functions

 ~GenericSeededDistanceMap2dImgLvl1 ()
 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::InBinImgget () const
 Getter for attribute InBinImg.
 
template<>
void set (const typename ipsdk::imaproc::attr::InBinImg::StorageType &value)
 Setter for attribute InBinImg.
 
template<>
const ipsdk::imaproc::attr::InBinSeedImgget () const
 Getter for attribute InBinSeedImg.
 
template<>
void set (const typename ipsdk::imaproc::attr::InBinSeedImg::StorageType &value)
 Setter for attribute InBinSeedImg.
 
template<>
const ipsdk::imaproc::attr::InDistWeight2dget () const
 Getter for attribute InDistWeight2d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InDistWeight2d::StorageType &value)
 Setter for attribute InDistWeight2d.
 
template<>
const ipsdk::imaproc::attr::InOptMaxDistanceget () const
 Getter for attribute InOptMaxDistance.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptMaxDistance::StorageType &value)
 Setter for attribute InOptMaxDistance.
 
template<>
const ipsdk::imaproc::attr::OutDistImgget () const
 Getter for attribute OutDistImg.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutDistImg::StorageType &value)
 Setter for attribute OutDistImg.
 
- 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< GenericSeededDistanceMap2dImgLvl1createProcessor ()
 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

 GenericSeededDistanceMap2dImgLvl1 ()
 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...
 
- 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::InBinImg_pInBinImg
 
boost::shared_ptr< ipsdk::imaproc::attr::InBinSeedImg_pInBinSeedImg
 
boost::shared_ptr< ipsdk::imaproc::attr::InDistWeight2d_pInDistWeight2d
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptMaxDistance_pInOptMaxDistance
 
boost::shared_ptr< ipsdk::imaproc::attr::OutDistImg_pOutDistImg
 
- 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 1 algorithm: generic seeded distance map transform of an input binary image according to a seeded image.

See Generic Seeded Distance Map 2d for a complete algorithm description.

Author
R. Abbal
Date
2015/11/09

Algorithm associated library :

IPSDKIPLAdvancedMorphology

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InBinImg [Input] binary image for processing operation X
ipsdk::imaproc::attr::InBinSeedImg [Input] Seeded binary image X
ipsdk::imaproc::attr::InDistWeight2d [Input] Weighting coefficients for 2d distance calculation X
ipsdk::imaproc::attr::InOptMaxDistance [Input Optional] Maximum distance authorized for the propagation (a value of 0 means no distance restriction) X
ipsdk::imaproc::attr::OutDistImg [Output] distance map image ipsdk::imaproc::duplicateInOut (_pOutDistImg, _pInBinImg, ipsdk::image::eImageBufferType::eIBT_Real32)

Global attributes rule :

Global rule on attributes is given by
(ipsdk::imaproc::matchSize (_pInBinImg,_pOutDistImg)) && 
(ipsdk::imaproc::matchSize (_pInBinSeedImg,_pOutDistImg))

Member Function Documentation

◆ getStorage()

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

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