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/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
4 files changed, 0 insertions, 114 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/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 9467963..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 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 5c377bf..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 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())
-```