RunningStatistics Class Reference
[Analysis]

Gathers the running average, variance, standard deviation, etc. More...

#include <RunningStatistics.h>

Inherits Marsyas::MarSystem.

Public Member Functions
void	myProcess (realvec &in, realvec &out)
	The core processing method of this MarSystem.
	RunningStatistics (const RunningStatistics &a)
	RunningStatistics (std::string name)
Private Member Functions
void	addControls ()
	Add specific controls needed by this MarSystem.
void	clear (void)
	Clear/initialize the internal buffers.
void	myUpdate (MarControlPtr sender)
	Reads changed controls and sets up variables if necessary.
Private Attributes
MarControlPtr	ctrl_clear_
	MarControlPtr for the clear control.
MarControlPtr	ctrl_clearPerTick_
	MarControlPtr for the clearPerTick control.
MarControlPtr	ctrl_enable_mean_
	MarControlPtr for enabling the mean.
MarControlPtr	ctrl_enable_skewness_
	MarControlPtr for enabling the skewness.
MarControlPtr	ctrl_enable_stddev_
	MarControlPtr for enabling the standard deviation.
mrs_bool	enable_mean_
	Cache of the enable mean control value.
mrs_bool	enable_skewsness_
	Cache of the enable skewness control value.
mrs_bool	enable_stddev_
	Cache of the enable stddev control value.
mrs_natural	samplecounter_
	Internal counter for counting the number of processed samples.
realvec	sumx2Buffer_
	Internal buffer for keeping the running sum of sample^2.
realvec	sumx3Buffer_
	Internal buffer for keeping the running sum of sample^3.
realvec	sumxBuffer_
	Internal buffer for keeping the running sum.

---

Detailed Description

Gathers the running average, variance, standard deviation, etc.

Outputs the running average and standard deviation of all the input so far.

Controls:

• mrs_bool/enableMean: enable outputting of the mean values (on by default).
• mrs_bool/enableStddev: enable outputting of the standard deviation values (on by default).
• mrs_bool/enableSkewness: enable outputting of the skewness values (off by default).
• mrs_bool/clear: clear the internal buffers to start fresh.
• mrs_book/clearPerTick: clear the buffers at the start of each tick. This disables the "running" property of the calculations.

Todo:

: add kurtosis

Todo:

: add option to output running energy (we're calculating it anyway)

Definition at line 48 of file RunningStatistics.h.

---

Constructor & Destructor Documentation

RunningStatistics

(

std::string

name

)

Add any specific controls needed by this MarSystem.

Definition at line 27 of file RunningStatistics.cpp.

References RunningStatistics::addControls().

RunningStatistics

(

const RunningStatistics &

a

)

All member MarControlPtr have to be explicitly reassigned in the copy constructor.

Definition at line 34 of file RunningStatistics.cpp.

References RunningStatistics::ctrl_clear_, RunningStatistics::ctrl_clearPerTick_, RunningStatistics::ctrl_enable_mean_, RunningStatistics::ctrl_enable_skewness_, and RunningStatistics::ctrl_enable_stddev_.

---

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

• /home/marsyas/marsyas/src/marsyas/RunningStatistics.h
• /home/marsyas/marsyas/src/marsyas/RunningStatistics.cpp