plot_acf

elk.plot.plot_acf(time, acf, acf_percentiles=None, title=None, fig=None, ax=None, show=True, save_path=None)

Plot an autocorrelation function

Parameters:

timendarray

Times at which autocorrelation function is evaluated

acfndarray, optional

The autocorrelation function, by default None

acf_percentilesndarray, optional

1-sigma confidence interval on the autocorrelation function, by default None

titlestr, optional

A title for the plot, by default None

figFigure, optional

Figure on which to plot, if either fig or ax is None then new ones are created, by default None

axAxesSubplot, optional

Axis on which to plot, if either fig or ax is None then new ones are created, by default None

showbool, optional

Whether to show the plot, by default True

save_pathstr, optional

Where to save the plot, if None then plot is not saved, by default None

Returns:

fig, axFigure, AxesSubplot

Figure and axis on which the periodogram has been plotted