From b3c17db3c6b34f66ef198b41b84fc105a53940a9 Mon Sep 17 00:00:00 2001 From: Tom Donoghue Date: Tue, 20 Feb 2024 15:46:06 -0500 Subject: [PATCH] fix docs layout in sim_bursty_oscillation --- neurodsp/sim/periodic.py | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/neurodsp/sim/periodic.py b/neurodsp/sim/periodic.py index 14d6ba43..42efc9c2 100644 --- a/neurodsp/sim/periodic.py +++ b/neurodsp/sim/periodic.py @@ -92,19 +92,18 @@ def sim_bursty_oscillation(n_seconds, fs, freq, burst_def='prob', burst_params=N burst_params : dict Parameters for the burst definition approach. - For the `prob` approach: + | For the `prob` approach, should contain the following keys and values: + | enter_burst : float, optional, default: 0.2 + | Probability of a cycle being oscillating given the last cycle is not oscillating. + | leave_burst : float, optional, default: 0.2 + | Probability of a cycle not being oscillating given the last cycle is oscillating. + | + | For the `durations` approach, should contain the following keys and values: + | n_cycles_burst : int + | The number of cycles within each burst. + | n_cycles_off : int + | The number of non-bursting cycles, between bursts. - enter_burst : float, optional, default: 0.2 - Probability of a cycle being oscillating given the last cycle is not oscillating. - leave_burst : float, optional, default: 0.2 - Probability of a cycle not being oscillating given the last cycle is oscillating. - - For the `durations` approach: - - n_cycles_burst : int - The number of cycles within each burst. - n_cycles_off - The number of non-bursting cycles, between bursts. cycle : {'sine', 'asine', 'sawtooth', 'gaussian', 'exp', '2exp', 'exp_cos', 'asym_harmonic'} What type of oscillation cycle to simulate. See `sim_cycle` for details on cycle types and parameters.