Skip to content

add warning in the docstring for accumulate_spikes #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TomGeorge1234 merged 1 commit into from
Aug 22, 2026
Merged

add warning in the docstring for accumulate_spikes #135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/simpl/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,6 +512,11 @@ def accumulate_spikes(Y: np.ndarray, window: int) -> np.ndarray:
field *shapes* are unaffected, but their *amplitudes* should not be
interpreted as physical firing rates.

Also, spatial information and mutual information will be inflated
roughly by a factor of ``window``. To calculate the corrected
information, divide F by ``window`` before calling
``calculate_spatial_information`` or ``calculate_mutual_information``.

Parameters
----------
Y : np.ndarray, shape (T, N_neurons)
Expand Down
Loading