Image Component Library (ICL)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
icl::filter::UnaryCompareOp Class Reference

Class for comparing operations. More...

#include <UnaryCompareOp.h>

Inheritance diagram for icl::filter::UnaryCompareOp:
icl::filter::UnaryOp icl::utils::Configurable

Public Types

enum  optype {
  lt = ippCmpLess, lteq = ippCmpLessEq, eq = ippCmpEq, gteq = ippCmpGreaterEq,
  gt = ippCmpGreater, eqt
}
 this enum specifiy all possible compare operations More...
 
- Public Types inherited from icl::utils::Configurable
typedef Function< void, const
Property & > 
Callback
 Function type for changed properties. More...
 

Public Member Functions

 UnaryCompareOp (optype ot=gt, icl64f value=128, icl64f tolerance=0)
 Creates a new UnaryCompareOp object with given optype, value and tolerance level. More...
 
 UnaryCompareOp (const std::string &op, icl64f value=128, icl64f tolerance=0)
 creates a new UnaryCompareOp instance with given parameters More...
 
virtual ~UnaryCompareOp ()
 Destructor. More...
 
void setOpType (optype ot)
 sets the current optype More...
 
void setValue (icl64f value)
 sets the current compare value More...
 
void setTollerance (icl64f tolerance)
 sets the current tolerance level More...
 
optype getOpType () const
 returns the current optype More...
 
icl64f getValue () const
 returns the current compare-value More...
 
icl64f getTolerance () const
 returns the current tolerance level More...
 
virtual void apply (const core::ImgBase *poSrc, core::ImgBase **ppoDst)
 applies the operation to a source image More...
 
- Public Member Functions inherited from icl::filter::UnaryOp
 UnaryOp ()
 Explicit empty constructor. More...
 
 UnaryOp (const UnaryOp &other)
 Explicit copy constructor. More...
 
UnaryOpoperator= (const UnaryOp &other)
 Explicit declaration of the assignment operator. More...
 
virtual ~UnaryOp ()
 Destructor. More...
 
virtual ICL_DEPRECATED void applyMT (const core::ImgBase *operand1, core::ImgBase **dst, unsigned int nThreads)
 apply function for multithreaded filtering (currently even slower than using one thread) More...
 
virtual const core::ImgBaseapply (const core::ImgBase *src)
 applys the filter usign an internal buffer as output image More...
 
void operator() (const core::ImgBase *src, core::ImgBase **dst)
 function operator (alternative for apply(src,dst) More...
 
const core::ImgBaseoperator() (const core::ImgBase *src)
 function operator for the implicit destination apply(src) call More...
 
const core::ImgBaseoperator() (const core::ImgBase &src)
 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...
 
virtual void setPropertyValue (const std::string &propertyName, const utils::Any &value) throw (utils::ICLException)
 sets value of a property (always call call_callbacks(propertyName) or Configurable::setPropertyValue) More...
 
- Public Member Functions inherited from icl::utils::Configurable
virtual ~Configurable ()
 virtual destructor More...
 
 Configurable (const Configurable &other)
 Copy constructor. More...
 
Configurableoperator= (const Configurable &other)
 Assignment operator. More...
 
void setConfigurableID (const std::string &ID) throw (ICLException)
 sets the ID of this configurable More...
 
const std::string & getConfigurableID () const
 returns the configurables static ID More...
 
bool isOrderedFlagSet () const
 returns whether the ordered flag is set More...
 
void deactivateProperty (const std::string &pattern)
 adds an additional deativation pattern More...
 
void deleteDeactivationPattern (const std::string &pattern)
 removed a formerly added deactivation pattern More...
 
std::vector< std::string > getPropertyListWithoutDeactivated () const
 this returns a filtered list of properties (using all filters added by deactivateProperty) More...
 
virtual void adaptProperty (const std::string &name, const std::string &newType, const std::string &newInfo, const std::string &newToolTip) throw (ICLException)
 this function can be used to adapt a specific property afterwards More...
 
void registerCallback (const Callback &cb)
 add a callback for changed properties More...
 
void removedCallback (const Callback &cb)
 removes a callback that was registered before More...
 
void syncChangesTo (Configurable *others, int num=1)
 this can be used to let this instance also apply property changes to others More...
 
virtual std::vector< std::string > getPropertyList () const
 returns a list of All properties, that can be set using setProperty More...
 
virtual bool supportsProperty (const std::string &propertyName) const
 base implementation for property check (seaches in the property list) More...
 
virtual void saveProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC) const
 writes all available properties into a file More...
 
virtual void loadProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC)
 reads a camera config file from disc More...
 
virtual std::string getPropertyType (const std::string &propertyName) const
 get type of property More...
 
virtual std::string getPropertyInfo (const std::string &propertyName) const
 get information of a properties valid values More...
 
virtual Any getPropertyValue (const std::string &propertyName) const
 returns the current value of a property or a parameter More...
 
virtual std::string getPropertyToolTip (const std::string &propertyName) const
 returns the tooltip description for a given property More...
 
virtual int getPropertyVolatileness (const std::string &propertyName) const
 Returns whether this property may be changed internally. More...
 

Static Public Member Functions

static optype translate_op_type (const std::string &stringVersion) throw (utils::ICLException)
 translate a given relation into an optype More...
 
- Static Public Member Functions inherited from icl::filter::UnaryOp
static UnaryOpfromString (const std::string &definition) throw (utils::ICLException)
 Creates a UnaryOp instance from given string definition. More...
 
static std::string getFromStringSyntax (const std::string &opSpecifier) throw (utils::ICLException)
 gives a string syntax description for given opSpecifier More...
 
static std::vector< std::string > listFromStringOps ()
 returns a list of all supported OP_SPEC values for the fromString function More...
 
static void applyFromString (const std::string &definition, const core::ImgBase *src, core::ImgBase **dst) throw (utils::ICLException)
 creates, applies and releases a UnaryOp defined by given definition string More...
 
- Static Public Member Functions inherited from icl::utils::Configurable
static std::string create_default_ID (const std::string &prefix)
 this function can be used in subclasses to create a default ID More...
 
static Configurableget (const std::string &id)
 returns configurable by given ID More...
 
static void register_configurable_type (const std::string &classname, Function< Configurable * > creator) throw (ICLException)
 registers a configurable type More...
 
static std::vector< std::string > get_registered_configurables ()
 returns a list of all registered configurable classnames More...
 
static Configurablecreate_configurable (const std::string &classname) throw (ICLException)
 creates a configurable by given name More...
 

Private Attributes

optype m_eOpType
 internal storage of the current optype More...
 
icl64f m_dValue
 internal storage of the current value More...
 
icl64f m_dTolerance
 internal storage of the current tolerance level More...
 

Additional Inherited Members

- Static Public Attributes inherited from icl::utils::Configurable
static const std::vector
< std::string > 
EMPTY_VEC
 used as shortcut – just an empty vector of std::strings More...
 
- Protected Member Functions inherited from icl::filter::UnaryOp
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)
 
- Protected Member Functions inherited from icl::utils::Configurable
void addProperty (const std::string &name, const std::string &type, const std::string &info, const Any &value=Any(), const int volatileness=0, const std::string &tooltip=std::string()) throw (ICLException)
 This can be used by derived classes to store supported properties in the internal list. More...
 
void addChildConfigurable (Configurable *configurable, const std::string &childPrefix="")
 This adds another configurable as child. More...
 
void removeChildConfigurable (Configurable *configurable)
 removes the given child configurable More...
 
Propertyprop (const std::string &propertyName) throw (ICLException)
 this CAN be used e.g. to store a property value in internal property-list More...
 
const Propertyprop (const std::string &propertyName) const throw (ICLException)
 this CAN be used e.g. to store a property value in internal property-list More...
 
 Configurable (const std::string &ID="", bool ordered=true) throw (ICLException)
 create this configurable with given ID More...
 
void call_callbacks (const std::string &propertyName, const Configurable *caller) const
 calls all registered callbacks More...
 
- Protected Attributes inherited from icl::filter::UnaryOp
utils::MultiThreaderm_poMT
 
- Protected Attributes inherited from icl::utils::Configurable
std::vector< Callbackcallbacks
 internally managed list of callbacks More...
 

Detailed Description

Class for comparing operations.

This class Compares each pixelvalue of an image with a constant value 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

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

icl::filter::UnaryCompareOp::UnaryCompareOp ( optype  ot = gt,
icl64f  value = 128,
icl64f  tolerance = 0 
)
inline

Creates a new UnaryCompareOp object with given optype, value and tolerance level.

Parameters
otoperation type ("<","<=",...)
valuevalue to compare each pixel with
tolerancetolerance level (only of optype==eqt)
icl::filter::UnaryCompareOp::UnaryCompareOp ( const std::string &  op,
icl64f  value = 128,
icl64f  tolerance = 0 
)
inline

creates a new UnaryCompareOp instance with given parameters

The optype parameters is here given as a string

See Also
translate_op_type(const std::string&)
virtual icl::filter::UnaryCompareOp::~UnaryCompareOp ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual void icl::filter::UnaryCompareOp::apply ( const core::ImgBase poSrc,
core::ImgBase **  ppoDst 
)
virtual

applies the operation to a source image

Parameters
poSrcsource image
ppoDstdestination image

Implements icl::filter::UnaryOp.

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

returns the current optype

icl64f icl::filter::UnaryCompareOp::getTolerance ( ) const
inline

returns the current tolerance level

Returns
current tolerance level
icl64f icl::filter::UnaryCompareOp::getValue ( ) const
inline

returns the current compare-value

Returns
current value
void icl::filter::UnaryCompareOp::setOpType ( optype  ot)
inline

sets the current optype

Parameters
otnew optype value
void icl::filter::UnaryCompareOp::setTollerance ( icl64f  tolerance)
inline

sets the current tolerance level

Parameters
tolerancenew tolerance level
void icl::filter::UnaryCompareOp::setValue ( icl64f  value)
inline

sets the current compare value

Parameters
valuenew compare value
static optype icl::filter::UnaryCompareOp::translate_op_type ( const std::string &  stringVersion)
throw (utils::ICLException
)
inlinestatic

translate a given relation into an optype

satisfy the compiler :-)

Member Data Documentation

icl64f icl::filter::UnaryCompareOp::m_dTolerance
private

internal storage of the current tolerance level

icl64f icl::filter::UnaryCompareOp::m_dValue
private

internal storage of the current value

optype icl::filter::UnaryCompareOp::m_eOpType
private

internal storage of the current optype


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