Image Component Library (ICL)
Public Types | Public Member Functions | Private Attributes | List of all members
icl::filter::BinaryLogicalOp Class Reference

Class for logical operations performed on two images. (and, or, xor) More...

#include <BinaryLogicalOp.h>

Inheritance diagram for icl::filter::BinaryLogicalOp:
icl::filter::BinaryOp

Public Types

enum  optype { andOp, orOp, xorOp }
 this enum specifiy all possible binary logical operations More...
 

Public Member Functions

 BinaryLogicalOp (optype t)
 Constructor. More...
 
virtual ~BinaryLogicalOp ()
 Destructor. More...
 
virtual void apply (const core::ImgBase *src1, const core::ImgBase *src2, core::ImgBase **dst)
 performes the logical operation, given in the constructor or by the setOpType method. More...
 
void setOpType (optype t)
 sets the operaion that will be performed by apply More...
 
optype getOpType () const
 returns the operaion that will be performed by apply More...
 
- Public Member Functions inherited from icl::filter::BinaryOp
 BinaryOp ()
 default constructor More...
 
 BinaryOp (const BinaryOp &other)
 copy constructor More...
 
BinaryOpoperator= (const BinaryOp &other)
 assignment operator More...
 
virtual ~BinaryOp ()
 virtual destructor More...
 
virtual const core::ImgBaseapply (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::ImgBaseoperator() (const core::ImgBase *src1, const core::ImgBase *src2)
 function operator for the implicit destination apply(a,b) call More...
 
const core::ImgBaseoperator() (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
 

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 logical operations performed on two images. (and, or, xor)

Logical operations are only possible on integer types like Img8u, Img16s and Img32s

Member Enumeration Documentation

this enum specifiy all possible binary logical operations

Enumerator
andOp 
orOp 
xorOp 

Constructor & Destructor Documentation

icl::filter::BinaryLogicalOp::BinaryLogicalOp ( optype  t)
inline

Constructor.

Parameters
tdefines the operaion that will be performed by apply
virtual icl::filter::BinaryLogicalOp::~BinaryLogicalOp ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual void icl::filter::BinaryLogicalOp::apply ( const core::ImgBase src1,
const core::ImgBase src2,
core::ImgBase **  dst 
)
virtual

performes the logical operation, given in the constructor or by the setOpType method.

Parameters
src1first operand (image)
src2second operand (image)
dstdestination image, to store the result

Implements icl::filter::BinaryOp.

optype icl::filter::BinaryLogicalOp::getOpType ( ) const
inline

returns the operaion that will be performed by apply

Returns
the operaion that will be performed by apply
void icl::filter::BinaryLogicalOp::setOpType ( optype  t)
inline

sets the operaion that will be performed by apply

Parameters
tdefines the operaion that will be performed by apply

Member Data Documentation

optype icl::filter::BinaryLogicalOp::m_eOpType
private

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