From c4552e04e1271a9210a934233beae5be1943d034 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 7 Jun 2023 14:34:14 +0200
Subject: Writing User guide and use cases section.

---
 .../user_guide/ar_environment/environment_setup.md | 77 ++++++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 docs/user_guide/ar_environment/environment_setup.md

(limited to 'docs/user_guide/ar_environment/environment_setup.md')

diff --git a/docs/user_guide/ar_environment/environment_setup.md b/docs/user_guide/ar_environment/environment_setup.md
new file mode 100644
index 0000000..b63f64a
--- /dev/null
+++ b/docs/user_guide/ar_environment/environment_setup.md
@@ -0,0 +1,77 @@
+Environment Setup
+=================
+
+AR environment setup is loaded from JSON file format.
+
+Each AR environment defines a unique ArUco detector dedicated to detection of markers from a specific ArUco dictionary and with a given size. However, it is possible to load multiple AR scenes into a same AR environment.
+
+Here is JSON environment file example where it is assumed that mentioned .obj files are located relatively to the environment file on disk.
+
+```
+{
+    "name": "my AR environment",
+    "aruco_detector": {
+    	"dictionary": {
+            "name": "DICT_APRILTAG_16h5"
+    	}
+    	"marker_size": 5,
+    	"camera": {
+            "rms": 0.6,
+            "dimensions": [
+                1920,
+                1080
+            ],
+            "K": [
+                [
+                    1135,
+                    0.0,
+                    956
+                ],
+                [
+                    0.0,
+                    1135,
+                    560
+                ],
+                [
+                    0.0,
+                    0.0,
+                    1.0
+                ]
+            ],
+            "D": [
+                0.01655492265003404,
+                0.1985524264972037,
+                0.002129965902489484,
+                -0.0019528582922179365,
+                -0.5792910353639452
+            ]
+        },
+        "parameters": {
+            "cornerRefinementMethod": 3,
+            "aprilTagQuadSigma": 2,
+            "aprilTagDeglitch": 1
+        }
+    },
+    "scenes": {
+        "my first AR scene" : {
+            "aruco_scene": "./first_scene/markers.obj",
+            "aoi_scene": "./first_scene/aoi.obj",
+            "angle_tolerance": 15.0,
+            "distance_tolerance": 2.54
+        },
+        "my second AR scene" : {
+            "aruco_scene": "./second_scene/markers.obj",
+            "aoi_scene": "./second_scene/aoi.obj",
+            "angle_tolerance": 15.0,
+            "distance_tolerance": 2.54
+        }
+    }
+}
+```
+
+```python
+from argaze import ArFeatures
+
+# Load AR environment
+ar_environment = ArFeatures.ArEnvironment.from_json('./environment.json')
+```
-- 
cgit v1.1