Skip to content

Commit

Permalink
Merge pull request #167 from effigies/enh/timeseries_metadata
Browse files Browse the repository at this point in the history
[FIX] Clarify continuous recording metadata fields
  • Loading branch information
sappelhoff authored May 7, 2019
2 parents c782b7a + 0b7a530 commit e32a4a9
Showing 1 changed file with 22 additions and 12 deletions.
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 @@ -90,6 +97,9 @@ sub-control01/
{
"SamplingFrequency": 100.0,
"StartTime": -22.345,
"Columns": ["cardiac", "respiratory", "trigger"]
"Columns": ["cardiac", "respiratory", "trigger"],
"cardiac": {
"Units": "mV"
}
}
```

0 comments on commit e32a4a9

Please sign in to comment.