SignalUtils.Peak Method

Overload List

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

Overload 1: Double Peak(TCplx aMax, TCplx aMin, TCplx aMean)

Find the maximum deviation from the aMean for complex data.

#NameTypeDescription
1aMaxTCplxscalar
2aMinTCplxscalar
3aMeanTCplxscalar

Returns: Double

Overload 2: Double Peak(Double aMax, Double aMin, Double aMean)

Find the maximum absolute deviation from the mean.

#NameDescription
1aMaxThe maximum sample value x_(max).
2aMinThe minimum sample value x_(min).
3aMeanThe signal mean x.

Returns: Double - 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