Rename Epochs.reset_drop_log_selection() to Epochs.reset_index() (#13675)

Author: cbrnr

doc/changes/dev/13675.other.rst

@@ -0,0 +1 @@
+Add :meth:`mne.Epochs.reset_index`, which replaces the legacy :meth:`mne.Epochs.reset_drop_log_selection` (the new name better reflects the method's purpose), by `Clemens Brunner`_.

mne/epochs.py

@@ -97,6 +97,7 @@
     check_fname,
     check_random_state,
     copy_function_doc_to_method_doc,
+    legacy,
     logger,
     object_size,
     repr_html,
@@ -702,6 +703,7 @@ def _check_consistency(self):
         assert all(isinstance(log, tuple) for log in self.drop_log)
         assert all(isinstance(s, str) for log in self.drop_log for s in log)
 
+    @legacy(alt="mne.Epochs.reset_index()")
     def reset_drop_log_selection(self):
         """Reset the drop_log and selection entries.
 
@@ -711,6 +713,17 @@ def reset_drop_log_selection(self):
         many Epochs instances, as ``drop_log`` can accumulate many entries
         which can become problematic when saving.
         """
+        self.reset_index()
+
+    def reset_index(self):
+        """Reset the epochs index.
+
+        This resets the epochs indexing and drop log so that ``self.selection`` becomes
+        a simple increasing sequence starting at zero and ``self.drop_log`` becomes a
+        tuple of empty tuples of the same length. The operation is in-place and is
+        useful when creating epochs from a subset of events (using ``event_id``) and the
+        original event indexes are not relevant anymore.
+        """
         self.selection = np.arange(len(self.events))
         self.drop_log = (tuple(),) * len(self.events)
         self._check_consistency()