skdh.features.RatioBeyondRSigma#

class skdh.features.RatioBeyondRSigma(r=2.0)#

The percent of the signal outside \(r\) standard deviations from the mean.

Parameters:
rfloat, optional

Number of standard deviations above or below the mean the range includes. Default is 2.0

Attributes:
r

Methods

compute(signal, *[, axis])

Compute the ratio beyond \(r\sigma\)

compute(signal, *, axis=-1)#

Compute the ratio beyond \(r\sigma\)

Parameters:
signalarray-like

Array-like containing values to compute the ratio beyond \(r\sigma\) for.

axisint, optional

Axis along which the signal entropy will be computed. Ignored if signal is a pandas.DataFrame. Default is last (-1).

Returns:
rbrnumpy.ndarray

Computed ratio beyond r sigma.