Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
ImpulseAvg Class Reference

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

#include <ImpulseAvgOp.h>

Inheritance diagram for ImpulseAvg:
Inheritance graph
[legend]
Collaboration diagram for ImpulseAvg:
Collaboration graph
[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 ImpulseAvgConf
 ImpulseAvgConf (const ImpulseAvgConf &conf)
 
- Public Member Functions inherited from BeanLike
 BeanLike (const BeanLike &b)
 
 BeanLike (const std::string &name, const std::string &description="")
 
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
 
template<class F >
getParameter (const std::string &p) const
 Gets a single parameter.
 
const map_tgetParameters () const
 
map_tgetParameters ()
 
template<class F >
void setParametersFromEntries (const F &args)
 
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.
 
BeanLikeoperator= (const BeanLike &b)
 
virtual std::ostream & toStream (std::ostream &ostr, bool compact=true) const
 

Additional Inherited Members

- Public Types inherited from ImpulseBucket< ImpulseAvgConf >
typedef ImpulseAvgConf conf_t
 
- Public Types inherited from BeanLike
typedef ReferenceMap map_t
 
- 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 BeanLike
const std::string name
 
const std::string description
 
map_t parameters
 

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

Member Function Documentation

◆ addDown()

void addDown ( int  i,
double  value,
double  weight 
)
virtual

Accumulate encoded value.

Implements ImpulseBucket< ImpulseAvgConf >.

◆ addLeft()

void addLeft ( int  i,
double  value,
double  weight 
)
virtual

Accumulate encoded value.

Implements ImpulseBucket< ImpulseAvgConf >.

◆ addRight()

void addRight ( int  i,
double  value,
double  weight 
)
virtual

Accumulate encoded value.

Implements ImpulseBucket< ImpulseAvgConf >.

◆ addUp()

void addUp ( int  i,
double  value,
double  weight 
)
virtual

Accumulate encoded value.

Implements ImpulseBucket< ImpulseAvgConf >.

◆ get()

double get ( int  i)
virtual

Return natural (not encoded) value at position i.

Implements ImpulseBucket< ImpulseAvgConf >.

◆ getWeight()

double getWeight ( int  i)
virtual

Return weight at position i.

Weight should reflect quality, reliability or relevance of the value returned by get(int i).

Implements ImpulseBucket< ImpulseAvgConf >.

◆ init()

void init ( const Channel src,
bool  horizontal 
)
virtual

Adapt to input geometry, type, and scaling.

Reimplemented from ImpulseBucket< ImpulseAvgConf >.

◆ reset()

void reset ( )
virtual

Clear statistics before traversing each row or column.

Implements ImpulseBucket< ImpulseAvgConf >.


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