Remove hardcoded value "BAD_blink" in _interpolate_blinks (#13531)

In order to have `_interpolate_blinks` and `_annotations_starts_stops`
don't have the same matching behaviour, we split
`_annotations_starts_stops` into two functions:

* one that does the grunt of the work using annotation indices
* another one that calls the former with annotations matching the
  argument.

Author: v01dxyz

mne/annotations.py

@@ -1244,14 +1244,25 @@ def _annotations_starts_stops(raw, kinds, name="skip_by_annotation", invert=Fals
         for kind in kinds:
             _validate_type(kind, "str", "All entries")
 
-    if len(raw.annotations) == 0:
+    idxs = [
+        idx
+        for idx, desc in enumerate(raw.annotations.description)
+        if any(desc.upper().startswith(kind.upper()) for kind in kinds)
+    ]
+    return _annotations_starts_stops_by_idxs(
+        raw,
+        idxs,
+        name,
+        invert,
+    )
+
+
+def _annotations_starts_stops_by_idxs(
+    raw, idxs, name="skip_by_annotation", invert=False
+):
+    if len(idxs) == 0 or 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)
-        ]
         # onsets are already sorted
         onsets = raw.annotations.onset[idxs]
         onsets = _sync_onset(raw, onsets)

mne/preprocessing/eyetracking/_pupillometry.py

@@ -5,7 +5,7 @@
 import numpy as np
 
 from ..._fiff.constants import FIFF
-from ...annotations import _annotations_starts_stops
+from ...annotations import _annotations_starts_stops_by_idxs
 from ...io import BaseRaw
 from ...utils import _check_preload, _validate_type, logger, warn
 
@@ -59,11 +59,17 @@ def interpolate_blinks(raw, buffer=0.05, match="BAD_blink", interpolate_gaze=Fal
         match = [match]
 
     # get the blink annotations
-    blink_annots = [annot for annot in raw.annotations if annot["description"] in match]
-    if not blink_annots:
+    blink_annots_idxs = [
+        idx
+        for idx, annot in enumerate(raw.annotations)
+        if annot["description"] in match
+    ]
+    if not blink_annots_idxs:
         warn(f"No annotations matching {match} found. Aborting.")
         return raw
-    _interpolate_blinks(raw, buffer, blink_annots, interpolate_gaze=interpolate_gaze)
+    _interpolate_blinks(
+        raw, buffer, blink_annots_idxs, interpolate_gaze=interpolate_gaze
+    )
 
     # remove bad from the annotation description
     for desc in match:
@@ -73,7 +79,7 @@ def interpolate_blinks(raw, buffer=0.05, match="BAD_blink", interpolate_gaze=Fal
     return raw
 
 
-def _interpolate_blinks(raw, buffer, blink_annots, interpolate_gaze):
+def _interpolate_blinks(raw, buffer, blink_annots_idxs, interpolate_gaze):
     """Interpolate eyetracking signals during blinks in-place."""
     logger.info("Interpolating missing data during blinks...")
     pre_buffer, post_buffer = buffer
@@ -88,10 +94,10 @@ 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_by_idxs(raw, blink_annots_idxs)
         starts = np.divide(starts, raw.info["sfreq"])
         ends = np.divide(ends, raw.info["sfreq"])
-        for annot, start, end in zip(blink_annots, starts, ends):
+        for annot, start, end in zip(raw.annotations[blink_annots_idxs], starts, ends):
             if "ch_names" not in annot or not annot["ch_names"]:
                 msg = f"Blink annotation missing values for 'ch_names' key: {annot}"
                 raise ValueError(msg)