mne.datasets.megsim.load_data

mne.datasets.megsim.load_data(condition='visual', data_format='raw', data_type='experimental', path=None, force_update=False, update_path=None, verbose=None)[source]

Get path to local copy of MEGSIM dataset type.

The MEGSIM dataset is described in [1].

Parameters
conditionstr

The condition to use. Either ‘visual’, ‘auditory’, or ‘somatosensory’.

data_formatstr

The data format. Either ‘raw’, ‘evoked’, or ‘single-trial’.

data_typestr

The type of data. Either ‘experimental’ or ‘simulation’.

pathNone | str

Location of where to look for the MEGSIM data storing location. If None, the environment variable or config parameter MNE_DATASETS_MEGSIM_PATH is used. If it doesn’t exist, the “~/mne_data” directory is used. If the MEGSIM dataset is not found under the given path, the data will be automatically downloaded to the specified folder.

force_updatebool

Force update of the dataset even if a local copy exists.

update_pathbool | None

If True, set the MNE_DATASETS_MEGSIM_PATH in mne-python config to the given path. If None, the user is prompted.

verbosebool, str, int, or None

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

Returns
pathslist

List of local data paths of the given type.

Notes

For example, one could do:

>>> from mne.datasets import megsim
>>> megsim.load_data('visual', 'raw', 'experimental', os.getenv('HOME') + '/datasets') # doctest:+SKIP

And this would download the raw visual experimental MEGSIM dataset to the ‘datasets’ folder, and prompt the user to save the ‘datasets’ path to the mne-python config, if it isn’t there already.

References

1

Aine CJ, Sanfratello L, Ranken D, Best E, MacArthur JA, Wallace T, Gilliam K, Donahue CH, Montano R, Bryant JE, Scott A, Stephen JM (2012) MEG-SIM: A Web Portal for Testing MEG Analysis Methods using Realistic Simulated and Empirical Data. Neuroinform 10:141-158