aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThéo de la Hogue2024-01-18 13:12:39 +0100
committerThéo de la Hogue2024-01-18 13:12:39 +0100
commitc98e3baa548791d7a627b37f287915a3f30585d1 (patch)
tree56a0918ac4baa97667bfa642f4223a50d58ef4dd /docs
parent25e300edf6a21ff8a0b8f7d8f38d4ecb9a3851c0 (diff)
downloadargaze-c98e3baa548791d7a627b37f287915a3f30585d1.zip
argaze-c98e3baa548791d7a627b37f287915a3f30585d1.tar.gz
argaze-c98e3baa548791d7a627b37f287915a3f30585d1.tar.bz2
argaze-c98e3baa548791d7a627b37f287915a3f30585d1.tar.xz
First work on TimestampedDataLogger system. Replacing log attribute by loggers dictionary in ArFrame and ArLayer.
Diffstat (limited to 'docs')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md32
1 files changed, 23 insertions, 9 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
index 4e2be92..ab0c6d0 100644
--- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
@@ -72,7 +72,7 @@ for name, ar_layer in ar_frame.layers.items():
...
# Look ArFrame at a timestamped gaze position
- gaze_position, gaze_movement, scan_path_analysis, layers_analysis, execution_times, exception = ar_frame.look(timestamp, gaze_position)
+ gaze_position, gaze_movement, scan_path_analysis, execution_times, exception, layers_look_data = ar_frame.look(timestamp, gaze_position)
# Check if a gaze movement has been identified
if gaze_movement.valid and gaze_movement.finished:
@@ -90,18 +90,32 @@ for name, ar_layer in ar_frame.layers.items():
for data, value in analysis.items():
...
- # Do something with each layer AOI scan path analysis
- for layer_name, layer_aoi_scan_path_analysis in layers_analysis.items():
- for module, analysis in layer_aoi_scan_path_analysis.items():
+ # Do something with ArFrame look execution times
+ ...
+
+ # Do something with ArFrame look exception
+ if exception:
+ ...
+
+ # Do something with each ArLayer look data
+ for layer_name, layer_look_data in layers_look_data.items():
+
+ looked_aoi_name, aoi_scan_path_analysis, layer_execution_times, layer_exception = layer_look_data
+
+ # Do something with looked AOI name
+ ...
+
+ # Do something with ArLayer AOI scan path analysis
+ for module, analysis in aoi_scan_path_analysis.items():
for data, value in analysis.items():
...
- # Do something with pipeline execution times
- ...
+ # Do something with ArLayer look execution times
+ ...
- # Do something with pipeline exception
- if exception:
- ...
+ # Do something with ArLayer look exception
+ if exception:
+ ...
```
Let's understand the meaning of each returned data.