Remove hardcoded value "BAD_blinks" in interpolate_blink (#13531)

The previous behaviour is faulty as there is no reason to think
`blink_annots` are "BAD_blinks"-prefixed.

Add an argument to `_annotations_starts_stops` to allow matching
exactly instead of being prefix.

Author: v01dxyz

doc/changes/dev/13740.bugfix.txt

@@ -0,0 +1 @@
+Fix bug where :func:`mne.preprocessing.eyetracking.interpolate_blinks` was overriding the user-passed ``match`` argument with the value ``"BAD_blink"``, by :newcontrib:`Robert Dazi`

doc/changes/names.inc

@@ -277,6 +277,7 @@
 .. _Richard Scholz: https://github.com/scholzri
 .. _Riessarius Stargardsky: https://github.com/Riessarius
 .. _Roan LaPlante: https://github.com/aestrivex
+.. _Robert Dazi: https://github.com/v01dxyz
 .. _Robert Luke: https://github.com/rob-luke
 .. _Robert Seymour: https://neurofractal.github.io
 .. _Romain Derollepot: https://github.com/rderollepot

mne/annotations.py

@@ -1232,9 +1232,15 @@ def _sync_onset(raw, onset, inverse=False):
     return annot_start
 
 
-def _annotations_starts_stops(raw, kinds, name="skip_by_annotation", invert=False):
+def _annotations_starts_stops(
+    raw, kinds, name="skip_by_annotation", invert=False, exact_match=False
+):
     """Get starts and stops from given kinds.
 
+    It picks an annotation if its description starts with one element
+    of kinds, unless exact_match=True then if it is equal to one of
+    them.
+
     onsets and ends are inclusive.
     """
     _validate_type(kinds, (str, list, tuple), name)
@@ -1247,11 +1253,18 @@ def _annotations_starts_stops(raw, kinds, name="skip_by_annotation", invert=Fals
     if len(raw.annotations) == 0:
         onsets, ends = np.array([], int), np.array([], int)
     else:
-        idxs = [
-            idx
-            for idx, desc in enumerate(raw.annotations.description)
-            if any(desc.upper().startswith(kind.upper()) for kind in kinds)
-        ]
+        if exact_match:
+            idxs = [
+                idx
+                for idx, desc in enumerate(raw.annotations.description)
+                if desc in kinds
+            ]
+        else:
+            idxs = [
+                idx
+                for idx, desc in enumerate(raw.annotations.description)
+                if any(desc.upper().startswith(kind.upper()) for kind in kinds)
+            ]
         # onsets are already sorted
         onsets = raw.annotations.onset[idxs]
         onsets = _sync_onset(raw, onsets)

mne/preprocessing/eyetracking/_pupillometry.py

@@ -88,7 +88,11 @@ def _interpolate_blinks(raw, buffer, blink_annots, interpolate_gaze):
                 continue
         # Create an empty boolean mask
         mask = np.zeros_like(raw.times, dtype=bool)
-        starts, ends = _annotations_starts_stops(raw, "BAD_blink")
+        starts, ends = _annotations_starts_stops(
+            raw,
+            list({annot["description"] for annot in blink_annots}),
+            exact_match=True,
+        )
         starts = np.divide(starts, raw.info["sfreq"])
         ends = np.divide(ends, raw.info["sfreq"])
         for annot, start, end in zip(blink_annots, starts, ends):

mne/preprocessing/eyetracking/tests/test_pupillometry.py

@@ -35,7 +35,7 @@ def test_interpolate_bad_blinks(
     raw = read_raw_eyelink(fname, create_annotations=["blinks"], find_overlaps=True)
 
     # read_raw_eyelink prefixes any blink description with "BAD_" but we want to
-    # test interpolate_blinks do not depend on this convention
+    # test interpolate_blinks does not depend on this convention
     if description_prefix != "BAD_":
         blink_description = f"{description_prefix}blink"
         raw.annotations.rename({"BAD_blink": blink_description})