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::FillHole3dImgLvl1 Class Reference

Level 1 algorithm: holes filling in a binary 3d image. More...

#include <FillHole3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::advmorpho::FillHole3dImgLvl1:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >

Public Member Functions

 ~FillHole3dImgLvl1 ()
 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::InBinImg3dget () const
 Getter for attribute InBinImg3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InBinImg3d::StorageType &value)
 Setter for attribute InBinImg3d.
 
template<>
const ipsdk::imaproc::attr::InOptNeighborhood3dget () const
 Getter for attribute InOptNeighborhood3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptNeighborhood3d::StorageType &value)
 Setter for attribute InOptNeighborhood3d.
 
template<>
const ipsdk::imaproc::attr::InOptOptimizationPolicyget () const
 Getter for attribute InOptOptimizationPolicy.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptOptimizationPolicy::StorageType &value)
 Setter for attribute InOptOptimizationPolicy.
 
template<>
const ipsdk::imaproc::attr::OutOptWk1BinImgget () const
 Getter for attribute OutOptWk1BinImg.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutOptWk1BinImg::StorageType &value)
 Setter for attribute OutOptWk1BinImg.
 
template<>
const ipsdk::imaproc::attr::OutOptWk1LabelImgget () const
 Getter for attribute OutOptWk1LabelImg.
 
template<>
void set (const typename ipsdk::imaproc::attr::OutOptWk1LabelImg::StorageType &value)
 Setter for attribute OutOptWk1LabelImg.
 
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::BaseRepeatedAsync1Action >
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< FillHole3dImgLvl1createProcessor ()
 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

 FillHole3dImgLvl1 ()
 constructor
 
ipsdk::processor::RetrievalResult retrieveProvider (const ipsdk::core::BasePriority &priority, ipsdk::ipUInt32 curNbIter, ipsdk::core::ActionProviderPtr &pProvider)
 method allowing to retrieve provider associated to asynchronous processing in derived class More...
 
ipsdk::core::ExecResult preProcess ()
 method called before processing More...
 
void clearIntermediateData ()
 method allowing to clear intermediate data for object
 
processor::RetrievalResult provideProcessor (const boost::shared_ptr< core::BaseAction > &pProcessor, const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
processor::RetrievalResult logicalNot (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
processor::RetrievalResult markBorder (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
processor::RetrievalResult maxPropagation (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
processor::RetrievalResult threshold (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
processor::RetrievalResult bitwiseOr (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
 
- Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
virtual BoolResult initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0
 

Protected Attributes

image::ImagePtr _pUsedImg
 working image for border removal operation
 
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InBinImg3d_pInBinImg3d
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptNeighborhood3d_pInOptNeighborhood3d
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptOptimizationPolicy_pInOptOptimizationPolicy
 
boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk1BinImg_pOutOptWk1BinImg
 
boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk1LabelImg_pOutOptWk1LabelImg
 
boost::shared_ptr< ipsdk::imaproc::attr::OutImg_pOutImg
 
- Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
eProcessorProgressAvailability _processorProgressAvailability
 
ipUInt32 _nbIter
 

Additional Inherited Members

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

Detailed Description

Level 1 algorithm: holes filling in a binary 3d image.

See Fill hole 3d for a complete algorithm description.

Author
E. Noirfalise
Date
2016/03/10

Algorithm associated library :

IPSDKIPLAdvancedMorphology

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InBinImg3d [Input] binary 3d image for processing operation X
ipsdk::imaproc::attr::InOptNeighborhood3d [Input optional] neighborhood 3d type for operation X
ipsdk::imaproc::attr::InOptOptimizationPolicy [Input Optional] processing optimization policy for algorithm X
ipsdk::imaproc::attr::OutOptWk1BinImg [Output Optional] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutOptWk1LabelImg [Output Optional] Temporary working image for algorithm X
ipsdk::imaproc::attr::OutImg [Output] image for processing operation ipsdk::imaproc::duplicateInOut (_pOutImg, _pInBinImg3d)

Global attributes rule :

Global rule on attributes is given by
((ipsdk::imaproc::matchSizeAndType (_pInBinImg3d,_pOutImg)) && 
 (ipsdk::processor::ifIsSet (
   _pOutOptWk1BinImg, (
    ipsdk::imaproc::matchSize (_pInBinImg3d,_pOutOptWk1BinImg))) && 
  (ipsdk::processor::ifIsSet (
    _pOutOptWk1LabelImg, (
     ipsdk::imaproc::matchSize (_pInBinImg3d,_pOutOptWk1LabelImg))))))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::advmorpho::FillHole3dImgLvl1::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::FillHole3dImgLvl1::retrieveProvider ( const ipsdk::core::BasePriority priority,
ipsdk::ipUInt32  curNbIter,
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

◆ preProcess()

ipsdk::core::ExecResult ipsdk::imaproc::advmorpho::FillHole3dImgLvl1::preProcess ( )
protected

method called before processing

Returns
execution result

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