From 551bc84879eaa1e04176f5a61dc48d9b981d03ac Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Tue, 29 Aug 2023 14:20:04 +0200
Subject: Adding user guide section about gaze analysis pipeline modules.

---
 .../pipeline_modules/scan_path_analyzers.md        | 40 ++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md

(limited to 'docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md')

diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md
new file mode 100644
index 0000000..29ee4f2
--- /dev/null
+++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md
@@ -0,0 +1,40 @@
+Scan path analyzers
+===================
+
+ArGaze provides ready-to-use scan path analysis algorithms.
+
+Here are JSON samples to include a chosen module inside [ArFrame configuration](../ar_frame_configuration_and_execution.md) *scan_path_analyzers* entry.
+
+## Basic metrics
+
+```json
+"Basic": {}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.Basic.ScanPathAnalyzer)
+
+## Exploit/Explore ratio
+
+```json
+"ExploitExploreRatio": {
+	"short_fixation_duration_threshold": 0
+}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.ExploitExploreRatio.ScanPathAnalyzer)
+
+## K coefficient
+
+```json
+"KCoefficient": {}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.KCoefficient.ScanPathAnalyzer)
+
+## Nearest neighbor index
+
+```json
+"NearestNeighborIndex": {}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.NearestNeighborIndex.ScanPathAnalyzer)
\ No newline at end of file
-- 
cgit v1.1