pymovements.Dataset.measure_reading#
- Dataset.measure_reading(aoi_dict: dict[str, str | Path], *, save_path: str | Path | None = None, word_index_column: str = 'word_idx', word_column: str = 'word') ReadingMeasures[source]#
Map fixations to AOIs and compute reading measures for an entire dataset.
This method implicitly annotates fixations with AOI data. See
map_to_aois()for further details.- Parameters:
aoi_dict (dict[str, str | Path]) – A dictionary mapping text IDs to their corresponding AOI file paths.
save_path (str | Path | None) – The directory path where the computed reading measures CSV files will be saved. If
None, no files are saved to disk. (default: None)word_index_column (str) – Shared column name in fixations and AOIs that corresponds to the word index of the text. (default:
'word_idx')word_column (str) – Column in AOIs with the content within each AOI. (default:
'word')
- Returns:
Returns a ReadingMeasures object containing the computed reading measures.
- Return type: