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

feat: Parse SMI BeGaze raw data files #1013

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

saeub
Copy link
Collaborator

@saeub saeub commented Mar 7, 2025

Description

Read BeGaze text files. Not aiming for full support for now (I don't have enough data for testing), but at least the raw samples and events in DIDEC should be parsed successfully (#980).

Documentation on file format: https://psychologie.unibas.ch/fileadmin/user_upload/psychologie/Forschung/N-Lab/SMI_BeGaze_Manual.pdf#page=343.21

#945 should be merged first (so that events can be implemented and tested the same way as for EyeLink)

Fixes #981

Implemented changes

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

  • Implement parse_begaze() like parse_eyelink()
  • Implement from_begaze() like from_asc()
  • ❓ Figure out a way to route BeGaze files through from_begaze() when loading datasets, even if the file extension is .txt (currently they are routed through from_csv(), not sure if this behavior is required by other datasets)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change is or requires a documentation update

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

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

@saeub saeub added enhancement New feature or request urgent resolve as soon as possible essential important and removed urgent resolve as soon as possible labels Mar 7, 2025
Copy link

codecov bot commented Mar 7, 2025

Codecov Report

Attention: Patch coverage is 66.66667% with 4 lines in your changes missing coverage. Please review.

Project coverage is 99.88%. Comparing base (2d9da18) to head (550945b).
Report is 6 commits behind head on main.

Files with missing lines Patch % Lines
src/pymovements/gaze/_utils/parsing.py 66.66% 2 Missing and 2 partials ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##              main    #1013      +/-   ##
===========================================
- Coverage   100.00%   99.88%   -0.12%     
===========================================
  Files           79       79              
  Lines         3586     3594       +8     
  Branches       632      634       +2     
===========================================
+ Hits          3586     3590       +4     
- Misses           0        2       +2     
- Partials         0        2       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@saeub saeub mentioned this pull request Mar 8, 2025
@saeub saeub self-assigned this Mar 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request essential important highlight parsing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

implement BeGaze parser.
2 participants