From 99845a52709d1b22a8cc6b924f68cb1bd5d31615 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 15 Nov 2023 12:39:12 +0100
Subject: Documenting gaze position calibration features.

---
 docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md')

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 eefeee1..4e2be92 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_movement, scan_path_analysis, layers_analysis, execution_times, exception = ar_frame.look(timestamp, gaze_position)
+    gaze_position, gaze_movement, scan_path_analysis, layers_analysis, execution_times, exception = ar_frame.look(timestamp, gaze_position)
 
     # Check if a gaze movement has been identified
     if gaze_movement.valid and gaze_movement.finished:
@@ -106,6 +106,10 @@ for name, ar_layer in ar_frame.layers.items():
 
 Let's understand the meaning of each returned data.
 
+### *gaze_position*
+
+This is the calibrated [GazePosition](../../../argaze.md/#argaze.GazeFeatures.GazePosition) returned by [GazePositionCalibrator](../../../argaze.md/#argaze.GazeFeatures.GazePositionCalibrator) if one is instanciated else, it is the given [GazePosition](../../../argaze.md/#argaze.GazeFeatures.GazePosition).
+
 ### *gaze_movement*
 
 A [GazeMovement](../../../argaze.md/#argaze.GazeFeatures.GazeMovement) once it have been identified by [ArFrame.gaze_movement_identifier](../../../argaze.md/#argaze.ArFeatures.ArFrame) object from incoming consecutive timestamped gaze positions. If no gaze movement have been identified, it returns an [UnvalidGazeMovement](../../../argaze.md/#argaze.GazeFeatures.UnvalidGazeMovement). 
-- 
cgit v1.1