mne.simulation.add_noise¶
-
mne.simulation.add_noise(inst, cov, iir_filter=None, random_state=None, verbose=None)[source]¶ Create noise as a multivariate Gaussian.
The spatial covariance of the noise is given from the cov matrix.
- Parameters
- instinstance of
Evoked,Epochs, orRaw Instance to which to add noise.
- covinstance of
Covariance The noise covariance.
- iir_filter
None| array_like IIR filter coefficients (denominator).
- random_state
None|int| instance ofRandomState If
random_stateis anint, it will be used as a seed forRandomState. IfNone, the seed will be obtained from the operating system (seeRandomStatefor details). Default isNone.- verbosebool,
str,int, orNone If not None, override default verbose level (see
mne.verbose()and Logging documentation for more). If used, it should be passed as a keyword-argument only.
- instinstance of
- Returns
Notes
Only channels in both
inst.info['ch_names']andcov['names']will have noise added to them.This function operates inplace on
inst.New in version 0.18.0.