aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/areas_of_interest
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user_guide/areas_of_interest')
-rw-r--r--docs/user_guide/areas_of_interest/aoi_matching.md48
-rw-r--r--docs/user_guide/areas_of_interest/aoi_scene_description.md83
-rw-r--r--docs/user_guide/areas_of_interest/aoi_scene_projection.md22
-rw-r--r--docs/user_guide/areas_of_interest/heatmap.md40
-rw-r--r--docs/user_guide/areas_of_interest/introduction.md8
-rw-r--r--docs/user_guide/areas_of_interest/vision_cone_filtering.md18
6 files changed, 0 insertions, 219 deletions
diff --git a/docs/user_guide/areas_of_interest/aoi_matching.md b/docs/user_guide/areas_of_interest/aoi_matching.md
deleted file mode 100644
index 60467f9..0000000
--- a/docs/user_guide/areas_of_interest/aoi_matching.md
+++ /dev/null
@@ -1,48 +0,0 @@
----
-title: AOI matching
----
-
-AOI matching
-============
-
-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.md/#argaze.AreaOfInterest.AOIFeatures.AreaOfInterest) class in [AOIFeatures](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures) provides two ways to accomplish such task.
-
-## Pointer-based matching
-
-Test if 2D pointer is inside or not AOI using contains_point() method as illustrated below.
-
-![Contains point](../../img/contains_point.png)
-
-``` python
-pointer = (x, y)
-
-for name, aoi in aoi2D_scene.items():
-
- if aoi.contains_point(pointer):
-
- # Do something with looked aoi
- ...
-
-```
-
-It is also possible to get where a pointer is looking inside an AOI provided that AOI is a rectangular plane:
-
-``` python
-
-inner_x, inner_y = aoi.inner_axis(pointer)
-
-```
-
-## Circle-based matching
-
-As positions have limited accuracy, it is possible to define a radius around a pointer to test circle intersection with AOI.
-
-![Circle intersection](../../img/circle_intersection.png)
-
-``` python
-
-intersection_shape, intersection_aoi_ratio, intersection_circle_ratio = aoi.circle_intersection(pointer, radius)
-
-```
diff --git a/docs/user_guide/areas_of_interest/aoi_scene_description.md b/docs/user_guide/areas_of_interest/aoi_scene_description.md
deleted file mode 100644
index b96c1e0..0000000
--- a/docs/user_guide/areas_of_interest/aoi_scene_description.md
+++ /dev/null
@@ -1,83 +0,0 @@
----
-title: AOI scene description
----
-
-AOI scene description
-=====================
-
-## 2D description
-
-An AOI scene can be described in 2D dimension using an [AOI2DScene](../../argaze.md/#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.md/#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.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
-o PIC_ND
-v 6.513238 -27.113548 -25.163900
-v 22.994461 -27.310783 -24.552130
-v 6.718690 -6.467261 -26.482569
-v 23.252594 -6.592890 -25.873484
-f 1 2 4 3
-o PIC_ND_Aircraft
-v 6.994747 -21.286463 -24.727146
-v 22.740919 -21.406120 -24.147078
-v 7.086208 -12.096219 -25.314123
-v 22.832380 -12.215876 -24.734055
-f 5 6 8 7
-o PIC_ND_Wind
-v 7.086199 -11.769333 -25.335127
-v 12.081032 -11.807289 -25.151123
-v 7.115211 -8.854101 -25.521320
-v 12.110044 -8.892057 -25.337317
-f 9 10 12 11
-o PIC_ND_Waypoint
-v 17.774197 -11.819057 -24.943428
-v 22.769030 -11.857013 -24.759424
-v 17.803209 -8.903825 -25.129622
-v 22.798042 -8.941781 -24.945618
-f 13 14 16 15
-...
-o Thrust_Lever
-v 19.046124 15.523837 4.774072
-v 18.997263 -0.967944 5.701000
-v 18.988382 15.923470 -13.243046
-v 18.921808 -0.417994 -17.869610
-v 19.032232 19.241346 -3.040264
-v 19.020988 6.392717 5.872663
-v 18.945322 6.876906 -17.699480
-s off
-f 185 190 186 188 191 187 189
-...
-```
-
-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
-
-# Load an AOI3D scene from OBJ file
-aoi_3d_scene = AOI3DScene.AOI3DScene.from_obj('./aoi_scene.obj')
-```
diff --git a/docs/user_guide/areas_of_interest/aoi_scene_projection.md b/docs/user_guide/areas_of_interest/aoi_scene_projection.md
deleted file mode 100644
index f348c6c..0000000
--- a/docs/user_guide/areas_of_interest/aoi_scene_projection.md
+++ /dev/null
@@ -1,22 +0,0 @@
----
-title: AOI scene projection
----
-
-AOI scene projection
-====================
-
-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)
-
-``` python
-...
-
-# Assuming pose estimation is done (tvec and rmat)
-
-# Project AOI 3D scene according pose estimation and optic parameters
-aoi2D_scene = aoi3D_scene.project(tvec, rmat, optic_parameters.K)
-
-# Draw AOI 2D scene
-aoi2D_scene.draw(image)
-```
diff --git a/docs/user_guide/areas_of_interest/heatmap.md b/docs/user_guide/areas_of_interest/heatmap.md
deleted file mode 100644
index 450c033..0000000
--- a/docs/user_guide/areas_of_interest/heatmap.md
+++ /dev/null
@@ -1,40 +0,0 @@
----
-title: Heatmap
----
-
-Heatmap
-=========
-
-[AOIFeatures](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures) provides [Heatmap](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.Heatmap) class to draw heatmap image.
-
-## Point spread
-
-The **point_spread** method draw a gaussian point spread into heatmap image at a given pointer position.
-
-![Point spread](../../img/point_spread.png)
-
-## Heatmap
-
-Heatmap visualisation allows to show where a pointer is most of the time.
-
-![Heatmap](../../img/heatmap.png)
-
-```python
-from argaze.AreaOfInterest import AOIFeatures
-
-# Create heatmap of 800px * 600px resolution
-heatmap = AOIFeatures.Heatmap((800, 600))
-
-# Initialize heatmap
-heatmap.init()
-
-# Assuming a pointer position (x, y) is moving inside frame
-...:
-
- # Update heatmap at pointer position
- heatmap.update((x, y), sigma=0.05)
-
- # Do something with heatmap image
- ... heatmap.image
-
-``` \ No newline at end of file
diff --git a/docs/user_guide/areas_of_interest/introduction.md b/docs/user_guide/areas_of_interest/introduction.md
deleted file mode 100644
index 6f74dd4..0000000
--- a/docs/user_guide/areas_of_interest/introduction.md
+++ /dev/null
@@ -1,8 +0,0 @@
-About Areas Of Interest (AOI)
-=============================
-
-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.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
deleted file mode 100644
index 7b29642..0000000
--- a/docs/user_guide/areas_of_interest/vision_cone_filtering.md
+++ /dev/null
@@ -1,18 +0,0 @@
-Vision cone filtering
-=====================
-
-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)
-
-``` python
-# Transform scene into camera referential
-aoi3D_camera = aoi3D_scene.transform(tvec, rmat)
-
-# Get aoi inside vision cone field
-# The vision cone tip is positionned behind the head
-aoi3D_inside, aoi3D_outside = aoi3D_camera.vision_cone(cone_radius=300, cone_height=150, cone_tip=[0., 0., -20.])
-
-# Keep only aoi inside vision cone field
-aoi3D_scene = aoi3D_scene.copy(exclude=aoi3D_outside.keys())
-```