clear_layer#

pypillometry.clear_layer(name, eyes=[], variables=[])#

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

Clear a mask layer (e.g., "blink") for the selected channels.

Clearing "blink" removes the blinks and their mask (e.g., to undo d.pupil.blinks_detect()). "excluded" is a recording-wide layer: clearing it removes the excluded periods (eyes and variables are ignored).

Parameters:

  • name (str) – name of the layer

  • eyes (str | list) – eye(s); if empty, all available eyes

  • variables (str | list) – variable(s); if empty, all available variables

  • inplace (bool or None, optional) – if True, make change in-place and return the object; if False, make and return copy before making changes; if None, use the object-level setting (specified in the constructor)

Return type:

EyeData

Returns:

the object without the layer (self or a copy, depending on inplace)