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, or Raw

Instance to which to add noise.

covinstance of Covariance

The noise covariance.

iir_filterNone | array_like

IIR filter coefficients (denominator).

random_stateNone | int | RandomState

To specify the random generator state.

verbosebool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns
instinstance of Evoked, Epochs, or Raw

The instance, modified to have additional noise.

Notes

Only channels in both inst.info['ch_names'] and cov['names'] will have noise added to them.

This function operates inplace on inst.

New in version 0.18.0.