Skip to content

Commit

Permalink
Minor tidy ups.
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeZiminski committed May 21, 2024
1 parent 889606a commit 5512a05
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/spikeinterface/postprocessing/amplitude_scalings.py
Original file line number Diff line number Diff line change
Expand Up @@ -408,9 +408,8 @@ def find_collisions(spikes, spikes_within_margin, delta_collision_samples, spars
"""
Finds the collisions between spikes.
Given an array of information on spikes extracted from all units,
find the 'spike collisions' - incidents where two spikes from different
units overlap temporally and spatially.
Given an array of spikes extracted from all units, find the 'spike collisions'
- incidents where two spikes from different units overlap temporally and spatially.
First for each spike, find all other spikes that temporally overlap the spike.
Temporal overlap is defined as another spike peak occurring within a time window around
Expand All @@ -420,7 +419,8 @@ def find_collisions(spikes, spikes_within_margin, delta_collision_samples, spars
Parameters
----------
spikes: np.array
An array of spikes (sample_index, channel_index, amplitude, segment_index, unit_index, in_margin)
An array of spikes, where spikes are represented by their:
(sample_index, channel_index, amplitude, segment_index, unit_index, in_margin)
spikes_within_margin: np.array
An array of spikes whose peaks are close to another spike, within a given margin
delta_collision_samples: int
Expand Down Expand Up @@ -588,7 +588,7 @@ def fit_collision(
### Debugging ###
def _plot_collisions(we, sparsity=None, num_collisions=None):
"""
Plot the fitting of collision spikes.
Plot the fitting of collision spikes for debugging.
----------
Parameters
Expand Down

0 comments on commit 5512a05

Please sign in to comment.