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

MEG file format "KRISS" mentions *_digitizer.txt file (and suffix) which is not defined in the spec #1560

Open
sappelhoff opened this issue Jul 20, 2023 · 3 comments
Assignees
Labels
consistency Spec is (potentially) inconsistent MEG Magnetoencephalography

Comments

@sappelhoff
Copy link
Member

sappelhoff commented Jul 20, 2023

See title.

https://bids-specification.readthedocs.io/en/latest/appendices/meg-file-formats.html#kriss

Each experimental run on the KRISS system produces a file with extension .kdf. Additional files can be available in the same directory: the digitized positions of the head points (_digitizer.txt), the position of the center of the MEG coils (.chn) and the event markers (.trg).

(emphasis by me)

How I read it, _digitizer.txt should be _headshape.<ext>, which is defined in the spec, and which fulfills exactly that use case (digitizing head points, and optionally electrodes).

Unfortunately, digitizer is defined in the bids-validator, see:

Was there a reason to name this _digitizer.txt for the KRISS MEG data format, and _headshape.<ext> for all other MEG data formats? Or was this simply an oversight? Either way, we need to clarify this and either:

  1. properly introduce _digitizer in the spec
  2. completely remove _digitizer from (i) the appendix in which it is mentioned, (ii) the bids-validator

Related to:

@sappelhoff sappelhoff added MEG Magnetoencephalography consistency Spec is (potentially) inconsistent labels Jul 20, 2023
@sappelhoff
Copy link
Member Author

sappelhoff commented Jul 20, 2023

Note that a quick search of our history yields that I was the one who introduced _digitizer.txt into both spec and validator in:

My intention was to sync GitHub spec and old Google docs (see section 16.5 in the old gdoc of the spec) shortly after the move to GitHub. It's of specific note that I repeatedly tried to find someone familiar with the KRISS system, but failed.

This lets me tend towards my solution "2" here:

Was there a reason to name this _digitizer.txt for the KRISS MEG data format, and _headshape. for all other MEG data formats? Or was this simply an oversight? Either way, we need to clarify this and either:

  1. properly introduce _digitizer in the spec
  2. completely remove _digitizer from (i) the appendix in which it is mentioned, (ii) the bids-validator

@sappelhoff
Copy link
Member Author

cc @robertoostenveld your opinion would be valuable here

@robertoostenveld
Copy link
Collaborator

Disclaimer: I don't know details about the KRISS system and file format.

I don't recall having discussed in the development of the MEG specification that the digitized head shape information for the KRISS format should be stored in the _digitizer.txt file. To me it would also make more sense if the file were called _headshape.txt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency Spec is (potentially) inconsistent MEG Magnetoencephalography
Projects
Development

No branches or pull requests

3 participants