ivs.timeseries.decorators

Module decorators

Various decorator functions for time series analysis

Parallel periodogram

Autocompletion of default arguments

Functions

[hide private]

parallel_pergram(fctn)
Run periodogram calculations in parallel.

source code

defaults_pergram(fctn)
Set default parameters common to all periodograms.

source code

defaults_filtering(fctn)
Set default parameters common to all filtering functions.

source code

float

getNyquist(times, nyq_stat=np.inf)
Calculate Nyquist frequency.

source code

Variables

[hide private]

logger = logging.getLogger("TS.DEC")

Function Details

[hide private]

parallel_pergram(fctn)

source code

Run periodogram calculations in parallel.

This splits up the frequency range between f0 and fn in 'threads' parts.

This must decorate a 'make_parallel' decorator.

getNyquist(times, nyq_stat=np.inf)

source code

Calculate Nyquist frequency.

Typical use is minimum or median of time points differences.

If nyq_stat is not callable, it is assumed to be a number and that number will just be returned: this you can do to search for frequencies above the nyquist frequency

Parameters:

times (numpy array) - sorted array containing time points
nyq_stat (callable or float) - statistic to use or absolute value of the Nyquist frequency

Returns: float

Nyquist frequency