set_blinks

pypillometry.set_blinks(intervals, eyes=[], variables=[])

Pipeline step for set_blinks() (d | pp.set_blinks(...)).

Set blinks for specified eyes and variables (in-place).

The blinks replace the "blink" layer of the selected variables (and the mask of the blinks set before). Blinks are masked under the mask policies (see mask()).

Parameters:

• intervals (Intervals, dict or None) –

  Either:

  • a single Intervals object: stored for all specified eyes/variables;

  • a dict of Intervals (or None) with keys like “left_pupil”, “right_x”, etc.; when a dict is provided, eyes and variables are ignored;

  • None: remove the blinks for the specified eyes/variables (and their mask).

• eyes (str or list of str, optional) – eye(s) to set blinks for (e.g., ["left", "right"]); if empty, all available eyes. Ignored if intervals is a dict.

• variables (str or list of str, optional) – variable(s) to set blinks for (e.g., ["pupil", "x", "y"]); if empty, all available variables. Ignored if intervals is a dict.

Return type:

EyeData

Returns:

the object itself (always modified in-place)