moabb.datasets.Zuo2025#
- class moabb.datasets.Zuo2025(subjects=None, sessions=None, *, return_all_modalities=False)[source]#
Bases:
BaseDataset[source]Dataset Snapshot
Zuo2025
Motor Imagery, 2 classes (left_leg vs right_leg)
Class Labels: left_leg, right_leg
Citation & Impact
- Paper DOI10.1038/s41597-025-05767-2
- CitationsLoadingβ¦
- Public APICrossref | OpenAlex
HED Event TagsHED tagsSource: MOABB BIDS HED annotation mapping.
left_legSensory-eventLabelright_legSensory-eventLabelHED tree view
Tree Β· left_leg
ββ Sensory-event ββ Label
Tree Β· right_leg
ββ Sensory-event ββ Label
Channel SummaryTotal channels30EEG30Montage10-05Sampling500 HzReferenceCPzNotch / line50 HzThis diagram is automatically generated from MOABB metadata. Please consult the original publication to confirm the experimental protocol details.
Lower-limb MI dataset for knee pain patients from Zuo et al. 2025.
Dataset from [1].
This dataset contains 30-channel EEG recordings from 30 knee pain patients performing left and right leg motor imagery. Recorded with ZhenTec EEG system at 500 Hz using the 10-20 montage.
Each subject completed 5 sessions (every 2 days), with 100 trials per session (50 left leg, 50 right leg). Trial structure: 4 s MI, 4 s rest, ~2 s gap.
Note
12 of 30 subjects have incomplete raw session files on Figshare (32 of 150 sessions missing). The adapter loads all available sessions per subject. Each session file is ~100 MB.
Note
There is a known inconsistency between the dataset README and events.json regarding the left/right leg label mapping. This adapter follows the events.json mapping (generated programmatically).
References
[1]Zuo, C., Yin, Y., Wang, H., et al. (2025). Enhancing classification of a large lower-limb motor imagery EEG dataset for BCI in knee pain patients. Scientific Data, 12, 1451. https://doi.org/10.1038/s41597-025-05767-2
from moabb.datasets import Zuo2025 dataset = Zuo2025() data = dataset.get_data(subjects=[1]) print(data[1])
Dataset summary
#Subj
30
#Chan
30
#Classes
2
#Trials / class
50
Trials length
4 s
Freq
500 Hz
#Sessions
5
#Runs
1
Total_trials
15000
Participants
Population: knee pain patients
Clinical population: knee_pain
Age: 33.5 (range: 24-45) years
Equipment
Amplifier: ZhenTec EEG system
Montage: standard_1005
Reference: CPz
Data Access
DOI: 10.1038/s41597-025-05767-2
Experimental Protocol
Paradigm: imagery
Feedback: none
Stimulus: visual
Notes
Added in version 1.2.0.
- __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
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.
- 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