Level 1 algorithm: Generates a 3D binary image with oriented lines. More...

#include <BuildLines3dImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::util::BuildLines3dImgLvl1:

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >
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< BuildLines3dImgLvl1 >	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
	BuildLines3dImgLvl1 ()
	constructor

ipsdk::processor::RetrievalResult	retrieveProvider (const ipsdk::core::BasePriority &priority, ipsdk::core::ActionProviderPtr &pProvider)
	method allowing to retrieve provider associated to asynchronous processing in derived class More...

Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >
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::InOutputImg3dSize >	_pInOutputImg3dSize

boost::shared_ptr< ipsdk::imaproc::attr::InTheta >	_pInTheta

boost::shared_ptr< ipsdk::imaproc::attr::InPhi >	_pInPhi

boost::shared_ptr< ipsdk::imaproc::attr::InAlpha >	_pInAlpha

boost::shared_ptr< ipsdk::imaproc::attr::InOffset >	_pInOffset

boost::shared_ptr< ipsdk::imaproc::attr::OutBinImg3d >	_pOutBinImg3d

Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >
eProcessorProgressAvailability	_processorProgressAvailability

ipUInt32	_nbIter

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

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

Detailed Description

Level 1 algorithm: Generates a 3D binary image with oriented lines.

See Build 3D Lines for a complete algorithm description.

Author: R. Abbal

Date: 2024/10/11

Copyright: 2024 ReactivIP, all right reserved.

Support GPU

Algorithm associated library :

IPSDKIPLUtility

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InOutputImg3dSize	[Input] output image 3d size	X
ipsdk::imaproc::attr::InTheta	[Input] 2d orientation for processing operation	X
ipsdk::imaproc::attr::InPhi	[Input] starting azimuth angle offset value	X
ipsdk::imaproc::attr::InAlpha	[Input] Component of a 3D orientation	X
ipsdk::imaproc::attr::InOffset	[Input] Offset. Used for instance by shading correction algorithm	X
ipsdk::imaproc::attr::OutBinImg3d	[Output] 3D binary image	customOutput (_pOutBinImg3d, outputBuild3d(_pInOutputImg3dSize))

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::customImageProperty (_pOutBinImg3d,
ipsdk::imaproc::util::matchROI3d (_pInOutputImg3dSize))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::util::BuildLines3dImgLvl1::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::util::BuildLines3dImgLvl1::retrieveProvider	(	const ipsdk::core::BasePriority &	priority,
		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/IPSDKIPLUtility/Processor/BuildLines3dImg/BuildLines3dImgLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes