SignalMean Class Reference

Computing the mean value of a discretely sampled signal. More...

#include <math/gzmath.hh>

Inherits SignalStatistic.

Public Member Functions

virtual size_t Count () const
 Get number of data points in measurement. More...
 
virtual void InsertData (const double _data)
 Add a new sample to the statistical measure. More...
 
virtual void Reset ()
 Forget all previous data. More...
 
virtual std::string ShortName () const
 Get a short version of the name of this statistical measure. More...
 
virtual double Value () const
 Get the current value of the statistical measure. More...
 

Protected Attributes

std::unique_ptr< SignalStatisticPrivate > dataPtr
 Pointer to private data. More...
 

Detailed Description

Computing the mean value of a discretely sampled signal.

Member Function Documentation

virtual size_t Count ( ) const
virtualinherited

Get number of data points in measurement.

Returns
Number of data points in measurement.
virtual void InsertData ( const double  _data)
virtual

Add a new sample to the statistical measure.

Parameters
[in]_dataNew signal data point.

Implements SignalStatistic.

virtual void Reset ( )
virtualinherited

Forget all previous data.

virtual std::string ShortName ( ) const
virtual

Get a short version of the name of this statistical measure.

Returns
"mean"

Implements SignalStatistic.

virtual double Value ( ) const
virtual

Get the current value of the statistical measure.

Returns
Current value of the statistical measure.

Implements SignalStatistic.

Member Data Documentation

std::unique_ptr<SignalStatisticPrivate> dataPtr
protectedinherited

Pointer to private data.


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