From 47bcf0f6845201140d011e93e5e36c49f9ed7292 Mon Sep 17 00:00:00 2001 From: julia-pfarr Date: Wed, 25 Oct 2023 13:24:23 +0200 Subject: [PATCH 1/8] Correct metadata.yml files - InstitutionName and Address was put under "required" but it should go under "recommended" --> corrected - give more information on where to find the specification that users can find the data types they have to fill --- eye2bids/config/metadata.yml | 10 ++++++---- tests/data/metadata.yml | 10 ++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/eye2bids/config/metadata.yml b/eye2bids/config/metadata.yml index fcd936c..c3d5429 100644 --- a/eye2bids/config/metadata.yml +++ b/eye2bids/config/metadata.yml @@ -1,17 +1,17 @@ --- # manual_metadata +# Please find the BIDS specification here: https://bids-specification--1128.org.readthedocs.build/en/1128/modality-specific-files/eye-tracking.html +# Please go through the specification and fille the fields below according to the data types given in the specification. -# Required, fill according to BIDS specification: +# REQUIRED, fill according to BIDS specification (!the converter will not run successfully if you leave this empty!): SampleCoordinateUnits: '' SampleCoordinateSystem: '' EnvironmentCoordinates: '' ScreenDistance: ScreenRefreshRate: ScreenSize: -InstitutionName: '' -InstitutionAddress: '' -# Recommended, leave empty if not available: +# Recommended (leave empty if not available but put information you want to share with your dataset here!): SoftwareVersion: '' ScreenAOIDefinition: EyeCameraSettings: @@ -19,3 +19,5 @@ EyeTrackerDistance: FeatureDetectionSettings: GazeMappingSettings: RawDataFilters: +InstitutionName: '' +InstitutionAddress: '' diff --git a/tests/data/metadata.yml b/tests/data/metadata.yml index 79ead08..3a5e69b 100644 --- a/tests/data/metadata.yml +++ b/tests/data/metadata.yml @@ -1,17 +1,17 @@ --- # manual_metadata +# Please find the BIDS specification here: https://bids-specification--1128.org.readthedocs.build/en/1128/modality-specific-files/eye-tracking.html +# Please go through the specification and fille the fields below according to the data types given in the specification. -# Required, fill according to BIDS specification: +# REQUIRED, fill according to BIDS specification (!the converter will not run successfully if you leave this empty!): SampleCoordinateUnits: pixel SampleCoordinateSystem: gaze-on-screen EnvironmentCoordinates: top-left ScreenDistance: 60 ScreenRefreshRate: 60 ScreenSize: [38.6, 29] -InstitutionName: Philipps-University Marburg -InstitutionAddress: Gutenbergstr. 18 -# Recommended, leave empty if not available: +# Recommended (leave empty if not available but put information you want to share with your dataset here!): SoftwareVersion: SREB1.10.1630 WIN32 LID:F2AE011 Mod:2017.04.21 15:19 CEST ScreenAOIDefinition: [square, [00, 150, 300, 350]] EyeCameraSettings: @@ -19,3 +19,5 @@ EyeTrackerDistance: FeatureDetectionSettings: GazeMappingSettings: RawDataFilters: +InstitutionName: Philipps-University Marburg +InstitutionAddress: Gutenbergstr. 18 From 25140ea055bc2f58eb51c2e27c4a7690fc373a13 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 25 Oct 2023 11:27:48 +0000 Subject: [PATCH 2/8] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- eye2bids/config/metadata.yml | 2 +- tests/data/metadata.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/eye2bids/config/metadata.yml b/eye2bids/config/metadata.yml index c3d5429..bdb6653 100644 --- a/eye2bids/config/metadata.yml +++ b/eye2bids/config/metadata.yml @@ -1,7 +1,7 @@ --- # manual_metadata # Please find the BIDS specification here: https://bids-specification--1128.org.readthedocs.build/en/1128/modality-specific-files/eye-tracking.html -# Please go through the specification and fille the fields below according to the data types given in the specification. +# Please go through the specification and fille the fields below according to the data types given in the specification. # REQUIRED, fill according to BIDS specification (!the converter will not run successfully if you leave this empty!): SampleCoordinateUnits: '' diff --git a/tests/data/metadata.yml b/tests/data/metadata.yml index 3a5e69b..e30e084 100644 --- a/tests/data/metadata.yml +++ b/tests/data/metadata.yml @@ -1,7 +1,7 @@ --- # manual_metadata # Please find the BIDS specification here: https://bids-specification--1128.org.readthedocs.build/en/1128/modality-specific-files/eye-tracking.html -# Please go through the specification and fille the fields below according to the data types given in the specification. +# Please go through the specification and fille the fields below according to the data types given in the specification. # REQUIRED, fill according to BIDS specification (!the converter will not run successfully if you leave this empty!): SampleCoordinateUnits: pixel From f53197c44b76475e3aa5630ff408b86cde373070 Mon Sep 17 00:00:00 2001 From: julia-pfarr <111446107+julia-pfarr@users.noreply.github.com> Date: Wed, 25 Oct 2023 12:06:46 +0000 Subject: [PATCH 3/8] put data types in metadata.yml files --- eye2bids/config/metadata.yml | 26 ++++++++++++++------------ tests/data/metadata.yml | 22 ++++++++++++---------- 2 files changed, 26 insertions(+), 22 deletions(-) diff --git a/eye2bids/config/metadata.yml b/eye2bids/config/metadata.yml index bdb6653..eb6237b 100644 --- a/eye2bids/config/metadata.yml +++ b/eye2bids/config/metadata.yml @@ -4,20 +4,22 @@ # Please go through the specification and fille the fields below according to the data types given in the specification. # REQUIRED, fill according to BIDS specification (!the converter will not run successfully if you leave this empty!): -SampleCoordinateUnits: '' -SampleCoordinateSystem: '' -EnvironmentCoordinates: '' -ScreenDistance: -ScreenRefreshRate: -ScreenSize: +SampleCoordinateUnits: !!str +SampleCoordinateSystem: !!str +EnvironmentCoordinates: !!str +ScreenDistance: !!int +ScreenRefreshRate: !!int +ScreenSize: [!!float] # Recommended (leave empty if not available but put information you want to share with your dataset here!): -SoftwareVersion: '' -ScreenAOIDefinition: +SoftwareVersion: !!str +ScreenAOIDefinition: [!!str [!!int]] EyeCameraSettings: -EyeTrackerDistance: -FeatureDetectionSettings: +EyeTrackerDistance: !!float +FeatureDetectionSettings: GazeMappingSettings: RawDataFilters: -InstitutionName: '' -InstitutionAddress: '' +InstitutionName: !!str +InstitutionAddress: !!str + +... diff --git a/tests/data/metadata.yml b/tests/data/metadata.yml index e30e084..9818321 100644 --- a/tests/data/metadata.yml +++ b/tests/data/metadata.yml @@ -4,20 +4,22 @@ # Please go through the specification and fille the fields below according to the data types given in the specification. # REQUIRED, fill according to BIDS specification (!the converter will not run successfully if you leave this empty!): -SampleCoordinateUnits: pixel -SampleCoordinateSystem: gaze-on-screen -EnvironmentCoordinates: top-left -ScreenDistance: 60 -ScreenRefreshRate: 60 -ScreenSize: [38.6, 29] +SampleCoordinateUnits: !!str pixel +SampleCoordinateSystem: !!str gaze-on-screen +EnvironmentCoordinates: !!str top-left +ScreenDistance: !!int 60 +ScreenRefreshRate: !!int 60 +ScreenSize: [!!float 38.6, 29] # Recommended (leave empty if not available but put information you want to share with your dataset here!): -SoftwareVersion: SREB1.10.1630 WIN32 LID:F2AE011 Mod:2017.04.21 15:19 CEST -ScreenAOIDefinition: [square, [00, 150, 300, 350]] +SoftwareVersion: !!str SREB1.10.1630 WIN32 LID:F2AE011 Mod:2017.04.21 15:19 CEST +ScreenAOIDefinition: [!!str square, [!!int 00, 150, 300, 350]] EyeCameraSettings: EyeTrackerDistance: FeatureDetectionSettings: GazeMappingSettings: RawDataFilters: -InstitutionName: Philipps-University Marburg -InstitutionAddress: Gutenbergstr. 18 +InstitutionName: !!str Philipps-University Marburg +InstitutionAddress: !!str Gutenbergstr. 18 + +... \ No newline at end of file From 3ed22aa8bed7f545a649ea52a0583b356a33ce65 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 25 Oct 2023 12:08:16 +0000 Subject: [PATCH 4/8] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- eye2bids/config/metadata.yml | 2 +- tests/data/metadata.yml | 22 ++++++++++------------ 2 files changed, 11 insertions(+), 13 deletions(-) diff --git a/eye2bids/config/metadata.yml b/eye2bids/config/metadata.yml index eb6237b..f93bb29 100644 --- a/eye2bids/config/metadata.yml +++ b/eye2bids/config/metadata.yml @@ -16,7 +16,7 @@ SoftwareVersion: !!str ScreenAOIDefinition: [!!str [!!int]] EyeCameraSettings: EyeTrackerDistance: !!float -FeatureDetectionSettings: +FeatureDetectionSettings: GazeMappingSettings: RawDataFilters: InstitutionName: !!str diff --git a/tests/data/metadata.yml b/tests/data/metadata.yml index 9818321..e30e084 100644 --- a/tests/data/metadata.yml +++ b/tests/data/metadata.yml @@ -4,22 +4,20 @@ # Please go through the specification and fille the fields below according to the data types given in the specification. # REQUIRED, fill according to BIDS specification (!the converter will not run successfully if you leave this empty!): -SampleCoordinateUnits: !!str pixel -SampleCoordinateSystem: !!str gaze-on-screen -EnvironmentCoordinates: !!str top-left -ScreenDistance: !!int 60 -ScreenRefreshRate: !!int 60 -ScreenSize: [!!float 38.6, 29] +SampleCoordinateUnits: pixel +SampleCoordinateSystem: gaze-on-screen +EnvironmentCoordinates: top-left +ScreenDistance: 60 +ScreenRefreshRate: 60 +ScreenSize: [38.6, 29] # Recommended (leave empty if not available but put information you want to share with your dataset here!): -SoftwareVersion: !!str SREB1.10.1630 WIN32 LID:F2AE011 Mod:2017.04.21 15:19 CEST -ScreenAOIDefinition: [!!str square, [!!int 00, 150, 300, 350]] +SoftwareVersion: SREB1.10.1630 WIN32 LID:F2AE011 Mod:2017.04.21 15:19 CEST +ScreenAOIDefinition: [square, [00, 150, 300, 350]] EyeCameraSettings: EyeTrackerDistance: FeatureDetectionSettings: GazeMappingSettings: RawDataFilters: -InstitutionName: !!str Philipps-University Marburg -InstitutionAddress: !!str Gutenbergstr. 18 - -... \ No newline at end of file +InstitutionName: Philipps-University Marburg +InstitutionAddress: Gutenbergstr. 18 From 8bd5c8984b327b35617eb0ef3b820cf8873d1d6a Mon Sep 17 00:00:00 2001 From: julia-pfarr <111446107+julia-pfarr@users.noreply.github.com> Date: Wed, 25 Oct 2023 12:11:58 +0000 Subject: [PATCH 5/8] update test metadata file --- tests/data/metadata.yml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/tests/data/metadata.yml b/tests/data/metadata.yml index e30e084..c992fa8 100644 --- a/tests/data/metadata.yml +++ b/tests/data/metadata.yml @@ -4,20 +4,22 @@ # Please go through the specification and fille the fields below according to the data types given in the specification. # REQUIRED, fill according to BIDS specification (!the converter will not run successfully if you leave this empty!): -SampleCoordinateUnits: pixel -SampleCoordinateSystem: gaze-on-screen -EnvironmentCoordinates: top-left -ScreenDistance: 60 -ScreenRefreshRate: 60 -ScreenSize: [38.6, 29] +SampleCoordinateUnits: !!str pixel +SampleCoordinateSystem: !!str gaze-on-screen +EnvironmentCoordinates: !!str top-left +ScreenDistance: !!int 60 +ScreenRefreshRate: !!int 60 +ScreenSize: [!!float 38.6, 29] # Recommended (leave empty if not available but put information you want to share with your dataset here!): -SoftwareVersion: SREB1.10.1630 WIN32 LID:F2AE011 Mod:2017.04.21 15:19 CEST -ScreenAOIDefinition: [square, [00, 150, 300, 350]] +SoftwareVersion: !!str SREB1.10.1630 WIN32 LID:F2AE011 Mod:2017.04.21 15:19 CEST +ScreenAOIDefinition: [!!str square, [!!int 00, 150, 300, 350]] EyeCameraSettings: EyeTrackerDistance: FeatureDetectionSettings: GazeMappingSettings: RawDataFilters: -InstitutionName: Philipps-University Marburg -InstitutionAddress: Gutenbergstr. 18 +InstitutionName: !!str Philipps-University Marburg +InstitutionAddress: !!str Gutenbergstr. 18 + +... From 17365937d292c23fc4c60ef3f22b09180acd3fb1 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 25 Oct 2023 12:12:14 +0000 Subject: [PATCH 6/8] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- tests/data/metadata.yml | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/tests/data/metadata.yml b/tests/data/metadata.yml index c992fa8..e30e084 100644 --- a/tests/data/metadata.yml +++ b/tests/data/metadata.yml @@ -4,22 +4,20 @@ # Please go through the specification and fille the fields below according to the data types given in the specification. # REQUIRED, fill according to BIDS specification (!the converter will not run successfully if you leave this empty!): -SampleCoordinateUnits: !!str pixel -SampleCoordinateSystem: !!str gaze-on-screen -EnvironmentCoordinates: !!str top-left -ScreenDistance: !!int 60 -ScreenRefreshRate: !!int 60 -ScreenSize: [!!float 38.6, 29] +SampleCoordinateUnits: pixel +SampleCoordinateSystem: gaze-on-screen +EnvironmentCoordinates: top-left +ScreenDistance: 60 +ScreenRefreshRate: 60 +ScreenSize: [38.6, 29] # Recommended (leave empty if not available but put information you want to share with your dataset here!): -SoftwareVersion: !!str SREB1.10.1630 WIN32 LID:F2AE011 Mod:2017.04.21 15:19 CEST -ScreenAOIDefinition: [!!str square, [!!int 00, 150, 300, 350]] +SoftwareVersion: SREB1.10.1630 WIN32 LID:F2AE011 Mod:2017.04.21 15:19 CEST +ScreenAOIDefinition: [square, [00, 150, 300, 350]] EyeCameraSettings: EyeTrackerDistance: FeatureDetectionSettings: GazeMappingSettings: RawDataFilters: -InstitutionName: !!str Philipps-University Marburg -InstitutionAddress: !!str Gutenbergstr. 18 - -... +InstitutionName: Philipps-University Marburg +InstitutionAddress: Gutenbergstr. 18 From 3e510e1963cc7905fdd6abb8010391eb66c39c42 Mon Sep 17 00:00:00 2001 From: julia-pfarr Date: Wed, 25 Oct 2023 15:05:46 +0200 Subject: [PATCH 7/8] change units for ScreenSize and EyeTrackerDistance to meter --- eye2bids/config/metadata.yml | 3 ++- tests/data/metadata.yml | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/eye2bids/config/metadata.yml b/eye2bids/config/metadata.yml index f93bb29..4d2f50d 100644 --- a/eye2bids/config/metadata.yml +++ b/eye2bids/config/metadata.yml @@ -2,6 +2,7 @@ # manual_metadata # Please find the BIDS specification here: https://bids-specification--1128.org.readthedocs.build/en/1128/modality-specific-files/eye-tracking.html # Please go through the specification and fille the fields below according to the data types given in the specification. +# !Note that ScreenSize and EyeTrackerDistance units are in meter, not centimeter! # REQUIRED, fill according to BIDS specification (!the converter will not run successfully if you leave this empty!): SampleCoordinateUnits: !!str @@ -9,7 +10,7 @@ SampleCoordinateSystem: !!str EnvironmentCoordinates: !!str ScreenDistance: !!int ScreenRefreshRate: !!int -ScreenSize: [!!float] +ScreenSize: [!!float] # Recommended (leave empty if not available but put information you want to share with your dataset here!): SoftwareVersion: !!str diff --git a/tests/data/metadata.yml b/tests/data/metadata.yml index e30e084..6453684 100644 --- a/tests/data/metadata.yml +++ b/tests/data/metadata.yml @@ -9,7 +9,7 @@ SampleCoordinateSystem: gaze-on-screen EnvironmentCoordinates: top-left ScreenDistance: 60 ScreenRefreshRate: 60 -ScreenSize: [38.6, 29] +ScreenSize: [0.386, 0.29] # Recommended (leave empty if not available but put information you want to share with your dataset here!): SoftwareVersion: SREB1.10.1630 WIN32 LID:F2AE011 Mod:2017.04.21 15:19 CEST From dcd041912d229e825e397309dc08a9d1750f579a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 25 Oct 2023 13:06:06 +0000 Subject: [PATCH 8/8] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- eye2bids/config/metadata.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eye2bids/config/metadata.yml b/eye2bids/config/metadata.yml index 4d2f50d..879e254 100644 --- a/eye2bids/config/metadata.yml +++ b/eye2bids/config/metadata.yml @@ -10,7 +10,7 @@ SampleCoordinateSystem: !!str EnvironmentCoordinates: !!str ScreenDistance: !!int ScreenRefreshRate: !!int -ScreenSize: [!!float] +ScreenSize: [!!float] # Recommended (leave empty if not available but put information you want to share with your dataset here!): SoftwareVersion: !!str