ipsdk::imaproc::attr::ImageValueExtractionMethod Class Reference

object allowing to define used image values extraction method More...

#include <ImageValueExtractionMethod.h>

Inheritance diagram for ipsdk::imaproc::attr::ImageValueExtractionMethod:

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...
	~ImageValueExtractionMethod ()
	public destructor
bool	checkTiledMethod (const ipUInt64 nbData, const ipUInt64 nbTotPixels) const
	method allowing to test whether we should use tiled method for processing
Methods associated to sub node Config
template<>
const ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eImageValueExtractionMethod > &	getNode () const
	access to sub node Config
template<>
ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eImageValueExtractionMethod > &	get ()
	access to sub node Config
template<>
const ipsdk::imaproc::attr::eImageValueExtractionMethod &	getValue () const
	access to value for sub node Config
template<>
void	setValue (const ipsdk::imaproc::attr::eImageValueExtractionMethod &value)
	access to value for sub node Config
Methods associated to sub node NbDataThreshold
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt64 > &	getNode () const
	access to sub node NbDataThreshold
template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt64 > &	get ()
	access to sub node NbDataThreshold
template<>
const ipsdk::ipUInt64 &	getValue () const
	access to value for sub node NbDataThreshold
template<>
void	setValue (const ipsdk::ipUInt64 &value)
	access to value for sub node NbDataThreshold
Methods associated to sub node ImageRatioThreshold
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	getNode () const
	access to sub node ImageRatioThreshold
template<>
ipsdk::DataItemLeaf< ipsdk::ipReal64 > &	get ()
	access to sub node ImageRatioThreshold
template<>
const ipsdk::ipReal64 &	getValue () const
	access to value for sub node ImageRatioThreshold
template<>
void	setValue (const ipsdk::ipReal64 &value)
	access to value for sub node ImageRatioThreshold
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< ImageValueExtractionMethod >	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
	ImageValueExtractionMethod ()
	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

object allowing to define used image values extraction method

Author

E.Noirfalise

Date

2016/12/08

Copyright

2016 Reactiv'IP, all right reserved.

Node associated library :

IPSDKIPLAttributes

SubNodes description

Name	ToolTip	Associated Class	Default Value
Config	configuration for definition of used extraction method	ipsdk::DataItemEnumLeaf<ipsdk::imaproc::attr::eImageValueExtractionMethod>	ipsdk::imaproc::attr::eImageValueExtractionMethod::eIVEM_ImageRatio
NbDataThreshold	threshold used to define used extraction method	ipsdk::DataItemLeaf<ipsdk::ipUInt64>
ImageRatioThreshold	image ratio threshold used to define used extraction method	ipsdk::DataItemLeaf<ipsdk::ipReal64>

Member Function Documentation

getItemIds()

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

virtual

retrieve item associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException

if existsItem(itemName) == false

Implements ipsdk::BaseDataItemNode.

---

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/ImageValueExtractionMethod.h