aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThéo de la Hogue2023-07-11 16:25:59 +0200
committerThéo de la Hogue2023-07-11 16:25:59 +0200
commit75e5a955730e005da1e55f37efc57786a7447a21 (patch)
tree9a08e13500f2757155d682326d86835ca9b8c4d1
parent1a58219a0440c56d924b029f3ac63dd1481d0f82 (diff)
downloadargaze-75e5a955730e005da1e55f37efc57786a7447a21.zip
argaze-75e5a955730e005da1e55f37efc57786a7447a21.tar.gz
argaze-75e5a955730e005da1e55f37efc57786a7447a21.tar.bz2
argaze-75e5a955730e005da1e55f37efc57786a7447a21.tar.xz
Documenting TimestampedGazePositions iterator feature.
-rw-r--r--docs/user_guide/gaze_analysis/gaze_position.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/user_guide/gaze_analysis/gaze_position.md b/docs/user_guide/gaze_analysis/gaze_position.md
index 8856bec..0ca6a12 100644
--- a/docs/user_guide/gaze_analysis/gaze_position.md
+++ b/docs/user_guide/gaze_analysis/gaze_position.md
@@ -85,3 +85,14 @@ dataframe = pandas.read_csv('gaze_positions.csv', delimiter="\t", low_memory=Fal
ts_gaze_positions = GazeFeatures.TimeStampedGazePositions.from_dataframe(dataframe, timestamp = 'Recording timestamp [ms]', x = 'Gaze point X [px]', y = 'Gaze point Y [px]')
```
+### Iterator
+
+Like [TimeStampedBuffer](../../../argaze/#argaze.DataStructures.TimeStampedBuffer), [TimeStampedGazePositions](../../../argaze/#argaze.GazeFeatures.TimeStampedGazePositions) class provides iterator feature:
+
+```python
+for timestamp, gaze_position in ts_gaze_positions.items():
+
+ # Do something with gaze positions
+ ...
+
+```