To provide the most recent news and documentation www.pymvpa.org reflects the development 2.0 series (renamed 0.6 series) of PyMVPA. If you are interested in the documentation of the previous stable 0.4 series of PyMVPA, please visit v04.pymvpa.org.

mvpa2.misc.data_generators.autocorrelated_noise

mvpa2.misc.data_generators.autocorrelated_noise(ds, sr, cutoff, lfnl=3.0, bord=10, hfnl=None)

Generate a dataset with samples being temporally autocorrelated noise.

Parameters :

ds : Dataset

Source dataset whose mean samples serves as the pedestal of the new noise samples. All attributes of this dataset will also go into the generated one.

sr : float

Sampling rate (in Hz) of the samples in the dataset.

cutoff : float

Cutoff frequency of the low-pass butterworth filter.

bord : int

Order of the butterworth filter that is applied for low-pass filtering.

lfnl : float

Low frequency noise level in percent signal (per feature).

hfnl : float or None

High frequency noise level in percent signal (per feature). If None, no HF noise is added.