mne.datasets.refmeg_noise.data_path#

mne.datasets.refmeg_noise.data_path(path=None, force_update=False, update_path=True, download=True, *, verbose=None)[source]#

Get path to local copy of refmeg_noise dataset.

Parameters
pathNone | str

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

force_updatebool

Force update of the refmeg_noise dataset even if a local copy exists. Default is False.

update_pathbool | None

If True (default), set the MNE_DATASETS_REFMEG_NOISE_PATH in mne-python config to the given path. If None, the user is prompted.

downloadbool

If False and the refmeg_noise dataset has not been downloaded yet, it will not be downloaded and the path will be returned as ‘’ (empty string). This is mostly used for debugging purposes and can be safely ignored by most users.

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns
pathinstance of pathlib.Path

Path to refmeg_noise dataset directory.

Examples using mne.datasets.refmeg_noise.data_path#

Find MEG reference channel artifacts

Find MEG reference channel artifacts

Find MEG reference channel artifacts