From 3bf8b12727974095b92db59434012e73266f6af2 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Wed, 7 Jun 2023 20:13:40 +0200 Subject: Improving cross reference in area of interest section. --- docs/user_guide/areas_of_interest/aoi_matching.md | 5 +++-- .../user_guide/areas_of_interest/aoi_projection.md | 22 ---------------------- .../areas_of_interest/aoi_scene_description.md | 4 ++-- .../areas_of_interest/aoi_scene_projection.md | 22 ++++++++++++++++++++++ docs/user_guide/areas_of_interest/introduction.md | 2 +- .../areas_of_interest/vision_cone_filtering.md | 2 +- mkdocs.yml | 2 +- 7 files changed, 30 insertions(+), 29 deletions(-) delete mode 100644 docs/user_guide/areas_of_interest/aoi_projection.md create mode 100644 docs/user_guide/areas_of_interest/aoi_scene_projection.md diff --git a/docs/user_guide/areas_of_interest/aoi_matching.md b/docs/user_guide/areas_of_interest/aoi_matching.md index 3bffeb9..299a212 100644 --- a/docs/user_guide/areas_of_interest/aoi_matching.md +++ b/docs/user_guide/areas_of_interest/aoi_matching.md @@ -5,8 +5,9 @@ title: AOI matching AOI matching ============ -Once AOI3D scene is projected into a frame as AOI2D scene, it could be needed to know which AOI2D is looked. -The AOI class in [AOIFeatures](/argaze/#argaze.AreaOfInterest.AOIFeatures) provides two ways to accomplish such task. +Once [AOI3DScene](/argaze/#argaze.AreaOfInterest.AOI3DScene) is projected into a frame as [AOI2DScene](/argaze/#argaze.AreaOfInterest.AOI2DScene), it could be needed to know which AOI is looked. + +The [AreaOfInterest](/argaze/#argaze.AreaOfInterest.AOIFeatures.AreaOfInterest) class in [AOIFeatures](/argaze/#argaze.AreaOfInterest.AOIFeatures) provides two ways to accomplish such task. ## Pointer-based matching diff --git a/docs/user_guide/areas_of_interest/aoi_projection.md b/docs/user_guide/areas_of_interest/aoi_projection.md deleted file mode 100644 index 7ffc42d..0000000 --- a/docs/user_guide/areas_of_interest/aoi_projection.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: AOI projection ---- - -AOI projection -============== - -An AOI3D scene can be rotated and translated according to a pose estimation before to project it onto camera frame as an AOI2D scene. - -![AOI projection](../../img/aoi_projection.png) - -``` python -... - -# Assuming pose estimation is done (tvec and rmat) - -# Project AOI 3D scene according pose estimation and camera intrinsic parameters -aoi2D_scene = aoi3D_scene.project(tvec, rmat, aruco_camera.K) - -# Draw AOI 2D scene -aoi2D_scene.draw(frame) -``` 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 dcda74b..e6a8a16 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,7 @@ title: AOI scene description AOI scene description ===================== -An AOI3D scene is built from a 3D model with all AOI as 3D planes and loaded through OBJ file format. +An [AOI3DScene](/argaze/#argaze.AreaOfInterest.AOI3DScene) is 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 @@ -47,7 +47,7 @@ f 185 190 186 188 191 187 189 ... ``` -Here is a sample of code to show the loading of an AOI3D scene from an OBJ file description: +Here is a sample of code to show the loading of an [AOI3DScene](/argaze/#argaze.AreaOfInterest.AOI3DScene) from an OBJ file description: ``` python from argaze.AreaOfInterest import AOI3DScene diff --git a/docs/user_guide/areas_of_interest/aoi_scene_projection.md b/docs/user_guide/areas_of_interest/aoi_scene_projection.md new file mode 100644 index 0000000..a23d069 --- /dev/null +++ b/docs/user_guide/areas_of_interest/aoi_scene_projection.md @@ -0,0 +1,22 @@ +--- +title: AOI scene projection +--- + +AOI scene projection +==================== + +An [AOI3DScene](/argaze/#argaze.AreaOfInterest.AOI3DScene) can be rotated and translated according to a pose estimation before to project it onto camera frame as an [AOI2DScene](/argaze/#argaze.AreaOfInterest.AOI2DScene). + +![AOI projection](../../img/aoi_projection.png) + +``` python +... + +# Assuming pose estimation is done (tvec and rmat) + +# Project AOI 3D scene according pose estimation and camera intrinsic parameters +aoi2D_scene = aoi3D_scene.project(tvec, rmat, aruco_camera.K) + +# Draw AOI 2D scene +aoi2D_scene.draw(frame) +``` diff --git a/docs/user_guide/areas_of_interest/introduction.md b/docs/user_guide/areas_of_interest/introduction.md index 7d44785..201e4b2 100644 --- a/docs/user_guide/areas_of_interest/introduction.md +++ b/docs/user_guide/areas_of_interest/introduction.md @@ -1,7 +1,7 @@ About Areas Of Interest (AOI) ============================= -The [AreaOfInterest submodule](/argaze/#argaze.AreaOfInterest) allows to deal with AOI in a AR environment through high level classes: +The [AreaOfInterest submodule](/argaze/#argaze.AreaOfInterest) allows to deal with AOI in a AR environment through a set of high level classes: * [AOIFeatures](/argaze/#argaze.AreaOfInterest.AOIFeatures) * [AOI3DScene](/argaze/#argaze.AreaOfInterest.AOI3DScene) diff --git a/docs/user_guide/areas_of_interest/vision_cone_filtering.md b/docs/user_guide/areas_of_interest/vision_cone_filtering.md index e2b31ea..e1f4f82 100644 --- a/docs/user_guide/areas_of_interest/vision_cone_filtering.md +++ b/docs/user_guide/areas_of_interest/vision_cone_filtering.md @@ -1,7 +1,7 @@ Vision cone filtering ===================== -The AOI3D scene provides cone clipping support in order to select only AOI which are inside vision cone field. +The [AOI3DScene](/argaze/#argaze.AreaOfInterest.AOI3DScene) provides cone clipping support in order to select only [AOI](/argaze/#argaze.AreaOfInterest.AOIFeatures.AreaOfInterest) which are inside vision cone field. ![Vision cone](../../img/vision_cone.png) diff --git a/mkdocs.yml b/mkdocs.yml index b74c453..e0ee939 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,7 +15,7 @@ nav: - Areas Of Interest: - user_guide/areas_of_interest/introduction.md - user_guide/areas_of_interest/aoi_scene_description.md - - user_guide/areas_of_interest/aoi_projection.md + - user_guide/areas_of_interest/aoi_scene_projection.md - user_guide/areas_of_interest/vision_cone_filtering.md - user_guide/areas_of_interest/aoi_matching.md - user_guide/areas_of_interest/aoi_frame.md -- cgit v1.1