moabb.datasets.BI2014b#

class moabb.datasets.BI2014b(subjects=None, sessions=None, *, return_all_modalities=False)[source]#

Bases: BaseDataset

[source]

Dataset Snapshot

BI2014b

EEG recordings of 38 subjects playing in pairs to the multi-user version of Brain Invaders P300-based BCI. Contains three conditions: Solo1, Solo2, and Collaboration.

P300 / ERP, 2 classes (Target vs NonTarget)

AuthorsLouis Korczowski, Ekaterina Ostaschenko, Anton Andreev, Grégoire Cattan, Pedro Luiz Coelho Rodrigues, Violette Gautheret, Marco Congedo

🇫🇷 GIPSA-lab, CNRS, University Grenoble-Alpes, Grenoble INP, FR·2019
P300 / ERP Code: BrainInvaders2014b 38 subjects 1 session 32 ch 512 Hz 2 classes 1.0 s trials CC BY 4.0

Class Labels: Target, NonTarget

Read Paper Compare Similar Report Issue

Overview

P300 dataset BI2014b from a "Brain Invaders" experiment.

This dataset contains electroencephalographic (EEG) recordings of 38 subjects playing in pair (19 pairs) to the multi-user version of a visual P300-based Brain-Computer Interface (BCI) named Brain Invaders. The interface uses the oddball paradigm on a grid of 36 symbols (1 Target, 35 Non-Target) that are flashed pseudo-randomly to elicit a P300 response, an evoked-potential appearing about 300ms after stimulation onset. EEG data were recorded using 32 active wet electrodes per subjects (total: 64 electrodes) during three randomized conditions (Solo1, Solo2, Collaboration). The experiment took place at GIPSA-lab, Grenoble, France, in 2014. A full description of the experiment is available at The ID of this dataset is BI2014b.

:Investigators: Eng. Louis Korczowski, B. Sc. Ekaterina Ostaschenko :Technical Support: Eng. Anton Andreev, Eng. Grégoire Cattan, Eng. Pedro. L. C. Rodrigues, M. Sc. Violette Gautheret :Scientific Supervisor: Ph.D. Marco Congedo

Open in Overview tab →

Benchmark Context

WithinSession

Included in 1 MOABB benchmark table(s). Scores are across available pipelines (WithinSession accuracy).

Sample frame: 38 subjects × 1 sessions

  • ERP/P300 all classes 5 pipelinesMax 91.88 · Median 83.73 · Mean 84.45 · Std 7.15

Citation & Impact

Stimulus Protocol
../_images/BI2014b.svg

1s task window per trial · 2-class p300 / erp paradigm · 1 runs/session across 1 sessions

HED Event Tags
HED tags2/2 events annotated

Source: MOABB BIDS HED annotation mapping.

Experimental-stimulus
2
Sensory-event
2
Visual-presentation
2
Non-target
1
Target
1
Target
Sensory-eventExperimental-stimulusVisual-presentationTarget
NonTarget
Sensory-eventExperimental-stimulusVisual-presentationNon-target

HED tree view

Tree · Target
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Target
Tree · NonTarget
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Non-target
Channel Summary
Total channels32
EEG32 (wet electrodes)
Montagestandard_1010
Sampling512 Hz
Referenceright earlobe
Notch / line50 Hz

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

P300 dataset BI2014b from a “Brain Invaders” experiment.

This dataset contains electroencephalographic (EEG) recordings of 38 subjects playing in pair (19 pairs) to the multi-user version of a visual P300-based Brain-Computer Interface (BCI) named Brain Invaders. The interface uses the oddball paradigm on a grid of 36 symbols (1 Target, 35 Non-Target) that are flashed pseudo-randomly to elicit a P300 response, an evoked-potential appearing about 300ms after stimulation onset. EEG data were recorded using 32 active wet electrodes per subjects (total: 64 electrodes) during three randomized conditions (Solo1, Solo2, Collaboration). The experiment took place at GIPSA-lab, Grenoble, France, in 2014. A full description of the experiment is available at [1]. The ID of this dataset is BI2014b.

Investigators:

Eng. Louis Korczowski, B. Sc. Ekaterina Ostaschenko

Technical Support:

Eng. Anton Andreev, Eng. Grégoire Cattan, Eng. Pedro. L. C. Rodrigues, M. Sc. Violette Gautheret

Scientific Supervisor:

Ph.D. Marco Congedo

References

[1]

Korczowski, L., Ostaschenko, E., Andreev, A., Cattan, G., Rodrigues, P. L. C., Gautheret, V., & Congedo, M. (2019). Brain Invaders Solo versus Collaboration: Multi-User P300-Based Brain-Computer Interface Dataset (BI2014b). https://hal.archives-ouvertes.fr/hal-02173958

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

Dataset summary

#Subj

38

#Chan

32

#Trials / class

200 NT / 40 T

Trials length

1 s

Freq

512 Hz

#Sessions

3

Participants

  • Population: healthy

  • Age: 24.1 years

  • BCI experience: not naïve users - selected on the basis of their individual score during a preliminary session of Brain Invaders

Equipment

  • Amplifier: g.USBamp (g.tec, Schiedlberg, Austria)

  • Electrodes: wet electrodes

  • Montage: standard_1010

  • Reference: right earlobe

Preprocessing

  • Data state: raw EEG with no digital filter applied, synchronized experimental tags using USB analog-to-digital converter to reduce jitter

  • Notes: Experimental tags produced by Brain Invaders 2 were synchronized with EEG signals using USB analog-to-digital converter connected to g.USBamp trigger channel. This tagging procedure allows consistent tagging latency and jitter.

Data Access

Experimental Protocol

  • Paradigm: p300

  • Task type: oddball

  • Feedback: visual

  • Stimulus: visual flashes

Notes

Note

BI2014b was previously named bi2014b. bi2014b will be removed in version 1.1.

Added in version 0.4.6.

__init__(subjects=None, sessions=None, *, return_all_modalities=False)[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