Skip to content

[DOC] Improve trial_shifting parameter documentation #704

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

Open
CozySocksAlways wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[DOC] Improve trial_shifting parameter documentation #704

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ccdbe0
Extended trial_shifting dither param doc to mention direction of dither
CozySocksAlways Jun 17, 2026
9eb2438
Update trial_shifting to use uniform dither and clarify docs
CozySocksAlways Oct 22, 2026
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
10 changes: 7 additions & 3 deletions elephant/spike_train_surrogates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1213,7 +1213,9 @@ def trial_shifting(spiketrains, dither, n_surrogates=1):
A list of spike trains of the same neuron
where each element corresponds to one trial.
dither : pq.Quantity
Amount of dithering.
Amount of dithering. All spikes in a trial are shifted by the same
random amount, drawn uniformly from the interval
`[-dither, +dither]`.
n_surrogates : int, optional
Number of surrogates to be generated.
Default: 1
Expand Down Expand Up @@ -1263,7 +1265,7 @@ def _trial_shifting(spiketrains, dither, t_starts, t_stops, n_surrogates):
surrogate_spiketrain = []
# looping over all trials
for trial_id, single_trial_st in enumerate(copied_spiketrain):
single_trial_st += dither * (2 * random.random() - 1)
single_trial_st += random.uniform(-dither, dither)
Comment thread
CozySocksAlways marked this conversation as resolved.
Resolved
single_trial_st = np.remainder(
single_trial_st - t_starts[trial_id],
t_stops[trial_id] - t_starts[trial_id]
Expand Down Expand Up @@ -1292,7 +1294,9 @@ def _trial_shifting_of_concatenated_spiketrain(
spiketrain : neo.SpikeTrain
A single spike train, where the trials are concatenated.
dither : pq.Quantity
Amount of dithering.
Amount of dithering. All spikes in a trial are shifted by the same
random amount, drawn uniformly from the interval
`[-dither, +dither]`.
trial_length : pq.Quantity
The length of the single-trial spiketrain.
trial_separation : pq.Quantity
Expand Down
Loading