diff options
author | Théo de la Hogue | 2023-09-26 17:39:10 +0200 |
---|---|---|
committer | Théo de la Hogue | 2023-09-26 17:39:10 +0200 |
commit | 6af30f98e4d8c89e4602c4048622ce5e66dbe774 (patch) | |
tree | 23618b9c533fb69ba1d62f2b1e54fced281823a7 /docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md | |
parent | 433e68397d3fcb7d3c9ab07e1fa0a8edc0c4e583 (diff) | |
download | argaze-6af30f98e4d8c89e4602c4048622ce5e66dbe774.zip argaze-6af30f98e4d8c89e4602c4048622ce5e66dbe774.tar.gz argaze-6af30f98e4d8c89e4602c4048622ce5e66dbe774.tar.bz2 argaze-6af30f98e4d8c89e4602c4048622ce5e66dbe774.tar.xz |
Adding new aruco markers pipeline scripting chapter.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md')
-rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md index 637ba57..eefeee1 100644 --- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md +++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md @@ -106,7 +106,7 @@ for name, ar_layer in ar_frame.layers.items(): Let's understand the meaning of each returned data. -### Gaze movement +### *gaze_movement* A [GazeMovement](../../../argaze.md/#argaze.GazeFeatures.GazeMovement) once it have been identified by [ArFrame.gaze_movement_identifier](../../../argaze.md/#argaze.ArFeatures.ArFrame) object from incoming consecutive timestamped gaze positions. If no gaze movement have been identified, it returns an [UnvalidGazeMovement](../../../argaze.md/#argaze.GazeFeatures.UnvalidGazeMovement). @@ -115,19 +115,19 @@ In that case, the returned gaze movement *finished* flag is false. Then, the returned gaze movement type can be tested thanks to [GazeFeatures.is_fixation](../../../argaze.md/#argaze.GazeFeatures.is_fixation) and [GazeFeatures.is_saccade](../../../argaze.md/#argaze.GazeFeatures.is_saccade) functions. -### Scan path analysis +### *scan_path_analysis* A dictionary with all last scan path analysis if new scan step have been added to the [ArFrame.scan_path](../../../argaze.md/#argaze.ArFeatures.ArFrame) object. -### Layers analysis +### *layers_analysis* A dictionary with all layers AOI scan path analysis if new AOI scan step have been added to an [ArLayer.aoi_scan_path](../../../argaze.md/#argaze.ArFeatures.ArLayer) object. -### Execution times +### *execution_times* A dictionary with each pipeline step execution time. -### Exception +### *exception* A [python Exception](https://docs.python.org/3/tutorial/errors.html#exceptions) object raised during pipeline execution. |