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::shape::analysis::ShapeFiltering3dImgLvl1 Class Reference

Level 1 algorithm: Shape 3d filtering algorithm. More...

#include <ShapeFiltering3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::shape::analysis::ShapeFiltering3dImgLvl1:
ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >

Public Member Functions

 ~ShapeFiltering3dImgLvl1 ()
 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::InBinLabImg3dget () const
 Getter for attribute InBinLabImg3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InBinLabImg3d::StorageType &value)
 Setter for attribute InBinLabImg3d.
 
template<>
const ipsdk::imaproc::attr::InGreyMsrImg3dget () const
 Getter for attribute InGreyMsrImg3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InGreyMsrImg3d::StorageType &value)
 Setter for attribute InGreyMsrImg3d.
 
template<>
const ipsdk::imaproc::attr::InFilterFormulaget () const
 Getter for attribute InFilterFormula.
 
template<>
void set (const typename ipsdk::imaproc::attr::InFilterFormula::StorageType &value)
 Setter for attribute InFilterFormula.
 
template<>
const ipsdk::imaproc::attr::InOptMeasureInfoSet3dget () const
 Getter for attribute InOptMeasureInfoSet3d.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptMeasureInfoSet3d::StorageType &value)
 Setter for attribute InOptMeasureInfoSet3d.
 
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::InOptLabelReindexingPolicyget () const
 Getter for attribute InOptLabelReindexingPolicy.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptLabelReindexingPolicy::StorageType &value)
 Setter for attribute InOptLabelReindexingPolicy.
 
template<>
const ipsdk::imaproc::attr::InOptSurfaceExtractionSettingsget () const
 Getter for attribute InOptSurfaceExtractionSettings.
 
template<>
void set (const typename ipsdk::imaproc::attr::InOptSurfaceExtractionSettings::StorageType &value)
 Setter for attribute InOptSurfaceExtractionSettings.
 
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::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< ShapeFiltering3dImgLvl1createProcessor ()
 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

 ShapeFiltering3dImgLvl1 ()
 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::InBinLabImg3d_pInBinLabImg3d
 
boost::shared_ptr< ipsdk::imaproc::attr::InGreyMsrImg3d_pInGreyMsrImg3d
 
boost::shared_ptr< ipsdk::imaproc::attr::InFilterFormula_pInFilterFormula
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptMeasureInfoSet3d_pInOptMeasureInfoSet3d
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptNeighborhood3d_pInOptNeighborhood3d
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptLabelReindexingPolicy_pInOptLabelReindexingPolicy
 
boost::shared_ptr< ipsdk::imaproc::attr::InOptSurfaceExtractionSettings_pInOptSurfaceExtractionSettings
 
boost::shared_ptr< ipsdk::imaproc::attr::OutImg_pOutImg
 
- 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: Shape 3d filtering algorithm.

See Shape Filtering 3d for a complete algorithm description.

Author
H. Delestre
Date
2016/05/04

Algorithm associated library :

IPSDKIPLShapeAnalysis

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InBinLabImg3d [Input] binary or label 3d image for processing operation X
ipsdk::imaproc::attr::InGreyMsrImg3d [Input] grey image 3d used for intensity measurements X
ipsdk::imaproc::attr::InFilterFormula [Input] Logic measure formula used for shape analysis filtering stage X
ipsdk::imaproc::attr::InOptMeasureInfoSet3d [Input Optional] shape analysis 3d measure information set X
ipsdk::imaproc::attr::InOptNeighborhood3d [Input optional] neighborhood 3d type for operation X
ipsdk::imaproc::attr::InOptLabelReindexingPolicy [Input Optional] used label reindexing policy X
ipsdk::imaproc::attr::InOptSurfaceExtractionSettings [Input Optional] Settings used for surfaces extraction X
ipsdk::imaproc::attr::OutImg [Output] image for processing operation duplicateInOut (_pOutImg, _pInBinLabImg3d)

Global attributes rule :

Global rule on attributes is given by
(ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_XYZT,_pInBinLabImg3d,_pInGreyMsrImg3d)) && 
(ipsdk::imaproc::matchSizeAndType (_pInBinLabImg3d,_pOutImg))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >
TAttribute::StorageType ipsdk::imaproc::shape::analysis::ShapeFiltering3dImgLvl1::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::shape::analysis::ShapeFiltering3dImgLvl1::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: