aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-09-04 14:49:27 +0200
committerThéo de la Hogue2023-09-04 14:49:27 +0200
commit01378ae467b6399a13042f02a67010dfc820aee2 (patch)
tree538522601eb3456035341b8e3284b11fc33abadf /docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md
parenta1a189674d7ca0dbd5a5d84f3715084f41eec012 (diff)
downloadargaze-01378ae467b6399a13042f02a67010dfc820aee2.zip
argaze-01378ae467b6399a13042f02a67010dfc820aee2.tar.gz
argaze-01378ae467b6399a13042f02a67010dfc820aee2.tar.bz2
argaze-01378ae467b6399a13042f02a67010dfc820aee2.tar.xz
Moving scripting features into a dedicated advanced chapter.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md47
1 files changed, 1 insertions, 46 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md b/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md
index 37100ab..cdc7fe0 100644
--- a/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md
+++ b/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md
@@ -40,26 +40,6 @@ from argaze import ArFeatures
# Load ArFrame
ar_frame = ArFeatures.ArFrame.from_json('./configuration.json')
-
-# Print ArFrame attributes
-print("name:", ar_frame.name)
-print("size:", ar_frame.size)
-print("gaze movement identifier type:", type(ar_frame.gaze_movement_identifier))
-print("scan path:", ar_frame.scan_path)
-
-for module, analyzer in ar_frame.scan_path_analyzers.items():
- print('scan path analyzer module:', module)
-```
-
-Finally, here is what the program writes in console:
-
-```txt
-name: My FullHD screen
-size: [1920, 1080]
-gaze movement identifier type: <class 'argaze.GazeAnalysis.DispersionThresholdIdentification.GazeMovementIdentifier'>
-scan path: []
-scan path analyzer module: argaze.GazeAnalysis.Basic
-scan path analyzer module: argaze.GazeAnalysis.ExploitExploreRatio
```
Now, let's understand the meaning of each JSON entry.
@@ -119,30 +99,5 @@ Timestamped gaze positions have to be passed one by one to [ArFrame.look](../../
...
# Look ArFrame at a timestamped gaze position
- movement, scan_path_analysis, _, execution_times, exception = ar_frame.look(timestamp, gaze_position)
-
- # Check if a movement has been identified
- if movement.valid and movement.finished:
-
- # Do something with identified fixation
- if GazeFeatures.is_fixation(movement):
- ...
-
- # Do something with identified saccade
- elif GazeFeatures.is_saccade(movement):
- ...
-
- # Do something with scan path analysis
- for module, analysis in scan_path_analysis.items():
- for data, value in analysis.items():
- ...
-
- # Do something with pipeline execution times
- ...
-
- # Do something with pipeline exception
- if exception:
- ...
+ ar_frame.look(timestamp, gaze_position)
```
-
-