diff options
author | Théo de la Hogue | 2023-08-28 15:05:01 +0200 |
---|---|---|
committer | Théo de la Hogue | 2023-08-28 15:05:01 +0200 |
commit | f93d3e2b011fe1c1de93d0094ca45584ddd49936 (patch) | |
tree | a627bdcf45da2a63caaf40d66a12668301acff63 /docs/user_guide/gaze_analysis_pipeline/advanced_topics/plugin_loading.md | |
parent | eb8915ec0750699695e4d70af4abef56f56fbe9f (diff) | |
download | argaze-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/plugin_loading.md')
-rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/advanced_topics/plugin_loading.md | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/plugin_loading.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/plugin_loading.md deleted file mode 100644 index 21e1f8b..0000000 --- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/plugin_loading.md +++ /dev/null @@ -1,46 +0,0 @@ -Loading plugins 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). - -To do so, simply prepend the package where to find the plugin into the JSON configuration file: - -``` -{ - ... - "gaze_movement_identifier": { - "my_package.MyGazeMovementIdentifierMethod": { - "specific_plugin_parameter": 0 - } - }, - ... - "scan_path_analyzers": { - "my_package.MyScanPathAnalyzerAlgorithm": { - "specific_plugin_parameter": 0 - } - } - ... - "aoi_scan_path_analyzers": { - "my_package.MyAOIScanPathAnalyzerAlgorithm": { - "specific_plugin_parameter": 0 - } - } -} -``` - -Then, load your package from the python script where the ArFrame is created. - -```python -from argaze import ArFeatures - -# Import your own package -import my_package - -# Load ArFrame -ar_frame = ArFeatures.ArFrame.from_json('./configuration.json') - -# Print ArFrame attributes - -for name, scan_path_analyzer in ar_frame.scan_path_analyzers.items(): - print('scan path analyzer type:', type(scan_path_analyzer)) -``` |