From 91857bacd4f82e48d8a06b43bcc48294701d6a1d Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Mon, 19 Jun 2023 10:01:10 +0200 Subject: Using relative path to code reference to make it works online. --- docs/user_guide/areas_of_interest/aoi_frame.md | 2 +- docs/user_guide/areas_of_interest/aoi_matching.md | 4 ++-- docs/user_guide/areas_of_interest/aoi_scene_description.md | 4 ++-- docs/user_guide/areas_of_interest/aoi_scene_projection.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, 11 insertions(+), 11 deletions(-) (limited to 'docs/user_guide/areas_of_interest') diff --git a/docs/user_guide/areas_of_interest/aoi_frame.md b/docs/user_guide/areas_of_interest/aoi_frame.md index 855e302..350efa8 100644 --- a/docs/user_guide/areas_of_interest/aoi_frame.md +++ b/docs/user_guide/areas_of_interest/aoi_frame.md @@ -5,7 +5,7 @@ title: AOI frame AOI Frame ========= -[AOIFeatures](/argaze/#argaze/AreaOfInterest.AOIFeatures) provides [AOIFrame](/argaze/#argaze/AreaOfInterest.AOIFeatures.AOIFrame) class to draw into an 2D AOI. +[AOIFeatures](../../../argaze/#argaze/AreaOfInterest.AOIFeatures) provides [AOIFrame](../../../argaze/#argaze/AreaOfInterest.AOIFeatures.AOIFrame) class to draw into an 2D AOI. ## Point spread diff --git a/docs/user_guide/areas_of_interest/aoi_matching.md b/docs/user_guide/areas_of_interest/aoi_matching.md index 299a212..1e18238 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 into a frame as [AOI2DScene](/argaze/#argaze.AreaOfInterest.AOI2DScene), it could be needed to know which AOI is looked. +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. +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_scene_description.md b/docs/user_guide/areas_of_interest/aoi_scene_description.md index e6a8a16..d50f061 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 [AOI3DScene](/argaze/#argaze.AreaOfInterest.AOI3DScene) 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 [AOI3DScene](/argaze/#argaze.AreaOfInterest.AOI3DScene) 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 index 4d06e87..ad50f6f 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 frame as an [AOI2DScene](/argaze/#argaze.AreaOfInterest.AOI2DScene). +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) diff --git a/docs/user_guide/areas_of_interest/introduction.md b/docs/user_guide/areas_of_interest/introduction.md index 201e4b2..ce0a6ef 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/#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/#argaze.AreaOfInterest.AOIFeatures) +* [AOI3DScene](../../../argaze/#argaze.AreaOfInterest.AOI3DScene) +* [AOI2DScene](../../../argaze/#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 e1f4f82..ddd83bd 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/#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) -- cgit v1.1