Improving aruco markers gaze analysis pipeline documentation.

1 files changed, 58 insertions, 0 deletions

diff --git a/docs/user_guide/aruco_markers_pipeline/aoi_analysis.md b/docs/user_guide/aruco_markers_pipeline/aoi_analysis.md
new file mode 100644
index 0000000..05afcd3
--- /dev/null
+++ b/docs/user_guide/aruco_markers_pipeline/aoi_analysis.md
@@ -0,0 +1,58 @@
+Add AOI analysis
+================
+
+
+
+## Add AOIMatcher, AOIScanPath and AOIScanPathAnalyzers to ArUcoCamera layer to enable gaze analysis
+
+Here is the previous extract where AOI matcher, AOI scan path and AOI scan path analyzers are added to the [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) layer:
+
+```json
+{
+    "name": "My FullHD camera",
+    "size": [1920, 1080],
+    ...
+    "scenes": {
+        "MyScene" : {
+            "aruco_markers_group": {
+                ...
+            },
+            "layers": {
+                 "MyLayer": {
+                    "aoi_scene": {
+                        ...
+                    }
+                } 
+            } 
+        }
+    },
+    "layers": {
+        "MyLayer": {
+            "aoi_matcher": {
+                "DeviationCircleCoverage": {
+                    "coverage_threshold": 0.5
+                }
+            },
+            "aoi_scan_path": {
+                "duration_max": 30000
+            },
+            "aoi_scan_path_analyzers": {
+                "Basic": {},
+                "TransitionMatrix": {},
+                "NGram": {
+                    "n_min": 3,
+                    "n_max": 5
+                }
+            }
+        }
+    },
+    "gaze_movement_identifier": {
+        ...
+    }
+    ...
+}
+```
+
+!!! warning
+
+    Adding scan path and scan path analyzers to [an ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) layer doesn't make sense if the camera is moving.
\ No newline at end of file