Skip to content

Commit

Permalink
Merge branch 'master' into indexed-group-change
Browse files Browse the repository at this point in the history
  • Loading branch information
sreekanthkura7 authored Aug 16, 2024
2 parents 22a897a + 585e2e0 commit 06ada41
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 11 deletions.
File renamed without changes.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions .github/workflows/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,7 @@ Aghajan
Zahra
Jörn
OBELAB
dataOffset
forihuelaespina
StO
StO2
Expand Down
13 changes: 5 additions & 8 deletions GOVERNMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,14 @@ _"SNIRF Contributors"_ are individuals who have contributed changes, revisions,

**Section 3.** Terms. The Steering Committee is composed of 3 or 5 members of the fNIRS community who are elected to serve 3 year terms. The number of members should remain odd.

**Section 4.** Meetings. A majority of Steering Committee members must meet at least biannually. At least one Maintainer must be present at these meetings. These meetings should review the following:
- The most recent Maintainers Report
**Section 4.** Meetings. A majority of Steering Committee members must meet at least biannually (twice a year). At least one Maintainer must be present at these meetings. These meetings should review the following:
- Any pending releases or critical changes
- project priorities and progress towards goals
- Project priorities and progress towards goals
- Delegation of resources (i.e maintainers' attention) towards completion of goals

The meeting should result in the authorship of a brief report.
The meeting decisions shall be publicly documented.

**Section 5.** Steering Committee Reports. The Steering Committee must author a brief report following each of its required biannual meetings. This report must document the actions and considerations of the committee, and must be archived and disseminated via the GitHub repository. The report must include the names of the Steering Committee's members.
**Section 5.** Meeting Documentation. The Steering Committee must document its decisions following each of its required biannual meetings. This consists of disseminating the actions and considerations of the committee via the GitHub repository.

**Section 6.** GitHub Repository Role. Steering Committee members must have the role of `Admin` on the GitHub repository.

Expand All @@ -52,9 +51,7 @@ The meeting should result in the authorship of a brief report.

**Section 3.** Terms. Maintainers serve 2 year terms. At the end of their term, they must step down or seek the renewal of their title from a member of the Steering Committee.

**Section 4.** Maintainers' Report. Maintainers must collectively author a biannual report summarizing their prominent actions and considerations since their previous report. This document must include any critical issues or pending releases which the Steering Committee must consider.

**Section 5.** GitHub Repository Role. Maintainers must have the role of `Maintainer` on the GitHub repository.
**Section 4.** GitHub Repository Role. Maintainers must have the role of `Maintainer` on the GitHub repository.

### Article III. Additional Bylaws

Expand Down
19 changes: 16 additions & 3 deletions snirf_specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Shared Near Infrared Spectroscopy Format (SNIRF) Specification
* [metaDataTags](#nirsimetadatatags)
* [data](#nirsidataj)
* [data.dataTimeSeries](#nirsidatajdatatimeseries)
* [data.dataOffset](#nirsidatajdataoffset)
* [data.time](#nirsidatajtime)
* [data.measurementList](#nirsidatajmeasurementlistk)
* [data.measurementList.sourceIndex](#nirsidatajmeasurementlistksourceindex)
Expand Down Expand Up @@ -156,6 +157,7 @@ Note that this table serves as machine-readable schema for the SNIRF format. Its
|     `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>,...]` * |
|        `offset`                       |* Absolute offset for all channels |  `[<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>`*|
Expand Down Expand Up @@ -374,6 +376,19 @@ filter or [3rd party filters such as `305-LZO` or `307-bzip2`](https://portal.hd

Chunked data is allowed to support real-time streaming of data in this array.


#### /nirs(i)/data(j)/dataOffset
* **Presence**: optional
* **Type**: numeric 1-D array
* **Location**: `/nirs(i)/data(j)/dataOffset`

This stores an optional offset value per channel, which, when added to
`/nirs(i)/data(j)/dataTimeSeries`, results in absolute data values.

The length of this array is equal to the <number of channels> as represented
by the second dimension in the `dataTimeSeries`.


#### /nirs(i)/data(j)/time
* **Presence**: required
* **Type**: numeric 1-D array
Expand Down Expand Up @@ -473,9 +488,7 @@ for list of possible values.
* **Type**: integer
* **Location**: `/nirs(i)/data(j)/measurementList(k)/dataTypeIndex`

Data-type specific parameter indices. The data type index specifies additional data type specific parameters that are further elaborated by other fields in the probe structure, as detailed below. Note that the Time Domain and Diffuse Correlation Spectroscopy data types have two additional parameters and so the data type index must be a vector with 2 elements that index the additional parameters. One use of this parameter is as a
stimulus condition index when `measurementList(k).dataType = 99999` (i.e, `processed` and
`measurementList(k).dataTypeLabel = 'HRF ...'` .
Data-type specific parameter index. The data type index specifies additional data type specific parameters that are further elaborated by other fields in the probe structure, as detailed below. Note that where multiple parameters are required, the same index must be used into each (examples include data types such as Time Domain and Diffuse Correlation Spectroscopy). One use of this parameter is as a stimulus condition index when `measurementList(k).dataType = 99999` (i.e, `processed` and `measurementList(k).dataTypeLabel = 'HRF ...'` .

#### /nirs(i)/data(j)/measurementList(k)/sourcePower
* **Presence**: optional
Expand Down

0 comments on commit 06ada41

Please sign in to comment.