Skip to content

Commit 0b97828

Browse files
Merge branch 'master' into bep032-review
2 parents b9a0d2e + 1dd81e0 commit 0b97828

17 files changed

Lines changed: 1098 additions & 111 deletions

File tree

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ repos:
3333
entry: env PRETTIER_LEGACY_CLI=1 prettier # temporary fix for https://github.com/prettier/prettier/issues/15742
3434
files: src/schema/.*/.*\.yaml
3535
- repo: https://github.com/adrienverge/yamllint
36-
rev: v1.37.1
36+
rev: v1.38.0
3737
hooks:
3838
- id: yamllint
3939
args: [-f=standard, -c=.yamllint.yml]

src/common-principles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ saved under a particular filename specified in the standard. This standard
8585
aspires to describe a majority of datasets, but acknowledges that there will be
8686
cases that do not fit. In such cases one can include additional files and
8787
subdirectories to the existing directory structure following common sense. For example
88-
one may want to include eye tracking data in a vendor specific format that is
88+
one may want to include eye-tracking data in a vendor specific format that is
8989
not covered by this standard. The most sensible place to put it is next to the
9090
continuous recording file with the same naming scheme but different extensions.
9191
The solutions will change from case to case and publicly available datasets will

src/modality-agnostic-files/events.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,22 @@ and a guide for using macros can be found at
264264
-->
265265
{{ MACROS___make_subobject_table("metadata.StimulusPresentation") }}
266266

267+
!!! warning "Important"
268+
269+
Some metadata of the `StimulusPresentation` object become REQUIRED with the presence of
270+
"gaze-on-screen"
271+
[eye-tracking data](../modality-specific-files/physiological-recordings.md#eye-tracking),
272+
as identified by the `"SampleCoordinateSystem"` metadata.
273+
274+
The following fields pertaining to `<matches>_events.json` of tasks that were acquired
275+
with the simultaneous recording of eye-tracking escalate to REQUIRED as they are considered
276+
essential in eye-tracking data analysis:
277+
278+
- `StimulusPresentation.ScreenDistance`,
279+
- `StimulusPresentation.ScreenOrigin`,
280+
- `StimulusPresentation.ScreenResolution`,
281+
- `StimulusPresentation.ScreenSize`.
282+
267283
The operating system description SHOULD include the following attributes:
268284

269285
- type (for example, Windows, macOS, Linux)

src/modality-specific-files/magnetic-resonance-imaging-data.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -902,6 +902,16 @@ A guide for using macros can be found at
902902

903903
### Other RECOMMENDED metadata
904904

905+
<!-- This block generates a metadata table.
906+
These tables are defined in
907+
src/schema/rules/sidecars
908+
The definitions of the fields specified in these tables may be found in
909+
src/schema/objects/metadata.yaml
910+
A guide for using macros can be found at
911+
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
912+
-->
913+
{{ MACROS___make_sidecar_table("dwi.MRIDiffusionOtherMetadata") }}
914+
905915
The `PhaseEncodingDirection` and `TotalReadoutTime` metadata
906916
fields are RECOMMENDED to enable the correction of geometrical distortions
907917
with [fieldmap information](#fieldmap-data).

0 commit comments

Comments
 (0)