pymovements.stimulus.TextStimulus.get_aoi#
- TextStimulus.get_aoi(*, row: row, x_eye: str, y_eye: str) DataFrame[source]#
Given eye movement and aoi dataframe, return aoi.
If width is used, calculation: start_x_column <= x_eye < start_x_column + width. If end_x_column is used, calculation: start_x_column <= x_eye < end_x_column. Analog for y coordinate and height.
- Parameters:
row (pl.DataFrame.row) – Eye movement row.
x_eye (str) – Name of x eye coordinate.
y_eye (str) – Name of y eye coordinate.
- Returns:
Looked at area of interest.
- Return type:
pl.DataFrame
- Raises:
ValueError – If width and end_TYPE_column is None.