From 8fc18a434da400f0fe82707e23838d6cc40a787d Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 3 Jul 2024 17:14:43 +0200
Subject: Rewriting eye tracking context and gaze analysis sections.

---
 .../advanced_topics/scripting.md                   | 54 +++++++++++++++++++++-
 1 file changed, 53 insertions(+), 1 deletion(-)

(limited to 'docs/user_guide/gaze_analysis_pipeline/advanced_topics')

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 026cb3f..f3ec6cd 100644
--- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
@@ -66,7 +66,28 @@ from argaze import ArFeatures
         ...
 ```
 
-## Pipeline execution updates
+## Pipeline execution
+
+Timestamped [GazePositions](../../argaze.md/#argaze.GazeFeatures.GazePosition) have to be passed one by one to the [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method to execute the whole instantiated pipeline. 
+
+!!! warning "Mandatory"
+
+    The [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method must be called from a *try* block to catch pipeline exceptions.
+
+```python
+# Assuming that timestamped gaze positions are available
+...
+
+    try:
+
+        # Look ArFrame at a timestamped gaze position
+        ar_frame.look(timestamped_gaze_position)
+
+    # Do something with pipeline exception
+    except Exception as e:
+        
+        ...
+```
 
 Calling [ArFrame.look](../../../argaze.md/#argaze.ArFeatures.ArFrame.look) method leads to update many data into the pipeline.
 
@@ -186,3 +207,34 @@ ar_frame_image = ar_frame.image(**image_parameters)
 # Do something with ArFrame image
 ...
 ```
+
+Then, [ArFrame.image](../../argaze.md/#argaze.ArFeatures.ArFrame.image) method can be called in various situations.
+
+### Live window display
+
+While timestamped gaze positions are processed by [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method, it is possible to display the [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) image thanks to the [OpenCV package](https://pypi.org/project/opencv-python/).
+
+```python
+import cv2
+
+def main():
+
+    # Assuming ArFrame is loaded
+    ...
+
+        # Create a window to display ArFrame
+        cv2.namedWindow(ar_frame.name, cv2.WINDOW_AUTOSIZE)
+
+        # Assuming that timestamped gaze positions are being processed by ArFrame.look method
+        ...
+
+            # Update ArFrame image display
+            cv2.imshow(ar_frame.name, ar_frame.image())
+
+            # Wait 10 ms
+            cv2.waitKey(10)
+
+if __name__ == '__main__':
+
+    main()
+```
\ No newline at end of file
-- 
cgit v1.1