Averaging operator. A simple example implementation of ImpulseBucket. More...

#include <ImpulseAvgOp.h>

Inheritance diagram for ImpulseAvg:

[legend]

Collaboration diagram for ImpulseAvg:

[legend]

Public Member Functions
	ImpulseAvg (const ImpulseAvg &avg)

	ImpulseAvg (const ImpulseAvgConf &conf)

virtual void	init (const Channel &src, bool horizontal)
	Adapt to input geometry, type, and scaling.

virtual void	reset ()
	Clear statistics before traversing each row or column.

virtual void	addLeft (int i, double value, double weight)
	Accumulate encoded value.

virtual void	addRight (int i, double value, double weight)
	Accumulate encoded value.

virtual void	addDown (int i, double value, double weight)
	Accumulate encoded value.

virtual void	addUp (int i, double value, double weight)
	Accumulate encoded value.

virtual double	get (int i)
	Return natural (not encoded) value at position i.

virtual double	getWeight (int i)
	Return weight at position i.

Public Member Functions inherited from ImpulseBucket< ImpulseAvgConf >
ValueHandler &	getValueHandler ()

Public Member Functions inherited from ImpulseAvgConf
	ImpulseAvgConf (const ImpulseAvgConf &conf)

Public Member Functions inherited from BeanLike
	BeanLike (const BeanLike &b)
	Copy constructor. Re-links `parameters` to the member variables of this (new) instance.

	BeanLike (const std::string &name, const std::string &description="")
	Constructor.

virtual const std::string &	getName () const
	Return the name of an instance.

virtual const std::string &	getDescription () const
	Return a brief description.

bool	hasParameters () const
	Tells if any parameters have been linked (registered) for this bean.

template<class F >
F	getParameter (const std::string &p) const
	Gets a single parameter.

const map_t &	getParameters () const
	Returns the parameter map (const access).

map_t &	getParameters ()
	Returns the parameter map.

template<class F >
void	setParametersFromEntries (const F &args)
	Sets several parameters at once from a sequence of key-value pairs.

void	setParameters (std::initializer_list< Variable::init_pair_t > args)
	Grants access to (if above hidden)

virtual void	setParameters (const std::string &p, char assignmentSymbol='=', char separatorSymbol=0)
	Sets comma-separated parameters in a predetermined order "a,b,c" or by specifing them "b=2".

template<class T >
void	setParameters (const std::map< std::string, T > &args)
	Set parameters.

template<class T >
void	setParameters (const SmartMap< T > &args)
	Set parameters.

void	setParameter (const std::string &p, const Castable &value)
	Sets a single parameter.

template<class T >
void	setParameter (const std::string &p, const VariableT< T > &value)

template<class F >
void	setParameter (const std::string &p, const F &value)
	Sets a single parameter.

template<class F >
void	setParameter (const std::string &p, std::initializer_list< F > value)
	Sets a single parameter.

BeanLike &	operator= (const BeanLike &b)
	Assigns the parameter values of another bean (by key) to this one's own parameters.

virtual std::ostream &	toStream (std::ostream &ostr, bool compact=true) const
	Prints the name, description and current parameter values.

Additional Inherited Members
Public Types inherited from ImpulseBucket< ImpulseAvgConf >
typedef ImpulseAvgConf	conf_t

typedef ImpulseBucket< ImpulseAvgConf >	bucket_t

typedef ValueHandler	value_handler_t

Public Types inherited from BeanLike
typedef ReferenceMap	map_t
	Reference map type used to store this bean's parameters (name -> linked variable).

Public Attributes inherited from ImpulseAvgConf
Decay4< double >	decays

Protected Member Functions inherited from BeanLike
virtual void	storeLastArguments (const std::string &p)
	Called after setParameters()

virtual void	updateBean () const
	Called after setParameters()

Protected Attributes inherited from ImpulseBucket< ImpulseAvgConf >
value_handler_t	valueHandler

Protected Attributes inherited from BeanLike
const std::string	name
	Name of this bean, typically also the name of the (derived) class.

const std::string	description
	Brief, human-readable description of this bean.

map_t	parameters
	Parameters (name -> linked variable), typically linked to member variables of the derived class.

Detailed Description

Averaging operator. A simple example implementation of ImpulseBucket.

drainage shapes.png --iImpulseAvg  0.8,5,5 -o shapes-impulse-80.png
drainage shapes.png --iImpulseAvg  0.5,5,5 -o shapes-impulse-50.png
drainage shapes.png --iImpulseAvg  0.2,5,5 -o shapes-impulse-20.png

drainage image.png --iImpulseAvg  0.5            -o impulseAvg.png
drainage image.png --iImpulseAvg  0.2,20,20      -o impulseAvgMarg.png
drainage image-rgba.png --target S --iImpulseAvg  0.5 -o impulseAvg-16b.png