Browse Source

some explanations

Robin Tibor Schirrmeister 5 years ago
parent
commit
c86a0a4d8c
1 changed files with 53 additions and 1 deletions
  1. 53 1
      README.md

+ 53 - 1
README.md

@@ -1 +1,53 @@
-# high-gamma-dataset
+# High Gamma Dataset
+
+This is the documnentation for the High Gamma Dataset used in "Deep learning with convolutional neural networks for EEG decoding and visualization"
+ (https://onlinelibrary.wiley.com/doi/full/10.1002/hbm.23730).
+See the paper and supporting information for a general description.
+
+## Download
+Download the files from here:
+https://www.dropbox.com/sh/vgxed0kx0b31aiv/AAAS2E7qXpn0vPjqjMLVW4ZOa?dl=0
+ 
+
+## Usage of this dataset
+
+The braindecode toolbox at https://github.com/robintibor/braindecode provides code to load this dataset in python.
+You can run the following code to get an MNE RawArray:
+
+```python
+from braindecode.datasets.bbci import  BBCIDataset
+cnt = BBCIDataset(filename='./test/1.mat', load_sensor_names=None).load()
+```
+
+The `example.py` code in this repository shows how to reproduce the decoding results for our dataset.
+
+
+## Data format
+The data are hdf5-files, the structure is based on the structure from the Berlin Brain Computer Interface Toolbox at https://github.com/bbci/bbci_public.
+Most fields have been removed, only some necessary fields are retained. We recommend to just use our loading code as above.
+
+## Details of recording
+
+The recodings were referenced to Cz, however in our recording setup, some residual signal remains on Cz.
+Note that for subject 14, about half of the sensors lost meaningful signal in the test set.
+It is still possible to get far-above chance accuracies even when not accounting for this in any way when training on all sensors of the training set.
+
+## Citing
+If you use this dataset in a scientific publication, please cite the above-mentioned HBM-paper as:
+
+```
+  @article {HBM:HBM23730,
+  author = {Schirrmeister, Robin Tibor and Springenberg, Jost Tobias and Fiederer,
+    Lukas Dominique Josef and Glasstetter, Martin and Eggensperger, Katharina and Tangermann, Michael and
+    Hutter, Frank and Burgard, Wolfram and Ball, Tonio},
+  title = {Deep learning with convolutional neural networks for EEG decoding and visualization},
+  journal = {Human Brain Mapping},
+  issn = {1097-0193},
+  url = {http://dx.doi.org/10.1002/hbm.23730},
+  doi = {10.1002/hbm.23730},
+  month = {aug},
+  year = {2017},
+  keywords = {electroencephalography, EEG analysis, machine learning, end-to-end learning, brain–machine interface, 
+    brain–computer interface, model interpretability, brain mapping},
+  }
+```