Skip to content

Commit

Permalink
Propagate changes to rest of raw files.
Browse files Browse the repository at this point in the history
  • Loading branch information
tsalo committed Aug 29, 2020
1 parent 246e71e commit f5ad3cb
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
12 changes: 6 additions & 6 deletions src/04-modality-specific-files/02-magnetoencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ files of various nature: for example, CTF's `.ds` format, or BTi/4D.
Yet other manufacturers split their files once they exceed a certain size
limit. For example Neuromag/Elekta/Megin, which can produce several files
for a single recording. Both `some_file.fif` and `some_file-1.fif` would
belong to a single recording. In BIDS, the `split` entity is RECOMMENDED to
belong to a single recording. In BIDS, the [`split`](../99-appendices/09-entities.md#split) entity is RECOMMENDED to
deal with split files.
Please refer to [Appendix VI](../99-appendices/06-meg-file-formats.md) for
general information on how to deal with such manufacturer specifics and to see
more examples.

The `proc` label is analogous to `rec` for MR and denotes a variant of a file
The [`proc-<label>`](../99-appendices/09-entities.md#proc) entity is analogous to [`rec-<label>`](../99-appendices/09-entities.md#proc) for MR and denotes a variant of a file
that was a result of particular processing performed on the device. This is
useful for files produced in particular by Elekta’s MaxFilter (e.g. sss, tsss,
trans, quat, mc, etc.), which some installations impose to be run on raw data
Expand Down Expand Up @@ -379,7 +379,7 @@ taped to the skin. Please note that the photos may need to be cropped or blurred
to conceal identifying features prior to sharing, depending on the terms of the
consent given by the participant.

The `acq` parameter can be used to indicate acquisition of different photos of
The [`acq-<label>`](../99-appendices/09-entities.md#acq) entity can be used to indicate acquisition of different photos of
the same face (or other body part in different angles to show, for example, the
location of the nasion (NAS) as opposed to the right periauricular point (RPA)).

Expand All @@ -403,7 +403,7 @@ This file is RECOMMENDED.

The 3-D locations of points that describe the head shape and/or EEG
electrode locations can be digitized and stored in separate files. The
`*_acq-<label>` can be used when more than one type of digitization in done for
[`acq-<label>`](../99-appendices/09-entities.md#acq) entity can be used when more than one type of digitization in done for
a session, for example when the head points are in a separate file from the EEG
locations. These files are stored in the specific format of the 3-D digitizer’s
manufacturer (see [Appendix VI](../99-appendices/06-meg-file-formats.md)).
Expand All @@ -429,9 +429,9 @@ In the context of BIDS it is RECOMMENDED to perform an empty-room recording for
each experimental session.
It is RECOMMENDED to store the empty-room recording inside a subject folder
named `sub-emptyroom`.
The label for the `task-<label>` entity in the empty-room recording SHOULD be
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>` entity is present, its label SHOULD be the date of the
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`, i.e., `ses-YYYYMMDD`.
The `scans.tsv` file containing the date and time of the acquisition SHOULD
also be included.
Expand Down
4 changes: 2 additions & 2 deletions src/04-modality-specific-files/03-electroencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ REF -0.0742 -0.0200 -0.0100 cup Ag/AgCl
GND 0.0742 -0.0200 -0.0100 cup Ag/AgCl
```

The `acq` parameter can be used to indicate acquisition of the same data. For
The [`acq-<label>`](../99-appendices/09-entities.md#acq) key/value pair can be used to indicate acquisition of the same data. For
example, this could be the recording of electrode positions with a different
electrode position recording device, or repeated digitization before and after
the recording.
Expand Down Expand Up @@ -439,7 +439,7 @@ Please note that the photos may need to be cropped or blurred to conceal
identifying features prior to sharing, depending on the terms of the consent
given by the participant.

The `acq` parameter can be used to indicate acquisition of different photos of
The [`acq-<label>`](../99-appendices/09-entities.md#acq) key/value pair can be used to indicate acquisition of different photos of
the same face (or other body part in different angles to show, for example, the
location of the nasion (NAS) as opposed to the right periauricular point (RPA).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ that coordinates are expected in cartesian coordinates according to the
`*_coordsystem.json`. If an `*_electrodes.tsv` file is specified, a
`*_coordsystem.json` file MUST be specified as well.

The optional space label (`*[_space-<label>]_electrodes.tsv`) can be used to
The optional [`space-<label>`](../99-appendices/09-entities.md#space) entity (`*[_space-<label>]_electrodes.tsv`) can be used to
indicate the way in which electrode positions are interpreted. The space label
needs to be taken from the list in
[Appendix VIII](../99-appendices/08-coordinate-systems.md)
Expand All @@ -325,7 +325,7 @@ For examples:
space)

When referring to the `*_electrodes.tsv` file in a certain _space_ as defined
above, the `space-<label>` of the accompanying `*_coordsystem.json` MUST
above, the [`space-<label>`](../99-appendices/09-entities.md#space) of the accompanying `*_coordsystem.json` MUST
correspond.

For example:
Expand Down Expand Up @@ -421,9 +421,9 @@ upper left pixel and (N,0) corresponding to the lower left pixel.
### Multiple coordinate systems

If electrode positions are known in multiple coordinate systems (e.g., MRI, CT
and MNI), these spaces can be distinguished by the optional `[_space-<label>]`
and MNI), these spaces can be distinguished by the optional [`space-<label>`](../99-appendices/09-entities.md#space)
field, see the [`*_electrodes.tsv`-section](#electrode-description-_electrodestsv)
for more information. Note that the `[_space-<label>]` fields must correspond
for more information. Note that the [`space-<label>`](../99-appendices/09-entities.md#space) fields must correspond
between `*_electrodes.tsv` and `*_coordsystem.json` if they refer to the same
data.

Expand Down Expand Up @@ -458,7 +458,7 @@ during surgery, or screenshots of a brain rendering with electrode positions.
The photos may need to be cropped and/or blurred to conceal identifying features
or entirely omitted prior to sharing, depending on obtained consent.

If there are photos of the electrodes, the acquisition field should be specified
If there are photos of the electrodes, the [`acq-<label>`](../99-appendices/09-entities.md#acq) entity should be specified
with:

- `*_photo.jpg` in case of an operative photo
Expand All @@ -470,7 +470,7 @@ with:

- `*_acq-render#_photo.jpg` in case of a rendering

The session label may be used to specify when the photo was taken.
The [`ses-<label>`](../99-appendices/09-entities.md#ses) entity may be used to specify when the photo was taken.

Example of the operative photo of ECoG electrodes (here is an annotated example in
which electrodes and vasculature are marked, taken from Hermes et al.,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ before the suffix.
For example for the file `sub-control01_task-nback_run-1_bold.nii.gz`,
`<matches>` would correspond to `sub-control01_task-nback_run-1`.

The `recording-<label>` entity can be used to distinguish between several
The [`recording-<label>`](../99-appendices/09-entities.md#recording) entity can be used to distinguish between several
recording files.
For example `sub-01_task-bart_recording-eyetracking_physio.tsv.gz` to contain
the eyetracking data in a certain sampling frequency, and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Additionally, events files that do not include the mandatory `onset` and
`duration` columns can still be included, but should be labeled `_beh.tsv`
rather than `_events.tsv`.

The OPTIONAL `acq-<label>` key/value pair corresponds to a custom label to
The OPTIONAL [`acq-<label>`](../99-appendices/09-entities.md#acq) key/value pair corresponds to a custom label to
distinguish different conditions present during multiple runs of the same task.
For example, if a study includes runs of an n-back task, with deep brain
stimulation turned on or off, the data files may be labelled
Expand Down

0 comments on commit f5ad3cb

Please sign in to comment.