icl::filter::BinaryCompareOp Class Reference

Class for comparing two images pixel-wise. More...

#include <BinaryCompareOp.h>

Inheritance diagram for icl::filter::BinaryCompareOp:

Public Types
enum	optype {   lt = ippCmpLess, lteq = ippCmpLessEq, eq = ippCmpEq, gteq = ippCmpGreaterEq,   gt = ippCmpGreater, eqt }
	this enum specifiy all possible compare operations More...

Public Member Functions
	BinaryCompareOp (optype ot, icl64f tolerance=0)
	creates a new BinaryCompareOp object with given optype and tolerance level More...
virtual	~BinaryCompareOp ()
	Destructor. More...
virtual void	apply (const core::ImgBase *poSrc1, const core::ImgBase *poSrc2, core::ImgBase **ppoDst)
	applies this compare operation to two source images into the given destination image More...
optype	getOpType () const
	returns the current optype More...
icl64f	getTolerance () const
	returns the current tolerance level More...
void	setOpType (optype ot)
	sets the current opttype More...
void	setTolerance (icl64f tolerance)
	sets the current tolerance level More...
virtual void	apply (const core::ImgBase *operand1, const core::ImgBase *operand2, core::ImgBase **result)=0
	import apply symbol from parent class More...
virtual const core::ImgBase *	apply (const core::ImgBase *operand1, const core::ImgBase *operand2)
	import apply symbol from parent class More...
Public Member Functions inherited from icl::filter::BinaryOp
	BinaryOp ()
	default constructor More...
	BinaryOp (const BinaryOp &other)
	copy constructor More...
BinaryOp &	operator= (const BinaryOp &other)
	assignment operator More...
virtual	~BinaryOp ()
	virtual destructor More...
virtual const core::ImgBase *	apply (const core::ImgBase *operand1, const core::ImgBase *operand2)
	applyfunction without explicit destination image More...
void	operator() (const core::ImgBase *src1, const core::ImgBase *src2, core::ImgBase **dst)
	function operator (alternative for apply(src1,src2,dst) More...
const core::ImgBase *	operator() (const core::ImgBase *src1, const core::ImgBase *src2)
	function operator for the implicit destination apply(a,b) call More...
const core::ImgBase &	operator() (const core::ImgBase &sr1, const core::ImgBase &src2)
	reference based function operator More...
void	setClipToROI (bool bClipToROI)
	sets if the image should be clip to ROI or not More...
void	setCheckOnly (bool bCheckOnly)
	sets if the destination image should be adapted to the source, or if it is only checked if it can be adapted. More...
bool	getClipToROI () const
	returns the ClipToROI status More...
bool	getCheckOnly () const
	returns the CheckOnly status More...

Private Attributes
optype	m_eOpType
	internal storage for the current optype More...
icl64f	m_dTolerance

Additional Inherited Members
Protected Member Functions inherited from icl::filter::BinaryOp
bool	prepare (core::ImgBase **ppoDst, core::depth eDepth, const utils::Size &imgSize, core::format eFormat, int nChannels, const utils::Rect &roi, utils::Time timestamp=utils::Time::null)
virtual bool	prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc)
	check+adapt destination image to properties of given source image More...
virtual bool	prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc, core::depth eDepth)
Static Protected Member Functions inherited from icl::filter::BinaryOp
static bool	check (const core::ImgBase *operand1, const core::ImgBase *operand2, bool checkDepths=true)

Detailed Description

Class for comparing two images pixel-wise.

Compares pixel values of two images using a specified compare operation. The result is written to a binarized image of type Img8u. If the result of the comparison is true, the corresponding output pixel is set to 255; otherwise, it is set to 0.

Member Enumeration Documentation

optype

enum icl::filter::BinaryCompareOp::optype

this enum specifiy all possible compare operations

Enumerator
lt	"<"- relation
lteq	"<="-relation
eq	"=="-relation
gteq	">="-relation
gt	">" -relation
eqt	"=="-relation using a given tolerance level

Constructor & Destructor Documentation

BinaryCompareOp()

icl::filter::BinaryCompareOp::BinaryCompareOp ( optype  ot, icl64f  tolerance = 0  )

inline

creates a new BinaryCompareOp object with given optype and tolerance level

Parameters

ot	optype to use
tolerance	tolerance level to use

~BinaryCompareOp()

virtual icl::filter::BinaryCompareOp::~BinaryCompareOp ( )

inlinevirtual

Destructor.

Member Function Documentation

apply() [1/3]

virtual void icl::filter::BinaryCompareOp::apply ( const core::ImgBase *  poSrc1, const core::ImgBase *  poSrc2, core::ImgBase **  ppoDst  )

virtual

applies this compare operation to two source images into the given destination image

Parameters

poSrc1	first source image
poSrc2	second source image
ppoDst	destination image

Implements icl::filter::BinaryOp.

apply() [2/3]

virtual const core::ImgBase* icl::filter::BinaryOp::apply

import apply symbol from parent class

apply() [3/3]

virtual void icl::filter::BinaryOp::apply

import apply symbol from parent class

getOpType()

optype icl::filter::BinaryCompareOp::getOpType ( ) const

inline

returns the current optype

Returns

current optype

getTolerance()

icl64f icl::filter::BinaryCompareOp::getTolerance ( ) const

inline

returns the current tolerance level

Returns

current tolerance level

setOpType()

void icl::filter::BinaryCompareOp::setOpType ( optype  ot )

inline

sets the current opttype

Parameters

ot	new optype

setTolerance()

void icl::filter::BinaryCompareOp::setTolerance ( icl64f  tolerance )

inline

sets the current tolerance level

Parameters

tolerance

new tolerance level

Member Data Documentation

m_dTolerance

icl64f icl::filter::BinaryCompareOp::m_dTolerance

private

m_eOpType

optype icl::filter::BinaryCompareOp::m_eOpType

private

internal storage for the current optype

---

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

• /Users/alneuman/vm/icl/ICLFilter/src/ICLFilter/BinaryCompareOp.h