Skip to content

Commit 229f836

Browse files
Add the dataset structure for EMG-BIDS examples
1 parent e52f77f commit 229f836

File tree

44 files changed

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

44 files changed

+688
-0
lines changed

emg_examples/.bidsignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Ignore any markdown file in the root directory, they include the source specifications
2+
*.md

emg_examples/Fields necessary to describe EMG-BIDS recordings.md

Lines changed: 565 additions & 0 deletions

emg_examples/README

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# EMG BIDS Examples Dataset
2+
3+
This dataset contains examples of different EMG recording setups to demonstrate various ways of documenting EMG data according to the BIDS specification. Each example includes metadata files in BIDS format describing the recording setup, electrode placement, and other relevant information. The examples follow a discussion of the [EMG metadata fields](https://docs.google.com/document/d/1s4SbStsm2VXqFbHEVF6Og7BCtjsRUDhzcZj9LO07r6Q) during the development of the BIDS-EMG extension. Each subject represents a different EMG recording configuration, showcasing different aspects of EMG metadata documentation.
4+
5+
## Dataset Structure
6+
7+
The dataset includes 6 example subjects showing different EMG recording configurations:
8+
9+
```shell
10+
.
11+
├── dataset_description.json
12+
├── participants.json
13+
├── participants.tsv
14+
├── sub-s1CustomBipolar/
15+
├── sub-s2IndependentMod/
16+
├── sub-s3CustomBipolarFace/
17+
├── sub-s5TwoHDsEMG/
18+
├── sub-s6MutliBodyParts/
19+
└── sub-s8concurrentIndepndentUnits/
20+
```
21+
22+
## Example Descriptions
23+
24+
### sub-s1CustomBipolar
25+
Demonstrates documentation of a custom-made bipolar EMG system recording from flexors of the lower arm. Shows how to document:
26+
- Single channel bipolar montage
27+
- Precise electrode placement using anatomical landmarks
28+
- Inter-electrode distance specifications
29+
30+
### sub-s2IndependentMod
31+
Shows documentation for commercial bipolar EMG modules recording from multiple muscles. Highlights:
32+
- Multiple independent bipolar channels
33+
- Wireless sensors
34+
- Documentation of multiple target muscles
35+
36+
### sub-s3CustomBipolarFace
37+
Illustrates recording from facial muscles with:
38+
- Many-to-many mapping between sensors and muscles
39+
- Functional localization for electrode placement
40+
- Recording from muscles without bony landmarks
41+
42+
### sub-s5TwoHDsEMG
43+
Demonstrates high-density EMG grid recordings from two body parts:
44+
- Multiple HD-EMG grids
45+
- Grid placement documentation
46+
- Channel grouping specifications
47+
48+
### sub-s6MutliBodyParts
49+
Shows recording from multiple body parts with:
50+
- Different types of electrodes
51+
- Multiple amplifier configurations
52+
- Complex electrode placement schemes
53+
54+
### sub-s8concurrentIndepndentUnits
55+
Illustrates concurrent recording with:
56+
- Multiple independent recording units
57+
- Different sampling rates
58+
- Synchronization between units
59+
60+
## Purpose
61+
62+
This dataset serves as a reference implementation showing how different EMG recording setups can be documented in BIDS format. Each example demonstrates specific aspects of EMG metadata documentation including:
63+
64+
- Electrode placement methods
65+
- Montage types
66+
- Channel configurations
67+
- Target muscle documentation
68+
- Recording system specifications
69+
- Spatial relationships between electrodes
70+
71+
## Usage
72+
73+
These examples can be used as templates when converting EMG data to BIDS format. The metadata fields and documentation approaches shown here cover common EMG recording scenarios.
74+
75+
## License
76+
77+
[Add license information]
78+
79+
## References
80+
81+
[Add relevant references]
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"Name": "Sample EMG dataset",
3+
"License": "BSD 3-Clause",
4+
"Authors": ["BEP042 Team"],
5+
"ReferencesAndLinks": ["https://github.com/bids-standard/bids-specification/issues/1371",
6+
"https://github.com/bids-standard/bids-specification/pull/1998"],
7+
"EthicsApprovals": ["Datasets are de-identified hypotheticals and do not require ethics approval."],
8+
"BIDSVersion": "1.10.0",
9+
"HEDVersion": "8.3.0",
10+
"DatasetType": "raw",
11+
"Acknowledgements": "We thank the participants and their families for their time and effort. We also thank the NeuroScience Gateway team for providing computational resources.",
12+
"GeneratedBy":[ {
13+
"Name": "bids-matlab-tools",
14+
"Version": "9.1"
15+
}]
16+
}

emg_examples/participants.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"participant_id": {
3+
"Description": "The prticipant name corresponding to the examples in the metadata discussion"
4+
},
5+
"sex": {
6+
"LongName": "Gender",
7+
"Description": "Gender",
8+
"Levels": {
9+
"F": "Female",
10+
"M": "Male"
11+
}
12+
},
13+
"age": {
14+
"LongName": "Age",
15+
"Description": "Age in years"
16+
}
17+
}

emg_examples/participants.tsv

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
participant_id age sex
2+
sub-s1CustomBipolar 25 M
3+
sub-s2IndependentMod 30 F
4+
sub-s3CustomBipolarFace 35 M
5+
sub-s5TwoHDsEMG 40 F
6+
sub-s6MutliBodyParts 45 M
7+
sub-s8concurrentIndepndentUnits 50 F

emg_examples/sub-s1CustomBipolar/emg/sub-s1CustomBipolar_task-holdWeight_channels.json

Whitespace-only changes.

emg_examples/sub-s1CustomBipolar/emg/sub-s1CustomBipolar_task-holdWeight_channels.tsv

Whitespace-only changes.

emg_examples/sub-s1CustomBipolar/emg/sub-s1CustomBipolar_task-holdWeight_electrodes.json

Whitespace-only changes.

emg_examples/sub-s1CustomBipolar/emg/sub-s1CustomBipolar_task-holdWeight_electrodes.tsv

Whitespace-only changes.

0 commit comments

Comments
 (0)