moabb.datasets.Rozado2015#

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

Bases: BaseDataset

[source]

Dataset Snapshot

Rozado2015

Motor Imagery, 2 classes (left_hand vs rest)

AuthorsDavid Rozado, Andreas Duenser, Ben Howell

🇦🇺 CSIRO, AU·2015
Motor Imagery Code: Rozado2015 30 subjects 1 session 32 ch 512 Hz 2 classes 6.0 s trials CC0 1.0

Class Labels: left_hand, rest

Read Paper Compare Similar Report Issue

Overview

Motor imagery BCI dataset with pupillometry augmentation.

Dataset from

This dataset contains 32-channel EEG recorded from 30 healthy subjects (15 female, 15 male, ages 15-61, mean 38) using a BioSemi ActiveTwo system at 512 Hz. The experiment investigates a two-class motor imagery BCI (left hand grasping vs. rest) augmented with pupil diameter measurements.

Each subject performed 1 session with 2 experiments of 25 trials each (50 trials total, ~25 per class). Each experiment is loaded as a separate run.

Trial structure (12 s total):

  • - 0 s: auditory cue ("Left" or "Nothing")
  • 0-6 s: motor imagery or rest period
  • 6 s: auditory stop cue ("Stop")
  • 6-12 s: micro-break

Data is stored as XDF (eXtensible Data Format) files inside two RAR archives on Harvard Dataverse. Loading requires the pyxdf library (install with pip install moabb[xdf]) and a RAR extraction tool (unar, unrar, or 7z).

27 subjects were right-handed, 3 were left-handed.

Open in Overview tab →

Citation & Impact

Stimulus Protocol
../_images/Rozado2015.svg

6s task window per trial · 2-class motor imagery paradigm · 2 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
left_hand
Sensory-eventAgent-action
rest
Sensory-eventExperimental-stimulusVisual-presentationRest

HED tree view

Tree · left_hand
├─ Sensory-event
│  ├─ Experimental-stimulus
│  └─ Visual-presentation
└─ Agent-action
   └─ Imagine
      ├─ Move
      └─ Left
         └─ Hand
Tree · rest
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Rest
Channel Summary
Total channels32
EEG32 (active)
Montagebiosemi32
Sampling512 Hz
ReferenceCMS/DRL
Notch / line50 Hz

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

Motor imagery BCI dataset with pupillometry augmentation.

Dataset from [1].

This dataset contains 32-channel EEG recorded from 30 healthy subjects (15 female, 15 male, ages 15-61, mean 38) using a BioSemi ActiveTwo system at 512 Hz. The experiment investigates a two-class motor imagery BCI (left hand grasping vs. rest) augmented with pupil diameter measurements.

Each subject performed 1 session with 2 experiments of 25 trials each (50 trials total, ~25 per class). Each experiment is loaded as a separate run.

Trial structure (12 s total):

  • 0 s: auditory cue (“Left” or “Nothing”)

  • 0-6 s: motor imagery or rest period

  • 6 s: auditory stop cue (“Stop”)

  • 6-12 s: micro-break

Data is stored as XDF (eXtensible Data Format) files inside two RAR archives on Harvard Dataverse. Loading requires the pyxdf library (install with pip install moabb[xdf]) and a RAR extraction tool (unar, unrar, or 7z).

27 subjects were right-handed, 3 were left-handed.

References

[1]

D. Rozado, T. Duenser, and B. Gruen, “Improving the performance of an EEG-based motor imagery brain computer interface using task evoked changes in pupil diameter,” PLoS ONE, vol. 10, no. 3, e0121262, 2015. DOI: 10.1371/journal.pone.0121262

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

Dataset summary

#Subj

30

#Chan

32

#Classes

2

#Trials / class

25

Trials length

6 s

Freq

512 Hz

#Sessions

1

#Runs

2

Total_trials

1550

Participants

  • Population: healthy

  • Age: 38 (range: 15-61) years

  • Handedness: {‘right’: 27, ‘left’: 3}

Equipment

  • Amplifier: BioSemi ActiveTwo

  • Electrodes: active

  • Montage: biosemi32

  • Reference: CMS/DRL

Data Access

Experimental Protocol

  • Paradigm: imagery

  • Task type: left hand grasping imagery vs rest

  • Feedback: none

  • Stimulus: auditory cue

__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)[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.

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]#

Return list of XDF file paths for a subject.

Downloads the appropriate RAR archive from Harvard Dataverse and extracts it if needed.

Parameters:

  • subject (int) – Subject number (1-30).

  • path (str | None) – Location for data storage.

  • force_update (bool) – Force re-download.

  • update_path (None) – Unused, kept for API compatibility.

  • verbose (bool | None) – Verbosity level.

Returns:

Paths to XDF files for this subject.

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