SEEDDataset¶
- class torcheeg.datasets.SEEDDataset(root_path: str = './Preprocessed_EEG', chunk_size: int = 200, overlap: int = 0, num_channel: int = 62, online_transform: None | Callable = None, offline_transform: None | Callable = None, label_transform: None | Callable = None, before_trial: None | Callable = None, after_trial: None | Callable = None, after_session: None | Callable = None, after_subject: None | Callable = None, io_path: None | str = None, io_size: int = 1048576, io_mode: str = 'lmdb', num_worker: int = 0, verbose: bool = True)[source][source]¶
The SJTU Emotion EEG Dataset (SEED), is a collection of EEG datasets provided by the BCMI laboratory, which is led by Prof. Bao-Liang Lu. This class generates training samples and test samples according to the given parameters, and caches the generated results in a unified input and output format (IO). The relevant information of the dataset is as follows:
Author: Zheng et al.
Year: 2015
Download URL: https://bcmi.sjtu.edu.cn/home/seed/index.html
Reference: Zheng W L, Lu B L. Investigating critical frequency bands and channels for EEG-based emotion recognition with deep neural networks[J]. IEEE Transactions on Autonomous Mental Development, 2015, 7(3): 162-175.
Stimulus: 15 four-minute long film clips from six Chinese movies.
Signals: Electroencephalogram (62 channels at 200Hz) of 15 subjects, and eye movement data of 12 subjects. Each subject conducts the experiment three times, with an interval of about one week, totally 15 people x 3 times = 45
Rating: positive (1), negative (-1), and neutral (0).
In order to use this dataset, the download folder
Preprocessed_EEG
is required, containing the following files:label.mat
readme.txt
10_20131130.mat
…
9_20140704.mat
An example dataset for CNN-based methods:
from torcheeg.datasets import SEEDDataset from torcheeg import transforms from torcheeg.datasets.constants.emotion_recognition.seed import SEED_CHANNEL_LOCATION_DICT dataset = SEEDDataset(root_path='./Preprocessed_EEG', offline_transform=transforms.Compose([ transforms.BandDifferentialEntropy(), transforms.ToGrid(SEED_CHANNEL_LOCATION_DICT) ]), online_transform=transforms.ToTensor(), label_transform=transforms.Compose([ transforms.Select('emotion'), transforms.Lambda(lambda x: x + 1) ])) print(dataset[0]) # EEG signal (torch.Tensor[4, 9, 9]), # coresponding baseline signal (torch.Tensor[4, 9, 9]), # label (int)
Another example dataset for CNN-based methods:
from torcheeg.datasets import SEEDDataset from torcheeg import transforms dataset = SEEDDataset(root_path='./Preprocessed_EEG', online_transform=transforms.Compose([ transforms.ToTensor(), transforms.To2d() ]), label_transform=transforms.Compose([ transforms.Select('emotion'), transforms.Lambda(lambda x: x + 1) ])) print(dataset[0]) # EEG signal (torch.Tensor[62, 200]), # coresponding baseline signal (torch.Tensor[62, 200]), # label (int)
An example dataset for GNN-based methods:
from torcheeg.datasets import SEEDDataset from torcheeg import transforms from torcheeg.datasets.constants.emotion_recognition.seed import SEED_ADJACENCY_MATRIX from torcheeg.transforms.pyg import ToG dataset = SEEDDataset(root_path='./Preprocessed_EEG', online_transform=transforms.Compose([ ToG(SEED_ADJACENCY_MATRIX) ]), label_transform=transforms.Compose([ transforms.Select('emotion'), transforms.Lambda(lambda x: x + 1) ])) print(dataset[0]) # EEG signal (torch_geometric.data.Data), # coresponding baseline signal (torch_geometric.data.Data), # label (int)
- Parameters:
root_path (str) – Downloaded data files in matlab (unzipped Preprocessed_EEG.zip) formats (default:
'./Preprocessed_EEG'
)chunk_size (int) – Number of data points included in each EEG chunk as training or test samples. If set to -1, the EEG signal of a trial is used as a sample of a chunk. (default:
200
)overlap (int) – The number of overlapping data points between different chunks when dividing EEG chunks. (default:
0
)num_channel (int) – Number of channels used, of which the first 62 channels are EEG signals. (default:
62
)online_transform (Callable, optional) – The transformation of the EEG signals and baseline EEG signals. The input is a
np.ndarray
, and the ouput is used as the first and second value of each element in the dataset. (default:None
)offline_transform (Callable, optional) – The usage is the same as
online_transform
, but executed before generating IO intermediate results. (default:None
)label_transform (Callable, optional) – The transformation of the label. The input is an information dictionary, and the ouput is used as the third value of each element in the dataset. (default:
None
)before_trial (Callable, optional) – The hook performed on the trial to which the sample belongs. It is performed before the offline transformation and thus typically used to implement context-dependent sample transformations, such as moving averages, etc. The input of this hook function is a 2D EEG signal with shape (number of electrodes, number of data points), whose ideal output shape is also (number of electrodes, number of data points).
after_trial (Callable, optional) – The hook performed on the trial to which the sample belongs. It is performed after the offline transformation and thus typically used to implement context-dependent sample transformations, such as moving averages, etc. The input and output of this hook function should be a sequence of dictionaries representing a sequence of EEG samples. Each dictionary contains two key-value pairs, indexed by
eeg
(the EEG signal matrix) andkey
(the index in the database) respectively.io_path (str) – The path to generated unified data IO, cached as an intermediate result. If set to None, a random path will be generated. (default:
None
)io_size (int) – Maximum size database may grow to; used to size the memory mapping. If database grows larger than
map_size
, an exception will be raised and the user must close and reopen. (default:1048576
)io_mode (str) – Storage mode of EEG signal. When io_mode is set to
lmdb
, TorchEEG provides an efficient database (LMDB) for storing EEG signals. LMDB may not perform well on limited operating systems, where a file system based EEG signal storage is also provided. When io_mode is set topickle
, pickle-based persistence files are used. When io_mode is set tomemory
, memory are used. (default:lmdb
)num_worker (int) – Number of subprocesses to use for data loading. 0 means that the data will be loaded in the main process. (default:
0
)verbose (bool) – Whether to display logs during processing, such as progress bars, etc. (default:
True
)