moabb.datasets.Kim2025BetaRange#

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

Bases: BaseDataset

[source]

Dataset Snapshot

Kim2025BetaRange

SSVEP, 40 classes

AuthorsHeegyu Kim, Kyungho Won, Minkyu Ahn, Sung Chan Jun

🇰🇷 Gwangju Institute of Science and Technology, KR·2025
SSVEP Code: Kim2025BetaRange 40 subjects 6 sessions 33 ch (31 EEG) 1024 Hz 40 classes 5.0 s trials CC BY 4.0

Class Labels: 14, 15, 16, 17, 18, 19, 20, 21, ...

Read Paper Compare Similar Report Issue

Overview

40-class beta-range SSVEP speller dataset.

Dataset from

This dataset contains 33-channel EEG (31 scalp + 2 mastoid references) recorded from 40 healthy subjects (25 males, 15 females, aged 20-35) performing a 40-target SSVEP-BCI speller task using beta-range frequencies (14.0-21.8 Hz, 0.2 Hz step). The JFPM approach was used with phase differences of 0.5*pi between adjacent stimuli.

Each subject completed 6 blocks of 40 trials. Trial structure was 1.5 s rest, 0.5 s cue, and 5.0 s SSVEP stimulation. EEG was recorded at 1024 Hz with a BioSemi ActiveTwo system. Stored epochs span [-2000, 5000] ms relative to stimulus onset (7168 samples at 1024 Hz). The event marker is placed at stimulus onset (sample 2048), and interval=[0.0, 5.0] extracts the 5 s stimulation window.

The stimuli were presented in a 5x8 matrix on a 120 Hz monitor.

Open in Overview tab →

Citation & Impact

Stimulus Protocol
../_images/Kim2025BetaRange.svg

5s task window per trial · 40-class ssvep paradigm · 1 runs/session across 6 sessions

HED Event Tags
HED tags40/40 events annotated

Source: MOABB BIDS HED annotation mapping.

Experimental-stimulus
40
Label
40
Sensory-event
40
Visual-presentation
40
14
Sensory-eventExperimental-stimulusVisual-presentationLabel
15
Sensory-eventExperimental-stimulusVisual-presentationLabel
16
Sensory-eventExperimental-stimulusVisual-presentationLabel
17
Sensory-eventExperimental-stimulusVisual-presentationLabel
18
Sensory-eventExperimental-stimulusVisual-presentationLabel
19
Sensory-eventExperimental-stimulusVisual-presentationLabel
20
Sensory-eventExperimental-stimulusVisual-presentationLabel
21
Sensory-eventExperimental-stimulusVisual-presentationLabel
14.2
Sensory-eventExperimental-stimulusVisual-presentationLabel
15.2
Sensory-eventExperimental-stimulusVisual-presentationLabel
16.2
Sensory-eventExperimental-stimulusVisual-presentationLabel
17.2
Sensory-eventExperimental-stimulusVisual-presentationLabel
18.2
Sensory-eventExperimental-stimulusVisual-presentationLabel
19.2
Sensory-eventExperimental-stimulusVisual-presentationLabel
20.2
Sensory-eventExperimental-stimulusVisual-presentationLabel
21.2
Sensory-eventExperimental-stimulusVisual-presentationLabel
14.4
Sensory-eventExperimental-stimulusVisual-presentationLabel
15.4
Sensory-eventExperimental-stimulusVisual-presentationLabel
16.4
Sensory-eventExperimental-stimulusVisual-presentationLabel
17.4
Sensory-eventExperimental-stimulusVisual-presentationLabel
18.4
Sensory-eventExperimental-stimulusVisual-presentationLabel
19.4
Sensory-eventExperimental-stimulusVisual-presentationLabel
20.4
Sensory-eventExperimental-stimulusVisual-presentationLabel
21.4
Sensory-eventExperimental-stimulusVisual-presentationLabel
14.6
Sensory-eventExperimental-stimulusVisual-presentationLabel
15.6
Sensory-eventExperimental-stimulusVisual-presentationLabel
16.6
Sensory-eventExperimental-stimulusVisual-presentationLabel
17.6
Sensory-eventExperimental-stimulusVisual-presentationLabel
18.6
Sensory-eventExperimental-stimulusVisual-presentationLabel
19.6
Sensory-eventExperimental-stimulusVisual-presentationLabel
20.6
Sensory-eventExperimental-stimulusVisual-presentationLabel
21.6
Sensory-eventExperimental-stimulusVisual-presentationLabel
14.8
Sensory-eventExperimental-stimulusVisual-presentationLabel
15.8
Sensory-eventExperimental-stimulusVisual-presentationLabel
16.8
Sensory-eventExperimental-stimulusVisual-presentationLabel
17.8
Sensory-eventExperimental-stimulusVisual-presentationLabel
18.8
Sensory-eventExperimental-stimulusVisual-presentationLabel
19.8
Sensory-eventExperimental-stimulusVisual-presentationLabel
20.8
Sensory-eventExperimental-stimulusVisual-presentationLabel
21.8
Sensory-eventExperimental-stimulusVisual-presentationLabel

HED tree view

Tree · 14
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 15
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 16
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 17
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 18
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 19
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 20
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 21
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 14.2
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 15.2
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 16.2
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 17.2
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 18.2
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 19.2
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 20.2
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 21.2
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 14.4
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 15.4
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 16.4
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 17.4
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 18.4
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 19.4
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 20.4
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 21.4
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 14.6
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 15.6
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 16.6
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 17.6
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 18.6
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 19.6
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 20.6
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 21.6
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 14.8
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 15.8
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 16.8
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 17.8
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 18.8
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 19.8
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 20.8
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Tree · 21.8
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Label
Channel Summary
Total channels33
EEG31 (active)
MISC2
Montage10-05
Sampling1024 Hz
ReferenceCMS/DRL
Notch / line60 Hz

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

40-class beta-range SSVEP speller dataset.

Dataset from [1].

This dataset contains 33-channel EEG (31 scalp + 2 mastoid references) recorded from 40 healthy subjects (25 males, 15 females, aged 20-35) performing a 40-target SSVEP-BCI speller task using beta-range frequencies (14.0-21.8 Hz, 0.2 Hz step). The JFPM approach was used with phase differences of 0.5*pi between adjacent stimuli.

Each subject completed 6 blocks of 40 trials. Trial structure was 1.5 s rest, 0.5 s cue, and 5.0 s SSVEP stimulation. EEG was recorded at 1024 Hz with a BioSemi ActiveTwo system. Stored epochs span [-2000, 5000] ms relative to stimulus onset (7168 samples at 1024 Hz). The event marker is placed at stimulus onset (sample 2048), and interval=[0.0, 5.0] extracts the 5 s stimulation window.

The stimuli were presented in a 5x8 matrix on a 120 Hz monitor.

References

[1]

H. Kim, K. Won, M. Ahn, and S. C. Jun, “A 40-class SSVEP speller dataset: beta range stimulation for low-fatigue BCI applications,” Scientific Data, vol. 12, p. 1751, 2025. DOI: 10.1038/s41597-025-06032-2

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

Dataset summary

#Subj

40

#Chan

33

#Classes

40

#Trials / class

6

Trials length

5 s

Freq

1024 Hz

#Sessions

6

Participants

  • Population: healthy

  • Age: 22.8 (range: 20-35) years

  • BCI experience: 3 of 40 had prior SSVEP-BCI experience

Equipment

  • Amplifier: BioSemi ActiveTwo

  • Electrodes: active

  • Montage: standard_1005

  • Reference: CMS/DRL

Preprocessing

  • Data state: epoched

Data Access

Experimental Protocol

  • Paradigm: ssvep

  • Task type: speller

  • Feedback: none

  • Stimulus: JFPM visual flicker

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

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.

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