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/aoi_matchers.md               | 24 +++++++++
 .../pipeline_modules/aoi_scan_path_analyzers.md    | 57 ++++++++++++++++++++++
 .../pipeline_modules/gaze_movement_identifiers.md  | 29 +++++++++++
 .../pipeline_modules/scan_path_analyzers.md        | 40 +++++++++++++++
 4 files changed, 150 insertions(+)
 create mode 100644 docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md
 create mode 100644 docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md
 create mode 100644 docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md
 create mode 100644 docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md

(limited to 'docs/user_guide/gaze_analysis_pipeline')

diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md
new file mode 100644
index 0000000..c8fa63c
--- /dev/null
+++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md
@@ -0,0 +1,24 @@
+AOI matchers
+============
+
+ArGaze provides ready-to-use AOI matching algorithms.
+
+Here are JSON samples to include the chosen module inside [ArLayer configuration](../ar_layer_configuration_and_execution.md) *aoi_matcher* entry.
+
+## Deviation circle coverage
+
+```json
+"DeviationCircleCoverage": {
+	"coverage_threshold": 0.5
+}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.DeviationCircleCoverage.AOIMatcher)
+
+## Focus point inside
+
+```json
+"FocusPointInside": {}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.FocusPointInside.AOIMatcher)
diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md
new file mode 100644
index 0000000..8d02967
--- /dev/null
+++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md
@@ -0,0 +1,57 @@
+AOI scan path analyzers
+=======================
+
+ArGaze provides ready-to-use AOI scan path analysis algorithms.
+
+Here are JSON samples to include a chosen module inside [ArLayer configuration](../ar_layer_configuration_and_execution.md) *aoi_scan_path_analyzers* entry.
+
+## Basic metrics
+
+```json
+"Basic": {}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.Basic.AOIScanPathAnalyzer)
+
+## Entropy
+
+```json
+"Entropy": {}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.Entropy.AOIScanPathAnalyzer)
+
+## K-modified coefficient
+
+```json
+"KCoefficient": {}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.KCoefficient.AOIScanPathAnalyzer)
+
+## Lempel-Ziv complexity
+
+```json
+"LempelZivComplexity": {}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.LempelZivComplexity.AOIScanPathAnalyzer)
+
+## N-Gram
+
+```json
+"NGram": {
+	"n_min": 3,
+	"n_max": 5
+}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.NGram.AOIScanPathAnalyzer)
+
+## Transition matrix
+
+```json
+"TransitionMatrix": {}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.TransitionMatrix.AOIScanPathAnalyzer)
\ No newline at end of file
diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md
new file mode 100644
index 0000000..6ae66bf
--- /dev/null
+++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md
@@ -0,0 +1,29 @@
+Gaze movement identifiers
+=========================
+
+ArGaze provides ready-to-use gaze movement identification algorithms.
+
+Here are JSON samples to include a chosen module inside [ArFrame configuration](../ar_frame_configuration_and_execution.md) *gaze_movement_identifier* entry.
+
+## Dispersion threshold identification (I-DT)
+
+```json
+"DispersionThresholdIdentification": {
+	"deviation_max_threshold": 50,
+	"duration_min_threshold": 200
+}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.DispersionThresholdIdentification.GazeMovementIdentifier)
+
+## Velocity threshold identification (I-VT)
+
+```json
+"VelocityThresholdIdentification": {
+	"velocity_max_threshold": 10,
+	"duration_min_threshold": 200
+}
+```
+
+[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.VelocityThresholdIdentification.GazeMovementIdentifier)
+
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