class for creating integral images More...

#include <IntegralImgOp.h>

Inheritance diagram for icl::filter::IntegralImgOp:

Public Member Functions
	IntegralImgOp (core::depth integralImageDepth=core::depth32s)
	Constructor. More...

	~IntegralImgOp ()
	Destructor. More...

void	setIntegralImageDepth (core::depth integralImageDepth)
	sets the depth of the integralImage (depth8u etc) More...

core::depth	getIntegralImageDepth () const
	returns the depth of the integralImage More...

void	apply (const core::ImgBase src, core::ImgBase *dst)
	applies the integralimage Operaor 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
core::depth	m_integralImageDepth
	destination depth More...

core::ImgBase *	m_buf
	used only if IPP is available More...

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

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 creating integral images

The integral image A of an image a (introduced by Viola & Jones (2001) in the paper : "Rapid Object Detection using a Boosted Cascade of Simple Features" ) defined as follows:

$A(i,j) = \sum\limits_{x=0}^i \sum\limits_{y=0}^j a(i,j)$

It can be calculated incrementally using the following equation:

$A(i,j) = a(i,j)+A(i-1,j)+A(i,j-1)-A(i-1,j-1)$

illustration:

  +++++..
  +++CA..
  +++BX..
  .......
  X = src(x) + A + B - C

Implementation

Other definitions

There are alternative definitions (like the ipp):

$A(i,j) = \sum\limits_{x=0}^{i-1} \sum\limits_{y=0}^{j-1} a(i,j)$

From this it follows, that the first integral image row and colum is filled with zeros and the internal image grows by one pixel in each dimension, with the benefit of some better usability of the result image. We use the above definition, which is a bit more convenient for the most common applications in our sight.

IPP Optimization

IPP optimization is not used, as IPP uses a different formulation of the integral image which leads to an integral image that is one row and one column larger as the source image. IPPs integral image formulation is

$A(i,j) = \sum\limits_{x=0}^{i-1} \sum\limits_{y=0}^{j-1} a(i,j)$

. As our implementation comes really close to the IPP-version in terms of performance, we dont use the IPP for this UnaryOp.

Supported Type-Combinations

We support all source image depth, the integral image always needs a large value domain, so here, only icl32s, icl32f and icl64f are supported.

Performance

The calculation is very fast and we come close to the IPP performace.

Benchmark plattworm: Intel Core2Duo with 2GHz, 2GB Ram (single core-performance)
Test Image: 1000x1000, 1-channel, icl8u (uchar)
Destination depth 32s (int)
Compiler: g++ 4.3
Compilation flags: -O4 -march=native
Times
- our implementation: 2.3ms
- Intel IPP 1.8ms (but different integral image, and not supported)

Constructor & Destructor Documentation

◆ IntegralImgOp()

icl::filter::IntegralImgOp::IntegralImgOp ( core::depth integralImageDepth = core::depth32s )

Constructor.

Parameters

integralImageDepth the depth of the integralImage (depth8u etc)

◆ ~IntegralImgOp()

icl::filter::IntegralImgOp::~IntegralImgOp ( )

Destructor.

Member Function Documentation

◆ apply() [1/3]

void icl::filter::IntegralImgOp::apply	(	const core::ImgBase *	src,
		core::ImgBase **	dst
	)

virtual

applies the integralimage Operaor

Parameters

src	The source image
dst	Pointer to the destination image

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.

◆ getIntegralImageDepth()

core::depth icl::filter::IntegralImgOp::getIntegralImageDepth ( ) const

returns the depth of the integralImage

Returns: the depth of the integralImage

◆ setIntegralImageDepth()

void icl::filter::IntegralImgOp::setIntegralImageDepth ( core::depth integralImageDepth )

sets the depth of the integralImage (depth8u etc)

Parameters

integralImageDepth the depth of the integralImage (depth8u etc)

Member Data Documentation

◆ m_buf

core::ImgBase* icl::filter::IntegralImgOp::m_buf

private

used only if IPP is available

◆ m_integralImageDepth

core::depth icl::filter::IntegralImgOp::m_integralImageDepth

private

destination depth

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

illustration:

Implementation

Other definitions

IPP Optimization

Supported Type-Combinations

Performance

Constructor & Destructor Documentation

◆ IntegralImgOp()

◆ ~IntegralImgOp()

Member Function Documentation

◆ apply() [1/3]

◆ apply() [2/3]

◆ apply() [3/3]

◆ getIntegralImageDepth()

◆ setIntegralImageDepth()

Member Data Documentation

◆ m_buf

◆ m_integralImageDepth