aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/areas_of_interest/aoi_frame.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-06-21 15:57:07 +0200
committerThéo de la Hogue2023-06-21 15:57:07 +0200
commit1cd915f9632f9138986749587ea6e9bfcb6f3b97 (patch)
tree057d0ae981cec1626a3728c55f97dae7cb46defe /docs/user_guide/areas_of_interest/aoi_frame.md
parenta594afb5bb17798cd138f1632dcfc53f4eaac09f (diff)
downloadargaze-1cd915f9632f9138986749587ea6e9bfcb6f3b97.zip
argaze-1cd915f9632f9138986749587ea6e9bfcb6f3b97.tar.gz
argaze-1cd915f9632f9138986749587ea6e9bfcb6f3b97.tar.bz2
argaze-1cd915f9632f9138986749587ea6e9bfcb6f3b97.tar.xz
Renaming AOIFrame in Heatmap. Adding new ArScreen class.
Diffstat (limited to 'docs/user_guide/areas_of_interest/aoi_frame.md')
-rw-r--r--docs/user_guide/areas_of_interest/aoi_frame.md43
1 files changed, 0 insertions, 43 deletions
diff --git a/docs/user_guide/areas_of_interest/aoi_frame.md b/docs/user_guide/areas_of_interest/aoi_frame.md
deleted file mode 100644
index 350efa8..0000000
--- a/docs/user_guide/areas_of_interest/aoi_frame.md
+++ /dev/null
@@ -1,43 +0,0 @@
----
-title: AOI frame
----
-
-AOI Frame
-=========
-
-[AOIFeatures](../../../argaze/#argaze/AreaOfInterest.AOIFeatures) provides [AOIFrame](../../../argaze/#argaze/AreaOfInterest.AOIFeatures.AOIFrame) class to draw into an 2D AOI.
-
-## Point spread
-
-The **point_spread** method draw a gaussian point spread into the frame 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 an AOI
-aoi = AOIFeatures.AreaOfInterest([[0, 0], [1, 0], [1, 1], [0, 1]])
-
-# Create AOIFrame related to this AOI with 800px * 600px resolution
-aoi_frame = AOIFeatures.AOIFrame(aoi, (800, 600))
-
-# Initialize heatmap
-aoi_frame.heatmap_init()
-
-# Assuming a pointer position (x, y) is moving inside frame
-...:
-
- # Update heatmap at pointer position
- aoi_frame.heatmap_update((x, y), sigma=0.05)
-
- # Do something with heatmap picture
- ... aoi_frame.heatmap
-
-``` \ No newline at end of file