Level 1 algorithm: Shape 2d analysis and measurement algorithm. More...

#include <ShapeAnalysis2dLvl1.h>

Inheritance diagram for ipsdk::imaproc::shape::analysis::ShapeAnalysis2dLvl1:

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

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

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

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

template<>
const ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d2 &	get () const
	Getter for attribute InOptPILabelsShape2d2.

template<>
void	set (const typename ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d2::StorageType &value)
	Setter for attribute InOptPILabelsShape2d2.

template<>
const ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d3 &	get () const
	Getter for attribute InOptPILabelsShape2d3.

template<>
void	set (const typename ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d3::StorageType &value)
	Setter for attribute InOptPILabelsShape2d3.

template<>
const ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d4 &	get () const
	Getter for attribute InOptPILabelsShape2d4.

template<>
void	set (const typename ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d4::StorageType &value)
	Setter for attribute InOptPILabelsShape2d4.

template<>
const ipsdk::imaproc::shape::analysis::InOptGreyMsrImg1 &	get () const
	Getter for attribute InOptGreyMsrImg1.

template<>
void	set (const typename ipsdk::imaproc::shape::analysis::InOptGreyMsrImg1::StorageType &value)
	Setter for attribute InOptGreyMsrImg1.

template<>
const ipsdk::imaproc::shape::analysis::InOptGreyMsrImg2 &	get () const
	Getter for attribute InOptGreyMsrImg2.

template<>
void	set (const typename ipsdk::imaproc::shape::analysis::InOptGreyMsrImg2::StorageType &value)
	Setter for attribute InOptGreyMsrImg2.

template<>
const ipsdk::imaproc::shape::analysis::InOptGreyMsrImg3 &	get () const
	Getter for attribute InOptGreyMsrImg3.

template<>
void	set (const typename ipsdk::imaproc::shape::analysis::InOptGreyMsrImg3::StorageType &value)
	Setter for attribute InOptGreyMsrImg3.

template<>
const ipsdk::imaproc::shape::analysis::InOptGreyMsrImg4 &	get () const
	Getter for attribute InOptGreyMsrImg4.

template<>
void	set (const typename ipsdk::imaproc::shape::analysis::InOptGreyMsrImg4::StorageType &value)
	Setter for attribute InOptGreyMsrImg4.

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

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

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< ShapeAnalysis2dLvl1 >	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
	ShapeAnalysis2dLvl1 ()
	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::InMeasureInfoSet2d >	_pInMeasureInfoSet2d

boost::shared_ptr< ipsdk::imaproc::attr::InPILabelsShape2d >	_pInPILabelsShape2d

boost::shared_ptr< ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d2 >	_pInOptPILabelsShape2d2

boost::shared_ptr< ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d3 >	_pInOptPILabelsShape2d3

boost::shared_ptr< ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d4 >	_pInOptPILabelsShape2d4

boost::shared_ptr< ipsdk::imaproc::shape::analysis::InOptGreyMsrImg1 >	_pInOptGreyMsrImg1

boost::shared_ptr< ipsdk::imaproc::shape::analysis::InOptGreyMsrImg2 >	_pInOptGreyMsrImg2

boost::shared_ptr< ipsdk::imaproc::shape::analysis::InOptGreyMsrImg3 >	_pInOptGreyMsrImg3

boost::shared_ptr< ipsdk::imaproc::shape::analysis::InOptGreyMsrImg4 >	_pInOptGreyMsrImg4

boost::shared_ptr< ipsdk::imaproc::attr::OutPIMeasureSet >	_pOutPIMeasureSet

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: Shape 2d analysis and measurement algorithm.

See Shape Analysis 2d for a complete algorithm description.

Author: E. Noirfalise

Date: 2015/06/23

Copyright: 2015 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLShapeAnalysis

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InMeasureInfoSet2d	[Input] shape analysis 2d measure information set	X
ipsdk::imaproc::attr::InPILabelsShape2d	[Input] Plan indexed collection of shape 2d associated to labels	X
ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d2	[Input Optional] second plan indexed collection of shape 2d associated to labels	X
ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d3	[Input Optional] third plan indexed collection of shape 2d associated to labels	X
ipsdk::imaproc::shape::analysis::InOptPILabelsShape2d4	[Input Optional] fourth plan indexed collection of shape 2d associated to labels	X
ipsdk::imaproc::shape::analysis::InOptGreyMsrImg1	[Input Optional] first grey image used for intensity measurements	X
ipsdk::imaproc::shape::analysis::InOptGreyMsrImg2	[Input Optional] second grey image used for intensity measurements	X
ipsdk::imaproc::shape::analysis::InOptGreyMsrImg3	[Input Optional] thirid grey image used for intensity measurements	X
ipsdk::imaproc::shape::analysis::InOptGreyMsrImg4	[Input Optional] fourth grey image used for intensity measurements	X
ipsdk::imaproc::attr::OutPIMeasureSet	[Output] Plan indexed collection of shape analysis measure set	fromOther (_pOutPIMeasureSet, _pInPILabelsShape2d, boost::function<OutPIMeasureSet::PlanStorageType()>(boost::bind(&ipsdk::imaproc::createMeasureSetFromInfo,_pInMeasureInfoSet2d)))

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchOther (_pInPILabelsShape2d,_pOutPIMeasureSet) &&
validateMeasureRequirements (_pInMeasureInfoSet2d,_pInPILabelsShape2d,_pInOptPILabelsShape2d2,_pInOptPILabelsShape2d3,_pInOptPILabelsShape2d4,_pInOptGreyMsrImg1,_pInOptGreyMsrImg2,_pInOptGreyMsrImg3,_pInOptGreyMsrImg4)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::shape::analysis::ShapeAnalysis2dLvl1::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::shape::analysis::ShapeAnalysis2dLvl1::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/IPSDKIPLShapeAnalysis/Processor/ShapeAnalysis2d/ShapeAnalysis2dLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes