aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/aruco_markers_pipeline/aruco_scene.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user_guide/aruco_markers_pipeline/aruco_scene.md')
-rw-r--r--docs/user_guide/aruco_markers_pipeline/aruco_scene.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/user_guide/aruco_markers_pipeline/aruco_scene.md b/docs/user_guide/aruco_markers_pipeline/aruco_scene.md
new file mode 100644
index 0000000..2f37fa7
--- /dev/null
+++ b/docs/user_guide/aruco_markers_pipeline/aruco_scene.md
@@ -0,0 +1,56 @@
+Add an ArUcoScene
+=================
+
+An [ArUcoScene](../../argaze.md/#argaze.ArUcoMarkers.ArUcoScene) class defines ...
+
+Besides, the [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) class projects [ArUcoScenes](../../argaze.md/#argaze.ArUcoMarkers.ArUcoScene)'s layers into its own layers thanks to ArUco markers pose estimations made by its [ArUcoDetector](../../argaze.md/#argaze.ArUcoMarkers.ArUcoDetector).
+
+![ArUco scene](../../img/aruco_scene.png)
+
+## Add ArUcoScene to ArUcoCamera JSON configuration file
+
+An [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) instance can contains multiples [ArUcoScene](../../argaze.md/#argaze.ArUcoMarkers.ArUcoScene).
+
+Here is an extract from the JSON ArUcoCamera configuration file with a sample where one scene is added:
+
+```json
+{
+ "name": "My FullHD camera",
+ "size": [1920, 1080],
+ ...
+ "scenes": {
+ "MyScene" : {
+ "aruco_markers_group": "aruco_description.json"
+ },
+ "layers": {
+ "MyLayer": {
+ "aoi_scene": "aoi_description.obj"
+ }
+ }
+ },
+ "layers": {
+ "MyLayer": {}
+ }
+ ...
+}
+```
+
+Now, let's understand the meaning of each JSON entry.
+
+### "MyLayer"
+
+The name of the [ArUcoScene](../../argaze.md/#argaze.ArUcoMarkers.ArUcoScene). Basically useful for visualisation purpose.
+
+### ArUco markers group
+
+...
+
+### Layers
+
+...
+
+### AOI scene
+
+The [AOIScene](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.AOIScene) defines a set of 2D [AreaOfInterest](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.AreaOfInterest) registered by name.
+
+![AOI Scene](../../img/ar_layer_aoi_scene.png)