moabb.datasets.base.BaseBIDSDataset#

class moabb.datasets.base.BaseBIDSDataset(subjects, sessions_per_subject, events, code, interval, paradigm, doi=None, unit_factor=1000000.0)[source]#

Abstract BIDS dataset class.

This abstract class can be used to facilitate the integration of datasets which are provided in the Brain Imaging Data Structure (BIDS) format into MOABB.

More information about BIDS can be found at https://bids.neuroimaging.io/.

The method _download_subject must be implemented in each subclass (see its docstring for more details).

If necessary, the methods _get_path_search_params and _get_read_extra_params can be implemented in the subclass.

data_path(subject, path=None, force_update=False, update_path=None, verbose=None)[source]#

Get path to local copy of a subject data.

Parameters:

  • subject (int) – Number of subject to use

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

  • force_update (bool) – Force update of the dataset even if a local copy exists.

  • update_path (bool | None Deprecated) – If True, set the MNE_DATASETS_(dataset)_PATH in mne-python config to the given path. If None, the user is prompted.

  • verbose (bool, str, int, or None) – If not None, override default verbose level (see mne.verbose()).

Returns:

path – Local path to the given data file. This path is contained inside a list of length one, for compatibility.

Return type:

list of str