Level 1 algorithm: Connected component 3d analysis and measurement algorithm. More...

#include <LabelAnalysis3dLvl1.h>

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

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

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

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

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

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

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

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

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

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::BaseAsync2Action >
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< LabelAnalysis3dLvl1 >	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
	LabelAnalysis3dLvl1 ()
	constructor

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

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

void	clearIntermediateData ()
	method allowing to clear intermediate data for object

Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync2Action >
virtual BoolResult	initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0

Protected Attributes
ipsdk::shape::segmentation::PlanIndexedShape3dCollPtr	_pPlanIndexedShape3dColl
	plan indexed collection of shape collection

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InGreyMsrImg3d >	_pInGreyMsrImg3d

boost::shared_ptr< ipsdk::imaproc::attr::InLabelImg3d >	_pInLabelImg3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptSurfaceExtractionSettings >	_pInOptSurfaceExtractionSettings

boost::shared_ptr< ipsdk::imaproc::attr::InMeasureInfoSet3d >	_pInMeasureInfoSet3d

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

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

ipUInt32	_nbIter

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

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

Detailed Description

Level 1 algorithm: Connected component 3d analysis and measurement algorithm.

See Label Analysis 3d for a complete algorithm description.

Author: E. Noirfalise

Date: 2017/10/23

Copyright: 2017 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLShapeAnalysis

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InGreyMsrImg3d	[Input] grey image 3d used for intensity measurements	X
ipsdk::imaproc::attr::InLabelImg3d	[Input] label image 3d for processing operation	X
ipsdk::imaproc::attr::InOptSurfaceExtractionSettings	[Input Optional] Settings used for surfaces extraction	X
ipsdk::imaproc::attr::InMeasureInfoSet3d	[Input] shape analysis 3d measure information set	X
ipsdk::imaproc::attr::OutPIMeasureSet	[Output] Plan indexed collection of shape analysis measure set	fromImage (_pOutPIMeasureSet, _pInGreyMsrImg3d, eFromImagePlanIndexedPolicy::eFIPIP_T, boost::function<OutPIMeasureSet::PlanStorageType()>(boost::bind(&ipsdk::imaproc::createMeasureSetFromInfo,_pInMeasureInfoSet3d)))

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::matchSize (ipsdk::imaproc::eMatchImageSizeType::eMIST_XYZT,_pInGreyMsrImg3d,_pInLabelImg3d) &&
ipsdk::imaproc::matchImagePlans (_pOutPIMeasureSet,_pInGreyMsrImg3d,eImagePlansMatchPolicy::eIPMP_T) &&
matchLabelAnalysis (_pInMeasureInfoSet3d)

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::shape::analysis::LabelAnalysis3dLvl1::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

◆ retrieveFirstProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::shape::analysis::LabelAnalysis3dLvl1::retrieveFirstProvider	(	const ipsdk::core::BasePriority &	priority,
		ipsdk::core::ActionProviderPtr &	pProvider
	)

protected

method allowing to retrieve first provider associated to asynchronous processing in derived class

Returns: provider retrieval result.

Note: On success provider pointer must not be null nor uninitialized

◆ retrieveSecondProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::shape::analysis::LabelAnalysis3dLvl1::retrieveSecondProvider	(	const ipsdk::core::BasePriority &	priority,
		ipsdk::core::ActionProviderPtr &	pProvider
	)

protected

method allowing to retrieve second 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/LabelAnalysis3d/LabelAnalysis3dLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members