ENH: Add mask_label_params parameter to plot_topomap

doc/changes/dev/13969.newfeature.rst

@@ -0,0 +1 @@
+Add ``mask_label_params`` parameter to :func:`~mne.viz.plot_topomap` and :func:`~mne.viz.plot_evoked_topomap` to allow for customisation of masked channel labels, by `Carina Forster`_.

mne/cov.py

@@ -327,6 +327,7 @@ def plot_topomap(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -362,6 +363,9 @@ def plot_topomap(
         %(show_names_topomap)s
         %(mask_topomap)s
         %(mask_params_topomap)s
+        %(mask_label_params_topomap)s
+
+            .. versionadded:: 1.13
         %(contours_topomap)s
         %(outlines_topomap)s
         %(sphere_topomap_auto)s
@@ -435,6 +439,7 @@ def plot_topomap(
             show_names=show_names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             outlines=outlines,
             contours=contours,
             image_interp=image_interp,

mne/decoding/csp.py

@@ -370,6 +370,7 @@ def plot_patterns(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -409,6 +410,9 @@ def plot_patterns(
         %(show_names_topomap)s
         %(mask_patterns_topomap)s
         %(mask_params_topomap)s
+        %(mask_label_params_topomap)s
+
+            .. versionadded:: 1.13
         %(contours_topomap)s
         %(outlines_topomap)s
         %(sphere_topomap_auto)s
@@ -453,6 +457,7 @@ def plot_patterns(
             show_names=show_names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             contours=contours,
             outlines=outlines,
             sphere=sphere,
@@ -487,6 +492,7 @@ def plot_filters(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -526,6 +532,9 @@ def plot_filters(
         %(show_names_topomap)s
         %(mask_patterns_topomap)s
         %(mask_params_topomap)s
+        %(mask_label_params_topomap)s
+
+            .. versionadded:: 1.13
         %(contours_topomap)s
         %(outlines_topomap)s
         %(sphere_topomap_auto)s
@@ -570,6 +579,7 @@ def plot_filters(
             show_names=show_names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             contours=contours,
             outlines=outlines,
             sphere=sphere,

mne/decoding/spatial_filter.py

@@ -26,6 +26,7 @@ def _plot_model(
     show_names=False,
     mask=None,
     mask_params=None,
+    mask_label_params=None,
     contours=6,
     outlines="head",
     sphere=None,
@@ -63,6 +64,7 @@ def _plot_model(
         show_names=show_names,
         mask=mask,
         mask_params=mask_params,
+        mask_label_params=mask_label_params,
         contours=contours,
         outlines=outlines,
         sphere=sphere,
@@ -394,6 +396,7 @@ def plot_filters(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -433,6 +436,9 @@ def plot_filters(
         %(show_names_topomap)s
         %(mask_evoked_topomap)s
         %(mask_params_topomap)s
+        %(mask_label_params_topomap)s
+
+            .. versionadded:: 1.13
         %(contours_topomap)s
         %(outlines_topomap)s
         %(sphere_topomap_auto)s
@@ -469,6 +475,7 @@ def plot_filters(
             show_names=show_names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             contours=contours,
             outlines=outlines,
             sphere=sphere,
@@ -503,6 +510,7 @@ def plot_patterns(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -542,6 +550,9 @@ def plot_patterns(
         %(show_names_topomap)s
         %(mask_evoked_topomap)s
         %(mask_params_topomap)s
+        %(mask_label_params_topomap)s
+
+            .. versionadded:: 1.13
         %(contours_topomap)s
         %(outlines_topomap)s
         %(sphere_topomap_auto)s
@@ -578,6 +589,7 @@ def plot_patterns(
             show_names=show_names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             contours=contours,
             outlines=outlines,
             sphere=sphere,

mne/defaults.py

@@ -252,6 +252,10 @@
         markeredgewidth=1,
         markersize=4,
     ),
+    mask_label_params=dict(
+        fontsize="medium",  # respects theme
+        fontweight="bold",
+    ),
     coreg=dict(
         mri_fid_opacity=1.0,
         dig_fid_opacity=1.0,

mne/evoked.py

@@ -655,6 +655,7 @@ def plot_topomap(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -697,6 +698,7 @@ def plot_topomap(
             show_names=show_names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             outlines=outlines,
             contours=contours,
             image_interp=image_interp,
@@ -804,6 +806,7 @@ def animate_topomap(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -848,6 +851,9 @@ def animate_topomap(
         %(show_names_topomap)s
         %(mask_evoked_topomap)s
         %(mask_params_topomap)s
+        %(mask_label_params_topomap)s
+
+            .. versionadded:: 1.13
         %(contours_topomap)s
         %(outlines_topomap)s
         %(sphere_topomap_auto)s
@@ -917,6 +923,7 @@ def animate_topomap(
             show_names=show_names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             contours=contours,
             outlines=outlines,
             sphere=sphere,

mne/preprocessing/_regress.py

@@ -271,6 +271,7 @@ def plot(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -295,6 +296,7 @@ def plot(
             show_names=show_names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             contours=contours,
             outlines=outlines,
             sphere=sphere,

mne/time_frequency/spectrum.py

@@ -213,6 +213,7 @@ def plot_psd_topomap(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=0,
         outlines="head",
         sphere=None,
@@ -249,6 +250,9 @@ def plot_psd_topomap(
         %(show_names_topomap)s
         %(mask_evoked_topomap)s
         %(mask_params_topomap)s
+        %(mask_label_params_topomap)s
+
+            .. versionadded:: 1.13
         %(contours_topomap)s
         %(outlines_topomap)s
         %(sphere_topomap_auto)s
@@ -789,6 +793,7 @@ def plot_topomap(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -819,6 +824,9 @@ def plot_topomap(
         %(show_names_topomap)s
         %(mask_evoked_topomap)s
         %(mask_params_topomap)s
+        %(mask_label_params_topomap)s
+
+            .. versionadded:: 1.13
         %(contours_topomap)s
         %(outlines_topomap)s
         %(sphere_topomap_auto)s
@@ -881,6 +889,7 @@ def plot_topomap(
             names=names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             contours=contours,
             outlines=outlines,
             sphere=sphere,

mne/time_frequency/tfr.py

@@ -2613,6 +2613,7 @@ def plot_topomap(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -2643,6 +2644,7 @@ def plot_topomap(
             show_names=show_names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             contours=contours,
             outlines=outlines,
             sphere=sphere,
@@ -3589,6 +3591,7 @@ def plot_topomap(
         show_names=False,
         mask=None,
         mask_params=None,
+        mask_label_params=None,
         contours=6,
         outlines="head",
         sphere=None,
@@ -3619,6 +3622,7 @@ def plot_topomap(
             show_names=show_names,
             mask=mask,
             mask_params=mask_params,
+            mask_label_params=mask_label_params,
             contours=contours,
             outlines=outlines,
             sphere=sphere,

mne/utils/docs.py

@@ -2572,6 +2572,13 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
     example=" (useful for, e.g. marking which channels at which times a "
     "statistical test of the data reaches significance)",
 )
+docdict["mask_label_params_topomap"] = """
+mask_label_params : dict | None
+    Additional plotting parameters for significant sensor labels.
+    Default (None) equals::
+
+        dict(fontsize='medium', fontweight='bold')
+"""
 docdict["mask_params_topomap"] = """
 mask_params : dict | None
     Additional plotting parameters for plotting significant sensors.