From 4358c40d358c811a46b3ec5325d9475c887c4b9e Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Mon, 28 Aug 2023 15:23:00 +0200 Subject: Fixing documentation linking. --- docs/user_guide/areas_of_interest/aoi_matching.md | 4 ++-- docs/user_guide/areas_of_interest/aoi_scene_description.md | 8 ++++---- docs/user_guide/areas_of_interest/aoi_scene_projection.md | 2 +- docs/user_guide/areas_of_interest/heatmap.md | 2 +- docs/user_guide/areas_of_interest/introduction.md | 8 ++++---- docs/user_guide/areas_of_interest/vision_cone_filtering.md | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) (limited to 'docs/user_guide/areas_of_interest') diff --git a/docs/user_guide/areas_of_interest/aoi_matching.md b/docs/user_guide/areas_of_interest/aoi_matching.md index ff658a2..60467f9 100644 --- a/docs/user_guide/areas_of_interest/aoi_matching.md +++ b/docs/user_guide/areas_of_interest/aoi_matching.md @@ -5,9 +5,9 @@ title: AOI matching AOI matching ============ -Once [AOI3DScene](../../../argaze/#argaze.AreaOfInterest.AOI3DScene) is projected as [AOI2DScene](../../../argaze/#argaze.AreaOfInterest.AOI2DScene), it could be needed to know which AOI is looked. +Once [AOI3DScene](../../argaze.md/#argaze.AreaOfInterest.AOI3DScene) is projected as [AOI2DScene](../../argaze.md/#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. +The [AreaOfInterest](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.AreaOfInterest) class in [AOIFeatures](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures) provides two ways to accomplish such task. ## Pointer-based matching 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 cdbbe26..b96c1e0 100644 --- a/docs/user_guide/areas_of_interest/aoi_scene_description.md +++ b/docs/user_guide/areas_of_interest/aoi_scene_description.md @@ -7,7 +7,7 @@ AOI scene description ## 2D description -An AOI scene can be described in 2D dimension using an [AOI2DScene](../../../argaze/#argaze.AreaOfInterest.AOI2DScene) from a dictionary description. +An AOI scene can be described in 2D dimension using an [AOI2DScene](../../argaze.md/#argaze.AreaOfInterest.AOI2DScene) from a dictionary description. ``` dict { @@ -19,7 +19,7 @@ An AOI scene can be described in 2D dimension using an [AOI2DScene](../../../arg ... ``` -Here is a sample of code to show the loading of an [AOI2DScene](../../../argaze/#argaze.AreaOfInterest.AOI2DScene) from a dictionary description: +Here is a sample of code to show the loading of an [AOI2DScene](../../argaze.md/#argaze.AreaOfInterest.AOI2DScene) from a dictionary description: ``` python @@ -31,7 +31,7 @@ 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. +An AOI scene can be described in 3D dimension using an [AOI3DScene](../../argaze.md/#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 @@ -73,7 +73,7 @@ f 185 190 186 188 191 187 189 ... ``` -Here is a sample of code to show the loading of an [AOI3DScene](../../../argaze/#argaze.AreaOfInterest.AOI3DScene) from an OBJ file description: +Here is a sample of code to show the loading of an [AOI3DScene](../../argaze.md/#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 index bdb3fe0..f348c6c 100644 --- a/docs/user_guide/areas_of_interest/aoi_scene_projection.md +++ b/docs/user_guide/areas_of_interest/aoi_scene_projection.md @@ -5,7 +5,7 @@ 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 image as an [AOI2DScene](../../../argaze/#argaze.AreaOfInterest.AOI2DScene). +An [AOI3DScene](../../argaze.md/#argaze.AreaOfInterest.AOI3DScene) can be rotated and translated according to a pose estimation before to project it onto camera image as an [AOI2DScene](../../argaze.md/#argaze.AreaOfInterest.AOI2DScene). ![AOI projection](../../img/aoi_projection.png) diff --git a/docs/user_guide/areas_of_interest/heatmap.md b/docs/user_guide/areas_of_interest/heatmap.md index 6142c5f..450c033 100644 --- a/docs/user_guide/areas_of_interest/heatmap.md +++ b/docs/user_guide/areas_of_interest/heatmap.md @@ -5,7 +5,7 @@ title: Heatmap Heatmap ========= -[AOIFeatures](../../../argaze/#argaze.AreaOfInterest.AOIFeatures) provides [Heatmap](../../../argaze/#argaze.AreaOfInterest.AOIFeatures.Heatmap) class to draw heatmap image. +[AOIFeatures](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures) provides [Heatmap](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.Heatmap) class to draw heatmap image. ## Point spread diff --git a/docs/user_guide/areas_of_interest/introduction.md b/docs/user_guide/areas_of_interest/introduction.md index ce0a6ef..6f74dd4 100644 --- a/docs/user_guide/areas_of_interest/introduction.md +++ b/docs/user_guide/areas_of_interest/introduction.md @@ -1,8 +1,8 @@ About Areas Of Interest (AOI) ============================= -The [AreaOfInterest submodule](../../../argaze/#argaze.AreaOfInterest) allows to deal with AOI in a AR environment through a set of high level classes: +The [AreaOfInterest submodule](../../argaze.md/#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) -* [AOI2DScene](../../../argaze/#argaze.AreaOfInterest.AOI2DScene) \ No newline at end of file +* [AOIFeatures](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures) +* [AOI3DScene](../../argaze.md/#argaze.AreaOfInterest.AOI3DScene) +* [AOI2DScene](../../argaze.md/#argaze.AreaOfInterest.AOI2DScene) \ No newline at end of file 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 ddd83bd..7b29642 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 [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. +The [AOI3DScene](../../argaze.md/#argaze.AreaOfInterest.AOI3DScene) provides cone clipping support in order to select only [AOI](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.AreaOfInterest) which are inside vision cone field. ![Vision cone](../../img/vision_cone.png) -- cgit v1.1