-
Notifications
You must be signed in to change notification settings - Fork 34
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.
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
Proposal: measurementLists
Group as alternative to many measurementList1
...measurementList2
indexed groups
#115
Merged
Merged
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
b29b163
Update CHANGELOG.md
sstucker 9232971
`sourceLabels` is string 2-D array
sstucker ac497de
Update CHANGELOG.md
sstucker 254b65e
Merge branch 'fNIRS:master' into master
sstucker c88c859
Add `nirs(i)/data(j)/measurementLists` as an alternative to the index…
sstucker fd5d7e6
Fix wording on measurementLists description
samuelpowell 3a3228e
Merge branch 'master' into indexed-group-change
samuelpowell 9093c4e
Update wordlist with measurementLists
samuelpowell 1a5b43f
Update snirf_specification.md
dboas 22a897a
Remove fields that are removed in PR #151
sreekanthkura7 06ada41
Merge branch 'master' into indexed-group-change
sreekanthkura7 4e5998e
update snirf_specification.md
sreekanthkura7 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -281,3 +281,4 @@ dataOffset | |
forihuelaespina | ||
StO | ||
StO2 | ||
measurementLists |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -411,7 +411,7 @@ a time spacing of 0.2 (s) indicates a sampling rate of 5 Hz. | |
Chunked data is allowed to support real-time streaming of data in this array. | ||
|
||
#### /nirs(i)/data(j)/measurementList(k) | ||
* **Presence**: required | ||
* **Presence**: required if `measurementLists` is not present | ||
* **Type**: indexed group | ||
* **Location**: `/nirs(i)/data(j)/measurementList(k)` | ||
|
||
|
@@ -537,6 +537,119 @@ As described below, optional variables `probe.sourceLabels` and | |
`probe.detectorLabels` are provided for indicating the instrument specific | ||
label for sources and detectors. | ||
|
||
#### /nirs(i)/data(j)/measurementLists | ||
* **Presence**: optional | ||
* **Type**: group | ||
* **Location**: `/nirs(i)/data(j)/measurementLists` | ||
|
||
The group for measurement list variables which map the data array onto the probe geometry (sources and detectors), data type, and wavelength. This group's datasets are arrays with size `<number of channels>`, with each position describing the corresponding column in the data matrix. (i.e. the values at `measurementLists/sourceIndex(3)` and `measurementLists/detectorIndex(3)` correspond to `dataTimeSeries(:,3)`). | ||
|
||
This group is required only if the indexed-group format `/nirs(i)/data(j)/measurementList(k)` is not used to encode the measurement list. `measurementLists` is an alternative that may offer better performance for larger probes. | ||
|
||
The arrays of `measurementLists` are: | ||
samuelpowell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
#### /nirs(i)/data(j)/measurementLists/sourceIndex | ||
* **Presence**: required if measurementLists is present | ||
* **Type**: integer 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/sourceIndex` | ||
|
||
Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. Source indices for each channel. | ||
samuelpowell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
#### /nirs(i)/data(j)/measurementLists/detectorIndex | ||
* **Presence**: required if measurementLists is present | ||
* **Type**: integer 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/detectorIndex` | ||
|
||
Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. Detector indices for each channel. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/wavelengthIndex | ||
* **Presence**: required if measurementLists is present | ||
* **Type**: integer 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/wavelengthIndex` | ||
|
||
Must be 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`) per channel. | ||
samuelpowell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
#### /nirs(i)/data(j)/measurementLists/wavelengthActual | ||
* **Presence**: optional | ||
* **Type**: numeric 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/wavelengthActual` | ||
|
||
Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. Actual (measured) wavelength in nm, if available, for the source in each channel. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/wavelengthEmissionActual | ||
* **Presence**: optional | ||
* **Type**: numeric 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/wavelengthEmissionActual` | ||
|
||
Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. Actual (measured) emission wavelength in nm, if available, for the source in each channel. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/dataType | ||
* **Presence**: required if measurementLists is present | ||
* **Type**: integer 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/dataType` | ||
|
||
Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. See Appendix for list of possible values. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/dataUnit | ||
* **Presence**: optional | ||
* **Type**: string 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/dataUnit` | ||
|
||
Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. International System of Units (SI units) identifier for each channel. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/dataTypeLabel | ||
* **Presence**: optional | ||
* **Type**: string 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/dataTypeLabel` | ||
|
||
Data-type label. Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/dataTypeIndex | ||
* **Presence**: required if measurementLists is present | ||
* **Type**: integer 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/dataTypeIndex` | ||
|
||
Data-type specific parameter indices. Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. Note that the Time Domain and Diffuse Correlation Spectroscopy data types have two additional parameters and so `dataTimeIndex` must be a 2-D array with 2 columns that index the additional parameters. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/sourcePower | ||
* **Presence**: optional | ||
* **Type**: numeric 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/sourcePower` | ||
|
||
Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. Units are optionally defined in `metaDataTags`. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/detectorGain | ||
* **Presence**: optional | ||
* **Type**: numeric 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/detectorGain` | ||
|
||
Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. Units are optionally defined in `metaDataTags`. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/moduleIndex | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove field |
||
* **Presence**: optional | ||
* **Type**: integer 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/moduleIndex` | ||
|
||
Index of a repeating module. Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/sourceModuleIndex | ||
samuelpowell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* **Presence**: optional | ||
* **Type**: integer 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/sourceModuleIndex` | ||
|
||
Index of the module that contains the source of the channel. | ||
This index must be used together with `detectorModuleIndex`, and | ||
can not be used when `moduleIndex` presents. Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. | ||
|
||
#### /nirs(i)/data(j)/measurementLists/detectorModuleIndex | ||
samuelpowell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* **Presence**: optional | ||
* **Type**: integer 1-D array | ||
* **Location**: `/nirs(i)/data(j)/measurementLists/detectorModuleIndex` | ||
samuelpowell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Index of the module that contains the detector of the channel. | ||
This index must be used together with `sourceModuleIndex`, and | ||
can not be used when `moduleIndex` presents. Must be 1-D array with length equal to the size of the second dimension of `/nirs(i)/data(j)/dataTimeSeries`. | ||
|
||
#### /nirs(i)/stim(j) | ||
* **Presence**: optional | ||
* **Type**: indexed group | ||
|
@@ -574,7 +687,7 @@ used to annotate the meanings of each data column. | |
|
||
#### /nirs(i)/stim(j)/dataLabels | ||
* **Presence**: optional | ||
* **Type**: string array | ||
* **Type**: string 1-D array | ||
* **Location**: `/nirs(i)/stim(j)/dataLabels(k)` | ||
|
||
This is a string array providing annotations for each data column in | ||
|
@@ -754,7 +867,7 @@ wavelengths>`. This is indexed by `measurementList(k).sourceIndex` and | |
|
||
#### /nirs(i)/probe/detectorLabels | ||
* **Presence**: optional | ||
* **Type**: string array | ||
* **Type**: string 1-D array | ||
* **Location**: `/nirs(i)/probe/detectorLabels(j)` | ||
|
||
This is a string array providing user friendly or instrument specific labels | ||
|
@@ -793,7 +906,7 @@ index to the labels of the given landmark. Label names are stored in the | |
|
||
#### /nirs(i)/probe/landmarkLabels(j) | ||
* **Presence**: optional | ||
* **Type**: string array | ||
* **Type**: string 1-D array | ||
* **Location**: `/nirs(i)/probe/landmarkLabels(j)` | ||
|
||
This string array stores the names of the landmarks. The first string denotes | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be 'required if
measurementList
is not present' for parity with @dboas changes to measurementList(k)?