diff options
author | Théo de la Hogue | 2023-09-26 12:47:42 +0200 |
---|---|---|
committer | Théo de la Hogue | 2023-09-26 12:47:42 +0200 |
commit | 460069c2f16028ad1da8ae8669b084d6c4100b78 (patch) | |
tree | 19b89dc00b0940aaea5bc8313499431a5fb049d4 /docs/user_guide/gaze_analysis_pipeline | |
parent | b7b9b3ed2149b3bf66b7192b71bdf0bf6ce7dedf (diff) | |
download | argaze-460069c2f16028ad1da8ae8669b084d6c4100b78.zip argaze-460069c2f16028ad1da8ae8669b084d6c4100b78.tar.gz argaze-460069c2f16028ad1da8ae8669b084d6c4100b78.tar.bz2 argaze-460069c2f16028ad1da8ae8669b084d6c4100b78.tar.xz |
Improving module loading documentation.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline')
-rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md | 10 |
1 files changed, 8 insertions, 2 deletions
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 0b45368..7796f45 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 @@ -1,7 +1,7 @@ Loading modules from another package ==================================== -It possible to load GazeMovementIdentifier, ScanPathAnalyzer or AOIScanPathAnalyzer modules from another [python package](https://docs.python.org/3/tutorial/modules.html#packages). +It possible to load [GazeMovementIdentifier](../../../argaze.md/#argaze.GazeFeatures.GazeMovementIdentifier), [ScanPathAnalyzer](../../../argaze.md/#argaze.GazeFeatures.ScanPathAnalyzer), [AOIMatcher](../../../argaze.md/#argaze.GazeFeatures.AOIMatcher) or [AOIScanPathAnalyzer](../../../argaze.md/#argaze.GazeFeatures.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 module into the JSON configuration file: @@ -20,6 +20,12 @@ To do so, simply prepend the package where to find the module into the JSON conf } } ... + "aoi_matcher": { + "my_package.MyAOIMatcherAlgorithm": { + "specific_plugin_parameter": 0 + } + } + ... "aoi_scan_path_analyzers": { "my_package.MyAOIScanPathAnalyzerAlgorithm": { "specific_plugin_parameter": 0 @@ -28,7 +34,7 @@ To do so, simply prepend the package where to find the module into the JSON conf } ``` -Then, load your package from the python script where the ArFrame is created. +Then, load your package from the python script where the [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) is created. ```python from argaze import ArFeatures |