moabb.datasets.Lee2019_ERP#
- class moabb.datasets.Lee2019_ERP(train_run=True, test_run=None, resting_state=False, sessions=None, subjects=None, *, return_all_modalities=False, **kwargs)[source]#
Bases:
Lee2019[source]Dataset Snapshot
Lee2019_ERP
EEG dataset and OpenBMI toolbox for three BCI paradigms: an investigation into BCI illiteracy
P300 / ERP, 2 classes (Target vs NonTarget)
Class Labels: Target, NonTarget
Benchmark Context
WithinSessionIncluded in 1 MOABB benchmark table(s). Scores are across available pipelines (WithinSession accuracy).
- ERP/P300 all classes 5 pipelinesMax 98.41 · Median 96.45 · Mean 89.89 · Std 10.85
Citation & Impact
- Paper DOI10.1093/gigascience/giz002
- CitationsLoading…
- Public APICrossref | OpenAlex
- Data DOI10.5524/100542
- MOABB tables1 (WithinSession)
- Page Views30d: 65 · all-time: 616#14 of 151 · Top 10% most viewedUpdated: 2026-03-18 UTC
HED Event TagsHED tagsSource: MOABB BIDS HED annotation mapping.
TargetSensory-eventExperimental-stimulusVisual-presentationTargetNonTargetSensory-eventExperimental-stimulusVisual-presentationNon-targetHED tree view
Tree · Target
├─ Sensory-event ├─ Experimental-stimulus ├─ Visual-presentation └─ Target
Tree · NonTarget
├─ Sensory-event ├─ Experimental-stimulus ├─ Visual-presentation └─ Non-target
Channel SummaryTotal channels62EEG62 (Ag/AgCl)EMG4Montage10-05Sampling1000 HzReferencenasionNotch / line60 HzThis diagram is automatically generated from MOABB metadata. Please consult the original publication to confirm the experimental protocol details.
BMI/OpenBMI dataset for P300.
Dataset from Lee et al 2019 [1].
Dataset Description
EEG signals were recorded with a sampling rate of 1,000 Hz and collected with 62 Ag/AgCl electrodes. The EEG amplifier used in the experiment was a BrainAmp (Brain Products; Munich, Germany). The channels were nasion-referenced and grounded to electrode AFz. Additionally, an EMG electrode recorded from each flexor digitorum profundus muscle with the olecranon used as reference. The EEG/EMG channel configuration and indexing numbers are described in Fig. 1. The impedances of the EEG electrodes were maintained below 10 k during the entire experiment.
ERP paradigm The interface layout of the speller followed the typical design of a row-column speller. The six rows and six columns were configured with 36 symbols (A to Z, 1 to 9, and _). Each symbol was presented equally spaced. To enhance the signal quality, two additional settings were incorporated into the original row-column speller design, namely, random-set presentation and face stimuli. These additional settings help to elicit stronger ERP responses by minimizing adjacency distraction errors and by presenting a familiar face image. The stimulus-time interval was set to 80 ms, and the inter-stimulus interval (ISI) to 135 ms. A single iteration of stimulus presentation in all rows and columns was considered a sequence. Therefore, one sequence consisted of 12 stimulus flashes. A maximum of five sequences (i.e., 60 flashes) was allotted without prolonged inter-sequence intervals for each target character. After the end of five sequences, 4.5 s were given to the user for identifying, locating, and gazing at the next target character. The participant was instructed to attend to the target symbol by counting the number of times each target character had been flashed. In the training session, subjects were asked to copy-spell a given sentence, “NEURAL NETWORKS AND DEEP LEARNING” (33 characters including spaces) by gazing at the target character on the screen. The training session was performed in the offline condition, and no feedback was provided to the subject during the EEG recording. In the test session, subjects were instructed to copy-spell “PATTERN RECOGNITION MACHINE LEARNING” (36 characters including spaces), and the real-time EEG data were analyzed based on the classifier that was calculated from the training session data. The selected character from the subject’s current EEG data was displayed in the top left area of the screen at the end of the presentation (i.e., after five sequences). Per participant, the collected EEG data for the ERP experiment consisted of 1,980 and 2,160 trials (samples) for training and test phase, respectively.
- param train_run:
if True, return runs corresponding to the training/offline phase (see paper).
- type train_run:
bool (default True)
- param test_run:
if True, return runs corresponding to the test/online phase (see paper). Beware that test_run for MI and SSVEP do not have labels associated with trials: these runs could not be used in classification tasks.
- type test_run:
bool (default: False for MI and SSVEP paradigms, True for ERP)
- param resting_state:
if True, return runs corresponding to the resting phases before and after recordings (see paper).
- type resting_state:
bool (default False)
- param sessions:
the list of the sessions to load (2 available).
- type sessions:
list of int (default [1,2])
References
[1]Lee, M. H., Kwon, O. Y., Kim, Y. J., Kim, H. K., Lee, Y. E., Williamson, J., … Lee, S. W. (2019). EEG dataset and OpenBMI toolbox for three BCI paradigms: An investigation into BCI illiteracy. GigaScience, 8(5), 1–16. https://doi.org/10.1093/gigascience/giz002
from moabb.datasets import Lee2019_ERP dataset = Lee2019_ERP() data = dataset.get_data(subjects=[1]) print(data[1])
Dataset summary
#Subj
54
#Chan
62
#Trials / class
6900 NT / 1380 T
Trials length
1 s
Freq
1000 Hz
#Sessions
2
Participants
Population: healthy
Age: 29.5 (range: 24-35) years
Handedness: right
BCI experience: mixed
Equipment
Amplifier: BrainAmp
Electrodes: Ag/AgCl
Montage: standard_1005
Reference: nasion
Preprocessing
Data state: raw
Data Access
DOI: 10.1093/gigascience/giz002
Repository: GigaDB
Experimental Protocol
Paradigm: p300
Task type: copy_spelling
Feedback: visual
Stimulus: rc_speller
- __init__(train_run=True, test_run=None, resting_state=False, sessions=None, subjects=None, *, return_all_modalities=False, **kwargs)[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
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