Level 2 algorithm: distance map transform of an input binary image. More...

#include <DistanceMap2dImgLvl2.h>

Inheritance diagram for ipsdk::imaproc::morpho::DistanceMap2dImgLvl2:

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

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

template<>
const ipsdk::imaproc::attr::InOptMaxDistance &	get () 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::OutDistImg &	get () 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::BaseAsync2Action >
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< DistanceMap2dImgLvl2 >	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
	DistanceMap2dImgLvl2 ()
	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)

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
bool	_bGpuCalculation

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InSubBinImg2d >	_pInSubBinImg2d

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::BaseAsync2Action >
eProcessorProgressAvailability	_processorProgressAvailability

ipUInt32	_nbIter

Additional Inherited Members
Protected Types inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
typedef std::vector< AttributePtr >	AttributeColl

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

Detailed Description

Level 2 algorithm: distance map transform of an input binary image.

See Distance Map 2d for a complete algorithm description.

Author: E.Noirfalise

Date: 2015/02/02

Copyright: 2015 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLBasicMorphology

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InSubBinImg2d	[Input] binary 2d single sub image for processing operation	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	X

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (_pInSubBinImg2d,_pOutDistImg)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::morpho::DistanceMap2dImgLvl2::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

◆ retrieveFirstProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::morpho::DistanceMap2dImgLvl2::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::morpho::DistanceMap2dImgLvl2::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::morpho::DistanceMap2dImgLvl2::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

Member Data Documentation

◆ _bGpuCalculation

bool ipsdk::imaproc::morpho::DistanceMap2dImgLvl2::_bGpuCalculation

protected

Flag indicating if the process has been calculated on GPU This is usefull since the disptance map based approach is not available on GPU yet

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLBasicMorphology/Processor/DistanceMap2dImg/DistanceMap2dImgLvl2.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Algorithm associated library :

Attribute description for algorithm :

Global attributes rule :

Member Function Documentation

◆ getStorage()

◆ retrieveFirstProvider()

◆ retrieveSecondProvider()

◆ retrieveThirdProvider()

Member Data Documentation

◆ _bGpuCalculation