Update wavelengthIndex description for processed data - #175
Update wavelengthIndex description for processed data#175sreekanthkura7 wants to merge 2 commits into
Conversation
Clarified requirements for wavelengthIndex in processed data.
HanBnrd
left a comment
There was a problem hiding this comment.
Thanks @sreekanthkura7, good catch! Looks good to me!
|
I guess this change would require a respective adjustment in the validator, right? Is @sstucker still the designated validator maintainer? |
|
is this the final convention that has been decided on? Some readers have made their own convention, e.g. Cedalion uses -1 https://github.com/ibs-lab/cedalion/blob/main/src/cedalion/io/snirf.py#L1003 |
The validator has a bit of backlog on the specs, we could sort this as part of #183
@sreekanthkura7 could we do |
|
I do not mind if 0 or -1, but it'd be good to proceed. |
| * **Location**: `/nirs(i)/data(j)/measurementList(k)/wavelengthIndex` | ||
|
|
||
| Index of the "nominal" wavelength (in `probe.wavelengths`). | ||
| Index of the "nominal" wavelength (in `probe.wavelengths`). For processed data channels (dataType=99999) that are wavelength-independent or derived from multiple wavelengths, this field MUST be set to `0`. |
There was a problem hiding this comment.
| Index of the "nominal" wavelength (in `probe.wavelengths`). For processed data channels (dataType=99999) that are wavelength-independent or derived from multiple wavelengths, this field MUST be set to `0`. | |
| Index of the "nominal" wavelength (in `probe.wavelengths`). For processed data channels (dataType=99999) that are wavelength-independent or derived from multiple wavelengths, this field MUST be set to `-1`. |
| * **Location**: `/nirs(i)/data(j)/measurementLists/wavelengthIndex` | ||
|
|
||
| Index of the "nominal" wavelength (in `probe.wavelengths`) for each channel. A 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. | ||
| Index of the "nominal" wavelength (in `probe.wavelengths`) for each channel. A 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. For processed data channels (`dataType=99999`) that are wavelength-independent or derived from multiple wavelengths, the corresponding value MUST be `0`. |
There was a problem hiding this comment.
| Index of the "nominal" wavelength (in `probe.wavelengths`) for each channel. A 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. For processed data channels (`dataType=99999`) that are wavelength-independent or derived from multiple wavelengths, the corresponding value MUST be `0`. | |
| Index of the "nominal" wavelength (in `probe.wavelengths`) for each channel. A 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. For processed data channels (`dataType=99999`) that are wavelength-independent or derived from multiple wavelengths, the corresponding value MUST be `-1`. |
samuelpowell
left a comment
There was a problem hiding this comment.
Change is breaking, requires entries in CHANGELOG, etc.?
|
Is there a reason why we want to enforce a specific value here? We could make the change non-breaking by saying that if the data are processed and wavelength independent; that the value can be absent or any value. |
Clarified requirements for wavelengthIndex in processed data.
Closes #174