diff options
| author | Théo de la Hogue | 2024-01-10 15:53:26 +0100 |
|---|---|---|
| committer | Théo de la Hogue | 2024-01-10 15:53:26 +0100 |
| commit | cd74c746987cc748d4ca5f41448d59254bf0b6ff (patch) | |
| tree | fabdcb3c9d744b2be9b05032d32c4e38b94e30a6 | |
| parent | e55058fe59aba28358759c9934349ea1bd145944 (diff) | |
| download | argaze-cd74c746987cc748d4ca5f41448d59254bf0b6ff.zip argaze-cd74c746987cc748d4ca5f41448d59254bf0b6ff.tar.gz argaze-cd74c746987cc748d4ca5f41448d59254bf0b6ff.tar.bz2 argaze-cd74c746987cc748d4ca5f41448d59254bf0b6ff.tar.xz | |
Recalling scan step and aoi scan step definitions.
3 files changed, 7 insertions, 1 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md index e68cf8f..9ac2f6d 100644 --- a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md +++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md @@ -3,6 +3,9 @@ AOI scan path analyzers ArGaze provides ready-to-use AOI scan path analysis algorithms. +!!! note "Definition" + An [AOIScanPath](../../../argaze.md/#argaze.GazeFeatures.AOIScanPath) defined as a list of [AOIScanSteps](../../../argaze.md/#argaze.GazeFeatures.AOIScanStep) made by a set of successive fixations/saccades onto a same AOI. + The JSON samples have to be included inside [ArLayer configuration](../aoi_analysis.md) *aoi_scan_path_analyzers* entry to select an algorithm. ```json diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md index c779112..f1d38e2 100644 --- a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md +++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md @@ -3,6 +3,9 @@ Scan path analyzers ArGaze provides ready-to-use scan path analysis algorithms. +!!! note "Definition" + A [ScanPath](../../../argaze.md/#argaze.GazeFeatures.ScanPath) is defined as a list of [ScanSteps](../../../argaze.md/#argaze.GazeFeatures.ScanStep) made by a fixation and a consecutive saccade. + The JSON samples have to be included inside [ArFrame configuration](../configuration_and_execution.md) *scan_path_analyzers* entry to select an algorithm. ```json diff --git a/src/argaze/GazeFeatures.py b/src/argaze/GazeFeatures.py index a4cf244..bed8576 100644 --- a/src/argaze/GazeFeatures.py +++ b/src/argaze/GazeFeatures.py @@ -874,7 +874,7 @@ class AOIScanStepError(Exception): @dataclass(frozen=True) class AOIScanStep(): - """Define a aoi scan step as a set of successive gaze movements onto a same AOI. + """Define an aoi scan step as a set of successive gaze movements onto a same AOI. !!! warning |