Level 1 algorithm: TopHat binary threshold on one 2d image. More...

#include <TopHat2dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::bin::TopHat2dImgLvl1:

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

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

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

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

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::InTopHatThreshold &	get () const
	Getter for attribute InTopHatThreshold.

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

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

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

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::OutOptWk2Img &	get () const
	Getter for attribute OutOptWk2Img.

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

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::OutBinImg &	get () const
	Getter for attribute OutBinImg.

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

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< TopHat2dImgLvl1 >	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
	TopHat2dImgLvl1 ()
	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...

processor::RetrievalResult	provideProcessor (const boost::shared_ptr< core::BaseAction > &pProcessor, const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	closing (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	opening (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	subtract (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)

processor::RetrievalResult	threshold (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
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InImg >	_pInImg

boost::shared_ptr< ipsdk::imaproc::attr::InSEXY >	_pInSEXY

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

boost::shared_ptr< ipsdk::imaproc::attr::InTopHatThreshold >	_pInTopHatThreshold

boost::shared_ptr< ipsdk::imaproc::attr::InOptBorderExtensionPolicy >	_pInOptBorderExtensionPolicy

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

boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk2Img >	_pOutOptWk2Img

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

boost::shared_ptr< ipsdk::imaproc::attr::OutBinImg >	_pOutBinImg

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: TopHat binary threshold on one 2d image.

See TopHat 2d for a complete algorithm description.

Author: E.Noirfalise

Date: 2014/12/01

Copyright: 2014 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLBinarization

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg	[Input] image for processing operation	X
ipsdk::imaproc::attr::InSEXY	[Input] structuring element xy for processing operation	X
ipsdk::imaproc::attr::InShapeGreyscaleType	[Input] shape greyscale type considered during processing	X
ipsdk::imaproc::attr::InTopHatThreshold	[Input] threshold value used for top hat binarization	X
ipsdk::imaproc::attr::InOptBorderExtensionPolicy	[Input Optional] flag indicating border extension policy for processing	X
ipsdk::imaproc::attr::OutOptWk1Img	[Output Optional] Temporary working image for algorithm	X
ipsdk::imaproc::attr::OutOptWk2Img	[Output Optional] Temporary working image for algorithm	X
ipsdk::imaproc::attr::OutWk1Img	[Output] Temporary working image for algorithm	ipsdk::imaproc::duplicateInOut (_pOutWk1Img, _pInImg)
ipsdk::imaproc::attr::OutBinImg	[Output] binary image for processing operation	ipsdk::imaproc::duplicateInOut (_pOutBinImg, _pInImg, image::eImageBufferType::eIBT_Binary)

Global attributes rule :

Global rule on attributes is given by
((ipsdk::imaproc::matchSize (_pInImg,_pOutBinImg)) &&
(ipsdk::imaproc::matchSizeAndType (_pInImg,_pOutWk1Img)) &&
(ipsdk::imaproc::noInSitu (_pInImg,_pOutWk1Img)) &&
(ipsdk::processor::ifIsSet (_pOutOptWk1Img,
   ipsdk::imaproc::customImageProperty (_pOutOptWk1Img,
    morpho::matchBorderExtension1 (_pInImg,_pInSEXY,_pInOptBorderExtensionPolicy)))) &&
(ipsdk::processor::ifIsSet (_pOutOptWk2Img,
   ipsdk::imaproc::customImageProperty (_pOutOptWk2Img,
    morpho::matchBorderExtension2 (_pInImg,_pInSEXY,_pInOptBorderExtensionPolicy)))))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::bin::TopHat2dImgLvl1::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::bin::TopHat2dImgLvl1::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/IPSDKIPLBinarization/Processor/TopHat2dImg/TopHat2dImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes