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

[FIX] tighter rules for sharing MEG cross-talk and fine-calibration .fif files #598

Merged
merged 4 commits into from
Sep 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/06-longitudinal-and-multi-site-studies.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ ses-followup 2009-06-17T13:45:30 110

This version of the BIDS specification does not explicitly cover studies with
data coming from multiple sites or multiple centers (such extension is planned
in [BIDS `2.0`](https://docs.google.com/document/d/1LEgsMiisGDe1Gv-hBp1EcLmoz7AlKj6VYULUgDD3Zdw/)).
in [BIDS `2.0`](https://github.com/bids-standard/bids-2-devel).
There are however ways to model your data without any loss in terms of metadata.

### Treat each site/center as a separate dataset
Expand Down
59 changes: 44 additions & 15 deletions src/99-appendices/06-meg-file-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,29 +76,58 @@ process of regular system maintenance.
In BIDS, the cross-talk and fine-calibration files are shared unmodified,
but with BIDS file naming convention and by using the `acq` entity.

- cross-talk file template: `[sub-<label>][_ses-<label>][_]acq-crosstalk_meg.dat`
- fine-calibration file template: `[sub-<label>][_ses-<label>][_]acq-calibration_meg.fif`
- cross-talk file template: `sub-<label>[_ses-<label>]_acq-crosstalk_meg.dat`
- fine-calibration file template: `sub-<label>[_ses-<label>]_acq-calibration_meg.fif`

Note that cross-talk files MUST be denoted using `acq-crosstalk` and
fine-calibration files MUST be denoted using `acq-calibration`.

By making use of the [Inheritance Principle](../02-common-principles.md#the-inheritance-principle),
the cross-talk and fine-calibration data can be stored at any level of nesting within the BIDS dataset.
For example for each session, or only once for a whole dataset.
The cross-talk and fine-calibration data MUST be stored in the subject-level `meg` folder,
which may be nested inside a `ses-<label>` folder, as shown in the following examples.

Example FIFF dataset with cross-talk and fine-calibration files stored once at the dataset root:
#### Example with single session (omitted session folder)

```Text
acq-crosstalk_meg.dat
acq-calibration_meg.fif
sub-control01/
ses-001/
sub-control01_ses-001_scans.tsv
sub-01/
meg/
sub-01_coordsystem.json
sub-01_task-rest_meg.fif
sub-01_task-rest_meg.json
sub-01_task-rest_channels.tsv
sub-01_acq-crosstalk_meg.dat
sub-01_acq-calibration_meg.fif
sub-02/
meg/
sub-02_coordsystem.json
sub-02_task-rest_meg.fif
sub-02_task-rest_meg.json
sub-02_task-rest_channels.tsv
sub-02_acq-crosstalk_meg.dat
sub-02_acq-calibration_meg.fif
```

#### Example with multiple sessions

```Text
sub-01/
ses-01/
sub-01_ses-01_scans.tsv
meg/
sub-control01_ses-001_coordsystem.json
sub-control01_ses-001_task-rest_run-01_meg.fif
sub-control01_ses-001_task-rest_run-01_meg.json
sub-control01_ses-001_task-rest_run-01_channels.tsv
sub-01_ses-01_coordsystem.json
sub-01_ses-01_task-rest_run-01_meg.fif
sub-01_ses-01_task-rest_run-01_meg.json
sub-01_ses-01_task-rest_run-01_channels.tsv
sub-01_ses-01_acq-crosstalk_meg.dat
sub-01_ses-01_acq-calibration_meg.fif
ses-02/
sub-01_ses-02_scans.tsv
meg/
sub-01_ses-02_coordsystem.json
sub-01_ses-02_task-rest_run-01_meg.fif
sub-01_ses-02_task-rest_run-01_meg.json
sub-01_ses-02_task-rest_run-01_channels.tsv
sub-01_ses-02_acq-crosstalk_meg.dat
sub-01_ses-02_acq-calibration_meg.fif
```

### Sharing FIFF data after signal-space separation (SSS)
Expand Down