Skip to content

Commit

Permalink
Clarify the language for sourcePos and sourcePos3D, close #41
Browse files Browse the repository at this point in the history
  • Loading branch information
fangq authored Apr 27, 2020
1 parent da550ab commit 504a7f9
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions snirf_specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -553,19 +553,23 @@ is paired with this emission wavelength for a given measurement.
* **Location**: `/nirs(i)/probe/sourcePos`

This field describes the position (in `LengthUnit` units) of each source
optode. This field has size `<number of sources> x 3`. For example,
`probe.sourcePos(1,:) = [1.4 1 0]`, and `LengthUnit='cm'`; places source
optode. The postions can be either coordinates in a flattened 2D probe
geometry (`z` is assumed to be 0), or 3D positions in the world-coordinate
system. If both information is stored in the file, one should use `sourcePos`
to store the flattened 2D probe coordinates and `sourcePos3D` to store the
3D optode coordinates. This field has size `<number of sources> x 3`. For example,
`probe.sourcePos(1,:) = [1.4 1 0]`, and `LengthUnit='cm'` places source
number 1 at x=1.4 cm and y=1 cm and z=0 cm.

Dimensions are relative coordinates (i.e. to some arbitrary defined origin).

#### /nirs(i)/probe/sourcePos3D
* **Presence**: optional
* **Type**: numeric 2-D array
* **Location**: `/nirs(i)/probe/sourcePos3D`

This field describes the position (in `LengthUnit` units) of each source
optode in 3D.
optode in 3D. When both `sourcePos` and `sourcePos3D` present, the former
specifies the source optode coordinates in a flattened 2D geometry, while
the latter specifies the 3D coordinates of the source optodes.


#### /nirs(i)/probe/detectorPos
Expand All @@ -582,7 +586,7 @@ Same as `probe.sourcePos`, but describing the detector positions.
* **Location**: `/nirs(i)/probe/detectorPos3D`

This field describes the position (in `LengthUnit` units) of each detector
optode in 3D.
optode in 3D, defined similarly to `sourcePos3D`.


#### /nirs(i)/probe/frequencies
Expand Down

0 comments on commit 504a7f9

Please sign in to comment.