Skip to content

Commit 9ead159

Browse files
CarinaFodrammock
CarinaFo
and
drammock
authored
ENH: Add mask_label_params parameter to plot_topomap (#13969)
Co-authored-by: Daniel McCloy <dan@mccloy.info>
1 parent d5fd153 commit 9ead159

12 files changed

Lines changed: 194 additions & 4 deletions

File tree

‎doc/changes/dev/13969.newfeature.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,7 @@ def plot_topomap(
327327
show_names=False,
328328
mask=None,
329329
mask_params=None,
330+
mask_label_params=None,
330331
contours=6,
331332
outlines="head",
332333
sphere=None,
@@ -362,6 +363,9 @@ def plot_topomap(
362363
%(show_names_topomap)s
363364
%(mask_topomap)s
364365
%(mask_params_topomap)s
366+
%(mask_label_params_topomap)s
367+
368+
.. versionadded:: 1.13
365369
%(contours_topomap)s
366370
%(outlines_topomap)s
367371
%(sphere_topomap_auto)s
@@ -435,6 +439,7 @@ def plot_topomap(
435439
show_names=show_names,
436440
mask=mask,
437441
mask_params=mask_params,
442+
mask_label_params=mask_label_params,
438443
outlines=outlines,
439444
contours=contours,
440445
image_interp=image_interp,

‎mne/decoding/csp.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,7 @@ def plot_patterns(
370370
show_names=False,
371371
mask=None,
372372
mask_params=None,
373+
mask_label_params=None,
373374
contours=6,
374375
outlines="head",
375376
sphere=None,
@@ -409,6 +410,9 @@ def plot_patterns(
409410
%(show_names_topomap)s
410411
%(mask_patterns_topomap)s
411412
%(mask_params_topomap)s
413+
%(mask_label_params_topomap)s
414+
415+
.. versionadded:: 1.13
412416
%(contours_topomap)s
413417
%(outlines_topomap)s
414418
%(sphere_topomap_auto)s
@@ -453,6 +457,7 @@ def plot_patterns(
453457
show_names=show_names,
454458
mask=mask,
455459
mask_params=mask_params,
460+
mask_label_params=mask_label_params,
456461
contours=contours,
457462
outlines=outlines,
458463
sphere=sphere,
@@ -487,6 +492,7 @@ def plot_filters(
487492
show_names=False,
488493
mask=None,
489494
mask_params=None,
495+
mask_label_params=None,
490496
contours=6,
491497
outlines="head",
492498
sphere=None,
@@ -526,6 +532,9 @@ def plot_filters(
526532
%(show_names_topomap)s
527533
%(mask_patterns_topomap)s
528534
%(mask_params_topomap)s
535+
%(mask_label_params_topomap)s
536+
537+
.. versionadded:: 1.13
529538
%(contours_topomap)s
530539
%(outlines_topomap)s
531540
%(sphere_topomap_auto)s
@@ -570,6 +579,7 @@ def plot_filters(
570579
show_names=show_names,
571580
mask=mask,
572581
mask_params=mask_params,
582+
mask_label_params=mask_label_params,
573583
contours=contours,
574584
outlines=outlines,
575585
sphere=sphere,

‎mne/decoding/spatial_filter.py‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ def _plot_model(
2626
show_names=False,
2727
mask=None,
2828
mask_params=None,
29+
mask_label_params=None,
2930
contours=6,
3031
outlines="head",
3132
sphere=None,
@@ -63,6 +64,7 @@ def _plot_model(
6364
show_names=show_names,
6465
mask=mask,
6566
mask_params=mask_params,
67+
mask_label_params=mask_label_params,
6668
contours=contours,
6769
outlines=outlines,
6870
sphere=sphere,
@@ -394,6 +396,7 @@ def plot_filters(
394396
show_names=False,
395397
mask=None,
396398
mask_params=None,
399+
mask_label_params=None,
397400
contours=6,
398401
outlines="head",
399402
sphere=None,
@@ -433,6 +436,9 @@ def plot_filters(
433436
%(show_names_topomap)s
434437
%(mask_evoked_topomap)s
435438
%(mask_params_topomap)s
439+
%(mask_label_params_topomap)s
440+
441+
.. versionadded:: 1.13
436442
%(contours_topomap)s
437443
%(outlines_topomap)s
438444
%(sphere_topomap_auto)s
@@ -469,6 +475,7 @@ def plot_filters(
469475
show_names=show_names,
470476
mask=mask,
471477
mask_params=mask_params,
478+
mask_label_params=mask_label_params,
472479
contours=contours,
473480
outlines=outlines,
474481
sphere=sphere,
@@ -503,6 +510,7 @@ def plot_patterns(
503510
show_names=False,
504511
mask=None,
505512
mask_params=None,
513+
mask_label_params=None,
506514
contours=6,
507515
outlines="head",
508516
sphere=None,
@@ -542,6 +550,9 @@ def plot_patterns(
542550
%(show_names_topomap)s
543551
%(mask_evoked_topomap)s
544552
%(mask_params_topomap)s
553+
%(mask_label_params_topomap)s
554+
555+
.. versionadded:: 1.13
545556
%(contours_topomap)s
546557
%(outlines_topomap)s
547558
%(sphere_topomap_auto)s
@@ -578,6 +589,7 @@ def plot_patterns(
578589
show_names=show_names,
579590
mask=mask,
580591
mask_params=mask_params,
592+
mask_label_params=mask_label_params,
581593
contours=contours,
582594
outlines=outlines,
583595
sphere=sphere,

‎mne/defaults.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,10 @@
253253
markeredgewidth=1,
254254
markersize=4,
255255
),
256+
mask_label_params=dict(
257+
fontsize="medium", # respects theme
258+
fontweight="bold",
259+
),
256260
coreg=dict(
257261
mri_fid_opacity=1.0,
258262
dig_fid_opacity=1.0,

‎mne/evoked.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -647,6 +647,7 @@ def plot_topomap(
647647
show_names=False,
648648
mask=None,
649649
mask_params=None,
650+
mask_label_params=None,
650651
contours=6,
651652
outlines="head",
652653
sphere=None,
@@ -689,6 +690,7 @@ def plot_topomap(
689690
show_names=show_names,
690691
mask=mask,
691692
mask_params=mask_params,
693+
mask_label_params=mask_label_params,
692694
outlines=outlines,
693695
contours=contours,
694696
image_interp=image_interp,
@@ -796,6 +798,7 @@ def animate_topomap(
796798
show_names=False,
797799
mask=None,
798800
mask_params=None,
801+
mask_label_params=None,
799802
contours=6,
800803
outlines="head",
801804
sphere=None,
@@ -840,6 +843,9 @@ def animate_topomap(
840843
%(show_names_topomap)s
841844
%(mask_evoked_topomap)s
842845
%(mask_params_topomap)s
846+
%(mask_label_params_topomap)s
847+
848+
.. versionadded:: 1.13
843849
%(contours_topomap)s
844850
%(outlines_topomap)s
845851
%(sphere_topomap_auto)s
@@ -909,6 +915,7 @@ def animate_topomap(
909915
show_names=show_names,
910916
mask=mask,
911917
mask_params=mask_params,
918+
mask_label_params=mask_label_params,
912919
contours=contours,
913920
outlines=outlines,
914921
sphere=sphere,

‎mne/preprocessing/_regress.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@ def plot(
271271
show_names=False,
272272
mask=None,
273273
mask_params=None,
274+
mask_label_params=None,
274275
contours=6,
275276
outlines="head",
276277
sphere=None,
@@ -295,6 +296,7 @@ def plot(
295296
show_names=show_names,
296297
mask=mask,
297298
mask_params=mask_params,
299+
mask_label_params=mask_label_params,
298300
contours=contours,
299301
outlines=outlines,
300302
sphere=sphere,

‎mne/time_frequency/spectrum.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ def plot_psd_topomap(
213213
show_names=False,
214214
mask=None,
215215
mask_params=None,
216+
mask_label_params=None,
216217
contours=0,
217218
outlines="head",
218219
sphere=None,
@@ -249,6 +250,9 @@ def plot_psd_topomap(
249250
%(show_names_topomap)s
250251
%(mask_evoked_topomap)s
251252
%(mask_params_topomap)s
253+
%(mask_label_params_topomap)s
254+
255+
.. versionadded:: 1.13
252256
%(contours_topomap)s
253257
%(outlines_topomap)s
254258
%(sphere_topomap_auto)s
@@ -789,6 +793,7 @@ def plot_topomap(
789793
show_names=False,
790794
mask=None,
791795
mask_params=None,
796+
mask_label_params=None,
792797
contours=6,
793798
outlines="head",
794799
sphere=None,
@@ -819,6 +824,9 @@ def plot_topomap(
819824
%(show_names_topomap)s
820825
%(mask_evoked_topomap)s
821826
%(mask_params_topomap)s
827+
%(mask_label_params_topomap)s
828+
829+
.. versionadded:: 1.13
822830
%(contours_topomap)s
823831
%(outlines_topomap)s
824832
%(sphere_topomap_auto)s
@@ -881,6 +889,7 @@ def plot_topomap(
881889
names=names,
882890
mask=mask,
883891
mask_params=mask_params,
892+
mask_label_params=mask_label_params,
884893
contours=contours,
885894
outlines=outlines,
886895
sphere=sphere,

‎mne/time_frequency/tfr.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2613,6 +2613,7 @@ def plot_topomap(
26132613
show_names=False,
26142614
mask=None,
26152615
mask_params=None,
2616+
mask_label_params=None,
26162617
contours=6,
26172618
outlines="head",
26182619
sphere=None,
@@ -2643,6 +2644,7 @@ def plot_topomap(
26432644
show_names=show_names,
26442645
mask=mask,
26452646
mask_params=mask_params,
2647+
mask_label_params=mask_label_params,
26462648
contours=contours,
26472649
outlines=outlines,
26482650
sphere=sphere,
@@ -3589,6 +3591,7 @@ def plot_topomap(
35893591
show_names=False,
35903592
mask=None,
35913593
mask_params=None,
3594+
mask_label_params=None,
35923595
contours=6,
35933596
outlines="head",
35943597
sphere=None,
@@ -3619,6 +3622,7 @@ def plot_topomap(
36193622
show_names=show_names,
36203623
mask=mask,
36213624
mask_params=mask_params,
3625+
mask_label_params=mask_label_params,
36223626
contours=contours,
36233627
outlines=outlines,
36243628
sphere=sphere,

‎mne/utils/docs.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2577,6 +2577,13 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
25772577
example=" (useful for, e.g. marking which channels at which times a "
25782578
"statistical test of the data reaches significance)",
25792579
)
2580+
docdict["mask_label_params_topomap"] = """
2581+
mask_label_params : dict | None
2582+
Additional plotting parameters for significant sensor labels.
2583+
Default (None) equals::
2584+
2585+
dict(fontsize='medium', fontweight='bold')
2586+
"""
25802587
docdict["mask_params_topomap"] = """
25812588
mask_params : dict | None
25822589
Additional plotting parameters for plotting significant sensors.

0 commit comments

Comments
 (0)