pupil_frequency_features: Extract pupil frequency-domain and activity features by group

View source: R/061-pupil-advanced-representations-0-8.R

pupil_frequency_featuresR Documentation

Extract pupil frequency-domain and activity features by group

Description

Extract pupil frequency-domain and activity features by group

Usage

pupil_frequency_features(
  data,
  by = c("person_id", "trial_id"),
  time = "time_ms",
  pupil = "pupil_bc",
  sampling_rate_hz = 60,
  low_band = c(0.05, 0.5),
  high_band = c(0.5, 4)
)

Arguments

data

Sample-level data.

by

Grouping columns, e.g. person and trial/window.

time, pupil

Column names.

sampling_rate_hz

Either a scalar or a column name.

low_band, high_band

Frequency bands.

Value

An object of class "eye_pupil_frequency_features", stored as a named list, with components "features", "low_band", "high_band", "by", "pupil", "time", "caveat". It contains pupil frequency-domain and activity features by group and associated metadata or diagnostics needed to interpret the result.


eyeprocess documentation built on Sept. 28, 2026, 5:08 p.m.