diff options
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md')
| -rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md | 50 |
1 files changed, 37 insertions, 13 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 ad1832d..e68cf8f 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,42 +3,66 @@ AOI scan path analyzers ArGaze provides ready-to-use AOI scan path analysis algorithms. -Here are JSON samples to include a chosen module inside [ArLayer configuration](../aoi_analysis.md) *aoi_scan_path_analyzers* entry. +The JSON samples have to be included inside [ArLayer configuration](../aoi_analysis.md) *aoi_scan_path_analyzers* entry to select an algorithm. + +```json +"aoi_scan_path_analyzers": { + JSON sample +} +``` + +Read more about [AOIScanPathAnalyzer base class in code reference](../../../argaze.md/#argaze.GazeFeatures.AOIScanPathAnalyzer). + +!!! note + + The members indicated as **property** are what returns the analyzer. ## Basic metrics +::: argaze.GazeAnalysis.Basic.AOIScanPathAnalyzer + +### JSON sample + ```json "Basic": {} ``` -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.Basic.AOIScanPathAnalyzer) - ## Entropy +::: argaze.GazeAnalysis.Entropy.AOIScanPathAnalyzer + +### JSON sample + ```json "Entropy": {} ``` -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.Entropy.AOIScanPathAnalyzer) - ## K-modified coefficient +::: argaze.GazeAnalysis.KCoefficient.AOIScanPathAnalyzer + +### JSON sample + ```json "KCoefficient": {} ``` -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.KCoefficient.AOIScanPathAnalyzer) - ## Lempel-Ziv complexity +::: argaze.GazeAnalysis.LempelZivComplexity.AOIScanPathAnalyzer + +### JSON sample + ```json "LempelZivComplexity": {} ``` -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.LempelZivComplexity.AOIScanPathAnalyzer) - ## N-Gram +::: argaze.GazeAnalysis.NGram.AOIScanPathAnalyzer + +### JSON sample + ```json "NGram": { "n_min": 3, @@ -46,12 +70,12 @@ Here are JSON samples to include a chosen module inside [ArLayer configuration]( } ``` -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.NGram.AOIScanPathAnalyzer) - ## Transition matrix +::: argaze.GazeAnalysis.TransitionMatrix.AOIScanPathAnalyzer + +### JSON sample + ```json "TransitionMatrix": {} ``` - -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.TransitionMatrix.AOIScanPathAnalyzer)
\ No newline at end of file |