From 9fd8c59818cd67846dab61b2edd817df4d4dffee Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Mon, 8 Jul 2024 10:08:46 +0200 Subject: Fixing relative links. Documenting performance recorder. --- docs/use_cases/pilot_gaze_monitoring/context.md | 2 +- docs/use_cases/pilot_gaze_monitoring/introduction.md | 2 +- docs/use_cases/pilot_gaze_monitoring/pipeline.md | 16 ++++++++++++++-- 3 files changed, 16 insertions(+), 4 deletions(-) (limited to 'docs/use_cases/pilot_gaze_monitoring') diff --git a/docs/use_cases/pilot_gaze_monitoring/context.md b/docs/use_cases/pilot_gaze_monitoring/context.md index d6b712e..71d2628 100644 --- a/docs/use_cases/pilot_gaze_monitoring/context.md +++ b/docs/use_cases/pilot_gaze_monitoring/context.md @@ -5,7 +5,7 @@ The context handles incoming eye tracker data before to pass them to a processin ## live_streaming_context.json -For this use case we need to connect to a Tobii Pro Glasses 2 device: **ArGaze** provides a [ready-made context](../../../user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2/) class to live stream data from this device. +For this use case we need to connect to a Tobii Pro Glasses 2 device: **ArGaze** provides a [ready-made context](../../user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2.md) class to live stream data from this device. While *address*, *project*, *participant* and *configuration* entries are specific to the [TobiiProGlasses2.LiveStream](../../argaze.md/#argaze.utils.contexts.TobiiProGlasses2.LiveStream) class, *name*, *pipeline* and *observers* entries are part of the parent [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) class. diff --git a/docs/use_cases/pilot_gaze_monitoring/introduction.md b/docs/use_cases/pilot_gaze_monitoring/introduction.md index f5de773..f8f0713 100644 --- a/docs/use_cases/pilot_gaze_monitoring/introduction.md +++ b/docs/use_cases/pilot_gaze_monitoring/introduction.md @@ -36,7 +36,7 @@ The setup to integrate **ArGaze** to the experiment is defined by 3 main files d * The pipeline file that processes gaze data and scene camera video: [live_processing_pipeline.json](pipeline.md) * The observers file that send fixation events via Ivy bus middleware: [observers.py](observers.md) -As any **ArGaze** setup, it is loaded by executing the following command: +As any **ArGaze** setup, it is loaded by executing the [*load* command](../../user_guide/utils/main_commands.md): ```shell python -m argaze load live_streaming_context.json diff --git a/docs/use_cases/pilot_gaze_monitoring/pipeline.md b/docs/use_cases/pilot_gaze_monitoring/pipeline.md index a083ade..16e79a0 100644 --- a/docs/use_cases/pilot_gaze_monitoring/pipeline.md +++ b/docs/use_cases/pilot_gaze_monitoring/pipeline.md @@ -136,7 +136,7 @@ The *ArUcoCameraLogger* observer object is defined into the [observers.py](obser ## optic_parameters.json -This file defines the Tobii Pro glasses 2 scene camera optic parameters which has been calculated as explained into [the camera calibration chapter](../../../user_guide/aruco_marker_pipeline/advanced_topics/optic_parameters_calibration/). +This file defines the Tobii Pro glasses 2 scene camera optic parameters which has been calculated as explained into [the camera calibration chapter](../../user_guide/aruco_marker_pipeline/advanced_topics/optic_parameters_calibration.md). ```json { @@ -174,7 +174,7 @@ This file defines the Tobii Pro glasses 2 scene camera optic parameters which ha ## detector_parameters.json -This file defines the ArUco detector parameters as explained into [the detection improvement chapter](../../../user_guide/aruco_marker_pipeline/advanced_topics/aruco_detector_configuration/). +This file defines the ArUco detector parameters as explained into [the detection improvement chapter](../../user_guide/aruco_marker_pipeline/advanced_topics/aruco_detector_configuration.md). ```json { @@ -305,3 +305,15 @@ This file defines the place of the AOI into the PFD frame. AOI positions have be ``` + +## look_performance.csv + +This file contains the logs of *ArUcoCamera.look* method execution info. It is created into an *_export* folder from where the [*load* command](../../user_guide/utils/main_commands.md) is launched. + +On a Jetson Xavier computer, the *look* method execution time is ~.. ms and it is called ~.. times per second. + +## watch_performance.csv + +This file contains the logs of *ArUcoCamera.watch* method execution info. It file is created into an *_export* folder from where the [*load* command](../../user_guide/utils/main_commands.md) is launched. + +On a Jetson Xavier computer, the *watch* method execution time is ~.. ms and it is called ~.. times per second. -- cgit v1.1