Skip to content

Limit screen requirements to gaze-on-screen #12

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 15, 2025
Merged

Limit screen requirements to gaze-on-screen #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b5ae195
Limit screen requirements to gaze-on-screen
effigies Oct 14, 2025
bfc9d9f
Merge branch 'bep020' of https://github.com/mszinte/bids-specificatio…
effigies Oct 14, 2025
933b1b3
Account for n/a values in StimulusPresentation
effigies Oct 14, 2025
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
4 changes: 3 additions & 1 deletion src/modality-agnostic-files/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,9 @@ and a guide for using macros can be found at
!!! warning "Important"

Some metadata of the `StimulusPresentation` object become REQUIRED with the presence of
[eye-tracking data](../modality-specific-files/physiological-recordings.md#eye-tracking)
"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 `<matches>_events.json` of tasks that were acquired
with the simultaneous recording of eye-tracking escalate to REQUIRED as they are considered
Expand Down
6 changes: 3 additions & 3 deletions src/modality-specific-files/physiological-recordings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,9 +539,9 @@ those derived from the saccade and blinks model some eye-trackers produce.

!!! warning "Important"

The following fields pertaining to `<matches>_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:
For eye-tracking recordings where `"SampleCoordinateSystem"` is set to `"gaze-on-screen"`,
the following fields pertaining to `<matches>_events.json` escalate to REQUIRED
as they are considered essential in eye-tracking data analysis:

- `StimulusPresentation.ScreenDistance`,
- `StimulusPresentation.ScreenOrigin`,
Expand Down
19 changes: 2 additions & 17 deletions src/schema/objects/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3592,7 +3592,7 @@ ScreenResolution:
(for example `[1920, 1200]` for a screen of 1920-width by 1080-height pixels),
if no screen use `n/a`.
`ScreenResolution` is REQUIRED when the experiment included simultaneous eye-tracking
recordings.
recordings with `SampleCoordinateSystem` matching `"gaze-on-screen"`.
anyOf:
- type: array
items:
Expand All @@ -3610,7 +3610,7 @@ ScreenSize:
(for example `[0.472, 0.295]` for a screen of 47.2-width by 29.5-height cm),
if no screen use `n/a`.
`ScreenSize` is REQUIRED when the experiment included simultaneous eye-tracking
recordings.
recordings with `SampleCoordinateSystem` matching `"gaze-on-screen"`.
anyOf:
- type: array
items:
Expand Down Expand Up @@ -4005,21 +4005,6 @@ StimulusPresentation:
$ref: objects.metadata.SoftwareVersion
Code:
$ref: objects.metadata.Code
StimulusPresentation__eyetrack:
$ref: objects.metadata.StimulusPresentation
required:
- ScreenDistance
- ScreenOrigin
- ScreenResolution
- ScreenSize
recommended:
- OperatingSystem
- ScreenRefreshRate
- SoftwareName
- SoftwareRRID
- SoftwareVersion
- Code
- HeadStabilization
StopTime_eyetrack:
name: StopTime
display_name: Eye-tracking recording stop time
Expand Down
7 changes: 4 additions & 3 deletions src/schema/rules/checks/eyetrack.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ EyetrackingStimulusPresentation:
- suffix == 'physio'
- extension == '.tsv.gz'
- sidecar.PhysioType == 'eyetrack'
- sidecar.SampleCoordinateSystem == 'gaze-on-screen'
Copy link

@yarikoptic yarikoptic Oct 14, 2025

Choose a reason for hiding this comment

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

this wouldn't check that they aren't "n/a" though, right - could/should checks be made more stringent?

Copy link
Author

@effigies effigies Oct 14, 2025

Choose a reason for hiding this comment

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

Updated, thanks.

checks:
- '"ScreenDistance" in associations.events.sidecar.StimulusPresentation'
- associations.events.sidecar.StimulusPresentation.ScreenDistance != 'n/a'
- '"ScreenOrigin" in associations.events.sidecar.StimulusPresentation'
- '"ScreenResolution" in associations.events.sidecar.StimulusPresentation'
- '"ScreenSize" in associations.events.sidecar.StimulusPresentation'
- associations.events.sidecar.StimulusPresentation.ScreenResolution != 'n/a'
- associations.events.sidecar.StimulusPresentation.ScreenSize != 'n/a'

OnsetSourceConsistency:
issue:
Expand Down