aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user_guide')
-rw-r--r--docs/user_guide/areas_of_interest/aoi_matching.md5
-rw-r--r--docs/user_guide/areas_of_interest/aoi_scene_description.md4
-rw-r--r--docs/user_guide/areas_of_interest/aoi_scene_projection.md (renamed from docs/user_guide/areas_of_interest/aoi_projection.md)8
-rw-r--r--docs/user_guide/areas_of_interest/introduction.md2
-rw-r--r--docs/user_guide/areas_of_interest/vision_cone_filtering.md2
5 files changed, 11 insertions, 10 deletions
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_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_projection.md b/docs/user_guide/areas_of_interest/aoi_scene_projection.md
index 7ffc42d..a23d069 100644
--- a/docs/user_guide/areas_of_interest/aoi_projection.md
+++ b/docs/user_guide/areas_of_interest/aoi_scene_projection.md
@@ -1,11 +1,11 @@
---
-title: AOI projection
+title: AOI scene projection
---
-AOI projection
-==============
+AOI scene 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.
+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 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)