Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FIX] Clarify continuous recording metadata fields #167

Merged
merged 5 commits into from
May 7, 2019
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,24 @@ directory. For example:`task-movie_stim.tsv.gz`
Physiological recordings such as cardiac and respiratory signals and other
continuous measures (such as parameters of a film or audio stimuli) can be
specified using two files: a gzip compressed TSV file with data (without header
line) and a JSON for storing start time, sampling frequency, and name of the
columns from the TSV. Please note that in contrast to other TSV files this one
does not include a header line. Instead the name of columns are specified in the
JSON file. This is to improve compatibility with existing software (FSL PNM) as
well as make support for other file formats possible in the future. Start time
should be expressed in seconds in relation to the time of start of acquisition
of the first volume in the corresponding imaging file (negative values are
allowed). Sampling frequency should be expressed in Hz. Recordings with
different sampling frequencies and/or starting times should be stored in
separate files. The following naming conventions should be used for column
names:
line) and a JSON for storing the following metadata fields:

| Field name | Definition |
| :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| SamplingFrequency | REQUIRED. Sampling frequency in Hz of all columns in the file. |
| StartTime | REQUIRED. Start time in seconds in relation to the start of acquisition of the first data sample in the corresponding neural dataset (negative values are allowed). |
| Columns | REQUIRED. Names of columns in file. |

Additional metadata may be included as in
[any TSV file](../02-common-principles.md#tabular-files) to specify, for
example, the units of the recorded time series.
Please note that in contrast to other TSV files this one does not include a
header line. Instead the name of columns are specified in the JSON file.
This is to improve compatibility with existing software (FSL PNM) as
well as make support for other file formats possible in the future.
Recordings with different sampling frequencies and/or starting times should be
stored in separate files.
The following naming conventions should be used for column names:

| Column name | Definition |
| :---------- | :--------------------------------------------------- |
Expand Down Expand Up @@ -91,5 +98,8 @@ sub-control01/
"SamplingFrequency": 100.0,
"StartTime": -22.345,
"Columns": ["cardiac", "respiratory", "trigger"]
effigies marked this conversation as resolved.
Show resolved Hide resolved
"cardiac": {
"Units": "mV"
}
}
```