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

Store calibration and other metadata in well-documented form #893

Open
3 tasks
saeub opened this issue Nov 9, 2024 · 1 comment
Open
3 tasks

Store calibration and other metadata in well-documented form #893

saeub opened this issue Nov 9, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request essential important

Comments

@saeub
Copy link
Collaborator

saeub commented Nov 9, 2024

Description of the problem

After merging #884, some metadata are still left in the metadata dictionary (stored as a private attribute GazeDataFrame._metadata). In particular:

There should be a well-documented public interface to access these metadata.

Description of a solution

I see several options to approach a solution:

  • Storing those metadata in custom data structures as attributes of GazeDataFrame (similar to the metadata stored in Experiment, EyeTracker etc.)
  • Storing time-dependent meta-events (like calibrations, validations, blinks) in a DataFrame similar to fixations and saccades (but it's probably difficult to find a useful set of columns for all the different types of events)

We might need to think about what metadata is available for non-EyeLink devices too, and how they could all fit into the same data structure.

Minimum acceptance criteria

@saeub saeub added the enhancement New feature or request label Nov 9, 2024
@dkrako
Copy link
Contributor

dkrako commented Dec 8, 2024

Probably the easiest next step will be to pass the parsed blinks as an EventDataFrame to the GazeDataFrame.__init__().
The dataframe will need the three columns: name, onset, offset. The name should be blink.

@saeub saeub self-assigned this Dec 11, 2024
@dkrako dkrako added the essential important label Dec 11, 2024
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
Projects
None yet
Development

No branches or pull requests

2 participants