aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-11-22 10:38:16 +0100
committerThéo de la Hogue2023-11-22 10:38:16 +0100
commit74ed30fa3417c5a1bb5f147d779250e5bbdbd521 (patch)
tree913dfa7d9d8ec844c02c6f2336b82eea76808aff /docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md
parentc2891756725486adbdf7c593a9ea4e4ccf7cd2ca (diff)
downloadargaze-74ed30fa3417c5a1bb5f147d779250e5bbdbd521.zip
argaze-74ed30fa3417c5a1bb5f147d779250e5bbdbd521.tar.gz
argaze-74ed30fa3417c5a1bb5f147d779250e5bbdbd521.tar.bz2
argaze-74ed30fa3417c5a1bb5f147d779250e5bbdbd521.tar.xz
Including code reference inside pipeline modules description.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md27
1 files changed, 19 insertions, 8 deletions
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)
-