From f93d3e2b011fe1c1de93d0094ca45584ddd49936 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Mon, 28 Aug 2023 15:05:01 +0200
Subject: Improving gaze analysis pipeline documentation.

---
 .../ar_frame_configuration_and_execution.md        | 29 ++++++----------------
 1 file changed, 8 insertions(+), 21 deletions(-)

(limited to 'docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md')

diff --git a/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md b/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md
index f1264c7..3e18f3e 100644
--- a/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md
+++ b/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md
@@ -29,11 +29,6 @@ Here is a simple JSON ArFrame configuration file example:
 		"ExploitExploreRatio": {
             "short_fixation_duration_threshold": 0
         }
-	},
-	"heatmap": {
-		"size": [320, 180],
-		"sigma": 0.025,
-		"buffer": 0
 	}
 }
 ```
@@ -54,8 +49,6 @@ print("scan path:", ar_frame.scan_path)
 
 for module, analyzer in ar_frame.scan_path_analyzers.items():
 	print('scan path analyzer module:', module)
-
-print("heatmap:", ar_frame.heatmap)
 ```
 
 Finally, here is what the program writes in console:
@@ -67,7 +60,6 @@ gaze movement identifier type: <class 'argaze.GazeAnalysis.DispersionThresholdId
 scan path: []
 scan path analyzer module: argaze.GazeAnalysis.Basic
 scan path analyzer module: argaze.GazeAnalysis.ExploitExploreRatio
-heatmap: Heatmap(size=[320, 180], buffer=0, sigma=0.025)
 ```
 
 Now, let's understand the meaning of each JSON entry.
@@ -80,15 +72,18 @@ The name of the [ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame). Basically
 
 The size of the [ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) defines the dimension of the rectangular area where gaze positions are projected. Be aware that gaze positions have to be in the same range of value.
 
+!!! warning
+	**ArGaze doesn't impose any spatial unit.** Gaze positions can either be integer or float, pixels, millimeters or what ever you need. The only concern is that all spatial values used in further configurations have to be all the same unit.
+
 ### Gaze Movement Identifier
 
 The first [ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) pipeline step is to identify fixations or saccades from consecutive timestamped gaze positions.
 
 ![Gaze Movement Identifier](../../img/ar_frame_gaze_movement_identifier.png)
 
-The identification method can be selected by instantiating a particular [GazeMovementIdentifier](../../../argaze/#argaze.GazeFeatures.GazeMovementIdentifier) from the [argaze.GazeAnalysis](../../../argaze/#argaze.GazeAnalysis) submodule or [another python package](../advanced_topics/plugin_loading).
+The identification algorithm can be selected by instantiating a particular [GazeMovementIdentifier](../../../argaze/#argaze.GazeFeatures.GazeMovementIdentifier) from the [argaze.GazeAnalysis](../../../argaze/#argaze.GazeAnalysis) submodule or [from another python package](../advanced_topics/module_loading).
 
-In the example file, the choosen identification method is the [Dispersion Threshold Identification (I-DT)](../../../argaze/#argaze.GazeAnalysis.DispersionThresholdIdentification) which has two specific *deviation_max_threshold* and *duration_min_threshold* attributes.
+In the example file, the choosen identification algorithm is the [Dispersion Threshold Identification (I-DT)](../../../argaze/#argaze.GazeAnalysis.DispersionThresholdIdentification) which has two specific *deviation_max_threshold* and *duration_min_threshold* attributes.
 
 !!! note
 	In ArGaze, [Fixation](../../../argaze/#argaze.GazeFeatures.Fixation) and [Saccade](../../../argaze/#argaze.GazeFeatures.Saccade) are considered as particular [GazeMovements](../../../argaze/#argaze.GazeFeatures.GazeMovement).
@@ -106,22 +101,14 @@ Once fixations and saccades are identified, they are automatically appended to t
 
 The [ScanPath.duration_max](../../../argaze/#argaze.GazeFeatures.ScanPath.duration_max) attribute is the duration from which older scan steps are removed each time new scan steps are added.
 
-### Scan Path Analyzers
-
-Finally, the last [ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) pipeline step consists in passing the previously built [ScanPath](../../../argaze/#argaze.GazeFeatures.ScanPath) to each loaded [ScanPathAnalyzer](../../../argaze/#argaze.GazeFeatures.ScanPathAnalyzer).
-
-Each analysis algorithm can be selected by instantiating a particular [ScanPathAnalyzer](../../../argaze/#argaze.GazeFeatures.ScanPathAnalyzer) from the [argaze.GazeAnalysis](../../../argaze/#argaze.GazeAnalysis) submodule or [another python package](../advanced_topics/plugin_loading).
-
 !!! note
 	JSON *scan_path* entry is not mandatory. If scan_path_analyzers entry is not empty, the ScanPath step is automatically enabled.
 
-### Heatmap
-
-This is an optional [ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) pipeline step. It is executed at each new gaze position to update Heatmap image.
+### Scan Path Analyzers
 
-![Heatmap](../../img/ar_frame_heatmap.png)
+Finally, the last [ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) pipeline step consists in passing the previously built [ScanPath](../../../argaze/#argaze.GazeFeatures.ScanPath) to each loaded [ScanPathAnalyzer](../../../argaze/#argaze.GazeFeatures.ScanPathAnalyzer).
 
-The Heatmap object have tree attributes to set its size, the sigma point spreading and optional buffer size (0 means no buffering).
+Each analysis algorithm can be selected by instantiating a particular [ScanPathAnalyzer](../../../argaze/#argaze.GazeFeatures.ScanPathAnalyzer) from the [argaze.GazeAnalysis](../../../argaze/#argaze.GazeAnalysis) submodule or [from another python package](../advanced_topics/module_loading).
 
 ## Pipeline execution
 
-- 
cgit v1.1