From 57651c6b344fa036e547d6e80846fd0967acb5a6 Mon Sep 17 00:00:00 2001 From: Masahiro Nakano Date: Fri, 21 Aug 2026 15:36:26 +0100 Subject: [PATCH] add warning in the docstring for accumulate_spikes --- src/simpl/utils.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/simpl/utils.py b/src/simpl/utils.py index 592f1df..f5ff11b 100644 --- a/src/simpl/utils.py +++ b/src/simpl/utils.py @@ -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)