From 0c5fb0f3ec5f773797fc08ec769f33e332c7dd46 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Wed, 10 Apr 2024 20:04:45 +0200 Subject: Updating documentation. --- .../gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md | 4 ++-- .../pipeline_modules/aoi_scan_path_analyzers.md | 12 ++++++------ .../pipeline_modules/gaze_movement_identifiers.md | 4 ++-- .../pipeline_modules/gaze_position_calibrators.md | 2 +- .../pipeline_modules/scan_path_analyzers.md | 8 ++++---- 5 files changed, 15 insertions(+), 15 deletions(-) (limited to 'docs/user_guide/gaze_analysis_pipeline/pipeline_modules') diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md index c0bc9df..5ba47b4 100644 --- a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md +++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md @@ -24,7 +24,7 @@ Read more about [AOIMatcher base class in code reference](../../../argaze.md/#ar ### JSON sample ```json -"DeviationCircleCoverage": { +"argaze.GazeAnalysis.DeviationCircleCoverage.AOIMatcher": { "coverage_threshold": 0.5 } ``` @@ -36,5 +36,5 @@ Read more about [AOIMatcher base class in code reference](../../../argaze.md/#ar ### JSON sample ```json -"FocusPointInside": {} +"argaze.GazeAnalysis.FocusPointInside.AOIMatcher": {} ``` 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 9ac2f6d..8bb2cf7 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 @@ -27,7 +27,7 @@ Read more about [AOIScanPathAnalyzer base class in code reference](../../../arga ### JSON sample ```json -"Basic": {} +"argaze.GazeAnalysis.Basic.AOIScanPathAnalyzer": {} ``` ## Entropy @@ -37,7 +37,7 @@ Read more about [AOIScanPathAnalyzer base class in code reference](../../../arga ### JSON sample ```json -"Entropy": {} +"argaze.GazeAnalysis.Entropy.AOIScanPathAnalyzer": {} ``` ## K-modified coefficient @@ -47,7 +47,7 @@ Read more about [AOIScanPathAnalyzer base class in code reference](../../../arga ### JSON sample ```json -"KCoefficient": {} +"argaze.GazeAnalysis.KCoefficient.AOIScanPathAnalyzer": {} ``` ## Lempel-Ziv complexity @@ -57,7 +57,7 @@ Read more about [AOIScanPathAnalyzer base class in code reference](../../../arga ### JSON sample ```json -"LempelZivComplexity": {} +"argaze.GazeAnalysis.LempelZivComplexity.AOIScanPathAnalyzer": {} ``` ## N-Gram @@ -67,7 +67,7 @@ Read more about [AOIScanPathAnalyzer base class in code reference](../../../arga ### JSON sample ```json -"NGram": { +"argaze.GazeAnalysis.NGram.AOIScanPathAnalyzer": { "n_min": 3, "n_max": 5 } @@ -80,5 +80,5 @@ Read more about [AOIScanPathAnalyzer base class in code reference](../../../arga ### JSON sample ```json -"TransitionMatrix": {} +"argaze.GazeAnalysis.TransitionMatrix.AOIScanPathAnalyzer": {} ``` 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 6530c15..969dd0b 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 @@ -20,7 +20,7 @@ Read more about [GazeMovementIdentifier base class in code reference](../../../a ### JSON sample ```json -"DispersionThresholdIdentification": { +"argaze.GazeAnalysis.DispersionThresholdIdentification.GazeMovementIdentifier": { "deviation_max_threshold": 25, "duration_min_threshold": 150 } @@ -33,7 +33,7 @@ Read more about [GazeMovementIdentifier base class in code reference](../../../a ### JSON sample ```json -"VelocityThresholdIdentification": { +"argaze.GazeAnalysis.VelocityThresholdIdentification.GazeMovementIdentifier": { "velocity_max_threshold": 10, "duration_min_threshold": 200 } diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_position_calibrators.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_position_calibrators.md index 67dd779..bbaf4dc 100644 --- a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_position_calibrators.md +++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_position_calibrators.md @@ -25,7 +25,7 @@ Read more about [GazePositionCalibrator base class in code reference](../../../a ### JSON sample ```json -"LinearRegression": { +"argaze.GazeAnalysis.LinearRegression.GazePositionCalibrator": { "coefficients": [ [ 0.901167941442693, 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 f1d38e2..39268b7 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 @@ -27,7 +27,7 @@ Read more about [ScanPathAnalyzer base class in code reference](../../../argaze. ### JSON sample ```json -"Basic": {} +"argaze.GazeAnalysis.Basic.ScanPathAnalyzer": {} ``` ## Explore/Exploit ratio @@ -37,7 +37,7 @@ Read more about [ScanPathAnalyzer base class in code reference](../../../argaze. ### JSON sample ```json -"ExploreExploitRatio": { +"argaze.GazeAnalysis.ExploreExploitRatio.ScanPathAnalyzer": { "short_fixation_duration_threshold": 0 } ``` @@ -49,7 +49,7 @@ Read more about [ScanPathAnalyzer base class in code reference](../../../argaze. ### JSON sample ```json -"KCoefficient": {} +"argaze.GazeAnalysis.KCoefficient.ScanPathAnalyzer": {} ``` ## Nearest neighbor index @@ -58,5 +58,5 @@ Read more about [ScanPathAnalyzer base class in code reference](../../../argaze. ### JSON sample ```json -"NearestNeighborIndex": {} +"argaze.GazeAnalysis.NearestNeighborIndex.ScanPathAnalyzer": {} ``` -- cgit v1.1