Result for images comparison operation. More...

#include <CompareResult.h>

Inheritance diagram for ipsdk::imaproc::attr::CompareResult:

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...

	~CompareResult ()
	public destructor

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

template<>
ipsdk::DataItemLeaf< ipsdk::ipBool > &	get ()
	access to sub node BEqual

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

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

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

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt64 > &	get ()
	access to sub node NbDiff

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

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

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

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt64 > &	get ()
	access to sub node PixCount

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

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

Methods associated to sub node OutOfTolPixPosition
template<>
const ipsdk::imaproc::attr::PixelPosition &	getNode () const
	access to sub node OutOfTolPixPosition

template<>
ipsdk::imaproc::attr::PixelPosition &	get ()
	access to sub node OutOfTolPixPosition

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

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

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

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

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

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

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

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

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< CompareResult >	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
	CompareResult ()
	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

Result for images comparison operation.

Author: E. Noirfalise

Date: 2015/12/09

Copyright: 2015 Reactiv'IP, all right reserved.

Node associated library :

IPSDKIPLAttributes

SubNodes description

Name	ToolTip	Associated Class
BEqual	Equality flag for comparison operation.	ipsdk::DataItemLeaf<ipsdk::ipBool>
NbDiff	Number of pixels with a different value in images.	ipsdk::DataItemLeaf<ipsdk::ipUInt64>
PixCount	Total number of pixels in images.	ipsdk::DataItemLeaf<ipsdk::ipUInt64>
OutOfTolPixPosition	Position of the first found pixel that is out of tolerance.	ipsdk::imaproc::attr::PixelPosition
OutOfTolPix1Value	Value of the first found pixel in the first input image that is out of tolerance.	ipsdk::DataItemLeaf<ipsdk::ipReal64>
OutOfTolPix2Value	Value of the first found pixel in the second input image that is out of tolerance.	ipsdk::DataItemLeaf<ipsdk::ipReal64>

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::attr::CompareResult::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/CompareResult.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()