moabb.datasets.Lioi2020_XP2#

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

Bases: OpenNeuroMirrorMixin, BaseBIDSDataset

[source]

Dataset Snapshot

Lioi2020_XP2

Imagery, 2 classes (rest vs right_hand)

AuthorsGiulia Lioi, Claire Cury, Lorraine Perronnet, Marsel Mano, Elise Bannier, Anatole Lecuyer, Christian Barillot

🇫🇷 Univ Rennes, Inria, CNRS, Inserm, IRISA, FR·2020
Imagery Code: Lioi2020-XP2 17 subjects 1 session 64 ch (63 EEG) 5000 Hz 2 classes 20.0 s trials

Class Labels: rest, right_hand

Read Paper Compare Similar Report Issue

Overview

Right-hand motor imagery EEG-fMRI neurofeedback dataset (XP2)

EEG recorded inside an MR scanner (fMRI is not loaded) from 17 healthy subjects (9 males, 8 females, 26-66 years) in 20 s rest / right-hand kinesthetic MI blocks Each subject has five runs: MIpre, three neurofeedback runs (1dNF or 2dNF) and MIpost; the data paper gives 5 min 20 s (8 rest + 8 task blocks) for MIpre and each NF run and does not state the MIpost duration. Task-MI and Task-NF blocks both map to right_hand and Rest to rest. The ECG channel is typed ecg and dropped unless return_all_modalities=True. Ragged rows in the released events.tsv files are normalised before mne-bids reads them.

:param imagery_only: If True, expose only the MIpre and MIpost runs (no feedback). :type imagery_only: bool

Open in Overview tab →

Citation & Impact

Stimulus Protocol
../_images/Lioi2020_XP2.svg

20s task window per trial · 2-class imagery paradigm · 5 runs/session across 1 sessions

HED Event Tags
HED tags2/2 events annotated

Source: MOABB BIDS HED annotation mapping.

Sensory-event
2
Agent-action
1
Experimental-stimulus
1
Rest
1
Visual-presentation
1
rest
Sensory-eventExperimental-stimulusVisual-presentationRest
right_hand
Sensory-eventAgent-action

HED tree view

Tree · rest
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Rest
Tree · right_hand
├─ Sensory-event
│  ├─ Experimental-stimulus
│  └─ Visual-presentation
└─ Agent-action
   └─ Imagine
      ├─ Move
      └─ Right
         └─ Hand
Channel Summary
Total channels64
EEG63
ECG1
Montage10-05
Sampling5000 Hz
ReferenceFCz
Notch / line50 Hz

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

Right-hand motor imagery EEG-fMRI neurofeedback dataset (XP2) [1].

EEG recorded inside an MR scanner (fMRI is not loaded) from 17 healthy subjects (9 males, 8 females, 26-66 years) in 20 s rest / right-hand kinesthetic MI blocks [2]. Each subject has five runs: MIpre, three neurofeedback runs (1dNF or 2dNF) and MIpost; the data paper gives 5 min 20 s (8 rest + 8 task blocks) for MIpre and each NF run and does not state the MIpost duration. Task-MI and Task-NF blocks both map to right_hand and Rest to rest. The ECG channel is typed ecg and dropped unless return_all_modalities=True. Ragged rows in the released events.tsv files are normalised before mne-bids reads them.

Note

The data paper’s XP2 paragraph says the 1d group imagined moving their left hand, but its calibration, EEG feature (Laplacian around C3, left motor cortex ROI) and source results (“sensory-motor cortex of the right upper limb”) all describe right-hand imagery, as in XP1; the loader labels every task block right_hand.

param imagery_only:

If True, expose only the MIpre and MIpost runs (no feedback).

type imagery_only:

bool

References

[1]

Lioi, G., Cury, C., Perronnet, L., Mano, M., Bannier, E., Lecuyer, A., & Barillot, C. (2020). Simultaneous EEG-fMRI during a neurofeedback task, a brain imaging dataset for multimodal data integration. Scientific Data, 7, 173. https://doi.org/10.1038/s41597-020-0498-3

[2]

Perronnet, L., Lecuyer, A., Mano, M., Bannier, E., Lotte, F., Clerc, M., & Barillot, C. (2017). Unimodal versus bimodal EEG-fMRI neurofeedback of a motor imagery task. Frontiers in Human Neuroscience, 11, 193.

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

Dataset summary

#Subj

17

#Chan

63

#Classes

2

#Trials / class

40

Trials length

20 s

Freq

5000 Hz

#Sessions

1

#Runs

5

Total_trials

1360

Participants

  • Population: healthy

Equipment

  • Amplifier: BrainProducts BrainAmp MR plus

  • Montage: standard_1005

  • Reference: FCz

Data Access

Experimental Protocol

  • Paradigm: imagery

  • Feedback: EEG-fMRI

  • Stimulus: visual

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

Notes

Use CacheConfig to configure caching for get_data(). Use moabb.datasets.bids_interface.get_bids_root to get the BIDS root path.

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.

When the dataset declares a nemar_id and the download provider is not "upstream", the files come from NEMAR’s sourcedata/ – the original pre-BIDS distribution, byte-identical to what the upstream host serves. On any NEMAR failure this falls back to the dataset’s own downloader with a warning (unless the provider is pinned to "nemar"). See sourcedata_path() and moabb.set_download_provider().

Parameters:

  • subject_list (list of int | None) – List of subjects id to download, if None all subjects are downloaded. On the NEMAR path each subject is resolved through the deposit’s sourcedata_provenance.json; deposits enriched before that manifest recorded subjects fetch the whole tree.

  • 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. Not used on the NEMAR path.

  • accept (bool) – Accept licence term to download the data, if any. Default: False. Only relevant to the dataset’s own downloader; NEMAR mirrors are already public.

  • 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)[source]#

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

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 | pandas.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

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, n_jobs=1)[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 (sklearn.pipeline.Pipeline | None) – Optional processing pipeline to apply to the data. To generate an adequate pipeline, we recommend using moabb.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.

  • n_jobs (int) – Number of jobs to run in parallel over subjects (passed to joblib.Parallel). Default 1 (sequential). Per-subject processing (reading, filtering, resampling, epoching) is independent, so this gives a near-linear speedup for datasets with many subjects.

Returns:

data – dict containing the raw data

Return type:

Dict

property metadata[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
sourcedata_path(subject=None, path=None, force_update=False, verbose=None)[source]#

Get the dataset’s original pre-BIDS distribution from NEMAR.

Where data_path() fetches the original files from the upstream host, this fetches the copy NEMAR mirrors under sourcedata/. The files keep their upstream names, so the two are interchangeable in content – but NEMAR stays reachable when the upstream host is slow, rate-limited, behind a bot gate, or retired.

Parameters:

  • subject (int | str | None) – Restrict the download to one subject, resolved through the deposit’s sourcedata_provenance.json. Deposits enriched before that manifest recorded subjects fall back to the whole tree with a warning. When None the whole tree is fetched.

  • path (None | str) – Base path where MOABB stores datasets.

  • force_update (bool) – Re-fetch even when a local copy is present.

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

Returns:

Local path to the sourcedata directory.

Return type:

str

Raises:

  • ValueError – If the dataset declares no nemar_id.

  • moabb.datasets.download.NemarDownloadError – If the download fails or the deposit publishes no sourcedata/.