Use SI units for eyetracking data, update tutorials#12846
Merged
larsoner merged 4 commits intomne-tools:mainfrom Sep 13, 2024
Merged
Use SI units for eyetracking data, update tutorials#12846larsoner merged 4 commits intomne-tools:mainfrom
larsoner merged 4 commits intomne-tools:mainfrom
Conversation
When setting scalings, I matched the scalings used for other channels of the same type: - eyegaze == fnirs_df_phase == radians - pupil == hbo/hbr == meters
agramfort
approved these changes
Sep 12, 2024
Contributor
Author
|
Ok here is the built documentation for the Eyetracking tutorials. Marking as ready for review! |
larsoner
reviewed
Sep 12, 2024
Comment on lines
+110
to
+111
| custom_scalings = dict(pupil=1e3) | ||
| raw.pick(picks="eyetrack").plot(scalings=custom_scalings) |
Member
Contributor
Author
There was a problem hiding this comment.
Sorry @larsoner Im not sure what you mean by setting the units and if you are referring to the eyegaze channel or pupil channel (I assume eyegaze) - Can you clarify?
Member
There was a problem hiding this comment.
I meant for plot_raw but I see now that we only have it for other viz functions like plot_evoked, so never mind! Also not sure it would actually help...
Member
|
Thanks @scott-huberty ! |
Member
|
looking a bit late, but why is the unit for pupil |
Member
|
Ugh yes that seems like a bug... |
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

closes #12756
Updated
mne.defaultsso that eyegaze channels are expected to be radians and pupil size channels are expected to be meters. When specifying the scalings, I matched the scalings with other MNE channel types that have a radians/meters unit (e.g. fnirs_fd_phase for radians, hbo/hbr for meters).Updated the eyetracking tutorials such that eygaze units are converted to radians as early as possible.
Notable exceptions: