pyhctsa.operations.distribution.withinp

pyhctsa.operations.distribution.withinp(x, p=1.0, mean_or_median='mean')

Proportion of data points within p standard deviations of the mean or median.

Parameters:
x : array-like

The input time series.

p : float

The number (proportion) of standard deviations. Default is 1.0

mean_or_median : str

Whether to use units of ‘mean’ and standard deviation, or ‘median’ and rescaled interquartile range. Default is 'mean'.

Returns:

The proportion of data points within p standard deviations.

Return type:

float