You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/modality-specific-files/physiological-recordings.md
+76Lines changed: 76 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,11 +72,87 @@ electrocardiogram, respiratory movement measured with a respiration belt,
72
72
gas concentration, or eye-tracking, MUST use `_physio.<tsv.gz|json>` pairs.
73
73
74
74
### Storing different recordings
75
+
76
+
Recorded physio data **MUST** be split into separate data files in case of
77
+
difference in top-level metadata like `SamplingFrequency`, `Software`, and
78
+
`Manufacturer` of the main recording device (i.e., data source). These
79
+
top-level metadata are discussed in the following section.
80
+
81
+
Data with common top-level metadata **MAY** be kept aggregated in one file
82
+
otherwise, or split based on channel type, if preferred.
83
+
The sole exception is eye tracking data, that **MUST** be split in its own
84
+
file, following [its specification](#eye-tracking).
85
+
86
+
We **RECOMMEND** keeping different files from different recording
87
+
devices separate, but for easier inspection and analysis they can kept together
88
+
to get a clearer picture of what the fluctuations describe (e.g., looking
89
+
at ventilation and respiration together, or PPG and ECG for motion artifacts).
90
+
91
+
We **RECOMMEND** to store trigger signals recorded alongside physiological channels in the same file when concurrent modalities are collected (e.g. functional MRI or EEG).
92
+
75
93
The [`recording-<label>`](../appendices/entities.md#recording)
76
94
entity MAY be used to distinguish between several recording files.
77
95
Recordings with different metadata such as sampling frequencies
78
96
or recording device MUST be stored in separate files with different
<!-- #!# There is a mention of `MeasurementType` that may be wrong -->
100
+
It is possible that the `recording-<label>` entity uses terms that could be confused with metadata field values, such as `MeasurementType` or `SamplingFrequency`. In that case, the lowest metadata level available should always be interpreted as the most reliable information. For instance, if the file name contains `recording-1000hz` but the `SamplingFrequency` metadata indicates a sampling frequency of 100Hz, data **MUST** be interpreted as being sampled at 100 Hz. Similarly, if the entity `recording-ecg` is used, but the `MeasurementType` metadata of the contained columns indicate “ppg” and “Ventilation”, the data **MUST** be interpreted as PPG and Ventilation, and not ECG.
101
+
102
+
103
+
<!-- #!# Conflict here -->
104
+
**For example:**
105
+
106
+
**Splitting recorded data into separate physio data files**
107
+
108
+
{{ MACROS___make_filetree_example(
109
+
{
110
+
"sub-001": {
111
+
"ses-01": {
112
+
"physio": {
113
+
"sub-001_ses-01_recording-scr_physio.json": "",
114
+
"sub-001_ses-01_recording-scr_physio.tsv.gz": "",
115
+
"sub-001_ses-01_recording-ecg_physio.json": "",
116
+
"sub-001_ses-01_recording-ecg_physio.tsv.gz": "",
117
+
"sub-001_ses-01_recording-resp_physio.json": "",
118
+
"sub-001_ses-01_recording-resp_physio.tsv.gz": ""
119
+
},
120
+
},
121
+
}
122
+
}
123
+
) }}
124
+
125
+
**Combining recorded data into one pair of physio data files**
126
+
127
+
{{ MACROS___make_filetree_example(
128
+
{
129
+
"sub-001": {
130
+
"ses-01": {
131
+
"physio": {
132
+
"sub-001_ses-01_physio.json": "",
133
+
"sub-001_ses-01_physio.tsv.gz": ""
134
+
},
135
+
},
136
+
}
137
+
}
138
+
) }}
139
+
140
+
{{ MACROS___make_filetree_example(
141
+
{
142
+
"dataset":{
143
+
"sub-<label>": {
144
+
"ses-<label>": {
145
+
"physio": {
146
+
"sub-001_ses-01_physio.json": "",
147
+
"sub-001_ses-01_physio.tsv.gz": "",
148
+
},
149
+
},
150
+
}
151
+
}
152
+
}
153
+
) }}
154
+
155
+
80
156
For example, given a BOLD acquisition of a breath-holding task (`task-bht`)
81
157
for which pulse and respiratory movement were sampled at different frequencies,
0 commit comments