diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/user_guide/areas_of_interest/aoi_frame.md | 43 | ||||
| -rw-r--r-- | docs/user_guide/areas_of_interest/heatmap.md | 40 |
2 files changed, 40 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. - - - -## Heatmap - -Heatmap visualisation allows to show where a pointer is most of the time. - - - -```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 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. + + + +## Heatmap + +Heatmap visualisation allows to show where a pointer is most of the time. + + + +```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 |