Cleanup base sorting extractor (#3871)

* small cleanup

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix zarr test

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* another deprecation

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: Zach McKenzie <[email protected]>

Author: h-mayorquin

src/spikeinterface/core/base.py

@@ -16,7 +16,6 @@
 
 from .globals import get_global_tmp_folder, is_set_global_tmp_folder
 from .core_tools import (
-    is_path_remote,
     clean_zarr_folder_name,
     is_dict_extractor,
     SIJsonEncoder,
@@ -50,9 +49,6 @@ class BaseExtractor:
     # kwargs which can be precomputed before being used by the extractor
     _precomputable_kwarg_names = []
 
-    installation_mesg = ""
-    installed = True
-
     def __init__(self, main_ids: Sequence) -> None:
         # store init kwargs for nested serialisation
         self._kwargs = {}

src/spikeinterface/core/baserecording.py

@@ -764,7 +764,7 @@ def frame_slice(self, start_frame: int | None, end_frame: int | None) -> BaseRec
         sub_recording = FrameSliceRecording(self, start_frame=start_frame, end_frame=end_frame)
         return sub_recording
 
-    def time_slice(self, start_time: float | None, end_time: float) -> BaseRecording:
+    def time_slice(self, start_time: float | None, end_time: float | None) -> BaseRecording:
         """
         Returns a new recording object, restricted to the time interval [start_time, end_time].
 

src/spikeinterface/core/baserecordingsnippets.py

@@ -16,8 +16,6 @@ class BaseRecordingSnippets(BaseExtractor):
     Mixin that handles all probe and channel operations
     """
 
-    has_default_locations = False
-
     def __init__(self, sampling_frequency: float, channel_ids: list[str, int], dtype: np.dtype):
         BaseExtractor.__init__(self, channel_ids)
         self._sampling_frequency = float(sampling_frequency)

src/spikeinterface/core/basesorting.py

@@ -17,10 +17,10 @@ class BaseSorting(BaseExtractor):
     Abstract class representing several segment several units and relative spiketrains.
     """
 
-    def __init__(self, sampling_frequency: float, unit_ids: List):
+    def __init__(self, sampling_frequency: float, unit_ids: list):
         BaseExtractor.__init__(self, unit_ids)
         self._sampling_frequency = float(sampling_frequency)
-        self._sorting_segments: List[BaseSortingSegment] = []
+        self._sorting_segments: list[BaseSortingSegment] = []
         # this weak link is to handle times from a recording object
         self._recording = None
         self._sorting_info = None
@@ -212,7 +212,7 @@ def set_sorting_info(self, recording_dict, params_dict, log_dict):
         sorting_info = dict(recording=recording_dict, params=params_dict, log=log_dict)
         self.annotate(__sorting_info__=sorting_info)
 
-    def has_recording(self):
+    def has_recording(self) -> bool:
         return self._recording is not None
 
     def has_time_vector(self, segment_index=None) -> bool:
@@ -302,14 +302,6 @@ def get_unit_property(self, unit_id, key):
         v = values[self.id_to_index(unit_id)]
         return v
 
-    def get_total_num_spikes(self):
-        warnings.warn(
-            "Sorting.get_total_num_spikes() is deprecated and will be removed in spikeinterface 0.102, use sorting.count_num_spikes_per_unit()",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.count_num_spikes_per_unit(outputs="dict")
-
     def count_num_spikes_per_unit(self, outputs="dict"):
         """
         For each unit : get number of spikes  across segments.
@@ -451,12 +443,34 @@ def remove_empty_units(self):
         non_empty_units = self.get_non_empty_unit_ids()
         return self.select_units(non_empty_units)
 
-    def get_non_empty_unit_ids(self):
+    def get_non_empty_unit_ids(self) -> np.ndarray:
+        """
+        Return the unit IDs that have at least one spike across all segments.
+
+        This method computes the number of spikes for each unit using
+        `count_num_spikes_per_unit` and filters out units with zero spikes.
+
+        Returns
+        -------
+        np.ndarray
+            Array of unit IDs (same dtype as self.unit_ids) for which at least one spike exists.
+        """
         num_spikes_per_unit = self.count_num_spikes_per_unit()
 
         return np.array([unit_id for unit_id in self.unit_ids if num_spikes_per_unit[unit_id] != 0])
 
-    def get_empty_unit_ids(self):
+    def get_empty_unit_ids(self) -> np.ndarray:
+        """
+        Return the unit IDs that have zero spikes across all segments.
+
+        This method returns the complement of `get_non_empty_unit_ids` with respect
+        to all unit IDs in the sorting.
+
+        Returns
+        -------
+        np.ndarray
+            Array of unit IDs (same dtype as self.unit_ids) for which no spikes exist.
+        """
         unit_ids = self.unit_ids
         empty_units = unit_ids[~np.isin(unit_ids, self.get_non_empty_unit_ids())]
         return empty_units
@@ -506,44 +520,6 @@ def time_to_sample_index(self, time, segment_index=0):
 
         return sample_index
 
-    def get_all_spike_trains(self, outputs="unit_id"):
-        """
-        Return all spike trains concatenated.
-        This is deprecated and will be removed in spikeinterface 0.102 use sorting.to_spike_vector() instead
-        """
-
-        warnings.warn(
-            "Sorting.get_all_spike_trains() will be deprecated. Sorting.to_spike_vector() instead",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
-        assert outputs in ("unit_id", "unit_index")
-        spikes = []
-        for segment_index in range(self.get_num_segments()):
-            spike_times = []
-            spike_labels = []
-            for i, unit_id in enumerate(self.unit_ids):
-                st = self.get_unit_spike_train(unit_id=unit_id, segment_index=segment_index)
-                spike_times.append(st)
-                if outputs == "unit_id":
-                    spike_labels.append(np.array([unit_id] * st.size))
-                elif outputs == "unit_index":
-                    spike_labels.append(np.zeros(st.size, dtype="int64") + i)
-
-            if len(spike_times) > 0:
-                spike_times = np.concatenate(spike_times)
-                spike_labels = np.concatenate(spike_labels)
-                order = np.argsort(spike_times)
-                spike_times = spike_times[order]
-                spike_labels = spike_labels[order]
-            else:
-                spike_times = np.array([], dtype=np.int64)
-                spike_labels = np.array([], dtype=np.int64)
-
-            spikes.append((spike_times, spike_labels))
-        return spikes
-
     def precompute_spike_trains(self, from_spike_vector=None):
         """
         Pre-computes and caches all spike trains for this sorting

src/spikeinterface/core/tests/test_basesorting.py

@@ -94,8 +94,6 @@ def test_BaseSorting(create_cache_folder):
     sorting4 = sorting.save(format="memory")
     check_sortings_equal(sorting, sorting4, check_annotations=True, check_properties=True)
 
-    with pytest.warns(DeprecationWarning):
-        num_spikes = sorting.get_all_spike_trains()
     # print(spikes)
 
     spikes = sorting.to_spike_vector()
@@ -198,12 +196,6 @@ def test_empty_sorting():
 
     assert len(sorting.unit_ids) == 0
 
-    with pytest.warns(DeprecationWarning):
-        spikes = sorting.get_all_spike_trains()
-        assert len(spikes) == 1
-        assert len(spikes[0][0]) == 0
-        assert len(spikes[0][1]) == 0
-
     spikes = sorting.to_spike_vector()
     assert spikes.shape == (0,)
 

src/spikeinterface/core/zarrextractors.py

@@ -382,7 +382,6 @@ def get_default_zarr_compressor(clevel: int = 5):
     Blosc.compressor
         The compressor object that can be used with the save to zarr function
     """
-    assert ZarrRecordingExtractor.installed, ZarrRecordingExtractor.installation_mesg
     from numcodecs import Blosc
 
     return Blosc(cname="zstd", clevel=clevel, shuffle=Blosc.BITSHUFFLE)

src/spikeinterface/extractors/tridesclousextractors.py

@@ -30,7 +30,6 @@ def __init__(self, folder_path, chan_grp=None):
         except ImportError:
             raise ImportError(self.installation_mesg)
 
-        assert self.installed, self.installation_mesg
         tdc_folder = Path(folder_path)
 
         dataio = tdc.DataIO(str(tdc_folder))

src/spikeinterface/postprocessing/tests/test_principal_component.py

@@ -100,7 +100,7 @@ def test_get_projections(self, sparse):
         some_channel_ids = sorting_analyzer.channel_ids[::2]
 
         random_spikes_indices = sorting_analyzer.get_extension("random_spikes").get_data()
-        all_num_spikes = sorting_analyzer.sorting.get_total_num_spikes()
+        all_num_spikes = sorting_analyzer.sorting.count_num_spikes_per_unit()
         unit_ids_num_spikes = np.sum(all_num_spikes[unit_id] for unit_id in some_unit_ids)
 
         # this should be all spikes all channels