SignalMaxAbsoluteValue Class Reference

Computing the maximum of the absolute value of a discretely sampled signal. Also known as the maximum norm, infinity norm, or supremum norm. More...

#include <SignalStats.hh>

Public Member Functions
virtual void	InsertData (const double _data) override
	Add a new sample to the statistical measure. More...
virtual std::string	ShortName () const override
	Get a short version of the name of this statistical measure. More...
virtual double	Value () const override
	Get the current value of the statistical measure. More...
Public Member Functions inherited from SignalStatistic
	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	Reset ()
	Forget all previous data. More...

Additional Inherited Members
Protected Attributes inherited from SignalStatistic
std::unique_ptr< SignalStatisticPrivate >	dataPtr
	Pointer to private data. More...

Detailed Description

Computing the maximum of the absolute value of a discretely sampled signal. Also known as the maximum norm, infinity norm, or supremum norm.

ignition/math/SignalStats.hh

Member Function Documentation

InsertData()

virtual void InsertData ( const double  _data )

overridevirtual

Add a new sample to the statistical measure.

Parameters

[in]

_data

New signal data point.

Implements SignalStatistic.

ShortName()

virtual std::string ShortName ( ) const

overridevirtual

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

Returns

"maxAbs"

Implements SignalStatistic.

Value()

virtual double Value ( ) const

overridevirtual

Get the current value of the statistical measure.

Returns

Current value of the statistical measure.

Implements SignalStatistic.

---

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

• gz/math/SignalStats.hh