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

[MISC] Restructure MEG empty room example texts #1677

Merged
merged 6 commits into from
Feb 5, 2024
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
26 changes: 14 additions & 12 deletions src/modality-specific-files/magnetoencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -504,25 +504,24 @@ has to be updated, then for MEG it could be considered to be a new session.

Empty-room MEG recordings capture the environmental and recording system's noise.

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`](../glossary.md#associatedemptyroom-metadata) field in the `*_meg.json` sidecar files.
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`](../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](#example-1)).
Empty-room recordings can also be collected for each individual experimental session (see [Example 2](#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>`](../appendices/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.

Empty-room recordings may also be collected for each individual experimental session (see [Example 2](#example-2)).
In either case, the label for the [`task-<label>`](../appendices/entities.md#task) entity in the empty-room recording SHOULD be set to `noise`.

### Example 1

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

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>`](../appendices/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.

<!-- 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
Expand All @@ -546,7 +545,10 @@ A guide for using macros can be found at

### Example 2

One recording per session, stored within the session directory.
One empty-room recording per each participant's session, stored within the session directory.
Copy link
Member

Choose a reason for hiding this comment

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

in BIDS, a session is always "per participant" (that is, you would not have two participants listed in the same session directory)

Suggested change
One empty-room recording per each participant's session, stored within the session directory.
One empty-room recording per session, stored within the session directory.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This was to clarify that in the other example (1) you can store under one session the noise recording to be used for multiple participants, but it's true it is redundant. How to store the emptyroom recordings is the thing I typically get the more questions about, as it is very MEG specific not applicable to other modalities, that's why I might have been over redundant in many places :)

Suggested change
One empty-room recording per each participant's session, stored within the session directory.
One empty-room recording per session, stored within the participant's session directory.

Copy link
Member

Choose a reason for hiding this comment

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

okay, let me try to push a commit and we can see whether you think that's an acceptable improvement.


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.

<!-- This block generates a file tree.
A guide for using macros can be found at
Expand Down
Loading