Feature: Pupil Deconvolution (port from pyeparse) #12505
+363
−6
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.
Reference issue
This PR implements the last feature proposed for my GSoC in #11879 that I didn't get to over the summer.
What does this implement/fix?
This basically ports the pupil deconvolution code from (the unmaintained?) https://github.com/pyeparse/pyeparse , and which was used for @larsoner and @drammock 's pupil deconvolution paper in 2016.
Additional information
I made some minor changes to the code and docstring to work with MNE's API and follow MNE conventions (and make the code more modern i.e. use format specifiers instead of percent specifiers).
To check that the ported code in this branch behaves similarly to the code in pyeparse, I re-ran the scripts to deconvolve the data and generate
figure 3
in Dan and Eric's paper (The original scripts used the deconvolution method frompyeparse
, and I updated the scripts to use the MNE API in this branch:Possible Alternatives
I have not opened an issue for deconvolution specifically, so if there are concerns about merging this into MNE or other ideas, don't hesitate to share.