|
24 | 24 | @check_dependency(plt, 'matplotlib') |
25 | 25 | def plot_spectra(freqs, power_spectra, log_freqs=False, log_powers=False, |
26 | 26 | colors=None, labels=None, ax=None, **plot_kwargs): |
27 | | - """Plot multiple power spectra on the same plot. |
| 27 | + """Plot one or multiple power spectra. |
28 | 28 |
|
29 | 29 | Parameters |
30 | 30 | ---------- |
31 | | - freqs : 2d array or 1d array or list of 1d array |
| 31 | + freqs : 1d or 2d array or list of 1d array |
32 | 32 | Frequency values, to be plotted on the x-axis. |
33 | | - power_spectra : 2d array or list of 1d array |
| 33 | + power_spectra : 1d or 2d array or list of 1d array |
34 | 34 | Power values, to be plotted on the y-axis. |
35 | 35 | log_freqs : bool, optional, default: False |
36 | 36 | Whether to plot the frequency axis in log spacing. |
@@ -79,13 +79,13 @@ def plot_spectra(freqs, power_spectra, log_freqs=False, log_powers=False, |
79 | 79 | @check_dependency(plt, 'matplotlib') |
80 | 80 | def plot_spectra_shading(freqs, power_spectra, shades, shade_colors='r', |
81 | 81 | add_center=False, ax=None, **plot_kwargs): |
82 | | - """Plot a group of power spectra with a shaded frequency region (or regions). |
| 82 | + """Plot one or multiple power spectra with a shaded frequency region (or regions). |
83 | 83 |
|
84 | 84 | Parameters |
85 | 85 | ---------- |
86 | | - freqs : 2d array or 1d array or list of 1d array |
| 86 | + freqs : 1d or 2d array or list of 1d array |
87 | 87 | Frequency values, to be plotted on the x-axis. |
88 | | - power_spectra : 2d array or list of 1d array |
| 88 | + power_spectra : 1d or 2d array or list of 1d array |
89 | 89 | Power values, to be plotted on the y-axis. |
90 | 90 | shades : list of [float, float] or list of list of [float, float] |
91 | 91 | Shaded region(s) to add to plot, defined as [lower_bound, upper_bound]. |
|
0 commit comments