Skip to content

Commit bcd3cb9

Browse files
authored
Merge pull request #467 from dorahermes/master
HED-SCORE example of EEG and iEEG data with annotations
2 parents 7c18d68 + ea3d80c commit bcd3cb9

File tree

548 files changed

+736
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

548 files changed

+736
-0
lines changed

dataset_listing.tsv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,4 @@ motion_spotrotation participants rotated heading using full-body motion or joyst
7979
mrs_2dmrsi 2D sLASER MRSI data from 8 subjects [link](https://zenodo.org/records/7701228) [@markmikkelsen](https://github.com/markmikkelsen) anat, mrs T1w, mrsi
8080
mrs_biggaba MEGA-PRESS and PRESS MRS data from 12 subjects from one site from the Big GABA project [link](https://www.nitrc.org/projects/biggaba) [@markmikkelsen](https://github.com/markmikkelsen) anat, mrs T1w, mrsref, svs
8181
mrs_fmrs Functional MRS data involving a pain stimulus task from 15 subjects [link](https://www.nitrc.org/projects/fmrs_2020) [@markmikkelsen](https://github.com/markmikkelsen) anat, mrs T1w, events, mrsref, svs
82+
xeeg_hed_score EEG and iEEG data with annotations of artifacts, seizures and modulators using HED-SCORE [@dorahermes](https://github.com/dorahermes) eeg, anat, ieeg channels, coordsystem, electrodes, events, ieeg, eeg, T1w

xeeg_hed_score/README

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# BIDS example with HED-SCORE schema library annotations
2+
3+
The HED schema library for the Standardized Computer-based Organized Reporting of EEG (SCORE) can be used to add annotations for BIDS datasets. The annotations are machine readable and validated with the BIDS and HED validators.
4+
5+
The examples are related to the following preprint:
6+
Attia TP, Robbins K, Beniczky S, Bosch-Bayard J, Delorme A, Lundstrom BN, Rogers C, Rampp S, Valdes-Sosa P, Truong D, Worrell G, Makeig S, Hermes D. Hierarchical Event Descriptor library schema for EEG data annotation. arXiv preprint arXiv:2310.15173. 2023 Oct 4.
7+
8+
# General information
9+
This BIDS example set includes 3 subjects where EEG data are annotated according to the HED-SCORE schema library:
10+
- Example subject with annotated Seizures.
11+
- Example subject with annotated Artifacts.
12+
- Example subject with an annotated Modulator (photic stimulation).
13+
14+
Data are annotated by adding a column for annotations in the _events.tsv. This levels/annotations in this column are defined in the _events.json sidecar as HED tags. When annotations are observed in particular EEG channels, the relevant channels is annotated by including a channel column in the events.tsv file.
15+
16+
# Source data
17+
Examples are based on original datasets:
18+
- sub-eegSeizureTUH The TUH EEG Seizure Corpus. Database: TUH EEG Seizure Corpus (TUSZ), Version: 1.5.3, Patient: 258, Session: s003 (../tuh_eeg_seizure/v1.5.3/edf/dev/01_tcp_ar/002/00000258/s003_2003_07_22)
19+
- sub-eegArtifactTUH The TUH EEG Artifact Corpus. Database: TUH EEG Artifact Corpus (TUAR), Version: v2.0.0, Patient: 715 , Session: s010 (../tuh_eeg_artifact/edf/01_tcp_ar/007/00000715/s010_2014_08_07)
20+
- sub-ieegModulator Intracranial EEG dataset collected at Mayo Clinic Rochester, MN during photic stimulation. The photic stimulation is annotated using the HED-SCORE modulator.
21+
22+
# More information
23+
HED: https://www.hedtags.org/
24+
HED schema library for SCORE: https://github.com/hed-standard/hed-schema-library
25+
Temple University Hospital EEG Data Corpus: https://isip.piconepress.com/projects/tuh_eeg/
26+
27+
# Contact
28+
Tal Pal Attia: attia.tal@mayo.edu
29+
Dora Hermes: hermes.dora@mayo.edu
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"Name": "HED schema library for SCORE annotations example",
3+
"BIDSVersion": "1.9.0",
4+
"HEDVersion": "score_2.0.0",
5+
"Authors": [
6+
"Tal Pal Attia",
7+
"Kay Robbins",
8+
"Dora Hermes"
9+
],
10+
"Acknowledgements": "Kay Robbins, Dung Truong, Arnaud Delorme, and Scott Makeig",
11+
"Funding": [
12+
"National Institute of Health Grant R01MH126700 (SM)",
13+
"National Institute of Health Grant R01MH122258 (DH)"
14+
],
15+
"SourceDatasets": [
16+
{
17+
"Name": "The TUH EEG Seizure Corpus. Database: TUH EEG Seizure Corpus (TUSZ).",
18+
"Version": "1.5.3",
19+
"URL": "https://isip.piconepress.com/projects/tuh_eeg/downloads/"
20+
},
21+
{
22+
"Name": "The TUH EEG Artifact Corpus. Database: TUH EEG Artifact Corpus (TUAR)",
23+
"Version": "2.0.0.",
24+
"URL": "https://isip.piconepress.com/projects/tuh_eeg/downloads/"
25+
}
26+
],
27+
"ReferencesAndLinks": ["https://github.com/hed-standard/hed-schema-library",
28+
"https://www.hedtags.org/",
29+
"Robbins, Kay, Dung Truong, Stefan Appelhoff, Arnaud Delorme, and Scott Makeig. 'Capturing the nature of events and event context using Hierarchical Event Descriptors (HED).' NeuroImage 245 (2021): 118766.",
30+
"Robbins, Kay, Dung Truong, Alexander Jones, Ian Callanan, and Scott Makeig. 'Building FAIR functionality: Annotating events in time series data using Hierarchical Event Descriptors (HED).' Neuroinformatics (2021): 1-19.",
31+
"Obeid, Iyad, and Joseph Picone. 'The temple university hospital EEG data corpus.' Frontiers in neuroscience 10 (2016): 196.",
32+
"Shah, Vinit, Eva Von Weltin, Silvia Lopez, James Riley McHugh, Lillian Veloso, Meysam Golmohammadi, Iyad Obeid, and Joseph Picone. 'The temple university hospital seizure detection corpus.' Frontiers in neuroinformatics 12 (2018): 83.",
33+
"Ochal, Domenic, Safwanur Rahman, Sean Ferrell, Tarek Elseify, Iyad Obeid, and Joseph Picone. 'The temple university hospital eeg corpus: Annotation guidelines.' Institute for Signal and Information Processing Report 1, no. 1 (2020).",
34+
"Buckwalter, G., S. Chhin, S. Rahman, I. Obeid, and J. Picone. 'Recent Advances in the TUH EEG Corpus: Improving the Interrater Agreement for Artifacts and Epileptiform Events.' In 2021 IEEE Signal Processing in Medicine and Biology Symposium (SPMB), pp. 1-3. IEEE, 2021.",
35+
"Hamid, Ahmed, Katherine Gagliano, Safwanur Rahman, Nikita Tulin, Vincent Tchiong, Iyad Obeid, and Joseph Picone. 'The temple university artifact corpus: An annotated corpus of EEG artifacts.' In 2020 IEEE Signal Processing in Medicine and Biology Symposium (SPMB), pp. 1-4. IEEE, 2020."
36+
]
37+
}

xeeg_hed_score/participants.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"participant_id": {
3+
"LongName": "Participant identifier",
4+
"Description": "Unique subject identifier"
5+
}
6+
}

xeeg_hed_score/participants.tsv

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
participant_id
2+
sub-ieegModulator
3+
sub-eegArtifactTUH
4+
sub-eegSeizureTUH

xeeg_hed_score/sub-eegArtifactTUH/ses-eeg01/eeg/.Rapp.history

Whitespace-only changes.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": {
3+
"Description": "REQUIRED. Label of the channel."
4+
},
5+
"type": {
6+
"Description": "REQUIRED. Type of channel; MUST use the channel types listed in bids-specification."
7+
},
8+
"units": {
9+
"Description": "REQUIRED. Physical unit of the value represented in this channel."
10+
}
11+
}
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name type units
2+
FP1-F7 EEG uV
3+
F7-T3 EEG uV
4+
T3-T5 EEG uV
5+
T5-O1 EEG uV
6+
FP2-F8 EEG uV
7+
F8-T4 EEG uV
8+
T4-T6 EEG uV
9+
T6-O2 EEG uV
10+
A1-T3 EEG uV
11+
T3-C3 EEG uV
12+
C3-CZ EEG uV
13+
CZ-C4 EEG uV
14+
C4-T4 EEG uV
15+
T4-A2 EEG uV
16+
FP1-F3 EEG uV
17+
F3-C3 EEG uV
18+
C3-P3 EEG uV
19+
P3-O1 EEG uV
20+
FP2-F4 EEG uV
21+
F4-C4 EEG uV
22+
C4-P4 EEG uV
23+
P4-O2 EEG uV

xeeg_hed_score/sub-eegArtifactTUH/ses-eeg01/eeg/sub-eegArtifactTUH_ses-eeg01_task-rest_run-000_eeg.edf

Whitespace-only changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"TaskName": "rest",
3+
"TaskDescription": "Subject resting",
4+
"InstitutionName": "Temple University Hospital",
5+
"EEGReference": "bipolar banana montage",
6+
"SamplingFrequency": 250,
7+
"PowerLineFrequency": 60,
8+
"SoftwareFilters": "n/a"
9+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"onset": {
3+
"Description": "REQUIRED. Onset (in seconds) of the event, measured from the beginning of the acquisition of the first data point stored in the corresponding task data file. Negative onsets are allowed, to account for events that occur prior to the first stored data point."
4+
},
5+
"duration": {
6+
"Description": "REQUIRED. Duration of the event (measured from onset) in seconds"
7+
},
8+
"annotation_type": {
9+
"LongName": "Hierarchical Event Descriptors annotations",
10+
"Description": "EEG interpretation Hierarchical Event Descriptors annotations",
11+
"Levels": {
12+
"eyem": "Eye movements can cause artifacts on recordings. The charge of the eye can especially cause artifacts in electrophysiology data.",
13+
"elec": "Non biological artifacts encompass various electrode related artifacts, such as electrode pop and electrode movement.",
14+
"musc": "EMG artifact. Artifact from muscle activity and myogenic potentials at the measurements site.",
15+
"eyem_musc": "Eye and Muscle artifacts."
16+
},
17+
"HED": {
18+
"eyem": "Eye-movement-artifact",
19+
"elec": "Nonbiological-artifact",
20+
"musc": "EMG-artifact",
21+
"eyem_musc": "(Eye-movement-artifact , EMG-artifact)"
22+
}
23+
},
24+
"channel": {
25+
"LongName": "Annotated channel",
26+
"Description": "Space separated list of annotated channels corresponding to *_channels.tsv.",
27+
"Delimiter": " ",
28+
"HED": "Parameter-value/#"
29+
}
30+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
onset duration annotation_type channel
2+
3.9989 2.3064 elec C3-CZ CZ-C4
3+
23.448 2.6466 elec C3-CZ CZ-C4
4+
27.2146 2.9121 elec C3-CZ CZ-C4
5+
31.0476 4.9861 elec C3-CZ CZ-C4
6+
36.2146 3.7334 eyem FP2-F8
7+
36.2312 3.5758 eyem FP1-F7
8+
36.4054 3.6339 eyem FP2-F4
9+
36.4552 3.5177 eyem FP1-F3
10+
63.2113 9.9806 elec C3-CZ CZ-C4
11+
91.0913 21.0564 elec C3-CZ CZ-C4
12+
91.5559 20.5752 eyem_musc FP2-F4
13+
91.5725 20.6333 eyem_musc FP1-F7
14+
91.5808 20.5503 eyem_musc FP1-F3
15+
91.589 20.6416 eyem_musc FP2-F8

xeeg_hed_score/sub-eegArtifactTUH/ses-eeg01/eeg/sub-eegArtifactTUH_ses-eeg01_task-rest_run-001_eeg.edf

Whitespace-only changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"TaskName": "rest",
3+
"TaskDescription": "Subject resting",
4+
"InstitutionName": "Temple University Hospital",
5+
"EEGReference": "bipolar banana montage",
6+
"SamplingFrequency": 250,
7+
"PowerLineFrequency": 60,
8+
"SoftwareFilters": "n/a"
9+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"onset": {
3+
"Description": "REQUIRED. Onset (in seconds) of the event, measured from the beginning of the acquisition of the first data point stored in the corresponding task data file. Negative onsets are allowed, to account for events that occur prior to the first stored data point."
4+
},
5+
"duration": {
6+
"Description": "REQUIRED. Duration of the event (measured from onset) in seconds"
7+
},
8+
"annotation_type": {
9+
"LongName": "Hierarchical Event Descriptors annotations",
10+
"Description": "EEG interpretation Hierarchical Event Descriptors annotations",
11+
"Levels": {
12+
"eyem": "Eye movements can cause artifacts on recordings. The charge of the eye can especially cause artifacts in electrophysiology data.",
13+
"elec": "Non biological artifacts encompass various electrode related artifacts, such as electrode pop and electrode movement.",
14+
"musc": "EMG artifact. Artifact from muscle activity and myogenic potentials at the measurements site.",
15+
"eyem_musc": "Eye and Muscle artifacts."
16+
},
17+
"HED": {
18+
"eyem": "Eye-movement-artifact",
19+
"elec": "Nonbiological-artifact",
20+
"musc": "EMG-artifact",
21+
"eyem_musc": "(Eye-movement-artifact, EMG-artifact)"
22+
}
23+
},
24+
"channel": {
25+
"LongName": "Annotated channel",
26+
"Description": "Space separated list of annotated channels corresponding to *_channels.tsv.",
27+
"Delimiter": " ",
28+
"HED": "Parameter-value/#"
29+
}
30+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
onset duration annotation_type channel
2+
0.531 31.1725 eyem_musc FP1-F7 FP2-F8 FP1-F3 FP2-F4
3+
34.1062 36.1504 eyem_musc FP1-F7 FP2-F8 FP1-F3 FP2-F4
4+
73.1062 22.677 eyem_musc FP1-F7 FP2-F8 FP1-F3 FP2-F4
5+
98.4823 15.0221 eyem FP1-F7 FP2-F8 FP1-F3 FP2-F4

xeeg_hed_score/sub-eegArtifactTUH/ses-eeg01/eeg/sub-eegArtifactTUH_ses-eeg01_task-rest_run-002_eeg.edf

Whitespace-only changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"TaskName": "rest",
3+
"TaskDescription": "Subject resting",
4+
"InstitutionName": "Temple University Hospital",
5+
"EEGReference": "bipolar banana montage",
6+
"SamplingFrequency": 250,
7+
"PowerLineFrequency": 60,
8+
"SoftwareFilters": "n/a"
9+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"onset": {
3+
"Description": "REQUIRED. Onset (in seconds) of the event, measured from the beginning of the acquisition of the first data point stored in the corresponding task data file. Negative onsets are allowed, to account for events that occur prior to the first stored data point."
4+
},
5+
"duration": {
6+
"Description": "REQUIRED. Duration of the event (measured from onset) in seconds"
7+
},
8+
"annotation_type": {
9+
"LongName": "Hierarchical Event Descriptors annotations",
10+
"Description": "EEG interpretation Hierarchical Event Descriptors annotations",
11+
"Levels": {
12+
"eyem": "Eye movements can cause artifacts on recordings. The charge of the eye can especially cause artifacts in electrophysiology data.",
13+
"elec": "Non biological artifacts encompass various electrode related artifacts, such as electrode pop and electrode movement.",
14+
"musc": "EMG artifact. Artifact from muscle activity and myogenic potentials at the measurements site.",
15+
"eyem_musc": "Eye and Muscle artifacts."
16+
},
17+
"HED": {
18+
"eyem": "Eye-movement-artifact",
19+
"elec": "Nonbiological-artifact",
20+
"musc": "EMG-artifact",
21+
"eyem_musc": "(Eye-movement-artifact, EMG-artifact)"
22+
}
23+
},
24+
"channel": {
25+
"LongName": "Annotated channel",
26+
"Description": "Space separated list of annotated channels corresponding to *_channels.tsv.",
27+
"Delimiter": " ",
28+
"HED": "Parameter-value/#"
29+
}
30+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
onset duration annotation_type channel
2+
0.365 59.3031 eyem_musc FP1-F7 FP2-F8 F8-T4 FP1-F3 FP2-F4
3+
61.0066 5.2489 eyem FP1-F7 FP2-F8 FP1-F3 FP2-F4
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": {
3+
"Description": "REQUIRED. Label of the channel."
4+
},
5+
"type": {
6+
"Description": "REQUIRED. Type of channel; MUST use the channel types listed in bids-specification."
7+
},
8+
"units": {
9+
"Description": "REQUIRED. Physical unit of the value represented in this channel."
10+
}
11+
}
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name type units
2+
FP1-F7 EEG uV
3+
F7-T3 EEG uV
4+
T3-T5 EEG uV
5+
T5-O1 EEG uV
6+
FP2-F8 EEG uV
7+
F8-T4 EEG uV
8+
T4-T6 EEG uV
9+
T6-O2 EEG uV
10+
A1-T3 EEG uV
11+
T3-C3 EEG uV
12+
C3-CZ EEG uV
13+
CZ-C4 EEG uV
14+
C4-T4 EEG uV
15+
T4-A2 EEG uV
16+
FP1-F3 EEG uV
17+
F3-C3 EEG uV
18+
C3-P3 EEG uV
19+
P3-O1 EEG uV
20+
FP2-F4 EEG uV
21+
F4-C4 EEG uV
22+
C4-P4 EEG uV
23+
P4-O2 EEG uV

xeeg_hed_score/sub-eegSeizureTUH/ses-eeg01/eeg/sub-eegSeizureTUH_ses-eeg01_task-rest_run-000_eeg.edf

Whitespace-only changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"TaskName": "rest",
3+
"TaskDescription": "Subject resting",
4+
"InstitutionName": "Temple University Hospital",
5+
"EEGReference": "bipolar banana montage",
6+
"SamplingFrequency": 250,
7+
"PowerLineFrequency": 60,
8+
"SoftwareFilters": "n/a"
9+
}

xeeg_hed_score/sub-eegSeizureTUH/ses-eeg01/eeg/sub-eegSeizureTUH_ses-eeg01_task-rest_run-001_eeg.edf

Whitespace-only changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"TaskName": "rest",
3+
"TaskDescription": "Subject resting",
4+
"InstitutionName": "Temple University Hospital",
5+
"EEGReference": "bipolar banana montage",
6+
"SamplingFrequency": 250,
7+
"PowerLineFrequency": 60,
8+
"SoftwareFilters": "n/a"
9+
}

xeeg_hed_score/sub-eegSeizureTUH/ses-eeg01/eeg/sub-eegSeizureTUH_ses-eeg01_task-rest_run-002_eeg.edf

Whitespace-only changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"TaskName": "rest",
3+
"TaskDescription": "Subject resting",
4+
"InstitutionName": "Temple University Hospital",
5+
"EEGReference": "bipolar banana montage",
6+
"SamplingFrequency": 250,
7+
"PowerLineFrequency": 60,
8+
"SoftwareFilters": "n/a"
9+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"duration": {
3+
"HED": "Duration/# second"
4+
},
5+
"seizure_info": {
6+
"LongName": "Hierarchical Event Descriptors annotations",
7+
"Description": "EEG interpretation Hierarchical Event Descriptors annotations from the HED-SCORE library",
8+
"Levels": {
9+
"tcs": "A sequence consisting of a tonic followed by a clonic phase. Definition from ILAE 2017 Classification of Seizure Types Expanded Version."
10+
},
11+
"HED": {
12+
"tcs": "({duration}, (Tonic-clonic-seizure,(Parameter-label/channels,{channel})))"
13+
}
14+
},
15+
"channel":{
16+
"LongName": "Channels involved in the seizure.",
17+
"Description": "Space separated list of annotated channels corresponding to *_channels.tsv.",
18+
"Delimiter": " ",
19+
"HED": "Parameter-value/#"
20+
}
21+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
onset duration seizure_info channel
2+
8.8275 118.1255 tcs CZ-C4 F4-C4 C4-P4 P4-O2
3+
8.8275 164.3851 tcs C4-T4
4+
13.8275 159.5516 tcs F8-T4 T4-T6
5+
24.8325 148.4851 tcs T4-A2
6+
24.8325 102.2255 tcs T3-T5 T5-O1 FP2-F8 T6-O2 A1-T3 T3-C3 C3-CZ FP1-F3 F3-C3 C3-P3 P3-O1 FP2-F4

xeeg_hed_score/sub-eegSeizureTUH/ses-eeg01/eeg/sub-eegSeizureTUH_ses-eeg01_task-rest_run-003_eeg.edf

Whitespace-only changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"TaskName": "rest",
3+
"TaskDescription": "Subject resting",
4+
"InstitutionName": "Temple University Hospital",
5+
"EEGReference": "bipolar banana montage",
6+
"SamplingFrequency": 250,
7+
"PowerLineFrequency": 60,
8+
"SoftwareFilters": "n/a"
9+
}

0 commit comments

Comments
 (0)