lpfilt {eyeris} | R Documentation |
Lowpass filtering of time series data
Description
The intended use of this method is for smoothing, although by specifying
wp
and ws
differently one can achieve highpass or bandpass filtering
as well. However, only lowpass filtering should be done on pupillometry data.
Usage
lpfilt(
eyeris,
wp = 4,
ws = 8,
rp = 1,
rs = 35,
plot_freqz = FALSE,
call_info = NULL
)
Arguments
eyeris |
An object of class |
wp |
The end of passband frequency in Hz (desired lowpass cutoff).
Defaults to |
ws |
The start of stopband frequency in Hz (required lowpass cutoff).
Defaults to |
rp |
Required maximal ripple within passband in dB. Defaults to |
rs |
Required minimal attenuation within stopband in dB.
Defaults to |
plot_freqz |
A flag to indicate whether to display the filter frequency
response. Defaults to |
call_info |
A list of call information and parameters. If not provided,
it will be generated from the function call. Defaults to |
Details
This function is automatically called by glassbox()
by default. If needed,
customize the parameters for lpfilt
by providing a parameter list. Use
glassbox(lpfilt = FALSE)
to disable this step as needed.
Users should prefer using glassbox()
rather than invoking this function
directly unless they have a specific reason to customize the pipeline
manually.
Value
An eyeris
object with a new column in timeseries
:
pupil_raw_{...}_lpfilt
Note
This function is part of the glassbox()
preprocessing pipeline and is not
intended for direct use in most cases. Provide parameters via
lpfilt = list(...)
.
Advanced users may call it directly if needed.
See Also
glassbox()
for the recommended way to run this step as
part of the full eyeris glassbox preprocessing pipeline
Examples
demo_data <- eyelink_asc_demo_dataset()
demo_data |>
# set lpfilt to FALSE (instead of a list of params) to skip step
eyeris::glassbox(lpfilt = list(plot_freqz = TRUE)) |>
plot(seed = 0)