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

[ENH] add screen parameters metadata #1369

Merged
merged 6 commits into from
Dec 24, 2022
Merged
Show file tree
Hide file tree
Changes from 3 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
6 changes: 5 additions & 1 deletion src/modality-specific-files/task-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,11 @@ in the accompanying JSON sidecar as follows (based on the example of the previou
"SoftwareName": "Psychtoolbox",
"SoftwareRRID": "SCR_002881",
"SoftwareVersion": "3.0.14",
"Code": "doi:10.5281/zenodo.3361717"
"Code": "doi:10.5281/zenodo.3361717",
"ScreenDistance": 180,
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

@Remi-Gau - even though unit was adjusted to become m, examples seems were not like here and below!... I will send a PR

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oops. Thanks for spotting it.

"ScreenRefreshRate": 60,
"ScreenResolution": [1920, 1200],
"ScreenSize": [47.2, 29.5]
}
}
```
68 changes: 64 additions & 4 deletions src/schema/objects/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2825,6 +2825,57 @@ ScatterFraction:
type: number
minimum: 0
maximum: 100
ScreenDistance:
name: ScreenDistance
display_name: Screen Distance
description: |
Distance between the participant's eye and the screen. If no screen was used, use `n/a`.
anyOf:
- type: number
unit: cm
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved
- type: string
enum:
- n/a
ScreenRefreshRate:
name: ScreenRefreshRate
display_name: Screen Refresh Rate
description: |
Refresh rate of the screen (when used), in Hertz (equivalent to frames per second, "FPS").
type: number
unit: Hz
ScreenResolution:
name: ScreenResolution
display_name: Screen Resolution
description: |
Screen resolution in pixel
(for example `[1920, 1200]` for a screen of 1920-length by 1080-height pixels),
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved
if no screen use `n/a`.
anyOf:
- type: array
items:
type: integer
minItems: 2
maxItems: 2
- type: string
enum:
- n/a
ScreenSize:
name: ScreenSize
display_name: Screen Size
description: |
Screen size in cm, excluding potential screen borders
(for example `[47.2, 29.5]` for a screen of 47.2-length by 29.5-height cm),
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved
if no screen use `n/a`.
anyOf:
- type: array
items:
type: number
unit: cm
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved
Remi-Gau marked this conversation as resolved.
Show resolved Hide resolved
minItems: 2
maxItems: 2
- type: string
enum:
- n/a
SequenceName:
name: SequenceName
display_name: Sequence Name
Expand Down Expand Up @@ -3135,20 +3186,29 @@ StimulusPresentation:
display_name: Stimulus Presentation
description: |
Object containing key-value pairs related to the software used to present
the stimuli during the experiment, specifically:
`"OperatingSystem"`, `"SoftwareName"`, `"SoftwareRRID"`, `"SoftwareVersion"` and
`"Code"`.
See table below for more information.
the stimuli during the experiment.
type: object
recommended_fields:
- OperatingSystem
- ScreenDistance
- ScreenRefreshRate
- ScreenResolution
- ScreenSize
- SoftwareName
- SoftwareRRID
- SoftwareVersion
- Code
properties:
OperatingSystem:
$ref: objects.metadata.OperatingSystem
ScreenDistance:
$ref: objects.metadata.ScreenDistance
ScreenRefreshRate:
$ref: objects.metadata.ScreenRefreshRate
ScreenResolution:
$ref: objects.metadata.ScreenResolution
ScreenSize:
$ref: objects.metadata.ScreenSize
SoftwareName:
$ref: objects.metadata.SoftwareName
SoftwareRRID:
Expand Down