lpfilt_pupil

This function lowpass filters pupil data using a Butterworth
filter.
This function is called by the exposed wrapper <code>lpfilt()</code>

internal

Pupillometry offers a non-invasive window into the mind and has been used extensively as a psychophysiological readout of arousal signals linked with cognitive processes like attention, stress, and emotional states [Clewett et al. (2020) <doi:10.1038/s41467-020-17851-9>; Kret & Sjak-Shie (2018) <doi:10.3758/s13428-018-1075-y>; Strauch (2024) <doi:10.1016/j.tins.2024.06.002>]. Yet, despite decades of pupillometry research, many established packages and workflows to date lack design patterns based on Findability, Accessibility, Interoperability, and Reusability (FAIR) principles [see Wilkinson et al. (2016) <doi:10.1038/sdata.2016.18>]. 'eyeris' provides a modular, performant, and extensible preprocessing framework for pupillometry data with BIDS-like organization and interactive output reports [Esteban et al. (2019) <doi:10.1038/s41592-018-0235-4>; Gorgolewski et al. (2016) <doi:10.1038/sdata.2016.44>]. Development was supported, in part, by the Stanford Wu Tsai Human Performance Alliance, Stanford Ric Weiland Graduate Fellowship, Stanford Center for Mind, Brain, Computation and Technology, NIH National Institute on Aging Grants (R01-AG065255, R01-AG079345), NSF GRFP (DGE-2146755), McKnight Brain Research Foundation Clinical Translational Research Scholarship in Cognitive Aging and Age-Related Memory Loss, American Brain Foundation, and the American Academy of Neurology.

Shawn Schwartz

eyeris

Flexible, Extensible, & Reproducible Pupillometry Preprocessing

lpfilt_pupil function

<dl><dt>x</dt>
<dd>A data frame containing pupil data</dd>
<dt>prev_op</dt>
<dd>The name of the previous operation in the pipeline</dd>
<dt>wp</dt>
<dd>The end of passband frequency in Hz (desired lowpass cutoff)</dd>
<dt>ws</dt>
<dd>The start of stopband frequency in Hz (required lowpass cutoff)</dd>
<dt>rp</dt>
<dd>Required maximal ripple within passband in dB</dd>
<dt>rs</dt>
<dd>Required minimal attenuation within stopband in dB</dd>
<dt>fs</dt>
<dd>The sample rate of the data</dd>
<dt>plot_freqz</dt>
<dd>A flag to indicate whether to display the filter frequency
response</dd></dl>

Arguments

Internal function to lowpass filter pupil data — lpfilt_pupil

<dl>

<dt>x</dt>
<dd>A data frame containing pupil data</dd>


<dt>prev_op</dt>
<dd>The name of the previous operation in the pipeline</dd>


<dt>wp</dt>
<dd>The end of passband frequency in Hz (desired lowpass cutoff)</dd>


<dt>ws</dt>
<dd>The start of stopband frequency in Hz (required lowpass cutoff)</dd>


<dt>rp</dt>
<dd>Required maximal ripple within passband in dB</dd>


<dt>rs</dt>
<dd>Required minimal attenuation within stopband in dB</dd>


<dt>fs</dt>
<dd>The sample rate of the data</dd>


<dt>plot_freqz</dt>
<dd>A flag to indicate whether to display the filter frequency
response</dd>

</dl>

lpfilt_pupil: Internal function to lowpass filter pupil data

Description

Usage

Value

Arguments