SignalStatistic Class Reference

Statistical properties of a discrete time scalar signal. More...

#include <ignition/math/SignalStats.hh>

Public Member Functions
	SignalStatistic ()
	Constructor. More...
	SignalStatistic (const SignalStatistic &_ss)
	Copy constructor. More...
virtual	~SignalStatistic ()
	Destructor. More...
virtual size_t	Count () const
	Get number of data points in measurement. More...
virtual void	InsertData (const double _data)=0
	Add a new sample to the statistical measure. More...
virtual void	Reset ()
	Forget all previous data. More...
virtual std::string	ShortName () const =0
	Get a short version of the name of this statistical measure. More...
virtual double	Value () const =0
	Get the current value of the statistical measure. More...

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

Detailed Description

Statistical properties of a discrete time scalar signal.

Constructor & Destructor Documentation

SignalStatistic() [1/2]

SignalStatistic

(

)

Constructor.

~SignalStatistic()

virtual ~SignalStatistic ( )

virtual

Destructor.

SignalStatistic() [2/2]

SignalStatistic

(

const SignalStatistic &

_ss

)

Copy constructor.

Parameters

[in]

_ss

SignalStatistic to copy

Member Function Documentation

Count()

virtual size_t Count ( ) const

virtual

Get number of data points in measurement.

Returns

Number of data points in measurement.

InsertData()

virtual void InsertData ( const double  _data )

pure virtual

Add a new sample to the statistical measure.

Parameters

[in]

_data

New signal data point.

Implemented in SignalVariance, SignalMaxAbsoluteValue, SignalRootMeanSquare, SignalMinimum, SignalMean, and SignalMaximum.

Reset()

virtual void Reset ( )

virtual

Forget all previous data.

ShortName()

virtual std::string ShortName ( ) const

pure virtual

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

Returns

Short name of the statistical measure.

Implemented in SignalVariance, SignalMaxAbsoluteValue, SignalRootMeanSquare, SignalMinimum, SignalMean, and SignalMaximum.

Value()

virtual double Value ( ) const

pure virtual

Get the current value of the statistical measure.

Returns

Current value of the statistical measure.

Implemented in SignalVariance, SignalMaxAbsoluteValue, SignalRootMeanSquare, SignalMinimum, SignalMean, and SignalMaximum.

Member Data Documentation

dataPtr

std::unique_ptr<SignalStatisticPrivate> dataPtr

protected

Pointer to private data.

---

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

• gz/math/SignalStats.hh