diff options
author | Théo de la Hogue | 2024-01-23 14:54:30 +0100 |
---|---|---|
committer | Théo de la Hogue | 2024-01-23 14:54:30 +0100 |
commit | d904b99cc969c977f911d36cfeb2279544c528e5 (patch) | |
tree | ff23c5f0a3279581a86aafe98f86a2894d9f00f1 /docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md | |
parent | 8d0a2f7c4f3483aac55603a141e23e1dcc5b0dca (diff) | |
download | argaze-d904b99cc969c977f911d36cfeb2279544c528e5.zip argaze-d904b99cc969c977f911d36cfeb2279544c528e5.tar.gz argaze-d904b99cc969c977f911d36cfeb2279544c528e5.tar.bz2 argaze-d904b99cc969c977f911d36cfeb2279544c528e5.tar.xz |
Defing PipelineStepObject and PipelineStepMethod to assess time execution. Removing exception managment to let the user catch them into the script.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md')
-rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md index 0edbef3..c53cfda 100644 --- a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md +++ b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md @@ -94,14 +94,25 @@ In the example file, the choosen analysis algorithms are the [Basic](../../argaz ## Pipeline execution -Timestamped gaze positions have to be passed one by one to [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method to execute the whole instantiated pipeline. +Timestamped gaze positions have to be passed one by one to [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method to execute the whole instantiated pipeline. + +!!! warning "Mandatory" + + [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method must be called from a *try* block to catch pipeline exceptions. ```python # Assuming that timestamped gaze positions are available ... - # Look ArFrame at a timestamped gaze position - ar_frame.look(timestamp, gaze_position) + try: + + # Look ArFrame at a timestamped gaze position + ar_frame.look(timestamp, gaze_position) + + # Do something with pipeline exception + except Exception as e: + + ... ``` !!! note "" |