moabb.datasets.AlexMI#
- class moabb.datasets.AlexMI(subjects=None, sessions=None)[source]#
Bases:
BaseDataset[source]Dataset Snapshot
AlexMI
Motor imagery dataset from the PhD dissertation of A. Barachant. Contains EEG recordings from 8 subjects performing motor imagination tasks (right hand, feet, or rest). Used to validate robust control of an effector via asynchronous EEG-based brain-machine interface.
Motor Imagery, 3 classes (right_hand vs feet vs rest)
Motor Imagery Code: AlexandreMotorImagery 8 subjects 1 session 16 ch 512 Hz 3 classes 3.0 s trials CC BY-SA 4.0Class Labels: right_hand, feet, rest
Benchmark Context
WithinSessionIncluded in 2 MOABB benchmark table(s). Scores are across available pipelines (WithinSession accuracy).
- MI all classes 16 pipelinesMax 69.79 Β· Median 60.84 Β· Mean 55.73 Β· Std 13.41
- MI right hand vs feet 16 pipelinesMax 86.56 Β· Median 77.11 Β· Mean 72.08 Β· Std 11.89
Citation & Impact
- Paper DOI10.5281/zenodo.806022
- CitationsLoadingβ¦
- Public APICrossref | OpenAlex
- MOABB tables2 (WithinSession)
- Page Views30d: 138 Β· all-time: 1,594#5 of 151 Β· Top 4% most viewedUpdated: 2026-03-18 UTC
HED Event TagsHED tagsSource: MOABB BIDS HED annotation mapping.
right_handSensory-eventAgent-actionfeetSensory-eventAgent-actionrestSensory-eventExperimental-stimulusVisual-presentationRestHED tree view
Tree Β· right_hand
ββ Sensory-event β ββ Experimental-stimulus β ββ Visual-presentation ββ Agent-action ββ Imagine ββ Move ββ Right ββ HandTree Β· feet
ββ Sensory-event β ββ Experimental-stimulus β ββ Visual-presentation ββ Agent-action ββ Imagine ββ Move ββ FootTree Β· rest
ββ Sensory-event ββ Experimental-stimulus ββ Visual-presentation ββ Rest
Channel SummaryTotal channels16EEG16 (EEG)Montage10-05Sampling512 HzReferenceearlobeNotch / line50 HzThis diagram is automatically generated from MOABB metadata. Please consult the original publication to confirm the experimental protocol details.
Alex Motor Imagery dataset.
Motor imagery dataset from the PhD dissertation of A. Barachant [1].
This Dataset contains EEG recordings from 8 subjects, performing 2 task of motor imagination (right hand, feet or rest). Data have been recorded at 512Hz with 16 wet electrodes (Fpz, F7, F3, Fz, F4, F8, T7, C3, Cz, C4, T8, P7, P3, Pz, P4, P8) with a g.tec g.USBamp EEG amplifier.
File are provided in MNE raw file format. A stimulation channel encoding the timing of the motor imagination. The start of a trial is encoded as 1, then the actual start of the motor imagination is encoded with 2 for imagination of a right hand movement, 3 for imagination of both feet movement and 4 with a rest trial.
The duration of each trial is 3 second. There is 20 trial of each class.
References
[1]Barachant, A., 2012. Commande robuste dβun effecteur par une interface cerveau machine EEG asynchrone (Doctoral dissertation, UniversitΓ© de Grenoble). https://tel.archives-ouvertes.fr/tel-01196752
from moabb.datasets import AlexMI dataset = AlexMI() data = dataset.get_data(subjects=[1]) print(data[1])
Dataset summary
#Subj
8
#Chan
16
#Classes
3
#Trials / class
20
Trials length
3 s
Freq
512 Hz
#Sessions
1
#Runs
1
Total_trials
480
Participants
Population: healthy
Equipment
Amplifier: g.tec g.USBamp
Electrodes: EEG
Montage: standard_1005
Reference: earlobe
Preprocessing
Re-reference: earlobe
Data Access
DOI: 10.5281/zenodo.806022
Data URL: https://zenodo.org/record/806023
Repository: Zenodo
Experimental Protocol
Paradigm: imagery
Feedback: none
Stimulus: visual cue
- 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
Nonethe 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 insubject_listare converted.overwrite (bool) β If
True, existing BIDS files for a subject are removed before saving. Default isFalse.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/. Requiresplotly(pip install moabb[interactive]). Default isFalse.
- Returns:
bids_root β Path to the root of the written BIDS dataset.
- Return type:
Examples
>>> from moabb.datasets import AlexMI >>> dataset = AlexMI() >>> bids_root = dataset.convert_to_bids(path='/tmp/bids', subjects=[1])
See also
CacheConfigCache configuration for
get_data().moabb.datasets.bids_interface.get_bids_rootReturn 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)_PATHis 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:
- 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)_PATHis 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.
- 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
- 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
*_pipelinearguments. These pipelines are applied in the following order:raw_pipeline->epochs_pipeline->array_pipeline. If a*_pipelineargument isNone, the step will be skipped. Therefore, thearray_pipelinemay either receive amne.io.Rawor amne.Epochsobject as input depending on whetherepochs_pipelineisNoneor not.- Parameters:
subjects (List of int) β List of subject number
cache_config (dict | CacheConfig) β Configuration for caching of datasets. See
CacheConfigfor 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 receivemne.io.BaseRawobjects. The steps names of this pipeline should be elements ofStepType. According to their name, the steps should either return amne.io.BaseRaw, amne.Epochs, or anumpy.ndarray(). This pipeline must be βfixedβ because it will not be trained, i.e. no call tofitwill 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