diff --git a/src/common-principles.md b/src/common-principles.md index c3a395c600..fac5eca13b 100644 --- a/src/common-principles.md +++ b/src/common-principles.md @@ -85,7 +85,7 @@ saved under a particular filename specified in the standard. This standard aspires to describe a majority of datasets, but acknowledges that there will be cases that do not fit. In such cases one can include additional files and subdirectories to the existing directory structure following common sense. For example -one may want to include eye tracking data in a vendor specific format that is +one may want to include eye-tracking data in a vendor specific format that is not covered by this standard. The most sensible place to put it is next to the continuous recording file with the same naming scheme but different extensions. The solutions will change from case to case and publicly available datasets will diff --git a/src/modality-agnostic-files/events.md b/src/modality-agnostic-files/events.md index 1c65a0196e..5aa206bce8 100644 --- a/src/modality-agnostic-files/events.md +++ b/src/modality-agnostic-files/events.md @@ -264,6 +264,22 @@ and a guide for using macros can be found at --> {{ MACROS___make_subobject_table("metadata.StimulusPresentation") }} +!!! warning "Important" + + Some metadata of the `StimulusPresentation` object become REQUIRED with the presence of + "gaze-on-screen" + [eye-tracking data](../modality-specific-files/physiological-recordings.md#eye-tracking), + as identified by the `"SampleCoordinateSystem"` metadata. + + The following fields pertaining to `_events.json` of tasks that were acquired + with the simultaneous recording of eye-tracking escalate to REQUIRED as they are considered + essential in eye-tracking data analysis: + + - `StimulusPresentation.ScreenDistance`, + - `StimulusPresentation.ScreenOrigin`, + - `StimulusPresentation.ScreenResolution`, + - `StimulusPresentation.ScreenSize`. + The operating system description SHOULD include the following attributes: - type (for example, Windows, macOS, Linux) diff --git a/src/modality-specific-files/physiological-recordings.md b/src/modality-specific-files/physiological-recordings.md index 14740b1b6f..fd9c726c92 100644 --- a/src/modality-specific-files/physiological-recordings.md +++ b/src/modality-specific-files/physiological-recordings.md @@ -1,10 +1,5 @@ # Physiological recordings -Physiological recordings such as cardiac and respiratory signals MAY be -specified using a [compressed tabular file](../common-principles.md#compressed-tabular-files) -([TSV.GZ file](../glossary.md#tsv_gz-extensions)) and a corresponding -JSON file for storing metadata fields (see below). - !!! example "Example datasets" [Example datasets](https://bids-standard.github.io/bids-examples/#dataset-index) @@ -14,31 +9,130 @@ JSON file for storing metadata fields (see below). - [`7t_trt`](https://github.com/bids-standard/bids-examples/tree/master/7t_trt) - [`ds210`](https://github.com/bids-standard/bids-examples/tree/master/ds210) +## General specifications + +Continuous (that is, regularly sampled over time at a fixed frequency) +physiological recordings such as cardiac and respiratory signals, and +asynchronous events corresponding to those signals MAY be specified using +[compressed tabular files](../common-principles.md#compressed-tabular-files) +([TSV.GZ file](../glossary.md#tsvgz-extensions)). +TSV.GZ files MUST be accompanied by a JSON file with the same name as their +corresponding tabular file but with a `.json` extension. + {{ MACROS___make_filename_template( "raw", placeholders=True, show_entities=["recording"], - suffixes=["physio"] + suffixes=["physio", "physioevents"] ) }} +The [`recording-