annotate_is_reg_out#

pymovements.measure.reading.annotate_is_reg_out(fixations: DataFrame) → DataFrame[source]#

Annotate fixations with a flag indicating a regression out.

A regression out occurs when the fixation departs to a lower-index word.

Parameters:

fixations (pl.DataFrame) – Fixation-level DataFrame. Must contain a delta_out column.

Returns:

Input DataFrame with an additional is_reg_out column.

Return type:

pl.DataFrame