Adjust Pupil channel units (again)#13314
Merged
larsoner merged 2 commits intomne-tools:mainfrom Jul 11, 2025
Merged
Conversation
Member
|
Thanks @scott-huberty ! |
larsoner
added a commit
to larsoner/mne-python
that referenced
this pull request
Jul 23, 2025
* upstream: (115 commits) Capitalize Get Help (mne-tools#13340) Website page load fixes (mostly) (mne-tools#13343) MAINT: Restore statsmodels to pip-pre (mne-tools#13345) BUG: Fix bug with reading old reports (mne-tools#13341) [pre-commit.ci] pre-commit autoupdate (mne-tools#13338) MAINT: Fix ref cycle with vtkPolyData (mne-tools#13336) MAINT: Dont set private attributes for PyVista Actor (mne-tools#13334) Add icon links to our donation pages (mne-tools#13331) MAINT: Dont set attribute on PolyData (mne-tools#13330) MAINT: Bump mins, deprecations (mne-tools#13322) Fix changes in SSD for backward compatibility [circle deploy] (mne-tools#13327) ENH: Add GED transformer (mne-tools#13259) FIX: Links MAINT: Stabilize MxNE tests (mne-tools#13321) FIX: DigMontage.rename_channels should return self (mne-tools#13320) MAINT: Prep for release (mne-tools#13319) [pre-commit.ci] pre-commit autoupdate (mne-tools#13317) MAINT: Update code credit (mne-tools#13318) MAINT: Make MxNE test more robust (mne-tools#13315) Adjust Pupil channel units (again) (mne-tools#13314) ...
WouterKroot
pushed a commit
to WouterKroot/mne-python
that referenced
this pull request
Aug 13, 2025
zEdS15B3GCwq
pushed a commit
to zEdS15B3GCwq/mne-python
that referenced
this pull request
Aug 25, 2025
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 #13244
There have been several iterations on the issue of eyetracking units, so let me summarize for brevity:
Stemming from Issue #12756 (comment) (and PR #12846 (comment) + #12850), we changed MNE internals to assume all incoming Eyetracking data were already represented in Meters (SI unit of distance, as some eyetrackers report pupil size in mm). In those PR's I adjusted the scaling for Pupil channels so that data in meters would look nice when plotting by default. I chose a scaling factor of 1e6 (meters -> micro meters).
This caused
inst.to_data_frame()to convert from meters -> micrometers which is probably not very intuitive for researchers (hence #13244).It is probably more intuitive to adjust the scalings to go from meters to mm. The plotting still looks good, and pupil channels will be converted to mm by default by
to_data_frame():Does this sound reasonable to you @larsoner and @drammock ?