From 8fed2ecbb7379e5277b9e3ab51a836d6686e76e1 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Tue, 11 Jul 2023 17:37:46 +0200
Subject: Documenting AOI2DScene description.

---
 .../areas_of_interest/aoi_scene_description.md     | 30 ++++++++++++++++++++--
 1 file changed, 28 insertions(+), 2 deletions(-)

(limited to 'docs')

diff --git a/docs/user_guide/areas_of_interest/aoi_scene_description.md b/docs/user_guide/areas_of_interest/aoi_scene_description.md
index d50f061..cdbbe26 100644
--- a/docs/user_guide/areas_of_interest/aoi_scene_description.md
+++ b/docs/user_guide/areas_of_interest/aoi_scene_description.md
@@ -5,7 +5,33 @@ title: AOI scene description
 AOI scene description
 =====================
 
-An [AOI3DScene](../../../argaze/#argaze.AreaOfInterest.AOI3DScene) is built from a 3D model with all AOI as 3D planes and loaded through OBJ file format. 
+## 2D description
+
+An AOI scene can be described in 2D dimension using an [AOI2DScene](../../../argaze/#argaze.AreaOfInterest.AOI2DScene) from a dictionary description.
+
+``` dict
+{
+	"tracking": [[672.0, 54.0], [1632.0, 54.0], [1632.0, 540.0], [672.0, 540.0]], 
+    "system": [[0.0, 54.0], [672.0, 54.0], [672.0, 540.0], [0.0, 540.0]], 
+    "communications": [[0.0, 594.0], [576.0, 594.0], [576.0, 1080.0], [0.0, 1080.0]], 
+    "resources": [[576.0, 594.0], [1632.0, 594.0], [1632.0, 1080.0], [576.0, 1080.0]]
+}
+...
+```
+
+Here is a sample of code to show the loading of an [AOI2DScene](../../../argaze/#argaze.AreaOfInterest.AOI2DScene) from a dictionary description:
+
+
+``` python
+from argaze.AreaOfInterest import AOI2DScene
+
+# Load an AOI2D scene from dictionary
+aoi_2d_scene = AOI2DScene.AOI2DScene(aoi_scene_dictionary)
+```
+
+## 3D description
+
+An AOI scene can be described in 3D dimension using an [AOI3DScene](../../../argaze/#argaze.AreaOfInterest.AOI3DScene) built from a 3D model with all AOI as 3D planes and loaded through OBJ file format. 
 Notice that plane normals are not needed and planes are not necessary 4 vertices shapes.
 
 ``` obj
@@ -53,5 +79,5 @@ Here is a sample of code to show the loading of an [AOI3DScene](../../../argaze/
 from argaze.AreaOfInterest import AOI3DScene
 
 # Load an AOI3D scene from OBJ file
-aoi3D_scene = AOI3DScene.AOI3DScene.from_obj('./aoi_scene.obj')
+aoi_3d_scene = AOI3DScene.AOI3DScene.from_obj('./aoi_scene.obj')
 ```
-- 
cgit v1.1