Level 1 algorithm: algorithm, based on watershed, allowing to separate grey 3d shapes. More...

#include <WatershedGreySeparation3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::advmorpho::WatershedGreySeparation3dImgLvl1:

Public Member Functions
	~WatershedGreySeparation3dImgLvl1 ()
	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::InIntImg3d &	get () const
	Getter for attribute InIntImg3d.

template<>
void	set (const typename ipsdk::imaproc::attr::InIntImg3d::StorageType &value)
	Setter for attribute InIntImg3d.

template<>
const ipsdk::imaproc::attr::InShapeGreyscaleType &	get () const
	Getter for attribute InShapeGreyscaleType.

template<>
void	set (const typename ipsdk::imaproc::attr::InShapeGreyscaleType::StorageType &value)
	Setter for attribute InShapeGreyscaleType.

template<>
const ipsdk::imaproc::attr::InDilateFactor &	get () const
	Getter for attribute InDilateFactor.

template<>
void	set (const typename ipsdk::imaproc::attr::InDilateFactor::StorageType &value)
	Setter for attribute InDilateFactor.

template<>
const ipsdk::imaproc::attr::InWatershedSeparationMode &	get () const
	Getter for attribute InWatershedSeparationMode.

template<>
void	set (const typename ipsdk::imaproc::attr::InWatershedSeparationMode::StorageType &value)
	Setter for attribute InWatershedSeparationMode.

template<>
const ipsdk::imaproc::attr::InOptWatershedProcMode &	get () const
	Getter for attribute InOptWatershedProcMode.

template<>
void	set (const typename ipsdk::imaproc::attr::InOptWatershedProcMode::StorageType &value)
	Setter for attribute InOptWatershedProcMode.

template<>
const ipsdk::imaproc::attr::InOptNbMinDataByThread &	get () const
	Getter for attribute InOptNbMinDataByThread.

template<>
void	set (const typename ipsdk::imaproc::attr::InOptNbMinDataByThread::StorageType &value)
	Setter for attribute InOptNbMinDataByThread.

template<>
const ipsdk::imaproc::attr::OutWk1Img &	get () const
	Getter for attribute OutWk1Img.

template<>
void	set (const typename ipsdk::imaproc::attr::OutWk1Img::StorageType &value)
	Setter for attribute OutWk1Img.

template<>
const ipsdk::imaproc::attr::OutWk2Img &	get () const
	Getter for attribute OutWk2Img.

template<>
void	set (const typename ipsdk::imaproc::attr::OutWk2Img::StorageType &value)
	Setter for attribute OutWk2Img.

template<>
const ipsdk::imaproc::attr::OutOptWk1Img &	get () const
	Getter for attribute OutOptWk1Img.

template<>
void	set (const typename ipsdk::imaproc::attr::OutOptWk1Img::StorageType &value)
	Setter for attribute OutOptWk1Img.

template<>
const ipsdk::imaproc::attr::OutImg &	get () 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 eProcessorRulePolicy &	getProcessorRulePolicy () const

std::string	getFullInfoStr () const

const BaseRule &	getGlobalRule () const

const ProcessorDispatchPolicy &	getDispatchPolicy () 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 BaseDataItem &	getHeaderItem (const std::string &key) const

BaseDataItem &	getHeaderItem (const std::string &key)

const BaseDataItem &	getHeaderItem (const std::string &key) const

BaseDataItem &	getHeaderItem (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 BaseAttribute &	getAttribute (ipUInt32 index) const

BaseAttribute &	getAttribute (ipUInt32 index)

const BaseAttribute &	getAttribute (const std::string &attributeName) const

BaseAttribute &	getAttribute (const std::string &attributeName)

const BaseAttribute &	getAttribute (ipUInt32 index) const

BaseAttribute &	getAttribute (ipUInt32 index)

const BaseAttribute &	getAttribute (const std::string &attributeName) const

BaseAttribute &	getAttribute (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 BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const

const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const

Static Public Member Functions
static boost::shared_ptr< WatershedGreySeparation3dImgLvl1 >	createProcessor ()
	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
	WatershedGreySeparation3dImgLvl1 ()
	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...

void	notifyLabelStepCompletion (const core::ActionPtr &pAction)
	completion callback for connected components analysis

void	clearIntermediateData ()
	method allowing to clear intermediate data for object

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
ipUInt32	_nbLabels
	number of labels for connected component analysis

attr::StatsResultPtr	_pGreyStatsResult
	statistics for used greyscale image

Watershed3dStackPtr	_pWatershed3dStack
	internal watershed stack

image::ImagePtr	_pWatershedImg
	watershed intermediate used image

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InIntImg3d >	_pInIntImg3d

boost::shared_ptr< ipsdk::imaproc::attr::InShapeGreyscaleType >	_pInShapeGreyscaleType

boost::shared_ptr< ipsdk::imaproc::attr::InDilateFactor >	_pInDilateFactor

boost::shared_ptr< ipsdk::imaproc::attr::InWatershedSeparationMode >	_pInWatershedSeparationMode

boost::shared_ptr< ipsdk::imaproc::attr::InOptWatershedProcMode >	_pInOptWatershedProcMode

boost::shared_ptr< ipsdk::imaproc::attr::InOptNbMinDataByThread >	_pInOptNbMinDataByThread

boost::shared_ptr< ipsdk::imaproc::attr::OutWk1Img >	_pOutWk1Img

boost::shared_ptr< ipsdk::imaproc::attr::OutWk2Img >	_pOutWk2Img

boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk1Img >	_pOutOptWk1Img

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< AttributePtr >	AttributeColl

typedef std::map< std::string, OutputInitializerPtr >	OutputInitializerColl

Detailed Description

Level 1 algorithm: algorithm, based on watershed, allowing to separate grey 3d shapes.

See Watershed Grey Separation 3d for a complete algorithm description.

Author: E. Noirfalise

Date: 2016/04/21

Copyright: 2016 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLAdvancedMorphology

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InIntImg3d	[Input] image 3d for processing operation (data contained in image buffer are integers)	X
ipsdk::imaproc::attr::InShapeGreyscaleType	[Input] shape greyscale type considered during processing	X
ipsdk::imaproc::attr::InDilateFactor	[Input] factor used for dilation	X
ipsdk::imaproc::attr::InWatershedSeparationMode	[Input] parameter allowing to define watershed separation mode	X
ipsdk::imaproc::attr::InOptWatershedProcMode	[Input Optional] Watershed processing mode	X
ipsdk::imaproc::attr::InOptNbMinDataByThread	[Input Optional] minimum number of data by thread	X
ipsdk::imaproc::attr::OutWk1Img	[Output] Temporary working image for algorithm	customOutput (_pOutWk1Img, outputWk1Watershed(_pInIntImg3d,_pInWatershedSeparationMode))
ipsdk::imaproc::attr::OutWk2Img	[Output] Temporary working image for algorithm	customOutput (_pOutWk2Img, outputWk2Watershed(_pInIntImg3d,_pInWatershedSeparationMode))
ipsdk::imaproc::attr::OutOptWk1Img	[Output Optional] Temporary working image for algorithm	X
ipsdk::imaproc::attr::OutImg	[Output] image for processing operation	customOutput (_pOutImg, outputWatershed(_pInIntImg3d,_pInWatershedSeparationMode))

Global attributes rule :

Global rule on attributes is given by
(ipsdk::imaproc::matchSize (_pInIntImg3d,_pOutImg) &&
ipsdk::imaproc::customImageProperty (_pOutImg,
  allowedBufferType (_pInWatershedSeparationMode,_pInIntImg3d)) &&
ipsdk::imaproc::matchSize (_pInIntImg3d,_pOutWk1Img) &&
ipsdk::imaproc::customImageProperty (_pOutWk1Img,
  allowedWk1BufferType (_pInWatershedSeparationMode)) &&
ipsdk::imaproc::matchSize (_pInIntImg3d,_pOutWk2Img) &&
ipsdk::imaproc::customImageProperty (_pOutWk2Img,
  allowedWk2BufferType (_pInWatershedSeparationMode,_pInIntImg3d)) &&
ipsdk::processor::ifIsSet (_pOutOptWk1Img,
  ipsdk::imaproc::matchSize (_pInIntImg3d,_pOutOptWk1Img)))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::advmorpho::WatershedGreySeparation3dImgLvl1::getStorage ( )

retrieve storage associated to a given attribute

Note: This method is only available for Output and In/Out attributes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ retrieveProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::advmorpho::WatershedGreySeparation3dImgLvl1::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

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLAdvancedMorphology/Processor/WatershedGreySeparation3dImg/WatershedGreySeparation3dImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes