Skip to content
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

Make either 2D or 3D positions a requirement #69

Merged
merged 6 commits into from
Sep 2, 2021
Merged

Make either 2D or 3D positions a requirement #69

merged 6 commits into from
Sep 2, 2021

Conversation

rob-luke
Copy link
Member

Closes #65

This changes the specification to require either 2D or 3D positions, not just 2D.

@dsleiter
Copy link

Good to hear this is being implemented!

To ensure internal consistency within the document, the "SNIRF data format summary" section should probably be updated as well. There isn't an existing notation for "one of" - one option that comes to mind is: *ⁿ (with for source positions and for detector positions)

  • *ⁿ in the last column indicates that at least one of the subfields in the subgroup identified by n required

But maybe there is another simpler notation.

Copy link
Member

@fangq fangq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use detectorPos2D to quote SNIRF field names.

also need to add a notation, say "**" or "+" in the summary table for the relevant fields

https://github.com/fNIRS/snirf/blob/master/snirf_specification.md#snirf-data-format-summary

for some reason, I feel that this solution is a bit cumbersome for future validator's/parsers, but don't have a better suggestion at this point.

@rob-luke
Copy link
Member Author

rob-luke commented Sep 2, 2021

Thanks for the review. @fangq does this look better?

Copy link
Member

@fangq fangq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, thanks

@fangq fangq merged commit e8b09f7 into fNIRS:master Sep 2, 2021
@rob-luke
Copy link
Member Author

rob-luke commented Sep 2, 2021

Thanks for the feedback @dsleiter and @fangq

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

sourcePos2D is required but 3D is not. Suggest to make either required, but not 2D.
3 participants