Skip to content

Commit

Permalink
Add formula to correlogram docstring description.
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeZiminski committed Jul 2, 2024
1 parent b1392ed commit 2741273
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/spikeinterface/postprocessing/correlograms.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,12 @@ class ComputeCorrelograms(AnalyzerExtension):
-------
correlogram : np.array
Correlograms with shape (num_units, num_units, num_bins)
The diagonal of correlogram is the auto correlogram. The output
is in bin counts.
correlogram[A, B, :] is the symmetry of correlogram[B, A, :]
correlogram[A, B, :] have to be read as the histogram of spiketimesA - spiketimesB
The diagonal of the correlogram (e.g. correlogram[A, A, :])
holds the unit auto correlograms. The off-diagonal elements
are the cross-correlograms between units, where correlogram[A, B, :]
and correlogram[B, A, :] represent cross-correlation between
the same pair of units, applied in opposite directions,
correlogram[A, B, :] = correlogram[B, A, ::-1].
bins : np.array
The bin edges in ms
Expand Down

0 comments on commit 2741273

Please sign in to comment.