MRG, VIZ: Fix title position in plot_sensors

[cbrnr]

The title is out of bounds in figures created by plot_sensors (including montage.plot()).

Before:

After:

[hoechenberger]

Care to add a changelog entry? :)

[larsoner]

@drammock feel free to review and merge when you're happy since you've been working in the viz code a lot lately

[cbrnr]

We could also move the title from the canvas to the window title bar (and maximize the montage plot again). What do you think?

[hoechenberger]

We could also move the title from the canvas to the window title bar (and maximize the montage plot again). What do you think?

Me likes!! 😍

[drammock]

We could also move the title from the canvas to the window title bar (and maximize the montage plot again).

There is a downside to this, in that window titles don't show up in our tutorial docs. We're not super consistent about this throughout the codebase, but I've been leaning toward using the plot title for generic descriptive stuff like "Power spectral density (magnetometers)" or "sensor positions", and using the window title for the information that is more useful interactively (esp. during preprocessing), like the subject ID. On that basis, I would lean toward leaving this as a plot title rather than a window title.

On the other hand, sensor location plots often get inset into data plots, so it might simplify things to not add axes titles to them by default? In which case putting that info in a window title makes sense (as long as we're careful that it doesn't change the window title when the sensor plot is merely an inset).

[cbrnr]

In general I agree, but in this case the title "Sensor positions (eeg)" really doesn't contain a lot of helpful information and takes up a lot of space. Either way, let me know how to proceed.

[drammock]

putting that info in a window title makes sense (as long as we're careful that it doesn't change the window title when the sensor plot is merely an inset)

I think this reasoning wins out for me. Just reading the code, I think currently it will change the figure title even when the sensor plot is merely an inset axes.... yep, just tested with this:

import os
import mne
import matplotlib.pyplot as plt
plt.ion()
fig, ax = plt.subplots()
inax = ax.inset_axes((0.1, 0.1, 0.4, 0.4))

dp = mne.datasets.multimodal.data_path()
raw = mne.io.read_raw(os.path.join(dp, 'multimodal_raw.fif'))
mne.viz.plot_sensors(raw.info, axes=inax)

[cbrnr]

Is there a way to check whether the axes are the sole axes in a figure or if they are inset?

[drammock]

Is there a way to check whether the axes are the sole axes in a figure or if they are inset?

I don't think so... I think ax.inset_axes() is ultimately syntactic sugar around fig.add_axes(), so they end up as the same object type. I think the right approach is to only set the figure window title in cases where our plot_sensors() function created the figure in the first place... so you can leverage the axes_was_none variable for that I think?

EDIT: it would be possible to check the length of fig.axes to see if there's only one axes object present, but I think only setting window titles on figure windows that we create is a sensible policy, so I wouldn't bother checking len(fig.axes)

[cbrnr]

@drammock I think this should work now - can you check?

[cbrnr]

@drammock done!

[drammock]

thanks @cbrnr!