plot_periodogram#
- elk.plot.plot_periodogram(frequencies, power, power_percentiles, peak_freqs, fap=None, fig=None, ax=None, show=True, title=None, save_path=None)[source]#
Plot a periodogram
- Parameters
- frequencies
ndarray Frequencies at which periodogram evaluated
- power
ndarray Power at each frequency
- power_percentiles
ndarray Percentiles on the power, if shape is (2, len(power)) then assumed to be 1-sigma values, if shape is (4, len(power)) then assumed to be 1- and 2-sigma values in order of (2-, 1-, 1+, 2+)
- peak_freqs
ndarray Frequencies at which peaks occur
- fapfloat, optional
False alarm probability for the maximum power peak - plotted as horizontal line if provided, by default None
- fig
Figure, optional Figure on which to plot, if either fig or ax is None then new ones are created, by default None
- ax
AxesSubplot, 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
- titlestr, optional
A title for the plot, by default None
- save_pathstr, optional
Where to save the plot, if None then plot is not saved, by default None
- frequencies
- Returns
- fig, ax
Figure,AxesSubplot Figure and axis on which the periodogram has been plotted
- fig, ax