Update src/spikeinterface/core/sorting_tools.py

SpikeInterface · Jun 21, 2024 · c1c9f1f · c1c9f1f
1 parent 6abb74b
commit c1c9f1f
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/src/spikeinterface/core/sorting_tools.py b/src/spikeinterface/core/sorting_tools.py
@@ -62,10 +62,9 @@ def spike_vector_to_indices(spike_vector: list[np.array], unit_ids: np.array, ab
     unit_ids: np.array
         Unit ids
     absolute_index: bool, default False
-        Give spike indices absolut usefull when having a unique spike vector
-        or relative to segment usefull with a list of spike vectors
-        When a unique spike vectors (or amplitudes) is used then absolute_index should be True.
-        When a list of spikes (or amplitudes) is used then absolute_index should be False.
+        It True, return absolute spike indices, else spike indices are relative to the segment.
+        When a unique spike vector is used,  then absolute_index should be True.
+        When a list of spikes per segment is used, then absolute_index should be False.
 
     Returns
     -------