Level 2 algorithm: calculates the histogram for each 3d data of an input image. More...

#include <HistogramMsr3dLvl2.h>

Inheritance diagram for ipsdk::imaproc::glbmsr::HistogramMsr3dLvl2:

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

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

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

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

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

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

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< HistogramMsr3dLvl2 >	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
	HistogramMsr3dLvl2 ()
	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...

processor::RetrievalResult	retrieveLastProvider (const core::BasePriority &priority, core::ActionProviderPtr &pProvider)
	method allowing to retrieve last provider

core::ExecResult	postProcess ()
	method called after processing More...

ipUInt32	getHistoNbClasses (ipReal64 fMin, ipReal64 fMax, ipReal64 fBinWidth) const
	computes the number of classes, given the histogram range [fMin, fMax] and the bin interval fBinWidth

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

	IPSDK_DECLARE_DYNAMIC_RESULT_COLL (OutHistogram, OutHistogramColl)

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
boost::shared_ptr< glbmsr::StatsMsr3dLvl2 >	_pStatsMsr3dLvl2
	shared pointer to statistics measurement algorithm

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InSubImg3d >	_pInSubImg3d

boost::shared_ptr< ipsdk::imaproc::attr::InOptHistoMsrParams >	_pInOptHistoMsrParams

boost::shared_ptr< ipsdk::imaproc::attr::OutHistogram >	_pOutHistogram

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 2 algorithm: calculates the histogram for each 3d data of an input image.

See Histogram measurement 3d for a complete algorithm description.

Author: R. Abbal

Date: 2016/06/06

Copyright: 2016 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLGlobalMeasure

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InSubImg3d	[Input] grey level 3d single sub image for operation	X
ipsdk::imaproc::attr::InOptHistoMsrParams	[Input Optional] histogram measure parameters	X
ipsdk::imaproc::attr::OutHistogram	[Output] Contains the result of a histogram calculation on an input image	X

Global attributes rule :

Global rule on attributes is given by
(ipsdk::processor::ifIsSet (_pInOptHistoMsrParams,ipsdk::imaproc::matchImageRange<ipsdk::imaproc::attr::HistoMsrParams::Min>(_pInSubImg3d,_pInOptHistoMsrParams) && ipsdk::imaproc::matchImageRange<ipsdk::imaproc::attr::HistoMsrParams::Max>(_pInSubImg3d,_pInOptHistoMsrParams) && ipsdk::processor::isGreater<ipsdk::imaproc::attr::HistoMsrParams::BinWidth>(_pInOptHistoMsrParams,0)))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::glbmsr::HistogramMsr3dLvl2::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::glbmsr::HistogramMsr3dLvl2::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::glbmsr::HistogramMsr3dLvl2::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

◆ postProcess()

core::ExecResult ipsdk::imaproc::glbmsr::HistogramMsr3dLvl2::postProcess ( )

protected

method called after processing

Returns: execution result

The documentation for this class was generated from the following file:

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLGlobalMeasure/Processor/HistogramMsr3d/HistogramMsr3dLvl2.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Algorithm associated library :

Attribute description for algorithm :

Global attributes rule :

Member Function Documentation

◆ getStorage()

◆ retrieveFirstProvider()

◆ retrieveSecondProvider()

◆ postProcess()