ipsdk::imaproc::morpho::Pruning3dImgLvl3 Class Reference

Level 3 algorithm: Reduces 3D skeleton branches. If enough iterations are processed, the branches are completely removed. More...

#include <Pruning3dImgLvl3.h>

Inheritance diagram for ipsdk::imaproc::morpho::Pruning3dImgLvl3:

Public Member Functions
	~Pruning3dImgLvl3 ()
	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::InBinKnlZStrip3d &	get () const
	Getter for attribute InBinKnlZStrip3d.
template<>
void	set (const typename ipsdk::imaproc::attr::InBinKnlZStrip3d::StorageType &value)
	Setter for attribute InBinKnlZStrip3d.
template<>
const ipsdk::imaproc::attr::InRemoveSkeletonsWithoutHoles &	get () const
	Getter for attribute InRemoveSkeletonsWithoutHoles.
template<>
void	set (const typename ipsdk::imaproc::attr::InRemoveSkeletonsWithoutHoles::StorageType &value)
	Setter for attribute InRemoveSkeletonsWithoutHoles.
template<>
const ipsdk::imaproc::attr::OutNbModifiedPixels &	get () const
	Getter for attribute OutNbModifiedPixels.
template<>
void	set (const typename ipsdk::imaproc::attr::OutNbModifiedPixels::StorageType &value)
	Setter for attribute OutNbModifiedPixels.
template<>
const ipsdk::imaproc::attr::InOutBinZStrip3d &	get () const
	Getter for attribute InOutBinZStrip3d.
template<>
void	set (const typename ipsdk::imaproc::attr::InOutBinZStrip3d::StorageType &value)
	Setter for attribute InOutBinZStrip3d.
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< Pruning3dImgLvl3 >	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 Types
typedef std::vector< OffsetXYZ >	OffsetColl
	collection of offsets
typedef std::vector< OffsetColl >	StructuringElementColl
	collection of structuring elements
typedef boost::scoped_array< const void * >	BufColl
	collection of buffer pointers
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

Protected Member Functions
	Pruning3dImgLvl3 ()
	constructor
ipsdk::core::ExecResult	preProcess ()
	method called before processing More...
void	fillStructuringElements ()
	Fill the structuring elements with predifined offsets allowing to compute the pruning pass.
void	generateExceptionBGOffsets (const OffsetColl &seExcept_fg, OffsetColl &seExcept_bg)
	Generates the collection of offsets for background exceptions.
template<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 core::ExecResult	postProcess ()
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
StructuringElementColl	_seColl_fg
	collection of offsets associated to patterns to remove
StructuringElementColl	_seColl_bg
StructuringElementColl	_seExceptColl_fg
StructuringElementColl	_seExceptColl_bg
BufColl	_pBufColl_fg [27]
	collection of buffer pointers associated to used structuring elements
BufColl	_pBufColl_bg [27]
BufColl	_pBufColl_except_fg [13]
BufColl	_pBufColl_except_bg [13]
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InBinKnlZStrip3d >	_pInBinKnlZStrip3d
boost::shared_ptr< ipsdk::imaproc::attr::InRemoveSkeletonsWithoutHoles >	_pInRemoveSkeletonsWithoutHoles
boost::shared_ptr< ipsdk::imaproc::attr::OutNbModifiedPixels >	_pOutNbModifiedPixels
boost::shared_ptr< ipsdk::imaproc::attr::InOutBinZStrip3d >	_pInOutBinZStrip3d
Parsed data attributes
boost::shared_ptr< LineStripParser >	_pInBinKnlZStrip3dBuf
	Data preparator associated to attribute InBinKnlZStrip3d.
boost::shared_ptr< LineStripParser >	_pInOutBinZStrip3dBuf
	Data preparator associated to attribute InOutBinZStrip3d.
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)

Detailed Description

Level 3 algorithm: Reduces 3D skeleton branches. If enough iterations are processed, the branches are completely removed.

See Pruning of 3d skeletons for a complete algorithm description.

Author

R. Abbal

Date

2020/05/13

Copyright

2020 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLBasicMorphology

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InBinKnlZStrip3d	[Input] binary image z strip 3d for operation associated to a kernel	X
ipsdk::imaproc::attr::InRemoveSkeletonsWithoutHoles	[Input] If the attribute equals true, the skeletons corresponding to objects without holes are completely removed. If the value is false, a single pixel remains for these objects	X
ipsdk::imaproc::attr::OutNbModifiedPixels	[Output] number of pixels modified by the algorithm	X
ipsdk::imaproc::attr::InOutBinZStrip3d	[InOut] binary z strip 3d for operation	X

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSizeAndType (_pInBinKnlZStrip3d,_pInOutBinZStrip3d)

Data type algorithm function selector informations :

This algorithm has no input data used to select processing function

For More informations about algorithm function selection see AlgorithmFunctionSelection

Algorithm parsed data informations :

Algorithm parsed data is based on following attributes :

• InBinKnlZStrip3d
• InOutBinZStrip3d

For More informations about algorithm parsed data see AlgorithmParsedData

Member Function Documentation

getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::morpho::Pruning3dImgLvl3::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::morpho::Pruning3dImgLvl3::preProcess ( )

protectedvirtual

method called before processing

Returns

execution result

Reimplemented from ipsdk::processor::BaseProcessingAlgorithm.

Member Data Documentation

_seExceptColl_fg

StructuringElementColl ipsdk::imaproc::morpho::Pruning3dImgLvl3::_seExceptColl_fg

protected

collection of offsets associated to patterns to keep (only if InRemoveSkeletonsWithoutHoles is set to false)

---

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/Pruning3dImg/Pruning3dImgLvl3.h