feat: variable eye to screen distance

jakobchwastek commented 9 months ago

Description

Fixes issue #495

Implemented changes

Insert a description of the changes implemented in the pull request.

Add functionality for distance values in a column to transforms.pix2deg()
Make distance_cm optional in Experiment and Screen
Add parameter for distance_column to classes DatasetDefinition, GazeDataFrame.
Add support for distance column in GazeDataFrame.transform()
Add support for distance column in Dataset loading method dataset_files.load_gaze_files() and in loading methods for GazeDataframe from_numpy(), from_pandas(), from_csv()
Changed a lot of tests..

...

Type of change

[x] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

[ ] Test A
[ ] Test B

Checklist:

[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[ ] Any dependent changes have been merged and published in downstream modules
[ ] I have checked my code and corrected any misspellings

codecov[bot] commented 9 months ago

Codecov Report

All modified lines are covered by tests :white_check_mark:

Comparison is base (ec40022) 100.00% compared to head (dbe0208) 100.00%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #583 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 52 52 Lines 2283 2331 +48 Branches 568 581 +13 ========================================= + Hits 2283 2331 +48 ``` | [Files](https://app.codecov.io/gh/aeye-lab/pymovements/pull/583?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab) | Coverage Δ | | |---|---|---| | [src/pymovements/dataset/dataset\_definition.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/583?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2RhdGFzZXQvZGF0YXNldF9kZWZpbml0aW9uLnB5) | `100.00% <100.00%> (ø)` | | | [src/pymovements/dataset/dataset\_files.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/583?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2RhdGFzZXQvZGF0YXNldF9maWxlcy5weQ==) | `100.00% <100.00%> (ø)` | | | [src/pymovements/gaze/experiment.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/583?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2dhemUvZXhwZXJpbWVudC5weQ==) | `100.00% <100.00%> (ø)` | | | [src/pymovements/gaze/gaze\_dataframe.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/583?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2dhemUvZ2F6ZV9kYXRhZnJhbWUucHk=) | `100.00% <100.00%> (ø)` | | | [src/pymovements/gaze/integration.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/583?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2dhemUvaW50ZWdyYXRpb24ucHk=) | `100.00% <100.00%> (ø)` | | | [src/pymovements/gaze/io.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/583?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2dhemUvaW8ucHk=) | `100.00% <ø> (ø)` | | | [src/pymovements/gaze/screen.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/583?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2dhemUvc2NyZWVuLnB5) | `100.00% <100.00%> (ø)` | | | [src/pymovements/gaze/transforms.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/583?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2dhemUvdHJhbnNmb3Jtcy5weQ==) | `100.00% <100.00%> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jakobchwastek commented 9 months ago

Thanks a lot for your comments @dkrako. Please let me know if any further change is required.

aeye-lab / pymovements