freq_vector_lomb_scargle (pyleoclim.utils.wavelet.freq_vector_lomb_scargle)

pyleoclim.utils.wavelet.freq_vector_lomb_scargle(ts, dt=None, nf=None, ofac=4, hifac=1)[source]

Return the frequency vector based on the REDFIT recommendation.

Parameters

ts (array) – time axis of the time series
dt (float) – The resolution of the data. If None, uses the median resolution. Defaults to None.
nf (int) – Number of frequency points. If None, calculated as the difference between the highest and lowest frequencies (set by hifac and ofac) divided by resolution. Defaults to None
ofac (float) –

Oversampling rate that influences the resolution of the frequency axis,
when equals to 1, it means no oversamling (should be >= 1). The default value 4 is usually a good value.
hifac (float) – fhi/fnyq (should be <= 1), where fhi is the highest frequency that can be analyzed by the Lomb-Scargle algorithm and fnyq is the Nyquist frequency.

Returns

freq – the frequency vector

Return type

array

References

Trauth, M. H. MATLAB® Recipes for Earth Sciences. (Springer, 2015). pp 181.