scipy.stats.signaltonoise

scipy.stats.signaltonoise(a, axis=0, ddof=0)

The signal-to-noise ratio of the input data.

Returns the signal-to-noise ratio of a, here defined as the mean divided by the standard deviation.

Parameters:

a : array_like

An array_like object containing the sample data.

axis : int or None, optional

If axis is equal to None, the array is first ravel’d. If axis is an integer, this is the axis over which to operate. Default is 0.

ddof : int, optional

Degrees of freedom correction for standard deviation. Default is 0.

Returns:

s2n : ndarray

The mean to standard deviation ratio(s) along axis, or 0 where the standard deviation is 0.