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] Clarify MEG empty-room recommendations #1125

Merged
merged 13 commits into from
Jul 20, 2022
Merged
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
64 changes: 45 additions & 19 deletions src/04-modality-specific-files/02-magnetoencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -588,26 +588,26 @@ has to be updated, then for MEG it could be considered to be a new session.

## Empty-room MEG recordings

Empty-room MEG recordings capture the environmental and recording system's
noise.
In the context of BIDS it is RECOMMENDED to perform an empty-room recording for
robertoostenveld marked this conversation as resolved.
Show resolved Hide resolved
each experimental session.
It is RECOMMENDED to store the empty-room recording inside a subject directory
named `sub-emptyroom`.
The label for the [`task-<label>`](../99-appendices/09-entities.md#task) entity in the empty-room recording SHOULD be
set to `noise`.
If a [`session-<label>`](../99-appendices/09-entities.md#ses) entity is present, its label SHOULD be the date of the
empty-room recording in the format `YYYYMMDD`, that is `ses-YYYYMMDD`.
The `scans.tsv` file containing the date and time of the acquisition SHOULD
also be included.
The rationale is that this naming scheme will allow users to easily retrieve the
empty-room recording that best matches a particular experimental session, based
on date and time of the recording.
It should be possible to query empty-room recordings just like usual subject
recordings, hence all metadata sidecar files (such as the `channels.tsv`) file
SHOULD be present as well.
Empty-room MEG recordings capture the environmental and recording system's noise.

Example:
It is RECOMMENDED to explicitly specify which empty-room recording should be used with which experimental run(s) or session(s). This can be done via the [`AssociatedEmptyRoom`](../99-appendices/14-glossary.md#associatedemptyroom-metadata) field in the `*_meg.json` sidecar files.

Empty-room recordings may be collected once per day, where a single empty-room recording may be shared between multiple subjects and/or sessions (see example 1).
Empty-room recordings can also be collected for each individual experimental session (see example 2).

In the case of empty-room recordings being associated with multiple subjects and/or sessions, it is RECOMMENDED to store the empty-room recording inside a subject directory named `sub-emptyroom`.
If a [`session-<label>`](../99-appendices/09-entities.md#ses) entity is present, its label SHOULD be the date of the empty-room recording in the format `YYYYMMDD`, that is `ses-YYYYMMDD`.
The `scans.tsv` file containing the date and time of the acquisition SHOULD also be included.
The rationale is that this naming scheme will allow users to easily retrieve the empty-room recording that best matches a particular experimental session, based on date and time of the recording.
It should be possible to query empty-room recordings just like usual subject recordings, hence all metadata sidecar files (such as the `channels.tsv`) file SHOULD be present as well.

In the case of empty-room recordings being collected for the individual experimental session, it is recommended to store the empty-room recording along with that subject and session.

In either case, the label for the [`task-<label>`](../99-appendices/09-entities.md#task) entity in the empty-room recording SHOULD be set to `noise`.

Example 1:
robertoostenveld marked this conversation as resolved.
Show resolved Hide resolved

One empty-room recording per day, applying to all subjects for that day.

<!-- This block generates a file tree.
A guide for using macros can be found at
Expand All @@ -630,4 +630,30 @@ A guide for using macros can be found at
}
) }}

Example 2:
robertoostenveld marked this conversation as resolved.
Show resolved Hide resolved

sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
One recording per session, stored within the session folder.

<!-- This block generates a file tree.
A guide for using macros can be found at
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
-->
{{ MACROS___make_filetree_example(
robertoostenveld marked this conversation as resolved.
Show resolved Hide resolved
{
"sub-control01": {
"ses-01": {
"sub-01_ses-01_scans.tsv": "",
"meg": {
"sub-control01_ses-01_task-rest_meg.ds": "",
"sub-control01_ses-01_task-rest_meg.json": "",
"sub-control01_ses-01_task-rest_channels.tsv": "",
"sub-control01_ses-01_task-noise_meg.ds": "",
"sub-control01_ses-01_task-noise_meg.json": "",
"sub-control01_ses-01_task-noise_channels.tsv": "",
}
}
},
}
) }}

<!-- Link Definitions -->