SignalUtils::Peak Function

Overload List

#SignatureDescription
1double Peak(double aMax, double aMin, double aMean);Find the maximum absolute deviation from the mean.
2double Peak(TCplx aMax, TCplx aMin, TCplx aMean);Find the maximum deviation from the aMean for complex data.

Overload 1: double Peak(double aMax, double aMin, double aMean);

Find the maximum absolute deviation from the mean.

#NameTypeDescription
1aMaxdoubleThe maximum sample value x_(max).
2aMindoubleThe minimum sample value x_(min).
3aMeandoubleThe signal mean x.

Returns: The peak deviation x_(peak) >= 0.

Remarks:

Returns the larger of the upward and downward excursions of a signal about its mean:
x_(peak) = max( | x_(max)-x|, | x-x_(min)| ) where aMax = x_(max) is the maximum value, aMin = x_(min) is the minimum value and aMean = x is the signal average. The result is always non-negative and feeds directly into the crest factor.

See Also: SignalUtils::Crest
Declared in Dew::Signal::Units::SignalUtils · Dew.Signal/Units.SignalUtils.h · Cross-compiler

Overload 2: double Peak(TCplx aMax, TCplx aMin, TCplx aMean);

Find the maximum deviation from the aMean for complex data.

#NameTypeDescription
1aMaxTCplx
2aMinTCplx
3aMeanTCplx
Declared in Dew::Signal::Units::SignalUtils · Dew.Signal/Units.SignalUtils.h · Cross-compiler