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.

Sign up for GitHub

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

Bump version number to 1.2.0-development; fix ordering and formatting of spec entries in schema table; adjust format of dataTypes appendix table #165

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Bump version number to 1.2.0-development; fix ordering and formatting of spec entries in schema table; adjust format of dataTypes appendix table #165

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a96d7db
Update snirf_specification.md
sstucker Dec 27, 2024
820032f
Update snirf_specification.md
sstucker Dec 27, 2024
255c488
Update snirf_specification.md
sstucker Dec 27, 2024
cb52dab
Update snirf_specification.md
sstucker Dec 27, 2024
ca4e46d
Edit dataType schema
sstucker Dec 31, 2024
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
23 changes: 11 additions & 12 deletions snirf_specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Shared Near Infrared Spectroscopy Format (SNIRF) Specification
==============================================================

* **Document Version**: v1.1
* **Document Version**: 1.2.0-development
* **License**: This document is in the public domain.

## Table of Content
Expand Down Expand Up @@ -168,9 +168,9 @@ Note that this table serves as machine-readable schema for the SNIRF format. Its
|         ...                           | * Additional user-defined metadata entries   |          |
|     `data{i}`                         | * Root-group for 1 or more data blocks    |  `{i}` * |
|        `dataTimeSeries`               | * Time-varying signals from all channels | `[[<f>,...]]`* |
|        `time`                         | * Time (in `TimeUnit` defined in metaDataTag)|  `[<f>,...]` * |
|        `dataOffset`                   | * Optional offset value per channel |  `[<f>,...]` |
|        `measurementList{i}`           | * Per-channel source-detector information    |  `{i}` * |
|        `time`                         | * Time (in `TimeUnit` defined in metaDataTag)|  `[<f>,...]` * |
|        `measurementList{i}`           | * Per-channel source-detector information    |  `{i}` *¹|
|            `sourceIndex`              | * Source index for a given channel  |   `<i>`  * |
|            `detectorIndex`            | * Detector index for a given channel  |   `<i>`  * |
|            `wavelengthIndex`          | * Wavelength index for a given channel  |   `<i>`  * |
Expand All @@ -182,7 +182,7 @@ Note that this table serves as machine-readable schema for the SNIRF format. Its
|            `dataTypeIndex`            | * Data type index for a given channel  |   `<i>`  * |
|            `sourcePower`              | * Source power for a given channel  |   `<f>`    |
|            `detectorGain`             | * Detector gain for a given channel  |   `<f>`    |
|        `measurementLists`            | * source-detector information     |  `{.}` * |
|        `measurementLists`            | * source-detector information     |  `{.}` *¹|
|            `sourceIndex`              | * Source index for each channel |   `[<i>,...]`* |
|            `detectorIndex`            | * Detector index for each channel |   `[<i>,...]`* |
|            `wavelengthIndex`          | * Wavelength index for each channel |   `[<i>,...]`* |
Expand All @@ -196,15 +196,15 @@ Note that this table serves as machine-readable schema for the SNIRF format. Its
|            `detectorGain`             | * Detector gain for each channel |   `[<f>,...]`  |
|     `stim{i}`                         | * Root-group for stimulus measurements       |  `{i}`    |
|         `name`                        | * Name of the stimulus data     |   `"s"`  + |
|         `data`                        | * Data stream of the stimulus channel | `[[<f>,...]]` +|
|         `data`                        | * Data stream of the stimulus channel | `[[<f>,...]]`+ |
|         `dataLabels`                  | * Names of additional columns of stim data |  `["s",...]`  |
|     `probe`                           | * Root group for NIRS probe information      |  `{.}` * |
|         `wavelengths`                 | * List of wavelengths (in nm)  | `[<f>,...]` * |
|         `wavelengthsEmission`         | * List of emission wavelengths (in nm) | `[<f>,...]`   |
|         `sourcePos2D`                 | * Source 2-D positions in `LengthUnit` | `[[<f>,...]]`*¹|
|         `sourcePos3D`                 | * Source 3-D positions in `LengthUnit` | `[[<f>,...]]`*¹|
|         `detectorPos2D`               | * Detector 2-D positions in `LengthUnit` | `[[<f>,...]]`*²|
|         `detectorPos3D`               | * Detector 3-D positions in `LengthUnit` | `[[<f>,...]]`*²|
|         `sourcePos2D`                 | * Source 2-D positions in `LengthUnit` | `[[<f>,...]]`*²|
|         `sourcePos3D`                 | * Source 3-D positions in `LengthUnit` | `[[<f>,...]]`*²|
|         `detectorPos2D`               | * Detector 2-D positions in `LengthUnit` | `[[<f>,...]]`*³|
|         `detectorPos3D`               | * Detector 3-D positions in `LengthUnit` | `[[<f>,...]]`*³|
|         `frequencies`                 | * Modulation frequency list  |  `[<f>,...]`   |
|         `timeDelays`                  | * Time delays for gated time-domain data |  `[<f>,...]`   |
|         `timeDelayWidths`             | * Time delay width for gated time-domain data|  `[<f>,...]`   |
Expand Down Expand Up @@ -1004,13 +1004,11 @@ This variable specifies the offset of the file time origin relative to absolute
+ 001-100: Raw - Continuous Wave (CW)
- 001 - Amplitude
- 051 - Fluorescence Amplitude

+ 101-200: Raw - Frequency Domain (FD)
- 101 - AC Amplitude
- 102 - Phase
- 151 - Fluorescence Amplitude
- 152 - Fluorescence Phase

+ 201-300: Raw - Time Domain - Gated (TD Gated)
- 201 - Amplitude
- 251 - Fluorescence Amplitude
Expand All @@ -1020,7 +1018,8 @@ This variable specifies the offset of the file time origin relative to absolute
+ 401-500: Raw - Diffuse Correlation Spectroscopy (DCS):
- 401 - g2
- 410 - BFi
+ 99999: Processed
+ \>500:
- 99999 - Processed


### Supported `measurementList(k).dataTypeLabel` values in `dataTimeSeries`
Expand Down
Loading