move yshade func

Author: TomDonoghue

fooof/plts/error.py

@@ -52,56 +52,3 @@ def plot_spectral_error(freqs, error, shade=None, log_freqs=False, ax=None, **pl
 
     style_spectrum_plot(ax, log_freqs, True)
     ax.set_ylabel('Absolute Error')
-
-
-@savefig
-@style_plot
-@check_dependency(plt, 'matplotlib')
-def plot_error_shade(freqs, power_spectra, shade=None, scale=1, log_freqs=False,
-                     log_powers=False, ax=None, **plot_kwargs):
-    """Plot standard deviation or error as a shaded region around the mean spectrum.
-
-    Parameters
-    ----------
-    freqs : 1d array
-        Frequency values, to be plotted on the x-axis.
-    power_spectra : 1d or 2d array
-        Power values, to be plotted on the y-axis. ``shade`` must be provided if 1d.
-    shade : 1d array, optional, default: None
-        Powers to shade above/below the mean spectrum. None defaults to one standard deviation.
-    scale : int, optional, default: 1
-        Factor to multiply the the standard deviation, or ``shade``, by.
-    log_freqs : bool, optional, default: False
-        Whether to plot the frequency axis in log spacing.
-    log_powers : bool, optional, default: False
-        Whether to plot the power axis in log spacing.
-    ax : matplotlib.Axes, optional
-        Figure axes upon which to plot.
-    plot_style : callable, optional, default: style_spectrum_plot
-        A function to call to apply styling & aesthetics to the plot.
-    **plot_kwargs
-        Keyword arguments to be passed to `plot_spectra` or to the plot call.
-    """
-
-    if shade is None and power_spectra.ndim != 2:
-        raise ValueError('Power spectra must be 2d if shade is not given.')
-
-    ax = check_ax(ax, plot_kwargs.pop('figsize', PLT_FIGSIZES['spectral']))
-
-    # Set plot data & labels, logging if requested
-    plt_freqs = np.log10(freqs) if log_freqs else freqs
-    plt_powers = np.log10(power_spectra) if log_powers else power_spectra
-
-    # Plot mean
-    powers_mean = np.mean(plt_powers, axis=0) if plt_powers.ndim == 2 else plt_powers
-    ax.plot(plt_freqs, powers_mean)
-
-    # Shade +/- scale * (standard deviation or shade)
-    shade = scale * np.std(plt_powers, axis=0) if shade is None else scale * shade
-    upper_shade = powers_mean + shade
-    lower_shade = powers_mean - shade
-
-    alpha = plot_kwargs.pop('alpha', 0.25)
-    ax.fill_between(plt_freqs, lower_shade, upper_shade, alpha=alpha, **plot_kwargs)
-
-    style_spectrum_plot(ax, log_freqs, log_powers)

fooof/plts/spectra.py

@@ -172,3 +172,56 @@ def plot_spectra_shading(freqs, power_spectra, shades, shade_colors='r',
 
     style_spectrum_plot(ax, plot_kwargs.get('log_freqs', False),
                         plot_kwargs.get('log_powers', False))
+
+
+@savefig
+@style_plot
+@check_dependency(plt, 'matplotlib')
+def plot_spectra_yshade(freqs, power_spectra, shade=None, scale=1, log_freqs=False,
+                        log_powers=False, ax=None, **plot_kwargs):
+    """Plot standard deviation or error as a shaded region around the mean spectrum.
+
+    Parameters
+    ----------
+    freqs : 1d array
+        Frequency values, to be plotted on the x-axis.
+    power_spectra : 1d or 2d array
+        Power values, to be plotted on the y-axis. ``shade`` must be provided if 1d.
+    shade : 1d array, optional, default: None
+        Powers to shade above/below the mean spectrum. None defaults to one standard deviation.
+    scale : int, optional, default: 1
+        Factor to multiply the the standard deviation, or ``shade``, by.
+    log_freqs : bool, optional, default: False
+        Whether to plot the frequency axis in log spacing.
+    log_powers : bool, optional, default: False
+        Whether to plot the power axis in log spacing.
+    ax : matplotlib.Axes, optional
+        Figure axes upon which to plot.
+    plot_style : callable, optional, default: style_spectrum_plot
+        A function to call to apply styling & aesthetics to the plot.
+    **plot_kwargs
+        Keyword arguments to be passed to `plot_spectra` or to the plot call.
+    """
+
+    if shade is None and power_spectra.ndim != 2:
+        raise ValueError('Power spectra must be 2d if shade is not given.')
+
+    ax = check_ax(ax, plot_kwargs.pop('figsize', PLT_FIGSIZES['spectral']))
+
+    # Set plot data & labels, logging if requested
+    plt_freqs = np.log10(freqs) if log_freqs else freqs
+    plt_powers = np.log10(power_spectra) if log_powers else power_spectra
+
+    # Plot mean
+    powers_mean = np.mean(plt_powers, axis=0) if plt_powers.ndim == 2 else plt_powers
+    ax.plot(plt_freqs, powers_mean)
+
+    # Shade +/- scale * (standard deviation or shade)
+    shade = scale * np.std(plt_powers, axis=0) if shade is None else scale * shade
+    upper_shade = powers_mean + shade
+    lower_shade = powers_mean - shade
+
+    alpha = plot_kwargs.pop('alpha', 0.25)
+    ax.fill_between(plt_freqs, lower_shade, upper_shade, alpha=alpha, **plot_kwargs)
+
+    style_spectrum_plot(ax, log_freqs, log_powers)

fooof/tests/plts/test_error.py

@@ -1,7 +1,5 @@
 """Tests for fooof.plts.error."""
 
-from pytest import raises, mark, param
-
 import numpy as np
 
 from fooof.tests.tutils import plot_test
@@ -20,24 +18,3 @@ def test_plot_spectral_error(skip_if_no_mpl):
 
     plot_spectral_error(fs, errs, save_fig=True, file_path=TEST_PLOTS_PATH,
                         file_name='test_plot_spectral_error.png')
-
-
-
-@plot_test
-def test_plot_error_shade(skip_if_no_mpl, tfg):
-
-    freqs = tfg.freqs
-    powers = tfg.power_spectra
-
-    # Invalid 1d array, without shade
-    with raises(ValueError):
-        plot_error_shade(freqs, powers[0])
-
-    # Valid 1d array with shade
-    plot_error_shade(freqs, np.mean(powers, axis=0), shade=np.std(powers, axis=0), 
-                     save_fig=True, file_path=TEST_PLOTS_PATH, 
-                     file_name='test_plot_spectral_error_shade1.png')
-
-    # 2d array
-    plot_error_shade(freqs, powers, save_fig=True, file_path=TEST_PLOTS_PATH, 
-                     file_name='test_plot_spectral_error_shade2.png')

fooof/tests/plts/test_spectra.py

@@ -1,5 +1,7 @@
 """Tests for fooof.plts.spectra."""
 
+from pytest import raises
+
 import numpy as np
 
 from fooof.tests.tutils import plot_test
@@ -59,3 +61,22 @@ def test_plot_spectra_shading(tfg, skip_if_no_mpl):
                          shades=[8, 12], add_center=True, log_freqs=True, log_powers=True,
                          labels=['A', 'B'], save_fig=True, file_path=TEST_PLOTS_PATH,
                          file_name='test_plot_spectra_shading_kwargs.png')
+
+@plot_test
+def test_plot_spectra_yshade(skip_if_no_mpl, tfg):
+
+    freqs = tfg.freqs
+    powers = tfg.power_spectra
+
+    # Invalid 1d array, without shade
+    with raises(ValueError):
+        plot_spectra_yshade(freqs, powers[0])
+
+    # Valid 1d array with shade
+    plot_spectra_yshade(freqs, np.mean(powers, axis=0), shade=np.std(powers, axis=0),
+                        save_fig=True, file_path=TEST_PLOTS_PATH,
+                        file_name='test_plot_spectra_yshade1.png')
+
+    # 2d array
+    plot_spectra_yshade(freqs, powers, save_fig=True, file_path=TEST_PLOTS_PATH,
+                        file_name='test_plot_spectra_yshade2.png')