data item containing cumulative histogram information More...

#include <CumulativeHistogramData.h>

Inheritance diagram for ipsdk::imaproc::attr::CumulativeHistogramData:

Public Member Functions
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 data item node

const std::string	getLibraryName () const
	retrieve library name associated data item node

const ipsdk::ItemNames &	getItemIds () const
	retrieve item associated to a given id More...

	~CumulativeHistogramData ()
	public destructor

ipsdk::ipReal64	getRange () const
	retrieve histogram global range

ipsdk::ipReal64	getBinMin (const ipUInt32 nBinIdx) const
	returns the minimal grey level of the bin of index nBinIdx More...

ipsdk::ipReal64	getBinMax (const ipUInt32 nBinIdx) const
	returns the maximal grey level of the bin of index nBinIdx More...

ipsdk::ipReal64	getBinMean (const ipUInt32 nBinIdx) const
	returns the mean grey level of the bin of index nBinIdx More...

ipsdk::ipReal64	getBinRange (const ipUInt32 nBinIdx) const
	returns the range grey level of the bin of index nBinIdx More...

ipsdk::ipUInt32	getNbClasses () const
	returns the number of classes in the histogram

ipsdk::Real64Vector	getBinMinColl () const
	returns the collection of bin minimum grey levels associated to histogram

ipsdk::Real64Vector	getBinMaxColl () const
	returns the collection of bin maximum grey levels associated to histogram

ipsdk::Real64Vector	getBinMeanColl () const
	returns the collection of bin mean grey levels associated to histogram

ipsdk::Real64Vector	getBinRangeColl () const
	returns the collection of bin range grey levels associated to histogram

ipsdk::ipUInt64	getPopulation () const
	compute the global histogram population

ipsdk::ipReal64	getQuantile (ipReal64 ratePerCent)
	compute the quantile for a given rate

Methods associated to sub node Min
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	getNode () const
	access to sub node Min

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	get ()
	access to sub node Min

template<>
const ipsdk::ipReal64 &	getValue () const
	access to value for sub node Min

template<>
void	setValue (const ipsdk::ipReal64 &value)
	access to value for sub node Min

Methods associated to sub node Max
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	getNode () const
	access to sub node Max

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	get ()
	access to sub node Max

template<>
const ipsdk::ipReal64 &	getValue () const
	access to value for sub node Max

template<>
void	setValue (const ipsdk::ipReal64 &value)
	access to value for sub node Max

Methods associated to sub node BinWidth
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	getNode () const
	access to sub node BinWidth

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	get ()
	access to sub node BinWidth

template<>
const ipsdk::ipReal64 &	getValue () const
	access to value for sub node BinWidth

template<>
void	setValue (const ipsdk::ipReal64 &value)
	access to value for sub node BinWidth

Methods associated to sub node Frequencies
template<>
const ipsdk::DataItemLeafColl< ipsdk::ipUInt64 > &	getNode () const
	access to sub node Frequencies

template<>
ipsdk::DataItemLeafColl< ipsdk::ipUInt64 > &	get ()
	access to sub node Frequencies

template<>
const std::vector< ipsdk::ipUInt64 > &	getLeafColl () const
	access to value collection for sub node Frequencies

template<>
std::vector< ipsdk::ipUInt64 > &	getLeafColl ()
	access to value collection for sub node Frequencies

template<>
bool	isEmpty () const
	check wether collection is empty for sub node Frequencies

template<>
ipsdk::ipUInt32	getSize () const
	retrieve collection size for sub node Frequencies

template<>
void	push_back (const ipsdk::ipUInt64 &value)
	push back a new element into collection for sub node Frequencies

template<>
void	clear ()
	remove all items from collection for sub node Frequencies

Public Member Functions inherited from ipsdk::BaseDataItemNode
eDataItemType	getDataItemType () const

bool	existsItem (const std::string &itemId) const

const BaseDataItem &	getItem (const std::string &itemId) const

const std::string &	getItemName (const std::string &itemId) const

const std::string &	getItemToolTip (const std::string &itemId) 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 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 data item node

static const std::string	getLibraryNameStr ()
	retrieve library name associated data item node

static boost::shared_ptr< CumulativeHistogramData >	createNode ()
	node creation function

Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()

Static Public Attributes
static const ipsdk::ipUInt32	g_nbChildNodes
	number of child nodes associated to object

Static Public Attributes inherited from ipsdk::BaseDataItemNode
static const bool	g_bIsColl

static const bool	g_bNode

static const bool	g_bLeaf

static const eDataItemType::domain	g_itemType

Protected Member Functions
	CumulativeHistogramData ()
	protected constructor

Protected Member Functions inherited from ipsdk::BaseDataItemNode
virtual ItemInfoPtr	getItemInfo (const std::string &itemId) const=0

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)

Additional Inherited Members
Protected Types inherited from ipsdk::BaseDataItemNode
typedef boost::shared_ptr< ItemInfo >	ItemInfoPtr

Detailed Description

data item containing cumulative histogram information

Author: H. Delestre

Date: 2017/06/08

Copyright: 2017 Reactiv'IP, all right reserved.

Node associated library :

IPSDKIPLAttributes

SubNodes description

Name	ToolTip	Associated Class
Min	minimal grey value of a cumulative histogram	ipsdk::DataItemLeaf<ipsdk::ipReal64>
Max	maximal grey value of a cumulative histogram	ipsdk::DataItemLeaf<ipsdk::ipReal64>
BinWidth	width of histogram bin	ipsdk::DataItemLeaf<ipsdk::ipReal64>
Frequencies	collection of the frequencies of a cumulative histogram	ipsdk::DataItemLeafColl<ipsdk::ipUInt64>

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::attr::CumulativeHistogramData::getItemIds ( ) const

virtual

retrieve item associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException if existsItem(itemName) == false

Implements ipsdk::BaseDataItemNode.

◆ getBinMin()

ipsdk::ipReal64 ipsdk::imaproc::attr::CumulativeHistogramData::getBinMin ( const ipUInt32 nBinIdx ) const

returns the minimal grey level of the bin of index nBinIdx

Exceptions

ipsdk::imaproc::attr::IPSDKIPLAttributesException if nBinIdx >= nbClasses

◆ getBinMax()

ipsdk::ipReal64 ipsdk::imaproc::attr::CumulativeHistogramData::getBinMax ( const ipUInt32 nBinIdx ) const

returns the maximal grey level of the bin of index nBinIdx

Exceptions

ipsdk::imaproc::attr::IPSDKIPLAttributesException if nBinIdx >= nbClasses

◆ getBinMean()

ipsdk::ipReal64 ipsdk::imaproc::attr::CumulativeHistogramData::getBinMean ( const ipUInt32 nBinIdx ) const

returns the mean grey level of the bin of index nBinIdx

Exceptions

ipsdk::imaproc::attr::IPSDKIPLAttributesException if nBinIdx >= nbClasses

◆ getBinRange()

ipsdk::ipReal64 ipsdk::imaproc::attr::CumulativeHistogramData::getBinRange ( const ipUInt32 nBinIdx ) const

returns the range grey level of the bin of index nBinIdx

Exceptions

ipsdk::imaproc::attr::IPSDKIPLAttributesException if nBinIdx >= nbClasses

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLAttributes/DataItem/CumulativeHistogramData.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Node associated library :

SubNodes description

Member Function Documentation

◆ getItemIds()

◆ getBinMin()

◆ getBinMax()

◆ getBinMean()

◆ getBinRange()