BUG: Fix bug with example (#13210)

Co-authored-by: Daniel McCloy <dan@mccloy.info>

Author: larsoner

examples/datasets/opm_data.py

@@ -149,6 +149,6 @@
     subjects_dir=subjects_dir,
     initial_time=dip_opm.times[idx],
     clim=dict(kind="percent", lims=[99, 99.9, 99.99]),
-    size=(400, 300),
+    size=(800, 600),
     background="w",
 )

mne/viz/_brain/_brain.py

@@ -531,9 +531,8 @@ def setup_time_viewer(self, time_viewer=True, show_traces=True):
         self.label_extract_mode = None
         all_keys = ("lh", "rh", "vol")
         self.act_data_smooth = {key: (None, None) for key in all_keys}
-        self.color_list = _get_color_list()
         # remove grey for better contrast on the brain
-        self.color_list.remove("#7f7f7f")
+        self.color_list = _get_color_list(remove=("#7f7f7f",))
         self.color_cycle = _ReuseCycle(self.color_list)
         self.mpl_canvas = None
         self.help_canvas = None

mne/viz/_figure.py

@@ -167,7 +167,8 @@ def _setup_annotation_colors(self):
         """Set up colors for annotations; init some annotation vars."""
         segment_colors = getattr(self.mne, "annotation_segment_colors", dict())
         labels = self._get_annotation_labels()
-        colors, red = _get_color_list(annotations=True)
+        red = "#ff0000"
+        colors = _get_color_list(remove=("#fa8174", "#d62728", "#ff0000"))
         color_cycle = cycle(colors)
         for key, color in segment_colors.items():
             if color != red and key in labels:

mne/viz/tests/test_raw.py

@@ -10,7 +10,7 @@
 import matplotlib.pyplot as plt
 import numpy as np
 import pytest
-from matplotlib import backend_bases
+from matplotlib import backend_bases, rc_context
 from numpy.testing import assert_allclose, assert_array_equal
 
 import mne
@@ -23,6 +23,7 @@
     _assert_no_instances,
     _dt_to_stamp,
     _record_warnings,
+    catch_logging,
     check_version,
     get_config,
     set_config,
@@ -49,6 +50,8 @@ def _get_button_xy(buttons, idx):
 
 def _annotation_helper(raw, browse_backend, events=False):
     """Test interactive annotations."""
+    from cycler import cycler  # dep of matplotlib, should be okay but nest just in case
+
     ismpl = browse_backend.name == "matplotlib"
     # Some of our checks here require modern mpl to work properly
     n_anns = len(raw.annotations)
@@ -60,7 +63,27 @@ def _annotation_helper(raw, browse_backend, events=False):
     else:
         events = None
         n_events = 0
-    fig = raw.plot(events=events)
+    # matplotlib 2.0 default cycler
+    default_cycler = cycler(
+        "color",
+        [
+            "#1f77b4",
+            "#ff7f0e",
+            "#2ca02c",
+            "#d62728",
+            "#9467bd",
+            "#8c564b",
+            "#e377c2",
+            "#7f7f7f",
+            "#bcbd22",
+            "#17becf",
+        ],
+    )  # noqa: E501
+    with catch_logging("debug") as log, rc_context({"axes.prop_cycle": default_cycler}):
+        fig = raw.plot(events=events)
+    log = log.getvalue()
+    assert "Removing from color cycle: #d62728" in log
+    assert log.count("Removing from color cycle") == 1
     if ismpl:
         assert browse_backend._get_n_figs() == 1
 

mne/viz/tests/test_utils.py

@@ -7,6 +7,8 @@
 import matplotlib.pyplot as plt
 import numpy as np
 import pytest
+from cycler import cycler
+from matplotlib import rc_context
 from numpy.testing import assert_allclose
 
 from mne import read_evokeds
@@ -46,10 +48,14 @@ def test_setup_vmin_vmax_warns():
 
 def test_get_color_list():
     """Test getting a colormap from rcParams."""
-    colors = _get_color_list()
-    assert isinstance(colors, list)
-    colors_no_red = _get_color_list(annotations=True)
-    assert "#ff0000" not in colors_no_red
+    with rc_context({"axes.prop_cycle": cycler(color=["#ff0000", "#00ff00"])}):
+        colors = _get_color_list()
+        assert isinstance(colors, list)
+        assert len(colors) == 2
+        assert "#ff0000" in colors
+        colors_no_red = _get_color_list(remove=("#ff0000",))
+        assert "#ff0000" not in colors_no_red
+        assert len(colors_no_red) == 1
 
 
 def test_mne_analyze_colormap():

mne/viz/utils.py

@@ -1773,33 +1773,33 @@ def disconnect(self):
         self.canvas.draw_idle()
 
 
-def _get_color_list(annotations=False):
+def _get_color_list(*, remove=None):
     """Get the current color list from matplotlib rcParams.
 
     Parameters
     ----------
-    annotations : boolean
-        Has no influence on the function if false. If true, check if color
-        "red" (#ff0000) is in the cycle and remove it.
+    remove : tuple of str | None
+        Has no influence on the function if None. Can be a list of colors to
+        remove from the list if within 1/255 of the color.
 
     Returns
     -------
     colors : list
     """
     from matplotlib import rcParams
+    from matplotlib.colors import to_rgba_array
 
     color_cycle = rcParams.get("axes.prop_cycle")
     colors = color_cycle.by_key()["color"]
 
-    # If we want annotations, red is reserved ... remove if present. This
-    # checks for the reddish color in MPL dark background style, normal style,
-    # and MPL "red", and defaults to the last of those if none are present
-    for red in ("#fa8174", "#d62728", "#ff0000"):
-        if annotations and red in colors:
-            colors.remove(red)
-            break
-
-    return (colors, red) if annotations else colors
+    colors_cast = to_rgba_array(colors)[:, :3]
+    atol = 1.5 / 255.0
+    for rem in to_rgba_array(remove or [])[:, :3]:
+        matches = np.where(np.isclose(colors_cast, rem, atol=atol).all(-1))[0][::-1]
+        for idx in matches:
+            logger.debug(f"Removing from color cycle: {colors[idx]}")
+            colors.pop(idx)
+    return colors
 
 
 def _merge_annotations(start, stop, description, annotations, current=()):