moabb.datasets.Kojima2024A#

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

Bases: BaseDataset

[source]

Dataset Snapshot

Kojima2024A

A 3-class auditory BCI using three tone sequences based on auditory stream segregation. Musical tones were presented to subjects' right ear, and subjects attended to one of three streams while counting target stimuli. P300 activity was elicited by target stimuli in the attended stream.

P300 / ERP, 2 classes (Target vs NonTarget)

AuthorsSimon Kojima, Shin'ichiro Kanoh

🇯🇵 Shibaura Institute of Technology, JP·2024·nb21106@shibaura-it.ac.jp
P300 / ERP Code: Kojima2024A 11 subjects 1 session 64 ch 1000 Hz 2 classes 1.7 s trials CC0 1.0

Class Labels: Target, NonTarget

Read Paper Compare Similar Report Issue

Overview

Class for Kojima2024A dataset management. P300 dataset.

Dataset description

This dataset originates from a study investigating a three-class auditory BCI based on auditory stream segregation (ASME-BCI)

In the experiment, participants focused on one of three auditory streams, leveraging auditory stream segregation to selectively attend to stimuli in the target stream. Each stream contained a two-stimulus oddball sequence composed of one deviant stimulus and one standard stimulus.

The sequence below illustrates an example trial. For instance, when D2 is the target stimulus, the participant attended to Stream2 and selectively listened for D2. In this case, D2 is the target, and D1 and D3 are considered non-target stimuli.

Each participant completed 1 session consisting of 6 runs. Each run lasted approximately 5 minutes. In each run, all deviant stimuli (D1--D4) were presented approximately 60 times.

Recording Details:

- EEG signals were recorded using a BrainAmp system (Brain Products, Germany) at a sampling rate of 1000 Hz.

- Data were collected in Tokyo, Japan, where the power line frequency is 50 Hz.

- EEG was recorded from 64 scalp electrodes according to the international 10--20 system: Fp1, Fp2, AF7, AF3, AFz, AF4, AF8, F7, F5, F3, F1, Fz, F2, F4, F6, F8, FT9, FT7, FC5, FC3, FC1, FCz, FC2, FC4, FC6, FT8, FT10, T7, C5, C3, C1, Cz, C2, C4, C6, T8, TP9, TP7, CP5, CP3, CP1, CPz, CP2, CP4, CP6, TP8, TP10, P7, P5, P3, P1, Pz, P2, P4, P6, P8, PO7, PO3, POz, PO4, PO8, O1, Oz, O2

EEG signals were referenced to the right mastoid and grounded to the left mastoid.

- EOG was recorded using 2 electrodes (vEOG and hEOG), placed above/below and lateral to one eye.

Open in Overview tab →

Citation & Impact

Stimulus Protocol
../_images/Kojima2024A.svg

1.7s task window per trial · 2-class p300 / erp paradigm · 6 runs/session across 1 sessions

HED Event Tags
HED tags2/2 events annotated

Source: MOABB BIDS HED annotation mapping.

Experimental-stimulus
2
Sensory-event
2
Visual-presentation
2
Non-target
1
Target
1
Target
Sensory-eventExperimental-stimulusVisual-presentationTarget
NonTarget
Sensory-eventExperimental-stimulusVisual-presentationNon-target

HED tree view

Tree · Target
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Target
Tree · NonTarget
├─ Sensory-event
├─ Experimental-stimulus
├─ Visual-presentation
└─ Non-target
Channel Summary
Total channels64
EEG64 (eeg)
EOG2
Montagestandard_1020
Sampling1000 Hz
Referenceright earlobe
Filter{'bandpass': '0.1 Hz to 100 Hz'}
Notch / line50 Hz

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

Class for Kojima2024A dataset management. P300 dataset.

Dataset description

This dataset [1] originates from a study investigating a three-class auditory BCI based on auditory stream segregation (ASME-BCI) [2].

In the experiment, participants focused on one of three auditory streams, leveraging auditory stream segregation to selectively attend to stimuli in the target stream. Each stream contained a two-stimulus oddball sequence composed of one deviant stimulus and one standard stimulus.

The sequence below illustrates an example trial. For instance, when D2 is the target stimulus, the participant attended to Stream2 and selectively listened for D2. In this case, D2 is the target, and D1 and D3 are considered non-target stimuli.

Stream3  ----- S3 -------- S3 -------- S3 -------- D3 -------- S3 -----
Stream2  -- S2 -------- S2 -------- D2 -------- S2 -------- S2 --------
Stream1  S1 -------- D1 -------- S1 -------- S1 -------- S1 -----------

Each participant completed 1 session consisting of 6 runs. Each run lasted approximately 5 minutes. In each run, all deviant stimuli (D1–D4) were presented approximately 60 times.

Recording Details:

  • EEG signals were recorded using a BrainAmp system (Brain Products, Germany) at a sampling rate of 1000 Hz.

  • Data were collected in Tokyo, Japan, where the power line frequency is 50 Hz.

  • EEG was recorded from 64 scalp electrodes according to the international 10–20 system: Fp1, Fp2, AF7, AF3, AFz, AF4, AF8, F7, F5, F3, F1, Fz, F2, F4, F6, F8, FT9, FT7, FC5, FC3, FC1, FCz, FC2, FC4, FC6, FT8, FT10, T7, C5, C3, C1, Cz, C2, C4, C6, T8, TP9, TP7, CP5, CP3, CP1, CPz, CP2, CP4, CP6, TP8, TP10, P7, P5, P3, P1, Pz, P2, P4, P6, P8, PO7, PO3, POz, PO4, PO8, O1, Oz, O2

    EEG signals were referenced to the right mastoid and grounded to the left mastoid.

  • EOG was recorded using 2 electrodes (vEOG and hEOG), placed above/below and lateral to one eye.

References

[1]

Kojima, S. (2024). Replication Data for: An auditory brain-computer interface based on selective attention to multiple tone streams. Harvard Dataverse, V1. DOI: https://doi.org/10.7910/DVN/MQOVEY

[2]

Kojima, S. & Kanoh, S. (2024). An auditory brain-computer interface based on selective attention to multiple tone streams. PLoS ONE 19(5): e0303565. DOI: https://doi.org/10.1371/journal.pone.0303565

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

Dataset summary

#Subj

11

#Chan

64

#Trials / class

~130 NT / ~65 T

Trials length

1 s

Freq

1000 Hz

#Sessions

1

Participants

  • Population: healthy

  • Age: 22.5 (range: 22-23) years

Equipment

  • Amplifier: Brain Amp DC (Brain Products GmbH, Germany) and MR plus (Brain Products GmbH, Germany)

  • Electrodes: eeg

  • Montage: standard_1020

  • Reference: right earlobe

Preprocessing

  • Data state: raw

Data Access

Experimental Protocol

  • Paradigm: p300

  • Task type: auditory selective attention

  • Tasks: attend to Stream 1, attend to Stream 2, attend to Stream 3

  • Feedback: none

  • Stimulus: auditory musical tones

__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_subject_to_subject_id(subjects)[source]#

Convert subject number(s) to subject ID(s). (In this dataset, subject IDs are encoded using alphabet letters.)

Parameters:

subjects (int or list of int) – Subject number(s) to convert.

Returns:

subject_id – Converted subject ID(s).

Return type:

str or list of str

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 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.

  • generate_figures (bool) – If True, generate interactive neural signature HTML figures in {bids_root}/derivatives/neural_signatures/. Requires plotly (pip install moabb[interactive]). Default is False.

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)[source]#

Return the data paths of a single subject.

Parameters:

  • subject (int) – The subject number to fetch data for.

  • path (None | str) – Location of where to look for the data storing location. If None, the environment variable or config parameter MNE_(dataset) 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.

Returns:

A list containing the Path object for the subject’s data file.

Return type:

list

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()).

download_by_subject(subject, path=None)[source]#

Download and extract the dataset.

Parameters:

  • subject (int) – The subject number to download the dataset for.

  • path (str | None) – The path to the directory where the dataset should be downloaded. If None, the default directory is used.

Returns:

path – The dataset path.

Return type:

str

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