Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MNT] - Make grid an updateable argument in PSD plots #300

Merged
merged 7 commits into from
Sep 13, 2023
Merged

[MNT] - Make grid an updateable argument in PSD plots #300

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
37d6cd8
make grid an updateable argument in PSD plots
TomDonoghue Aug 27, 2023
81cc698
update styling stuff - collection, check func
TomDonoghue Sep 5, 2023
85a3fdb
add public facing plt utils to API list
TomDonoghue Sep 5, 2023
d4b27d1
update descriptions of plot_kwargs
TomDonoghue Sep 5, 2023
6ac86e6
update check_style options
TomDonoghue Sep 5, 2023
f086163
extend setable axis plot kwargs
TomDonoghue Sep 6, 2023
3874dc8
fix docstring label
TomDonoghue Sep 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions fooof/plts/spectra.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ def plot_spectra(freqs, power_spectra, log_freqs=False, log_powers=False, freq_r
Additional plot related keyword arguments.
"""

# Create the plot & collect plot kwargs of interest
ax = check_ax(ax, plot_kwargs.pop('figsize', PLT_FIGSIZES['spectral']))

# Create the plot
plot_kwargs = check_plot_kwargs(plot_kwargs, {'linewidth' : 2.0})
grid = plot_kwargs.pop('grid', True)

# Check for frequency range input, and log if x-axis is in log space
if freq_range is not None:
Expand Down Expand Up @@ -82,7 +82,7 @@ def plot_spectra(freqs, power_spectra, log_freqs=False, log_powers=False, freq_r

ax.set_xlim(freq_range)

style_spectrum_plot(ax, log_freqs, log_powers)
style_spectrum_plot(ax, log_freqs, log_powers, grid)


# Alias `plot_spectrum` to `plot_spectra` for backwards compatibility
Expand Down Expand Up @@ -127,7 +127,8 @@ def plot_spectra_shading(freqs, power_spectra, shades, shade_colors='r',
add_shades(ax, shades, shade_colors, add_center, plot_kwargs.get('log_freqs', False))

style_spectrum_plot(ax, plot_kwargs.get('log_freqs', False),
plot_kwargs.get('log_powers', False))
plot_kwargs.get('log_powers', False),
plot_kwargs.get('grid', True))


# Alias `plot_spectrum_shading` to `plot_spectra_shading` for backwards compatibility
Expand Down Expand Up @@ -172,6 +173,7 @@ def plot_spectra_yshade(freqs, power_spectra, shade='std', average='mean', scale
raise ValueError('Power spectra must be 2d if shade is not given.')

ax = check_ax(ax, plot_kwargs.pop('figsize', PLT_FIGSIZES['spectral']))
grid = plot_kwargs.pop('grid', True)

# Set plot data & labels, logging if requested
plt_freqs = np.log10(freqs) if log_freqs else freqs
Expand Down Expand Up @@ -208,4 +210,4 @@ def plot_spectra_yshade(freqs, power_spectra, shade='std', average='mean', scale
ax.fill_between(plt_freqs, lower_shade, upper_shade,
alpha=alpha, color=color, **plot_kwargs)

style_spectrum_plot(ax, log_freqs, log_powers)
style_spectrum_plot(ax, log_freqs, log_powers, grid)
6 changes: 4 additions & 2 deletions fooof/plts/style.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
###################################################################################################
###################################################################################################

def style_spectrum_plot(ax, log_freqs, log_powers):
def style_spectrum_plot(ax, log_freqs, log_powers, grid=True):
"""Apply style and aesthetics to a power spectrum plot.

Parameters
Expand All @@ -23,6 +23,8 @@ def style_spectrum_plot(ax, log_freqs, log_powers):
Whether the frequency axis is plotted in log space.
log_powers : bool
Whether the power axis is plotted in log space.
grid : bool, optional, default: True
Whether to add grid lines to the plot.
"""

# Get labels, based on log status
Expand All @@ -33,7 +35,7 @@ def style_spectrum_plot(ax, log_freqs, log_powers):
ax.set_xlabel(xlabel, fontsize=20)
ax.set_ylabel(ylabel, fontsize=20)
ax.tick_params(axis='both', which='major', labelsize=16)
ax.grid(True)
ax.grid(grid)

# If labels were provided, add a legend
if ax.get_legend_handles_labels()[0]:
Expand Down