annotate_is_reg_in#

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

Annotate fixations with a flag indicating a regression in.

A regression in occurs when the fixation arrives from a higher-index word.

Parameters:

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

Returns:

Input DataFrame with an additional is_reg_in column.

Return type:

pl.DataFrame