pq::Smoother Class Reference

Simple moving average transform filter. More...

#include <Smoother.h>

Inheritance diagram for pq::Smoother:

Collaboration diagram for pq::Smoother:

Public Member Functions
	Smoother (Engine &engine=Engine::primary())
	Constructor with default smoothing.
	Smoother (float timeWindow, Engine &engine=Engine::primary())
	Constructor with smoothing window.
virtual void	reset ()
	Resets the filter.
virtual void	reset (float estimatedMeanValue)
	Resets the filter with a prior estimate of the mean value.
virtual void	reset (float estimatedMinValue, float estimatedMaxValue)
	Resets the moving filter with a prior estimate of the min and max values.
virtual float	put (float value)
	Pushes value into the unit.
virtual float	filter (float value)
	Returns the filtered value (without calibrating).
virtual void	resumeCalibrating ()
	Switches to calibration mode (default).
virtual void	pauseCalibrating ()
	Switches to non-calibration mode: calls to put(value) will return filtered value without updating the normalization statistics.
virtual void	toggleCalibrating ()
	Toggles calibration mode.
virtual bool	isCalibrating () const
	Returns true iff the moving filter is in calibration mode.
unsigned int	nSamples () const
	Returns the number of samples that have been processed thus far.
virtual bool	isPreInitialized () const
	Returns true if the moving filter has been initialized with a starting range at reset.
virtual float	get ()
	Returns value in [0, 1].
virtual float	mapTo (float toLow, float toHigh)
	Maps value to new range.
virtual void	clearEvents ()
float	seconds () const
	Returns engine time in seconds.
uint32_t	milliSeconds () const
	Returns engine time in milliseconds.
uint64_t	microSeconds () const
	Returns engine time in microseconds.
unsigned long	nSteps () const
	Returns number of engine steps.
float	sampleRate () const
	Returns engine sample rate.
float	samplePeriod () const
	Returns enginesample period.
	operator float ()
	Object can be used directly to access its value.
	operator bool ()
	Operator that allows usage in conditional expressions.
virtual void	infiniteTimeWindow ()
	Sets time window to infinite.
virtual void	noTimeWindow ()
	Sets time window to no time window.
virtual void	timeWindow (float seconds)
	Changes the time window (expressed in seconds).
virtual float	timeWindow () const
	Returns the time window (expressed in seconds).
virtual bool	timeWindowIsInfinite () const
	Returns true if time window is infinite.
virtual void	cutoff (float hz)
	Changes the time window cutoff frequency (expressed in Hz).
virtual float	cutoff () const
	Returns the time window cutoff frequency (expressed in Hz).

Static Public Member Functions
static bool	analogToDigital (float f)
	Converts analog (float) value to digital (bool) value.
static float	digitalToAnalog (bool b)
	Converts digital (bool) value to analog (float) value.

Protected Member Functions
virtual void	step ()
virtual void	begin ()
virtual float	alpha () const
virtual bool	eventTriggered (EventType eventType)
	Returns true iff an event of a certain type has been triggered.
virtual void	onEvent (EventCallback callback, EventType eventType)
	Registers event callback.
Engine *	engine () const
	Returns the engine that owns this unit.

Protected Attributes
float	_currentValueStep
bool	_isCalibrating: 1
bool	_isPreInitialized: 1
uint8_t	_nValuesStep: 6
unsigned int	_nSamples
float	_value
float	_timeWindow

Detailed Description

Simple moving average transform filter.

Constructor & Destructor Documentation

Smoother() [1/2]

pq::Smoother::Smoother

(

Engine &

engine = Engine::primary()

)

Constructor with default smoothing.

Parameters

engine

the engine running this unit

Smoother() [2/2]

pq::Smoother::Smoother	(	float	timeWindow,
		Engine &	engine = Engine::primary()
	)

Constructor with smoothing window.

Parameters

timeWindow	the time window over which the smoothing applies (in seconds)
engine	the engine running this unit

Member Function Documentation

begin()

void pq::MovingFilter::begin ( )

protectedvirtualinherited

Reimplemented from pq::Unit.

eventTriggered()

virtual bool pq::Unit::eventTriggered ( EventType  eventType )

inlineprotectedvirtualinherited

Returns true iff an event of a certain type has been triggered.

Reimplemented in pq::AbstractWave, pq::Alarm, pq::Metronome, pq::PeakDetector, pq::DigitalSource, pq::Ramp, pq::StreamIn, and pq::TimeSliceField< COUNT >.

filter()

float pq::Smoother::filter ( float  value )

virtual

Returns the filtered value (without calibrating).

Implements pq::MovingFilter.

get()

virtual float pq::AnalogSource::get ( )

inlinevirtualinherited

Returns value in [0, 1].

Reimplemented from pq::Flowable.

Reimplemented in pq::AbstractWave, and pq::RobustScaler.

mapTo()

virtual float pq::AnalogSource::mapTo ( float  toLow, float  toHigh  )

inlinevirtualinherited

Maps value to new range.

Reimplemented from pq::Flowable.

Reimplemented in pq::Normalizer, pq::StreamIn, and pq::StreamOut.

put()

float pq::Smoother::put ( float  value )

virtual

Pushes value into the unit.

Parameters

value

the value sent to the unit

Returns

the new value of the unit

Reimplemented from pq::Flowable.

reset() [1/3]

void pq::Smoother::reset ( )

virtual

Resets the filter.

Reimplemented from pq::MovingFilter.

reset() [2/3]

void pq::Smoother::reset ( float  estimatedMeanValue )

virtual

Resets the filter with a prior estimate of the mean value.

Reimplemented from pq::MovingFilter.

reset() [3/3]

void pq::Smoother::reset ( float  estimatedMinValue, float  estimatedMaxValue  )

virtual

Resets the moving filter with a prior estimate of the min and max values.

Reimplemented from pq::MovingFilter.

resumeCalibrating()

void pq::MovingFilter::resumeCalibrating ( )

virtualinherited

Switches to calibration mode (default).

Calls to put(value) will return filtered value AND update the normalization statistics.

step()

void pq::Smoother::step ( )

protectedvirtual

Reimplemented from pq::Unit.

---

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

• /home/tats/Documents/workspace/Plaquette/src/Smoother.h
• /home/tats/Documents/workspace/Plaquette/src/Smoother.cpp