aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_position_calibrators.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-11-22 10:38:16 +0100
committerThéo de la Hogue2023-11-22 10:38:16 +0100
commit74ed30fa3417c5a1bb5f147d779250e5bbdbd521 (patch)
tree913dfa7d9d8ec844c02c6f2336b82eea76808aff /docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_position_calibrators.md
parentc2891756725486adbdf7c593a9ea4e4ccf7cd2ca (diff)
downloadargaze-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/gaze_position_calibrators.md')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_position_calibrators.md22
1 files changed, 18 insertions, 4 deletions
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)
-