aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/advanced_topics
diff options
context:
space:
mode:
authorThéo de la Hogue2023-08-28 15:05:01 +0200
committerThéo de la Hogue2023-08-28 15:05:01 +0200
commitf93d3e2b011fe1c1de93d0094ca45584ddd49936 (patch)
treea627bdcf45da2a63caaf40d66a12668301acff63 /docs/user_guide/gaze_analysis_pipeline/advanced_topics
parenteb8915ec0750699695e4d70af4abef56f56fbe9f (diff)
downloadargaze-f93d3e2b011fe1c1de93d0094ca45584ddd49936.zip
argaze-f93d3e2b011fe1c1de93d0094ca45584ddd49936.tar.gz
argaze-f93d3e2b011fe1c1de93d0094ca45584ddd49936.tar.bz2
argaze-f93d3e2b011fe1c1de93d0094ca45584ddd49936.tar.xz
Improving gaze analysis pipeline documentation.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/advanced_topics')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md (renamed from docs/user_guide/gaze_analysis_pipeline/advanced_topics/plugin_loading.md)11
1 files changed, 5 insertions, 6 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/plugin_loading.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
index 21e1f8b..0b45368 100644
--- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/plugin_loading.md
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
@@ -1,15 +1,15 @@
-Loading plugins from another package
+Loading modules from another package
====================================
-It possible to load GazeMovementIdentifier, ScanPathAnalyzer or AOIScanPathAnalyzer plugins from another [python package](https://docs.python.org/3/tutorial/modules.html#packages).
+It possible to load GazeMovementIdentifier, ScanPathAnalyzer or AOIScanPathAnalyzer modules from another [python package](https://docs.python.org/3/tutorial/modules.html#packages).
-To do so, simply prepend the package where to find the plugin into the JSON configuration file:
+To do so, simply prepend the package where to find the module into the JSON configuration file:
```
{
...
"gaze_movement_identifier": {
- "my_package.MyGazeMovementIdentifierMethod": {
+ "my_package.MyGazeMovementIdentifierAlgorithm": {
"specific_plugin_parameter": 0
}
},
@@ -40,7 +40,6 @@ import my_package
ar_frame = ArFeatures.ArFrame.from_json('./configuration.json')
# Print ArFrame attributes
-
-for name, scan_path_analyzer in ar_frame.scan_path_analyzers.items():
+for module, scan_path_analyzer in ar_frame.scan_path_analyzers.items():
print('scan path analyzer type:', type(scan_path_analyzer))
```