diff --git a/snirf_specification.md b/snirf_specification.md index b386d7c..5430aef 100644 --- a/snirf_specification.md +++ b/snirf_specification.md @@ -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 @@ -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 | `[[,...]]`* | -|        `time`                         | * Time (in `TimeUnit` defined in metaDataTag)|  `[,...]` * | |        `dataOffset`                   | * Optional offset value per channel |  `[,...]` | -|        `measurementList{i}`           | * Per-channel source-detector information    |  `{i}` * | +|        `time`                         | * Time (in `TimeUnit` defined in metaDataTag)|  `[,...]` * | +|        `measurementList{i}`           | * Per-channel source-detector information    |  `{i}` *¹| |            `sourceIndex`              | * Source index for a given channel  |   ``  * | |            `detectorIndex`            | * Detector index for a given channel  |   ``  * | |            `wavelengthIndex`          | * Wavelength index for a given channel  |   ``  * | @@ -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  |   ``  * | |            `sourcePower`              | * Source power for a given channel  |   ``    | |            `detectorGain`             | * Detector gain for a given channel  |   ``    | -|        `measurementLists`            | * source-detector information     |  `{.}` * | +|        `measurementLists`            | * source-detector information     |  `{.}` *¹| |            `sourceIndex`              | * Source index for each channel |   `[,...]`* | |            `detectorIndex`            | * Detector index for each channel |   `[,...]`* | |            `wavelengthIndex`          | * Wavelength index for each channel |   `[,...]`* | @@ -196,15 +196,15 @@ Note that this table serves as machine-readable schema for the SNIRF format. Its |            `detectorGain`             | * Detector gain for each channel |   `[,...]`  | |     `stim{i}`                         | * Root-group for stimulus measurements       |  `{i}`    | |         `name`                        | * Name of the stimulus data     |   `"s"`  + | -|         `data`                        | * Data stream of the stimulus channel | `[[,...]]` +| +|         `data`                        | * Data stream of the stimulus channel | `[[,...]]`+ | |         `dataLabels`                  | * Names of additional columns of stim data |  `["s",...]`  | |     `probe`                           | * Root group for NIRS probe information      |  `{.}` * | |         `wavelengths`                 | * List of wavelengths (in nm)  | `[,...]` * | |         `wavelengthsEmission`         | * List of emission wavelengths (in nm) | `[,...]`   | -|         `sourcePos2D`                 | * Source 2-D positions in `LengthUnit` | `[[,...]]`*¹| -|         `sourcePos3D`                 | * Source 3-D positions in `LengthUnit` | `[[,...]]`*¹| -|         `detectorPos2D`               | * Detector 2-D positions in `LengthUnit` | `[[,...]]`*²| -|         `detectorPos3D`               | * Detector 3-D positions in `LengthUnit` | `[[,...]]`*²| +|         `sourcePos2D`                 | * Source 2-D positions in `LengthUnit` | `[[,...]]`*²| +|         `sourcePos3D`                 | * Source 3-D positions in `LengthUnit` | `[[,...]]`*²| +|         `detectorPos2D`               | * Detector 2-D positions in `LengthUnit` | `[[,...]]`*³| +|         `detectorPos3D`               | * Detector 3-D positions in `LengthUnit` | `[[,...]]`*³| |         `frequencies`                 | * Modulation frequency list  |  `[,...]`   | |         `timeDelays`                  | * Time delays for gated time-domain data |  `[,...]`   | |         `timeDelayWidths`             | * Time delay width for gated time-domain data|  `[,...]`   | @@ -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 @@ -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`