Skip to content

Commit

Permalink
fix docs layout in sim_bursty_oscillation
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Feb 20, 2024
1 parent d33fff2 commit b3c17db
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions neurodsp/sim/periodic.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit b3c17db

Please sign in to comment.