aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/visualisation.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-08-30 23:15:59 +0200
committerThéo de la Hogue2023-08-30 23:15:59 +0200
commit31df32870f06460be8069c171cb032f5aa74a098 (patch)
tree56e6c37209166f526f9207cc1005ccdb26774892 /docs/user_guide/gaze_analysis_pipeline/visualisation.md
parent6cce228412f3f3b074fdaf87775b8d62a5adb060 (diff)
downloadargaze-31df32870f06460be8069c171cb032f5aa74a098.zip
argaze-31df32870f06460be8069c171cb032f5aa74a098.tar.gz
argaze-31df32870f06460be8069c171cb032f5aa74a098.tar.bz2
argaze-31df32870f06460be8069c171cb032f5aa74a098.tar.xz
More documention about gaze analysis pipeline.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/visualisation.md')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/visualisation.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/visualisation.md b/docs/user_guide/gaze_analysis_pipeline/visualisation.md
index 5eae7f5..ad59d54 100644
--- a/docs/user_guide/gaze_analysis_pipeline/visualisation.md
+++ b/docs/user_guide/gaze_analysis_pipeline/visualisation.md
@@ -1,7 +1,7 @@
Visualize ArFrame and ArLayers
==============================
-All [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) and [ArLayers](../../argaze.md/#argaze.ArFeatures.ArFrame) pipeline steps can be drawn in real time or afterward.
+All [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) and [ArLayers](../../argaze.md/#argaze.ArFeatures.ArFrame) pipeline steps result can be drawn in real time or afterward.
![ArFrame visualisation](../../img/ar_frame_visualisation.png)
@@ -76,6 +76,9 @@ if __name__ == '__main__':
[ArFrame.image](../../argaze.md/#argaze.ArFeatures.ArFrame.image) method parameters can be configured thanks to dictionary.
```python
+# Assuming ArFrame is loaded
+...
+
# Edit ArFrame image parameters
image_parameters = {
"draw_scan_path": {
@@ -187,4 +190,8 @@ Here is the JSON ArFrame configuration file example with image parameters includ
}
}
}
-``` \ No newline at end of file
+```
+
+!!! warning
+ Most of *image_parameters* entries work if related ArFrame/ArLayer pipeline steps are enabled.
+ For example, JSON *draw_scan_path* entry needs GazeMovementIdentifier and ScanPath steps to be enabled. \ No newline at end of file