Skip to content

CHANGELOG.md

Latest commit

 

History

History
45 lines (35 loc) · 2.71 KB

CHANGELOG.md

File metadata and controls

45 lines (35 loc) · 2.71 KB
Raw

Change Log For The SNIRF File Format

SNIRF uses the Semantic Versioning scheme.

In development

  • Add nirs(i)/data(j)/measurementLists as an alternative to the indexed-Group measurementList nirs(i)/data(j)/measurementList(k).
  • Add nirs(i)/data(j)/name as an optional, free-form string field to label time series (#177)

v1.1

  • Added dataUnit to indexed groups aux and measurementList
  • Uses of the word "numerical" were replaced with "numeric" for consistency.
  • stim/data was incorrectly described as [<f>,...]+ in the table when it should be [[<f>,...]]+
  • aux/dataTimeSeries was incorrectly described as [[<f>,...]]+ in the table when it should be [<f>,...]+
  • aux/dataTimeSeries and aux/time were described as numeric in the document when they should be 1-D numeric array
  • probe/detectorPos2D was described as numeric in the document when it should be 2-D array
  • Added "Data format" section
  • Specified that non-array fields must be saved using scalar dataspaces, and that array fields must be saved using simple dataspaces of the specified rank
  • Specified that all strings must be saved in a variable length format
  • Added writing code samples
  • Removed ambiguity in the units of the nirs(i)/data(j)/measurementList(k)/sourcePower field, which were defined as both being in mW, and arbitrary. Only the latter definition is retained.
  • Changed /nirs(i)/data(j)/time and /nirs(i)/aux(j)/time to specify the variable be stored as a rank-1 array, rather than a rank-2 array with a singleton trailing dimension.
  • Specified that probe/sourceLabels is 2D string array. In wavelength-less case, spec describes 2nd dimension of 1
  • Specified that aux{i}/dataTimeSeris is a 2D array. Multiple channels of data can be present, otherwise 2nd dimension should be 1.
  • Added language preventing metaDataTags sub-groups
  • Added notice that the summary table is intended to be machine-readable
  • Removed local channel indexing owing to incomplete specification.

v1.0 (September 23 2021)

View this version of the specification

  • General clarification of wording throughout the specification.
  • Removed sourcePos, detectorPos, and landmarkPos.
  • Added wavelengthActual and wavelengthEmissionActual.
  • Changed stim/data names from attribute to regular dataset.
  • Required either 2D or 3D positions, not just 2D.
  • Added list of supported aux name values including accel, gyro, magn
  • Added datatypes for processed TD moment data.

v1.0 - Draft 3 (November 11 2019)

View this version of the specification

  • Initial version with change log.