aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/advanced_topics
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/advanced_topics')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md20
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md8
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md12
3 files changed, 20 insertions, 20 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md
index c413e84..9e0ec4c 100644
--- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md
@@ -30,20 +30,20 @@ Here is an extract from the JSON ArFrame configuration file where a [Linear Regr
# Assuming the ArFrame is loaded
...
-# Start calibration process
-ar_frame.gaze_position_calibrator.reset()
+ # Start calibration process
+ ar_frame.gaze_position_calibrator.reset()
-# Assuming that expected and observed gaze positions are available
-...
+ # Assuming that expected and observed gaze positions are available
+ ...
- # If calibration process started
- if ar_frame.gaze_position_calibrator.calibrating:
+ # If calibration process started
+ if ar_frame.gaze_position_calibrator.calibrating:
- # Store calibration data
- ar_frame.gaze_position_calibrator.store(timestamp, observed_gaze_position, expected_gaze_position)
+ # Store calibration data
+ ar_frame.gaze_position_calibrator.store(timestamp, observed_gaze_position, expected_gaze_position)
-# End calibration process
-score = ar_frame.gaze_position_calibrator.calibrate()
+ # End calibration process
+ score = ar_frame.gaze_position_calibrator.calibrate()
```
## Save calibration parameters as JSON file
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
index 6d37ea6..fb717b6 100644
--- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
@@ -43,9 +43,9 @@ from argaze import ArFeatures
import my_package
# Load ArFrame
-ar_frame = ArFeatures.ArFrame.from_json('./configuration.json')
+with ArFeatures.ArFrame.from_json('./configuration.json') as ar_frame:
-# Print ArFrame attributes
-for module, scan_path_analyzer in ar_frame.scan_path_analyzers.items():
- print('scan path analyzer type:', type(scan_path_analyzer))
+ # Print ArFrame attributes
+ for module, scan_path_analyzer in ar_frame.scan_path_analyzers.items():
+ print('scan path analyzer type:', type(scan_path_analyzer))
```
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
index 7952e9f..c3c0266 100644
--- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
@@ -40,10 +40,10 @@ configuration = {
}
# Load ArFrame
-ar_frame = ArFeatures.ArFrame.from_dict(configuration)
+with ArFeatures.ArFrame.from_dict(configuration) as ar_frame:
-# Do something with ArFrame
-...
+ # Do something with ArFrame
+ ...
```
## Access to ArFrame and ArLayers attributes
@@ -58,9 +58,9 @@ from argaze import ArFeatures
# Assuming the ArFrame is loaded
...
-# Iterate over each ArFrame layers
-for name, ar_layer in ar_frame.layers.items():
- ...
+ # Iterate over each ArFrame layers
+ for name, ar_layer in ar_frame.layers.items():
+ ...
```
## Pipeline execution updates