diff options
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/heatmap.md')
| -rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/heatmap.md | 24 |
1 files changed, 5 insertions, 19 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/heatmap.md b/docs/user_guide/gaze_analysis_pipeline/heatmap.md index a741810..fe4246e 100644 --- a/docs/user_guide/gaze_analysis_pipeline/heatmap.md +++ b/docs/user_guide/gaze_analysis_pipeline/heatmap.md @@ -1,5 +1,5 @@ -Add Heatmap -=========== +Add a heatmap +============= Heatmap is an optional [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) pipeline step. It is executed at each new gaze position to update heatmap image. @@ -9,7 +9,7 @@ Heatmap is an optional [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) pip [ArFrame.heatmap](../../argaze.md/#argaze.ArFeatures.ArFrame.heatmap) can be enabled thanks to a dedicated JSON entry. -Here is the JSON ArFrame configuration file example where heatmap is enabled and displayed: +Here is an extract from the JSON ArFrame configuration file where heatmap is enabled and displayed: ```json { @@ -28,22 +28,8 @@ Here is the JSON ArFrame configuration file example where heatmap is enabled and } } ``` - -Then, here is how to access to heatmap object: - -```python - -# Assuming an ArFrame is loaded -... - -print("heatmap:", ar_frame.heatmap) -``` - -Finally, here is what the program writes in console: - -```txt -heatmap: Heatmap(size=[320, 180], buffer=0, sigma=0.025) -``` +!!! note + [ArFrame.heatmap](../../argaze.md/#argaze.ArFeatures.ArFrame.heatmap) is automatically updated each time the [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method is called. As explained in [visualisation chapter](visualisation.md), the resulting image is accessible thanks to [ArFrame.image](../../argaze.md/#argaze.ArFeatures.ArFrame.image) method. Now, let's understand the meaning of each JSON entry. |