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

[ENH] Harmonize CoordinateSystem details for MRI, MEG, EEG, iEEG #717

Merged
merged 5 commits into from
Feb 1, 2021

Conversation

sappelhoff
Copy link
Member

@sappelhoff sappelhoff commented Jan 28, 2021

pruned down version of #700

This PR contains uncontroversial (well, you be the judge) changes only.

  • STY: several typo and formatting changes
  • DOC: change ambiguous <datatype>CoordinateSystem to <CoordSysType>CoordinateSystem, because we use datatype differently in the spec, and given a "FiducialsCoordinateSystem", it's more reasonable to call "Fiducials" a "CoordSysType" rather than a datatype
  • DOC: misc clarifications and uppercasing some MUSTs
  • ENH: allow MEG coordsystems for EEG and vice versa
  • ENH: allow standard template coordinate systems for MEG, EEG, iEEG

See the accompanying validator changes that are required in this PR: bids-standard/bids-validator#1149


Allow MEG keywords for EEG (and vice versa)

When recording EEG together with MEG (which happens rather often), the EEG electrode coordinates are very often digitized in the same coordinate system as the MEG sensors. Currently, we have permissible keywords for MEG and EEG separate.

I changed this in the spec: Now, when users record MEG+EEG, they can specify the CoordinateSystem for EEG with MEG keywords.

see also bids-standard/bids-examples#217 (comment)

Allow any "Standard template identifiers"

At least in iEEG it is apparently common to transform the sensor coordinates to some standard template, as specified in our table in appendix VIII. So far, the keywords in that table were not explicitly mentioned to be valid keywords for CoordinateSystem fields.

I changed that: MEG, EEG, and iEEG users are now free to transform their coordinates to any standard template, and then use the respective keywords as a value to the CoordinateSystem field.

I don't think this will commonly be used in MEG or EEG, but I may be wrong and it doesn't hurt to stay consistent between (i)MEEG.

to do

@sappelhoff sappelhoff added consistency Spec is (potentially) inconsistent EEG Electroencephalography iEEG MEG Magnetoencephalography labels Jan 28, 2021
@sappelhoff sappelhoff added this to the 1.5.0 milestone Jan 28, 2021
Copy link
Member

@adam2392 adam2392 left a comment

Choose a reason for hiding this comment

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

For iEEG this looks good to me. I like the clarification of CoordSysType.

Copy link
Member

@tsalo tsalo left a comment

Choose a reason for hiding this comment

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

I know so little about EEG/MEG that I don't feel like I can properly review the content of this PR, so I just focused on formatting and phrasing. It looks really good, and the only suggestions I have made are completely optional.

src/99-appendices/08-coordinate-systems.md Outdated Show resolved Hide resolved
Co-authored-by: Taylor Salo <tsalo006@fiu.edu>
@sappelhoff sappelhoff merged commit 3b612fb into bids-standard:master Feb 1, 2021
@sappelhoff sappelhoff deleted the coords2 branch February 1, 2021 12:28
@sappelhoff
Copy link
Member Author

Thanks for the review everyone.

sappelhoff added a commit to sappelhoff/bids-specification that referenced this pull request Feb 1, 2021
…-standard#717)

* harmonize coordsystems

* fix table pipe

* remove two typos

* fix typo

* text clarifications

Co-authored-by: Taylor Salo <tsalo006@fiu.edu>

Co-authored-by: Taylor Salo <tsalo006@fiu.edu>
sappelhoff added a commit that referenced this pull request Feb 1, 2021
@sappelhoff sappelhoff changed the title ENH: Harmonize CoordinateSystem details for MRI, MEG, EEG, iEEG [ENH] Harmonize CoordinateSystem details for MRI, MEG, EEG, iEEG Feb 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency Spec is (potentially) inconsistent EEG Electroencephalography iEEG MEG Magnetoencephalography
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants