BUGFIX: return events if provided when current = desired sfreq (#13070)

Co-authored-by: Eric Larson <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Daniel McCloy <[email protected]>
mne-tools · Jan 24, 2025 · 7daecee · 7daecee
1 parent aca4965
commit 7daecee
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/doc/changes/devel/13070.bugfix.rst b/doc/changes/devel/13070.bugfix.rst
@@ -0,0 +1 @@
+Return events when requested even when current matches the desired sfreq in :meth:`mne.io.Raw.resample` by :newcontrib:`Roy Eric Wieske`.
diff --git a/doc/changes/names.inc b/doc/changes/names.inc
@@ -258,6 +258,7 @@
 .. _Roman Goj: https://romanmne.blogspot.co.uk
 .. _Ross Maddox: https://www.urmc.rochester.edu/labs/maddox-lab.aspx
 .. _Rotem Falach: https://github.com/Falach
+.. _Roy Eric Wieske: https://github.com/Randomidous
 .. _Sammi Chekroud: https://github.com/schekroud
 .. _Samu Taulu: https://phys.washington.edu/people/samu-taulu
 .. _Samuel Deslauriers-Gauthier: https://github.com/sdeslauriers

diff --git a/mne/io/base.py b/mne/io/base.py
@@ -1386,7 +1386,10 @@ def resample(
         sfreq = float(sfreq)
         o_sfreq = float(self.info["sfreq"])
         if _check_resamp_noop(sfreq, o_sfreq):
-            return self
+            if events is not None:
+                return self, events.copy()
+            else:
+                return self
 
         # When no event object is supplied, some basic detection of dropped
         # events is performed to generate a warning. Finding events can fail

diff --git a/mne/io/fiff/tests/test_raw_fiff.py b/mne/io/fiff/tests/test_raw_fiff.py
@@ -23,6 +23,7 @@
     concatenate_events,
     create_info,
     equalize_channels,
+    events_from_annotations,
     find_events,
     make_fixed_length_epochs,
     pick_channels,
@@ -1318,6 +1319,15 @@ def test_crop():
     assert raw.n_times - 1 == raw3.n_times
 
 
+@testing.requires_testing_data
+def test_resample_with_events():
+    """Test resampling raws with events."""
+    raw = read_raw_fif(fif_fname)
+    raw.resample(250)  # pretend raw is recorded at 250 Hz
+    events, _ = events_from_annotations(raw)
+    raw, events = raw.resample(250, events=events)
+
+
 @testing.requires_testing_data
 def test_resample_equiv():
     """Test resample (with I/O and multiple files)."""
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Return events when requested even when current matches the desired sfreq in :meth:`mne.io.Raw.resample` by :newcontrib:`Roy Eric Wieske`.