Autoperiod.detect

static Autoperiod.detect(data, k=100, percentile=95, window_func='boxcar', detrend_func='linear')

Find periods in the given series.

Parameters:

dataarray_like

Data to be investigated. Must be squeezable to 1-d.

kint, optional, default = 100

The number of times the data is randomly permuted while estimating the power threshold.

percentileint, optional, default = 95

Percentage for the percentile parameter used in computing the power threshold. Value must be between 0 and 100 inclusive.

window_funcfloat, str, tuple, default = ‘boxcar’

Window function to be applied to the time series. Check window parameter documentation for scipy.signal.get_window function for more information on the accepted formats of this parameter.

detrend_func{‘constant’, ‘linear’}, optional, default = ‘linear’

The kind of detrending to be applied on the signal. If None, no detrending is applied.

Returns:

NDArray

List of detected periods.

See also

scipy.signal.detrend

Remove linear trend along axis from data.

scipy.signal.get_window

Return a window of a given length and type.