BUG: Fix constrained layout in psd.plot (#12103)

Author: larsoner

doc/changes/devel.rst

@@ -38,7 +38,7 @@ Enhancements
 - Add support for writing forward solutions to HDF5 and convenience function :meth:`mne.Forward.save` (:gh:`12036` by `Eric Larson`_)
 - Refactored internals of :func:`mne.read_annotations` (:gh:`11964` by `Paul Roujansky`_)
 - Add support for drawing MEG sensors in :ref:`mne coreg` (:gh:`12098` by `Eric Larson`_)
-- By default MNE-Python creates matplotlib figures with ``layout='constrained'`` rather than the default ``layout='tight'`` (:gh:`12050` by `Mathieu Scheltienne`_ and `Eric Larson`_)
+- By default MNE-Python creates matplotlib figures with ``layout='constrained'`` rather than the default ``layout='tight'`` (:gh:`12050`, :gh:`12103` by `Mathieu Scheltienne`_ and `Eric Larson`_)
 - Enhance :func:`~mne.viz.plot_evoked_field` with a GUI that has controls for time, colormap, and contour lines (:gh:`11942` by `Marijn van Vliet`_)
 - Add :class:`mne.viz.ui_events.UIEvent` linking for interactive colorbars, allowing users to link figures and change the colormap and limits interactively. This supports :func:`~mne.viz.plot_evoked_topomap`, :func:`~mne.viz.plot_ica_components`, :func:`~mne.viz.plot_tfr_topomap`, :func:`~mne.viz.plot_projs_topomap`, :meth:`~mne.Evoked.plot_image`, and :meth:`~mne.Epochs.plot_image` (:gh:`12057` by `Santeri Ruuskanen`_)
 

mne/viz/_mpl_figure.py

@@ -2331,38 +2331,16 @@ def _get_scale_bar_texts(self):
 class MNELineFigure(MNEFigure):
     """Interactive figure for non-scrolling line plots."""
 
-    def __init__(self, inst, n_axes, figsize, *, layout=None, **kwargs):
-        super().__init__(figsize=figsize, inst=inst, layout=layout, **kwargs)
-
-        # AXES: default margins (inches)
-        l_margin = 0.8
-        r_margin = 0.2
-        b_margin = 0.65
-        t_margin = 0.35
-        # AXES: default margins (figure-relative coordinates)
-        left = self._inch_to_rel(l_margin)
-        right = 1 - self._inch_to_rel(r_margin)
-        bottom = self._inch_to_rel(b_margin, horiz=False)
-        top = 1 - self._inch_to_rel(t_margin, horiz=False)
-        # AXES: make subplots
-        axes = [self.add_subplot(n_axes, 1, 1)]
-        for ix in range(1, n_axes):
-            axes.append(self.add_subplot(n_axes, 1, ix + 1, sharex=axes[0]))
-        self.subplotpars.update(
-            left=left, bottom=bottom, top=top, right=right, hspace=0.4
-        )
-        # save useful things
-        self.mne.ax_list = axes
-
-    def _resize(self, event):
-        """Handle resize event."""
-        old_width, old_height = self.mne.fig_size_px
-        new_width, new_height = self._get_size_px()
-        new_margins = _calc_new_margins(
-            self, old_width, old_height, new_width, new_height
+    def __init__(self, inst, n_axes, figsize, *, layout="constrained", **kwargs):
+        super().__init__(
+            figsize=figsize,
+            inst=inst,
+            layout=layout,
+            sharex=True,
+            **kwargs,
         )
-        self.subplots_adjust(**new_margins)
-        self.mne.fig_size_px = (new_width, new_height)
+        for ix in range(n_axes):
+            self.add_subplot(n_axes, 1, ix + 1)
 
 
 def _close_all():
@@ -2426,11 +2404,10 @@ def _line_figure(inst, axes=None, picks=None, **kwargs):
             FigureClass=MNELineFigure,
             figsize=figsize,
             n_axes=n_axes,
-            layout=None,
             **kwargs,
         )
         fig.mne.fig_size_px = fig._get_size_px()  # can't do in __init__
-        axes = fig.mne.ax_list
+        axes = fig.axes
     return fig, axes
 
 

mne/viz/epochs.py

@@ -302,9 +302,11 @@ def plot_epochs_image(
 
     # check for compatible `fig` / `axes`; instantiate figs if needed; add
     # fig(s) and axes into group_by
+    needs_colorbar = colorbar and (axes is not None or fig is not None)
     group_by = _validate_fig_and_axes(
-        fig, axes, group_by, evoked, colorbar, clear=clear
+        fig, axes, group_by, evoked, colorbar=needs_colorbar, clear=clear
     )
+    del fig, axes, needs_colorbar, clear
 
     # prepare images in advance to get consistent vmin/vmax.
     # At the same time, create a subsetted epochs object for each group
@@ -649,20 +651,26 @@ def _plot_epochs_image(
         ax["evoked"].xaxis.set_major_locator(loc)
         ax["evoked"].yaxis.set_major_locator(AutoLocator())
 
+    fig = ax_im.get_figure()
+
     # draw the colorbar
     if colorbar:
         from matplotlib.pyplot import colorbar as cbar
 
-        this_colorbar = cbar(im, cax=ax["colorbar"])
-        this_colorbar.ax.set_ylabel(unit, rotation=270, labelpad=12)
+        if "colorbar" in ax:  # axes supplied by user
+            this_colorbar = cbar(im, cax=ax["colorbar"])
+            this_colorbar.ax.set_ylabel(unit, rotation=270, labelpad=12)
+        else:  # we created them
+            this_colorbar = fig.colorbar(im, ax=ax_im)
+            this_colorbar.ax.set_title(unit)
         if cmap[1]:
             ax_im.CB = DraggableColorbar(
                 this_colorbar, im, kind="epochs_image", ch_type=unit
             )
 
     # finish
-    plt_show(show)
-    return ax_im.get_figure()
+    plt_show(show, fig=fig)
+    return fig
 
 
 def plot_drop_log(

mne/viz/evoked.py

@@ -2027,7 +2027,7 @@ def plot_evoked_joint(
     if topomap_args.get("colorbar", True):
         from matplotlib import ticker
 
-        cbar = fig.colorbar(map_ax[0].images[0], ax=map_ax, cax=cbar_ax)
+        cbar = fig.colorbar(map_ax[0].images[0], ax=map_ax, cax=cbar_ax, shrink=0.8)
         cbar.ax.grid(False)  # auto-removal deprecated as of 2021/10/05
         if isinstance(contours, (list, np.ndarray)):
             cbar.set_ticks(contours)

mne/viz/topomap.py

@@ -304,15 +304,13 @@ def _add_colorbar(
     im,
     cmap,
     *,
-    side="right",
     title=None,
     format=None,
-    size="5%",
     kind=None,
     ch_type=None,
 ):
     """Add a colorbar to an axis."""
-    cbar = ax.figure.colorbar(im, format=format)
+    cbar = ax.figure.colorbar(im, format=format, shrink=0.6)
     if cmap is not None and cmap[1]:
         ax.CB = DraggableColorbar(cbar, im, kind, ch_type)
     cax = cbar.ax
@@ -1712,7 +1710,6 @@ def plot_ica_components(
                     im,
                     cmap,
                     title="AU",
-                    side="right",
                     format=cbar_fmt,
                     kind="ica_comp_topomap",
                     ch_type=ch_type,
@@ -2564,7 +2561,7 @@ def _plot_topomap_multi_cbar(
     )
 
     if colorbar:
-        cbar, cax = _add_colorbar(ax, im, cmap, title=None, size="10%", format=cbar_fmt)
+        cbar, cax = _add_colorbar(ax, im, cmap, title=None, format=cbar_fmt)
         cbar.set_ticks(_vlim)
         if unit is not None:
             cbar.ax.set_ylabel(unit, fontsize=8)
@@ -3744,7 +3741,7 @@ def plot_bridged_electrodes(
     if title is not None:
         im.axes.set_title(title)
     if colorbar:
-        cax = fig.colorbar(im)
+        cax = fig.colorbar(im, shrink=0.6)
         cax.set_label(r"Electrical Distance ($\mu$$V^2$)")
     return fig
 

tutorials/epochs/20_visualize_epochs.py

@@ -12,7 +12,6 @@
 We'll start by importing the modules we need, loading the continuous (raw)
 sample data, and cropping it to save memory:
 """
-
 # %%
 
 import mne

tutorials/evoked/20_visualize_evoked.py

@@ -10,6 +10,7 @@
 
 As usual we'll start by importing the modules we need:
 """
+
 # %%
 
 import numpy as np

tutorials/raw/40_visualize_raw.py

@@ -13,7 +13,6 @@
 :ref:`example data <sample-dataset>`, and cropping the `~mne.io.Raw`
 object to just 60 seconds before loading it into RAM to save memory:
 """
-
 # %%
 
 import os