ipsdk::imaproc::advmorpho::SuperPixels2dImgLvl3 Class Reference

Level 3 algorithm: Super pixels algorithm based on SLIC. More...

#include <SuperPixels2dImgLvl3.h>

Inheritance diagram for ipsdk::imaproc::advmorpho::SuperPixels2dImgLvl3:

Public Member Functions
	~SuperPixels2dImgLvl3 ()
	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::InColorYStrip2d &	get () const
	Getter for attribute InColorYStrip2d.
template<>
void	set (const typename ipsdk::imaproc::attr::InColorYStrip2d::StorageType &value)
	Setter for attribute InColorYStrip2d.
template<>
const ipsdk::imaproc::attr::InPixelsColor &	get () const
	Getter for attribute InPixelsColor.
template<>
void	set (const typename ipsdk::imaproc::attr::InPixelsColor::StorageType &value)
	Setter for attribute InPixelsColor.
template<>
const ipsdk::imaproc::attr::InCompactness &	get () const
	Getter for attribute InCompactness.
template<>
void	set (const typename ipsdk::imaproc::attr::InCompactness::StorageType &value)
	Setter for attribute InCompactness.
template<>
const ipsdk::imaproc::attr::InSizeSuperPixels &	get () const
	Getter for attribute InSizeSuperPixels.
template<>
void	set (const typename ipsdk::imaproc::attr::InSizeSuperPixels::StorageType &value)
	Setter for attribute InSizeSuperPixels.
template<>
const ipsdk::imaproc::attr::OutSuperPixelUpdateCenters &	get () const
	Getter for attribute OutSuperPixelUpdateCenters.
template<>
void	set (const typename ipsdk::imaproc::attr::OutSuperPixelUpdateCenters::StorageType &value)
	Setter for attribute OutSuperPixelUpdateCenters.
template<>
const ipsdk::imaproc::attr::OutLabelYStrip2d &	get () const
	Getter for attribute OutLabelYStrip2d.
template<>
void	set (const typename ipsdk::imaproc::attr::OutLabelYStrip2d::StorageType &value)
	Setter for attribute OutLabelYStrip2d.
Public Member Functions inherited from ipsdk::processor::BaseSyncProcessor
eProcessorType	getProcessorType () const
Public Member Functions inherited from ipsdk::processor::BaseProcessor
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
ItemNames	getHeaderKeys () const
const BaseDataItem &	getHeaderItem (const std::string &key) const
BaseDataItem &	getHeaderItem (const std::string &key)
void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)
void	removeHeaderItem (const std::string &key)
void	clearHeader ()
ipUInt32	getNbAttributes () const
const BaseAttribute &	getAttribute (ipUInt32 index) const
BaseAttribute &	getAttribute (ipUInt32 index)
bool	existsAttribute (const std::string &attributeName) const
StringVector	getAttributeNameColl () const
const BaseAttribute &	getAttribute (const std::string &attributeName) const
BaseAttribute &	getAttribute (const std::string &attributeName)
bool	hasOutputInitializer (const std::string &attributeName) const
const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const
bool	existsHeaderKey (const std::string &key) const
ItemNames	getHeaderKeys () const
const BaseDataItem &	getHeaderItem (const std::string &key) const
BaseDataItem &	getHeaderItem (const std::string &key)
void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)
void	removeHeaderItem (const std::string &key)
void	clearHeader ()
ipUInt32	getNbAttributes () const
const BaseAttribute &	getAttribute (ipUInt32 index) const
BaseAttribute &	getAttribute (ipUInt32 index)
bool	existsAttribute (const std::string &attributeName) const
StringVector	getAttributeNameColl () const
const BaseAttribute &	getAttribute (const std::string &attributeName) const
BaseAttribute &	getAttribute (const std::string &attributeName)
bool	hasOutputInitializer (const std::string &attributeName) const
const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const
Public Member Functions inherited from ipsdk::core::BaseComplexAction
bool	isComplexAction () const
Public Member Functions inherited from ipsdk::core::BaseAction
bool	isInit () const
eExecutionStatus	getStatus () const
const ePriority &	getActionPriority () const
void	setActionPriority (const BasePriority &actionPriority)
void	addCompletionCB (const ActionCompletionCB &completionCB)
ExecResult	run (const eSynchroType &synchroType=eSynchroType::eST_Default)
void	requestCancellation ()
bool	isCancellationRequested () const
void	waitForCompletion ()
ExecResult	getActionResult () const
double	getFullActionDuration () const
double	getExecutionActionDuration () const
BoolResult	clear ()
bool	hasSocketGuid () const
void	setSocketGuid (const Guid &socketGuid)
const Guid &	getSocketGuid () const
bool	hasSocketGuid () const
void	setSocketGuid (const Guid &socketGuid)
const Guid &	getSocketGuid () const
Public Member Functions inherited from ipsdk::SerializationObjectWithGuid
const Guid &	getGuid () const
Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
virtual BaseDynamicObject *	createNew () const=0
virtual DynamicObjectPtr	createShared () const=0
virtual bool	hasCopySupport () const=0
virtual BaseDynamicObject *	duplicate () const=0
virtual DynamicObjectPtr	duplicateShared () const=0

Static Public Member Functions
static boost::shared_ptr< SuperPixels2dImgLvl3 >	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
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()

Protected Member Functions
	SuperPixels2dImgLvl3 ()
	constructor
ipsdk::core::ExecResult	preProcess ()
	method called before processing More...
ipsdk::core::ExecResult	postProcess ()
	method called after processing More...
template<typename TIn , typename TOut , ipsdk::eInstructionSet::domain IS>
ipsdk::BoolResult	genericProcessFunction (const ipsdk::processor::ProcessingInfo &info)
	generic processing function associated to class
Protected Member Functions inherited from ipsdk::processor::BaseProcessingAlgorithm
virtual const FunctionSelector &	getFunctionSelector () const=0
virtual const InstructionSetsIdentifier &	getForcedInstructionSets () const=0
virtual void	getDataTypeIdColl (DataTypeIdColl &dataTypeIdColl) const=0
virtual void	initDataParserColl (DataParserColl &dataParserColl)=0
virtual void	clearDataParserColl ()=0
virtual void	getNoParseInfo (ipUInt64 &nbDataByElement, ipUInt64 &nbMaxInitData, ipUInt64 &nbMaxFinalData) const
Protected Member Functions inherited from ipsdk::processor::BaseSyncProcessor
virtual core::ExecResult	mainProcess ()=0
Protected Member Functions inherited from ipsdk::processor::BaseProcessor
virtual BoolResult	initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0
Protected Member Functions inherited from ipsdk::core::BaseComplexAction
virtual ExecResult	initProcess ()
virtual ExecResult	endProcess ()
ExecResult	execInitProcess ()
ExecResult	execEndProcess ()
Protected Member Functions inherited from ipsdk::core::BaseAction
bool	isSynchronismForced () const
BoolResult	initBase (const BasePriority &defaultPriority=NormalPriority())
virtual BoolResult	globalCleanDerived ()
virtual BoolResult	cleanOnErrorDerived (const eCleanReason &cleanReason)
virtual ExecResultDerived	runDerived ()=0
virtual void	requestCancellationdDerived ()
void	notifyCompletion (const ExecResult &bCompletionResult)
ExecResultDerived	toExecResultDerived (const ExecResult &execResult) const
virtual BoolResult	syncInputDataDerived (const Guid &processingSocketGuid)
virtual BoolResult	syncOutputDataDerived (const Guid &processingSocketGuid)
virtual void	clearInputData ()
virtual void	clearIntermediateData ()
virtual void	clearOutputData ()
Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
virtual BoolResult	read (BaseIArchive &ar)
Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)
virtual void	copy (const BaseDynamicObject &object)

Protected Attributes
std::vector< ipReal32 * >	_vBufCenterIntensities
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InColorYStrip2d >	_pInColorYStrip2d
boost::shared_ptr< ipsdk::imaproc::attr::InPixelsColor >	_pInPixelsColor
boost::shared_ptr< ipsdk::imaproc::attr::InCompactness >	_pInCompactness
boost::shared_ptr< ipsdk::imaproc::attr::InSizeSuperPixels >	_pInSizeSuperPixels
boost::shared_ptr< ipsdk::imaproc::attr::OutSuperPixelUpdateCenters >	_pOutSuperPixelUpdateCenters
boost::shared_ptr< ipsdk::imaproc::attr::OutLabelYStrip2d >	_pOutLabelYStrip2d
Parsed data attributes
boost::shared_ptr< LineStripParser >	_pInColorYStrip2dBuf
	Data preparator associated to attribute InColorYStrip2d.
boost::shared_ptr< LineStripParser >	_pOutLabelYStrip2dBuf
	Data preparator associated to attribute OutLabelYStrip2d.
Protected Attributes inherited from ipsdk::processor::BaseProcessor
eProcessorProgressAvailability	_processorProgressAvailability
ipUInt32	_nbIter
Protected Attributes inherited from ipsdk::core::BaseAction
	eCR_Failure
	eCR_Exception
	eCR_Cancellation
	eERD_Success
	eERD_Failure
	eERD_Canceled
	eERD_Running
Protected Attributes inherited from ipsdk::SerializationObjectWithGuid
Guid	_guid

Additional Inherited Members
Public Types inherited from ipsdk::processor::BaseProcessingAlgorithm
typedef DataTypeIdentifierColl	DataTypeIdColl
typedef AlgorithmFunctionIdentifier	FunctionId
typedef AlgorithmFunctionSelector	FunctionSelector
typedef BoolResult(BaseProcessingAlgorithm::*	FunctionType) (const ProcessingInfo &info)
Protected Types inherited from ipsdk::processor::BaseProcessingAlgorithm
typedef std::vector< DataParserPtr >	DataParserColl
Protected Types inherited from ipsdk::processor::BaseProcessor
typedef std::vector< AttributePtr >	AttributeColl
typedef std::map< std::string, OutputInitializerPtr >	OutputInitializerColl
Protected Types inherited from ipsdk::core::BaseAction
enum	eCleanReason
enum	eExecutionResultDerived
typedef ProcessingResult< eExecutionResultDerived >	ExecResultDerived

Detailed Description

Level 3 algorithm: Super pixels algorithm based on SLIC.

See Super Pixels 2d for a complete algorithm description.

Author

Warren AIM

Date

2022/03/07

Copyright

2022 Reactiv IP, all right reserved.

Algorithm associated library :

IPSDKIPLAdvancedMorphology

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InColorYStrip2d	[Input] color y strip 2d for processing operation	X
ipsdk::imaproc::attr::InPixelsColor	[Input] Collection of pixels with color intensities	X
ipsdk::imaproc::attr::InCompactness	[Input] Ratio between distance and color for super pixels algorithm	X
ipsdk::imaproc::attr::InSizeSuperPixels	[Input] Real size of super pixels	X
ipsdk::imaproc::attr::OutSuperPixelUpdateCenters	[Output] Collection of super pixel update centers	X
ipsdk::imaproc::attr::OutLabelYStrip2d	[Output] label y strip 2d for processing operation	X

Global attributes rule :

Global rule on attributes is given by
ipsdk::processor::none ()

Data type algorithm function selector informations :

Processing function selection for this algorithm is based on following attribute data types :

• InColorYStrip2d
• OutLabelYStrip2d

For More informations about algorithm function selection see AlgorithmFunctionSelection

Algorithm parsed data informations :

Algorithm parsed data is based on following attributes :

• InColorYStrip2d
• OutLabelYStrip2d

For More informations about algorithm parsed data see AlgorithmParsedData

Member Function Documentation

getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::advmorpho::SuperPixels2dImgLvl3::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

preProcess()

ipsdk::core::ExecResult ipsdk::imaproc::advmorpho::SuperPixels2dImgLvl3::preProcess ( )

protectedvirtual

method called before processing

Returns

execution result

Reimplemented from ipsdk::processor::BaseProcessingAlgorithm.

postProcess()

ipsdk::core::ExecResult ipsdk::imaproc::advmorpho::SuperPixels2dImgLvl3::postProcess ( )

protectedvirtual

method called after processing

Returns

execution result

Reimplemented from ipsdk::processor::BaseProcessingAlgorithm.

---

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/SuperPixels2dImg/SuperPixels2dImgLvl3.h