diff options
author | Théo de la Hogue | 2023-11-22 10:38:16 +0100 |
---|---|---|
committer | Théo de la Hogue | 2023-11-22 10:38:16 +0100 |
commit | 74ed30fa3417c5a1bb5f147d779250e5bbdbd521 (patch) | |
tree | 913dfa7d9d8ec844c02c6f2336b82eea76808aff /docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md | |
parent | c2891756725486adbdf7c593a9ea4e4ccf7cd2ca (diff) | |
download | argaze-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/aoi_matchers.md')
-rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md | 26 |
1 files changed, 21 insertions, 5 deletions
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) |