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

space filename keyword is not restricted to the controlled vocabulary #743

Closed
chrisgorgo opened this issue Mar 6, 2019 · 6 comments · Fixed by #1190
Closed

space filename keyword is not restricted to the controlled vocabulary #743

chrisgorgo opened this issue Mar 6, 2019 · 6 comments · Fixed by #1190
Labels
EEG effort: low Estimated low effort task iEEG impact: high Estimated high impact task MEG related to magnetoencephalography data

Comments

@chrisgorgo
Copy link
Contributor

See https://github.com/bids-standard/bids-validator/blob/2dab5a40bf38292bf91a1bedeb4dfddfe0d06b05/bids-validator/bids_validator/rules/file_level_rules.json#L174

My reading of the spec is that the allowed values are:

  • Other
  • Pixels
  • ACPC
  • MNI152Lin
  • MNI152NLin6[Sym|Asym]
  • MNI152NLin2009[a-c][Sym|Asym]
  • MNIColin27
  • MNI305
  • NIHPD
  • Talairach
  • OASIS30AntsOASISAnts
  • OASIS30Atropos
  • ICBM452AirSpace
  • ICBM452Warp5Space
  • IXI549Space
  • fsaverage[3|4|5|6|sym]
  • UNCInfant[0|1|2]V[21|22|23]

Related to https://neurostars.org/t/questions-about-appendix-viii-preferred-names-of-coordinate-systems/3758. Pinging @dorahermes and @choldgraf for confirmation

@chrisgorgo chrisgorgo added the iEEG label Mar 6, 2019
@dorahermes
Copy link
Member

Yes, this is my understanding also. The reason for this question is that many iEEG coordinates are in the original scanner space of the T1 and there is no specific tag for this yet, and adding this tag (e.g. -orig) from the iEEG spec was not preferred.
--> therefore, my understanding is that iEEG can currently use Other (for scanner coordinates) or ACPC (if we ACPC transform the image).

@effigies
Copy link
Collaborator

effigies commented Mar 7, 2019

There's discussion over in bids-standard/bids-specification#109 (currently at the bottom) about the subject-native T1w "space", and how that should be treated. Input from interested parties would be welcome.

@sappelhoff
Copy link
Member

We made some progress, see: https://bids-specification.readthedocs.io/en/latest/99-appendices/08-coordinate-systems.html

in brief:

  • MEG, EEG, and iEEG can all use the defined "standard templates" (such as MNI152Lin and many more, see also list in the OP)
  • EEG can use MEG keywords and vice versa

This is now finally also validated in the JSON schemas. However it remains an open issue with the filenames: it's currently possible for someone to have a file like *_space-Foo, and a corresponding CoordinateSystem entry of CapTrak in the coordsystem.json file. That's obviously bad.

Filenames should be checked such that their space-* value corresponds to the entry in the accompanying coordsystem.json file.

As a first step however, it would probably already be an improvement to constrain the RegExps for space to the list of accepted Keywords. That way something like space-RandomStuff won't be possible anymore.

cc @adam2392

@adam2392
Copy link
Member

My reading of the spec is that the allowed values are:

  • Other
  • Pixels
  • ACPC
  • MNI152Lin
  • MNI152NLin6[Sym|Asym]
  • MNI152NLin2009[a-c][Sym|Asym]
  • MNIColin27
  • MNI305
  • NIHPD
  • Talairach
  • OASIS30AntsOASISAnts
  • OASIS30Atropos
  • ICBM452AirSpace
  • ICBM452Warp5Space
  • IXI549Space
  • fsaverage[3|4|5|6|sym]
  • UNCInfant[0|1|2]V[21|22|23]

From this list, I don't see fsnative for the T1w image of the subject from FreeSurfer? Is this encompassed in the above?

@sappelhoff
Copy link
Member

@adam2392 the list you should look at is in appendix VIII

you could also look at the JSON schema for these fields. That is used to validate the iEEGCoordinateSystem field in coordsystem.json. The original idea as far as I can see it was that the iEEGCoordinateSystem field and space label should be aligned.

https://github.com/bids-standard/bids-validator/blob/4c1be20980b1215d45aee5e595b62c14bf2604e2/bids-validator/validators/json/schemas/common_definitions.json#L9-L53

@adam2392
Copy link
Member

Currently discussing with @sappelhoff about some issue with the space entity here: bids-standard/bids-specification#734

The topic is usage of space entity to identify ieeg electrodes coordinates localized on the FreeSurfer T1w image. Anyone have thoughts, feel free to chime in.

sappelhoff referenced this issue in bids-standard/bids-specification Mar 5, 2021
…nels+electrodes do not have to match (#734)

* clarify that label of _space-<label> must be from appendix VIII

related to https://github.com/bids-standard/bids-validator/issues/743

* clarify that channels and electrodes do not have to match

closes #667

* catch typo again

* link channels+electrodes examples

* clarify _where_ restricted keywords for space entity come from

* fix typo L -> l (capitalization)

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* extend yml lint limit to 120 chard

* use existing .yamllint.yml file

Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EEG effort: low Estimated low effort task iEEG impact: high Estimated high impact task MEG related to magnetoencephalography data
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants