From e88fe8f8c2b0bffee3d67b73200381cde2351dab Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Wed, 23 Aug 2023 13:58:16 +0200 Subject: Adding gaze analysis pipeline user guide section. Hidding older user guide sections. --- .../ar_frame_configuration_and_execution.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md') 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 00300a8..f1264c7 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 @@ -3,7 +3,7 @@ Configure and execute ArFrame The [ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) class defines a rectangular area where timestamped gaze positions are projected in and inside which they need to be analyzed. -![Timestamped Gaze Positions](../../img/ar_frame.png) +![Empty frame area](../../img/ar_frame_empty.png) ## Load JSON configuration file @@ -22,7 +22,7 @@ Here is a simple JSON ArFrame configuration file example: } }, "scan_path": { - "duration_max": 30000, + "duration_max": 30000 }, "scan_path_analyzers": { "Basic": {}, @@ -60,7 +60,7 @@ print("heatmap:", ar_frame.heatmap) Finally, here is what the program writes in console: -``` +```txt name: My FullHD screen size: [1920, 1080] gaze movement identifier type: @@ -88,7 +88,7 @@ The first [ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) pipeline step is The identification method can be selected by instantiating a particular [GazeMovementIdentifier](../../../argaze/#argaze.GazeFeatures.GazeMovementIdentifier) from the [argaze.GazeAnalysis](../../../argaze/#argaze.GazeAnalysis) submodule or [another python package](../advanced_topics/plugin_loading). -In the example file, the choosen identification method is the [Dispersion Threshold Identification (I-DT)](../../../argaze/#argaze.GazeAnalysis.DispersionThresholdIdentification) which has two specific deviation_max_threshold and duration_min_threshold attributes. +In the example file, the choosen identification method is the [Dispersion Threshold Identification (I-DT)](../../../argaze/#argaze.GazeAnalysis.DispersionThresholdIdentification) which has two specific *deviation_max_threshold* and *duration_min_threshold* attributes. !!! note In ArGaze, [Fixation](../../../argaze/#argaze.GazeFeatures.Fixation) and [Saccade](../../../argaze/#argaze.GazeFeatures.Saccade) are considered as particular [GazeMovements](../../../argaze/#argaze.GazeFeatures.GazeMovement). @@ -128,7 +128,7 @@ The Heatmap object have tree attributes to set its size, the sigma point spreadi Timestamped gaze positions have to be passed one by one to [ArFrame.look](../../../argaze/#argaze.ArFeatures.ArFrame.look) method to execute the whole intanciated pipeline. ```python -# Assuming that timestamp gaze positions are available +# Assuming that timestamped gaze positions are available ... # Look ArFrame at a timestamped gaze position -- cgit v1.1