Abstract Base class for Unary Operators. More...

#include <UnaryOp.h>

Inheritance diagram for icl::filter::UnaryOp:

Public Member Functions
	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 void	apply (const core::ImgBase operand1, core::ImgBase *dst)=0
	pure virtual apply function, that must be implemented in all derived classes 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...

Static Public Member Functions
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...

Protected Member Functions
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
utils::MultiThreader *	m_poMT

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

Private Member Functions
void	initConfigurable ()

Private Attributes
OpROIHandler	m_oROIHandler

core::ImgBase *	m_buf

Additional Inherited Members
Public Types inherited from icl::utils::Configurable
typedef Function< void, const Property & >	Callback
	Function type for changed properties. 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...

Detailed Description

Abstract Base class for Unary Operators.

A list of unary operators can be found here:
Collection of Unary Operations

Constructor & Destructor Documentation

◆ UnaryOp() [1/2]

icl::filter::UnaryOp::UnaryOp ( )

Explicit empty constructor.

◆ UnaryOp() [2/2]

icl::filter::UnaryOp::UnaryOp ( const UnaryOp & other )

Explicit copy constructor.

◆ ~UnaryOp()

virtual icl::filter::UnaryOp::~UnaryOp ( )

virtual

Destructor.

Member Function Documentation

◆ apply() [1/2]

virtual void icl::filter::UnaryOp::apply	(	const core::ImgBase *	operand1,
		core::ImgBase **	dst
	)

pure virtual

pure virtual apply function, that must be implemented in all derived classes

Implemented in icl::filter::MedianOp, icl::filter::ChamferOp, icl::filter::LUTOp3Channel< T >, icl::filter::FFTOp, icl::filter::LocalThresholdOp, icl::filter::GaborOp, icl::filter::MotionSensitiveTemporalSmoothing, icl::filter::IFFTOp, icl::filter::MorphologicalOp, icl::filter::ColorSegmentationOp, icl::filter::WarpOp, icl::filter::UnaryCompareOp, icl::filter::CannyOp, icl::filter::IntegralImgOp, icl::filter::AffineOp, icl::filter::ConvolutionOp, icl::filter::UnaryOpPipe, icl::filter::ThresholdOp, icl::filter::DitheringOp, icl::filter::LUTOp, icl::filter::WeightedSumOp, icl::filter::BilateralFilterOp, icl::filter::WeightChannelsOp, icl::filter::UnaryArithmeticalOp, icl::filter::ColorDistanceOp, icl::filter::WienerOp, icl::filter::UnaryLogicalOp, and icl::filter::MirrorOp.

◆ apply() [2/2]

virtual const core::ImgBase* icl::filter::UnaryOp::apply ( const core::ImgBase * src )

virtual

applys the filter usign an internal buffer as output image

Normally, this function must not be reimplemented, because it's default implementation will call apply(const ImgBase *,ImgBase**) using an internal buffer as destination image. This destination image is returned.

Reimplemented in icl::filter::UnaryOpPipe.

◆ applyFromString()

static void icl::filter::UnaryOp::applyFromString	(	const std::string &	definition,
		const core::ImgBase *	src,
		core::ImgBase **	dst
	)

static

creates, applies and releases a UnaryOp defined by given definition string

◆ applyMT()

virtual ICL_DEPRECATED void icl::filter::UnaryOp::applyMT	(	const core::ImgBase *	operand1,
		core::ImgBase **	dst,
		unsigned int	nThreads
	)

virtual

apply function for multithreaded filtering (currently even slower than using one thread)

Reimplemented in icl::filter::NeighborhoodOp.

◆ fromString()

static UnaryOp* icl::filter::UnaryOp::fromString ( const std::string & definition )

static

Creates a UnaryOp instance from given string definition.

Supported definitions have the followin syntax: OP_SPEC<(PARAM_LIST)>

examples are:

sobelX3x3
median(5x3)
closeBorder(3x3)

A complete list of OP_SPECS can be obtained by the static listFromStringOps function. Each specific parameter list's syntax is accessible using the static getFromStringSyntax function.

◆ getCheckOnly()

bool icl::filter::UnaryOp::getCheckOnly ( ) const

inline

returns the CheckOnly status

Returns: true=CheckOnly is enable, false=CheckOnly is disabled

◆ getClipToROI()

bool icl::filter::UnaryOp::getClipToROI ( ) const

inline

returns the ClipToROI status

Returns: true=ClipToROI is enable, false=ClipToROI is disabled

◆ getFromStringSyntax()

static std::string icl::filter::UnaryOp::getFromStringSyntax ( const std::string & opSpecifier )

static

gives a string syntax description for given opSpecifier

opSpecifier must be a member of the list returned by the static function listFromStringOps

◆ initConfigurable()

void icl::filter::UnaryOp::initConfigurable ( )

private

◆ listFromStringOps()

static std::vector<std::string> icl::filter::UnaryOp::listFromStringOps ( )

static

returns a list of all supported OP_SPEC values for the fromString function

◆ operator()() [1/3]

void icl::filter::UnaryOp::operator()	(	const core::ImgBase *	src,
		core::ImgBase **	dst
	)

inline

function operator (alternative for apply(src,dst)

◆ operator()() [2/3]

const core::ImgBase* icl::filter::UnaryOp::operator() ( const core::ImgBase * src )

inline

function operator for the implicit destination apply(src) call

◆ operator()() [3/3]

const core::ImgBase& icl::filter::UnaryOp::operator() ( const core::ImgBase & src )

inline

reference based function operator

◆ operator=()

UnaryOp& icl::filter::UnaryOp::operator= ( const UnaryOp & other )

Explicit declaration of the assignment operator.

◆ prepare() [1/3]

bool icl::filter::UnaryOp::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`
	)

inlineprotected

◆ prepare() [2/3]

virtual bool icl::filter::UnaryOp::prepare	(	core::ImgBase **	ppoDst,
		const core::ImgBase *	poSrc
	)

inlineprotectedvirtual

check+adapt destination image to properties of given source image

Reimplemented in icl::filter::NeighborhoodOp.

◆ prepare() [3/3]

virtual bool icl::filter::UnaryOp::prepare	(	core::ImgBase **	ppoDst,
		const core::ImgBase *	poSrc,
		core::depth	eDepth
	)

inlineprotectedvirtual

check+adapt destination image to properties of given source image but use explicitly given depth

Reimplemented in icl::filter::NeighborhoodOp.

◆ setCheckOnly()

void icl::filter::UnaryOp::setCheckOnly ( bool bCheckOnly )

inline

sets if the destination image should be adapted to the source, or if it is only checked if it can be adapted.

Parameters

bCheckOnly true = destination image is only checked, false = destination image will be checked and adapted.

◆ setClipToROI()

void icl::filter::UnaryOp::setClipToROI ( bool bClipToROI )

inline

sets if the image should be clip to ROI or not

Parameters

bClipToROI true=yes, false=no

◆ setPropertyValue()

virtual void icl::filter::UnaryOp::setPropertyValue	(	const std::string &	propertyName,
		const utils::Any &	value
	)

virtual

sets value of a property (always call call_callbacks(propertyName) or Configurable::setPropertyValue)

Reimplemented from icl::utils::Configurable.

Member Data Documentation

◆ m_buf

core::ImgBase* icl::filter::UnaryOp::m_buf

private

◆ m_oROIHandler

OpROIHandler icl::filter::UnaryOp::m_oROIHandler

private

◆ m_poMT

utils::MultiThreader* icl::filter::UnaryOp::m_poMT

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UnaryOp() [1/2]

◆ UnaryOp() [2/2]

◆ ~UnaryOp()

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyFromString()

◆ applyMT()

◆ fromString()

◆ getCheckOnly()

◆ getClipToROI()

◆ getFromStringSyntax()

◆ initConfigurable()

◆ listFromStringOps()

◆ operator()() [1/3]

◆ operator()() [2/3]

◆ operator()() [3/3]

◆ operator=()

◆ prepare() [1/3]

◆ prepare() [2/3]

◆ prepare() [3/3]

◆ setCheckOnly()

◆ setClipToROI()

◆ setPropertyValue()

Member Data Documentation

◆ m_buf

◆ m_oROIHandler

◆ m_poMT