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/aoi_matchers.md | 26 ++++++++--- .../pipeline_modules/aoi_scan_path_analyzers.md | 50 ++++++++++++++++------ .../pipeline_modules/gaze_movement_identifiers.md | 27 ++++++++---- .../pipeline_modules/gaze_position_calibrators.md | 22 ++++++++-- .../pipeline_modules/scan_path_analyzers.md | 37 ++++++++++++---- 5 files changed, 123 insertions(+), 39 deletions(-) (limited to 'docs/user_guide') 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 61338cc..c0bc9df 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 @@ -3,22 +3,38 @@ AOI matchers ArGaze provides ready-to-use AOI matching algorithms. -Here are JSON samples to include the chosen module inside [ArLayer configuration](../aoi_analysis.md) *aoi_matcher* entry. +The JSON samples have to be included inside [ArLayer configuration](../aoi_analysis.md) *aoi_matcher* entry to select an algorithm. + +```json +"aoi_matcher": { + JSON sample +} +``` + +Read more about [AOIMatcher base class in code reference](../../../argaze.md/#argaze.GazeFeatures.AOIMatcher). + +!!! note + + The members indicated as **property** are what returns the matcher. ## Deviation circle coverage +::: argaze.GazeAnalysis.DeviationCircleCoverage.AOIMatcher + +### JSON sample + ```json "DeviationCircleCoverage": { "coverage_threshold": 0.5 } ``` -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.DeviationCircleCoverage.AOIMatcher) - ## Focus point inside +::: argaze.GazeAnalysis.FocusPointInside.AOIMatcher + +### JSON sample + ```json "FocusPointInside": {} ``` - -[See in code reference](../../../argaze.md/#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 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 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) - 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 69139ed..67dd779 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 @@ -3,10 +3,27 @@ Gaze position calibrators ArGaze provides ready-to-use gaze position calibrator algorithms. -Here are JSON samples to include the chosen module inside [ArFrame configuration](../advanced_topics/gaze_position_calibration.md) *gaze_position_calibrator* entry. + +The JSON samples have to be included inside [ArFrame configuration](../advanced_topics/gaze_position_calibration.md) *gaze_position_calibrator* entry to select an algorithm. + +```json +"gaze_position_calibrator": { + JSON sample +} +``` + +Read more about [GazePositionCalibrator base class in code reference](../../../argaze.md/#argaze.GazeFeatures.GazePositionCalibrator). + +!!! note + + The members indicated as **property** are what returns the matcher. ## Linear regression +::: argaze.GazeAnalysis.LinearRegression.GazePositionCalibrator + +### JSON sample + ```json "LinearRegression": { "coefficients": [ @@ -25,6 +42,3 @@ Here are JSON samples to include the chosen module inside [ArFrame configuration ] } ``` - -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.LinearRegression.GazePositionCalibrator) - 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 f9f757a..c779112 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,38 +3,57 @@ Scan path analyzers ArGaze provides ready-to-use scan path analysis algorithms. -Here are JSON samples to include a chosen module inside [ArFrame configuration](../configuration_and_execution.md) *scan_path_analyzers* entry. +The JSON samples have to be included inside [ArFrame configuration](../configuration_and_execution.md) *scan_path_analyzers* entry to select an algorithm. + +```json +"scan_path_analyzers": { + JSON sample +} +``` + +Read more about [ScanPathAnalyzer base class in code reference](../../../argaze.md/#argaze.GazeFeatures.ScanPathAnalyzer). + +!!! note + + The members indicated as **property** are what returns the analyzer. ## Basic metrics +::: argaze.GazeAnalysis.Basic.ScanPathAnalyzer + +### JSON sample + ```json "Basic": {} ``` -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.Basic.ScanPathAnalyzer) - ## Explore/Exploit ratio +::: argaze.GazeAnalysis.ExploreExploitRatio.ScanPathAnalyzer + +### JSON sample + ```json "ExploreExploitRatio": { "short_fixation_duration_threshold": 0 } ``` -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.ExploreExploitRatio.ScanPathAnalyzer) - ## K coefficient +::: argaze.GazeAnalysis.KCoefficient.ScanPathAnalyzer + +### JSON sample + ```json "KCoefficient": {} ``` -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.KCoefficient.ScanPathAnalyzer) - ## Nearest neighbor index +::: argaze.GazeAnalysis.NearestNeighborIndex.ScanPathAnalyzer + +### JSON sample ```json "NearestNeighborIndex": {} ``` - -[See in code reference](../../../argaze.md/#argaze.GazeAnalysis.NearestNeighborIndex.ScanPathAnalyzer) \ No newline at end of file -- cgit v1.1