moabb.datasets.fake.FakeDataset#

class moabb.datasets.fake.FakeDataset(event_list=('fake1', 'fake2', 'fake3'), n_sessions=2, n_runs=2, n_subjects=10, code='FakeDataset', paradigm='imagery', channels=('C3', 'Cz', 'C4'), seed=None, sfreq=128, duration=120, n_events=60, stim=True, annotations=False, subjects=None, sessions=None, *, return_all_modalities=False, **kwargs)[source]#

Bases: BaseDataset

[source]

Dataset Snapshot

FakeDataset

Motor Imagery, 3 classes (fake1 vs fake2 vs fake3)

Motor Imagery Code: FakeDataset-imagery-10-2--60-60--120-120--fake1-fake2-fake3--c3-cz-c4 10 subjects 2 sessions 3 classes 3.0 s trials

Class Labels: fake1, fake2, fake3

Compare Similar Report Issue

Overview

Fake Dataset for test purpose.

By default, the dataset has 2 sessions, 10 subjects, and 3 classes.

Open in Overview tab →
Stimulus Protocol
../_images/FakeDataset.svg

3s task window per trial · 3-class motor imagery paradigm

HED Event Tags
HED tags3/3 events annotated

Source: MOABB BIDS HED annotation mapping.

Label
3
Sensory-event
3
fake1
Sensory-eventLabel
fake2
Sensory-eventLabel
fake3
Sensory-eventLabel

HED tree view

Tree · fake1
├─ Sensory-event
└─ Label
Tree · fake2
├─ Sensory-event
└─ Label
Tree · fake3
├─ Sensory-event
└─ Label

This diagram is automatically generated from MOABB metadata. Please consult the original publication to confirm the experimental protocol details.

Fake Dataset for test purpose.

By default, the dataset has 2 sessions, 10 subjects, and 3 classes.

from moabb.datasets import FakeDataset
dataset = FakeDataset()
data = dataset.get_data(subjects=[1])
print(data[1])

Changed in version 0.4.3: Added annotations parameter.

param event_list:

List of event to generate, default: (“fake1”, “fake2”, “fake3”)

type event_list:

list or tuple of str

param n_sessions:

Number of session to generate

type n_sessions:

int, default 2

param n_runs:

Number of runs to generate

type n_runs:

int, default 2

param n_subjects:

Number of subject to generate

type n_subjects:

int, default 10

param paradigm:

Defines what sort of dataset this is. Allowed values are ‘p300’, ‘imagery’, and ‘ssvep’.

type paradigm:

str

param channels:

List of channels to generate, default (“C3”, “Cz”, “C4”)

type channels:

list or tuple of str

param duration:

Duration of each run in seconds. If float, same duration for all runs. If list, duration for each run.

type duration:

float or list of float

param n_events:

Number of events per run. If int, same number of events for all runs. If list, number of events for each run.

type n_events:

int or list of int

param stim:

If True, pass events through stim channel.

type stim:

bool

param annotations:

If True, pass events through Annotations.

type annotations:

bool

__init__(event_list=('fake1', 'fake2', 'fake3'), n_sessions=2, n_runs=2, n_subjects=10, code='FakeDataset', paradigm='imagery', channels=('C3', 'Cz', 'C4'), seed=None, sfreq=128, duration=120, n_events=60, stim=True, annotations=False, subjects=None, sessions=None, *, return_all_modalities=False, **kwargs)[source]#

Initialize function for the BaseDataset.

property all_subjects#

Full list of subjects available in this dataset (unfiltered).

convert_to_bids(path=None, subjects=None, overwrite=False, format='EDF', verbose=None, generate_figures=False)[source]#

Convert the dataset to BIDS format.

Saves the raw EEG data in a BIDS-compliant directory structure. Unlike the caching mechanism (see CacheConfig), the files produced here do not contain a processing-pipeline hash (desc-<hash>) in their names, making the output a clean, shareable BIDS dataset.

Parameters:

  • path (str | Path | None) – Directory under which the BIDS dataset will be written. If None the default MNE data directory is used (same default as the rest of MOABB).

  • subjects (list of int | None) – Subject numbers to convert. If None, all subjects in subject_list are converted.

  • overwrite (bool) – If True, existing BIDS files for a subject are removed before saving. Default is False.

  • format (str) – The file format for the raw EEG data. Supported values are "EDF" (default), "BrainVision", and "EEGLAB".

  • verbose (str | None) – Verbosity level forwarded to MNE/MNE-BIDS.

  • generate_figures (bool) – If True, generate interactive neural signature HTML figures in {bids_root}/derivatives/neural_signatures/. Requires plotly (pip install moabb[interactive]). Default is False.

Returns:

bids_root – Path to the root of the written BIDS dataset.

Return type:

pathlib.Path

Examples

>>> from moabb.datasets import AlexMI
>>> dataset = AlexMI()
>>> bids_root = dataset.convert_to_bids(path='/tmp/bids', subjects=[1])

See also

CacheConfig

Cache configuration for get_data().

moabb.datasets.bids_interface.get_bids_root

Return the BIDS root path.

Notes

Added in version 1.5.

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

download(subject_list=None, path=None, force_update=False, update_path=None, accept=False, verbose=None)[source]#

Download all data from the dataset.

This function is only useful to download all the dataset at once.

Parameters:

  • subject_list (list of int | None) – List of subjects id to download, if None all subjects are downloaded.

  • 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) – If True, set the MNE_DATASETS_(dataset)_PATH in mne-python config to the given path. If None, the user is prompted.

  • accept (bool) – Accept licence term to download the data, if any. Default: False

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

get_additional_metadata(subject: str, session: str, run: str) → None | DataFrame[source]#

Load additional metadata for a specific subject, session, and run.

This method is intended to be overridden by subclasses to provide additional metadata specific to the dataset. The metadata is typically loaded from an events.tsv file or similar data source.

Parameters:

  • subject (str) – The identifier for the subject.

  • session (str) – The identifier for the session.

  • run (str) – The identifier for the run.

Returns:

A DataFrame containing the additional metadata if available, otherwise None.

Return type:

None | pd.DataFrame

get_block_repetition(paradigm, subjects, block_list, repetition_list)[source]#

Select data for all provided subjects, blocks and repetitions.

subject -> session -> run -> block -> repetition

See also

BaseDataset.get_data

Parameters:

  • subjects (List of int) – List of subject number

  • block_list (List of int) – List of block number

  • repetition_list (List of int) – List of repetition number inside a block

Returns:

data – dict containing the raw data

Return type:

Dict

get_data(subjects=None, cache_config=None, process_pipeline=None)[source]#

Return the data corresponding to a list of subjects.

The returned data is a dictionary with the following structure:

data = {'subject_id' :
            {'session_id':
                {'run_id': run}
            }
        }

subjects are on top, then we have sessions, then runs. A sessions is a recording done in a single day, without removing the EEG cap. A session is constitued of at least one run. A run is a single contiguous recording. Some dataset break session in multiple runs.

Processing steps can optionally be applied to the data using the *_pipeline arguments. These pipelines are applied in the following order: raw_pipeline -> epochs_pipeline -> array_pipeline. If a *_pipeline argument is None, the step will be skipped. Therefore, the array_pipeline may either receive a mne.io.Raw or a mne.Epochs object as input depending on whether epochs_pipeline is None or not.

Parameters:

  • subjects (List of int) – List of subject number

  • cache_config (dict | CacheConfig) – Configuration for caching of datasets. See CacheConfig for details.

  • process_pipeline (Pipeline | None) – Optional processing pipeline to apply to the data. To generate an adequate pipeline, we recommend using moabb.utils.make_process_pipelines(). This pipeline will receive mne.io.BaseRaw objects. The steps names of this pipeline should be elements of StepType. According to their name, the steps should either return a mne.io.BaseRaw, a mne.Epochs, or a numpy.ndarray(). This pipeline must be “fixed” because it will not be trained, i.e. no call to fit will be made.

Returns:

data – dict containing the raw data

Return type:

Dict

property metadata: DatasetMetadata | None[source]#

Return structured metadata for this dataset.

Returns the DatasetMetadata object from the centralized catalog, or None if metadata is not available for this dataset.

Returns:

The metadata object containing acquisition parameters, participant demographics, experiment details, and documentation. Returns None if no metadata is registered for this dataset.

Return type:

DatasetMetadata | None

Examples

>>> from moabb.datasets import BNCI2014_001
>>> dataset = BNCI2014_001()
>>> dataset.metadata.participants.n_subjects
9
>>> dataset.metadata.acquisition.sampling_rate
250.0