Skip to content

Commit 963616d

Browse files
committed
add doc note about simulating gaussians outside simulated freq range
1 parent 472ba27 commit 963616d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

fooof/synth.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,8 @@ def gen_power_spectrum(freq_range, background_params, gauss_params, nlv=0.005, f
199199
- If length of 2, the 'fixed' background is used, if length of 3, 'knee' is used.
200200
Gaussian Parameters:
201201
- Each gaussian description is a set of three values:
202-
- mean (CF), amplitude (Amp), and std (BW)
202+
- mean (Center Frequency), amplitude (Amplitude), and std (Bandwidth)
203+
- Make sure any center frequencies you request are within the simulated frequency range
203204
- The total number of parameters that need to be specified is number of peaks * 3
204205
- These can be specified in as all together in a flat list.
205206
- For example: [10, 1, 1, 20, 0.5, 1]
@@ -264,7 +265,8 @@ def gen_group_power_spectra(n_spectra, freq_range, background_params,
264265
- If length of 2, 'fixed' background is used, if length of 3, 'knee' is used.
265266
Gaussian Parameters:
266267
- Each gaussian description is a set of three values:
267-
- mean (CF), amplitude (Amp), and std (BW)
268+
- mean (Center Frequency), amplitude (Amplitude), and std (Bandwidth)
269+
- Make sure any center frequencies you request are within the simulated frequency range
268270
269271
Examples
270272
--------

0 commit comments

Comments
 (0)