Class for Arithmetic Functions. More...

#include <UnaryArithmeticalOp.h>

Inheritance diagram for icl::filter::UnaryArithmeticalOp:

Public Types
enum	optype { addOp =0, subOp =1, mulOp =2, divOp =3, sqrOp =10, sqrtOp =11, lnOp =12, expOp =13, absOp =14 }
	this enum specifiy all possible binary arithmetical operations More...

Public Types inherited from icl::utils::Configurable
typedef Function< void, const Property & >	Callback
	Function type for changed properties. More...

Public Member Functions
	UnaryArithmeticalOp (optype t, icl64f val=0)
	Constructor. More...

virtual	~UnaryArithmeticalOp ()
	Destructor. More...

virtual void	apply (const core::ImgBase poSrc, core::ImgBase *ppoDst)
	performes the arithmetical operation, given in the constructor or by the setOpType method. More...

void	setValue (icl64f value)
	sets the second operand, with the source is operated with. More...

icl64f	getValue () const
	returns the value of the second operand More...

void	setOpType (optype t)
	changes the operator type More...

optype	getOpType () const
	returns the operator type More...

virtual void	apply (const core::ImgBase operand1, core::ImgBase *dst)=0
	Import unaryOps apply function without destination image. More...

virtual const core::ImgBase *	apply (const core::ImgBase *src)
	Import unaryOps apply function without destination image. More...

Public Member Functions inherited from icl::filter::UnaryOp
	UnaryOp ()
	Explicit empty constructor. More...

	UnaryOp (const UnaryOp &other)
	Explicit copy constructor. More...

UnaryOp &	operator= (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::ImgBase *	apply (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::ImgBase *	operator() (const core::ImgBase *src)
	function operator for the implicit destination apply(src) call More...

const core::ImgBase &	operator() (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)
	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...

Configurable &	operator= (const Configurable &other)
	Assignment operator. More...

void	setConfigurableID (const std::string &ID)
	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)
	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...

Private Attributes
optype	m_eOpType

icl64f	m_dValue

Additional Inherited Members
Static Public Member Functions inherited from icl::filter::UnaryOp
static UnaryOp *	fromString (const std::string &definition)
	Creates a UnaryOp instance from given string definition. More...

static std::string	getFromStringSyntax (const std::string &opSpecifier)
	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)
	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 Configurable *	get (const std::string &id)
	returns configurable by given ID More...

static void	register_configurable_type (const std::string &classname, Function< Configurable * > creator)
	registers a configurable type More...

static std::vector< std::string >	get_registered_configurables ()
	returns a list of all registered configurable classnames More...

static Configurable *	create_configurable (const std::string &classname)
	creates a configurable by given name More...

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

Property &	prop (const std::string &propertyName)
	this CAN be used e.g. to store a property value in internal property-list More...

const Property &	prop (const std::string &propertyName) const
	this CAN be used e.g. to store a property value in internal property-list More...

	Configurable (const std::string &ID="", bool ordered=true)
	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::MultiThreader *	m_poMT

Protected Attributes inherited from icl::utils::Configurable
std::vector< Callback >	callbacks
	internally managed list of callbacks More...

Detailed Description

Class for Arithmetic Functions.

(nearly all functions: Img8u, Img16s, Img32f: IPP + Fallback, all other Types: Fallback only!) The functions AddC, SubC, MulC, DivC, AbsDiff, Sqr, Sqrt, Ln, Exp, Abs are implemented for: Img8u IPP+Fallback Img16s IPP+Fallback Img32f IPP+Fallback Img32s Fallback only Img64f Fallback only The user have to take care about overflows. For example 255+1=0 on icl8u

Member Enumeration Documentation

◆ optype

enum icl::filter::UnaryArithmeticalOp::optype

this enum specifiy all possible binary arithmetical operations

Enumerator
addOp	add a constant value to each pixel
subOp	substract a constant value from each pixel
mulOp	multiply each pixel by a constant value
divOp	divide each pixle through a constant value
sqrOp	squares each pixel
sqrtOp	calculates the square root of each pixel
lnOp	calculates the natural logarithm of each pixel
expOp	calculates the exponential function for each pixel
absOp	calculates the absolute value for each pixel

Constructor & Destructor Documentation

◆ UnaryArithmeticalOp()

icl::filter::UnaryArithmeticalOp::UnaryArithmeticalOp	(	optype	t,
		icl64f	val = `0`
	)

inline

Constructor.

◆ ~UnaryArithmeticalOp()

virtual icl::filter::UnaryArithmeticalOp::~UnaryArithmeticalOp ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ apply() [1/3]

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

virtual

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

Parameters

poSrc	first operand (image)
ppoDst	destination image, to store the result

Implements icl::filter::UnaryOp.

◆ apply() [2/3]

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

Import unaryOps apply function without destination image.

◆ apply() [3/3]

virtual void icl::filter::UnaryOp::apply

Import unaryOps apply function without destination image.

◆ getOpType()

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

inline

returns the operator type

See also: optype

Returns: operator type

◆ getValue()

icl64f icl::filter::UnaryArithmeticalOp::getValue ( ) const

inline

returns the value of the second operand

Returns: the value of the second operand

◆ setOpType()

void icl::filter::UnaryArithmeticalOp::setOpType ( optype t )

inline

changes the operator type

See also: optype

Parameters

t	operator type

◆ setValue()

void icl::filter::UnaryArithmeticalOp::setValue ( icl64f value )

inline

sets the second operand, with the source is operated with.

Parameters

value the value for the operand

Member Data Documentation

◆ m_dValue

icl64f icl::filter::UnaryArithmeticalOp::m_dValue

private

◆ m_eOpType

optype icl::filter::UnaryArithmeticalOp::m_eOpType

private

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

/Users/alneuman/vm/icl/ICLFilter/src/ICLFilter/UnaryArithmeticalOp.h

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ optype

Constructor & Destructor Documentation

◆ UnaryArithmeticalOp()

◆ ~UnaryArithmeticalOp()

Member Function Documentation

◆ apply() [1/3]

◆ apply() [2/3]

◆ apply() [3/3]

◆ getOpType()

◆ getValue()

◆ setOpType()

◆ setValue()

Member Data Documentation

◆ m_dValue

◆ m_eOpType