Skip to content

Commit 5fb3668

Browse files
ecobostpre-commit-ci[bot]alejoe91
authored
Use sorting._recording (if available) in remove_excess_spikes (#4407)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Alessio Buccino <alejoe9187@gmail.com>
1 parent 484f5b7 commit 5fb3668

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

src/spikeinterface/curation/remove_excess_spikes.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def get_unit_spike_train(self, unit_id, start_frame: int | None = None, end_fram
8181
return spike_train[min_spike:max_spike]
8282

8383

84-
def remove_excess_spikes(sorting: BaseSorting, recording: BaseRecording):
84+
def remove_excess_spikes(sorting: BaseSorting, recording: BaseRecording | None = None):
8585
"""
8686
Remove excess spikes from the spike trains.
8787
Excess spikes are the ones exceeding a recording number of samples, for each segment.
@@ -90,14 +90,19 @@ def remove_excess_spikes(sorting: BaseSorting, recording: BaseRecording):
9090
----------
9191
sorting : BaseSorting
9292
The parent sorting.
93-
recording : BaseRecording
94-
The recording to use to get the number of samples.
93+
recording : BaseRecording | None. Default: None
94+
The recording to use to get the number of samples. If None, it uses the recording registered
95+
with the sorting object.
9596
9697
Returns
9798
-------
9899
sorting_without_excess_spikes : Sorting
99100
The sorting without any excess spikes.
100101
"""
102+
if recording is None:
103+
assert sorting.has_recording(), "If recording is not provided, sorting should have a registered recording"
104+
recording = sorting._recording
105+
101106
if has_exceeding_spikes(sorting=sorting, recording=recording):
102107
return RemoveExcessSpikesSorting(sorting=sorting, recording=recording)
103108
else:

0 commit comments

Comments
 (0)