From 74ed30fa3417c5a1bb5f147d779250e5bbdbd521 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Wed, 22 Nov 2023 10:38:16 +0100 Subject: Including code reference inside pipeline modules description. --- .../pipeline_modules/gaze_movement_identifiers.md | 27 +++++++++++++++------- 1 file changed, 19 insertions(+), 8 deletions(-) (limited to 'docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md') diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md index 751cc7b..6530c15 100644 --- a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md +++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md @@ -3,27 +3,38 @@ Gaze movement identifiers ArGaze provides ready-to-use gaze movement identification algorithms. -Here are JSON samples to include a chosen module inside [ArFrame configuration](../configuration_and_execution.md) *gaze_movement_identifier* entry. +The JSON samples have to be included inside [ArFrame configuration](../configuration_and_execution.md) *gaze_movement_identifier* entry to select an algorithm. + +```json +"gaze_movement_identifier": { + JSON sample +} +``` + +Read more about [GazeMovementIdentifier base class in code reference](../../../argaze.md/#argaze.GazeFeatures.GazeMovementIdentifier). ## Dispersion threshold identification (I-DT) +::: argaze.GazeAnalysis.DispersionThresholdIdentification.GazeMovementIdentifier + +### JSON sample + ```json "DispersionThresholdIdentification": { - "deviation_max_threshold": 50, - "duration_min_threshold": 200 + "deviation_max_threshold": 25, + "duration_min_threshold": 150 } ``` -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.DispersionThresholdIdentification.GazeMovementIdentifier) - ## Velocity threshold identification (I-VT) +::: argaze.GazeAnalysis.VelocityThresholdIdentification.GazeMovementIdentifier + +### JSON sample + ```json "VelocityThresholdIdentification": { "velocity_max_threshold": 10, "duration_min_threshold": 200 } ``` - -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.VelocityThresholdIdentification.GazeMovementIdentifier) - -- cgit v1.1