aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/areas_of_interest/heatmap.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user_guide/areas_of_interest/heatmap.md')
-rw-r--r--docs/user_guide/areas_of_interest/heatmap.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/user_guide/areas_of_interest/heatmap.md b/docs/user_guide/areas_of_interest/heatmap.md
new file mode 100644
index 0000000..6142c5f
--- /dev/null
+++ b/docs/user_guide/areas_of_interest/heatmap.md
@@ -0,0 +1,40 @@
+---
+title: Heatmap
+---
+
+Heatmap
+=========
+
+[AOIFeatures](../../../argaze/#argaze.AreaOfInterest.AOIFeatures) provides [Heatmap](../../../argaze/#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