Improving gaze analysis pipeline documentation.

1 files changed, 45 insertions, 0 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
new file mode 100644
index 0000000..0b45368
--- /dev/null
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
@@ -0,0 +1,45 @@
+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).
+
+To do so, simply prepend the package where to find the module into the JSON configuration file:
+
+```
+{
+		...
+		"gaze_movement_identifier": {
+			"my_package.MyGazeMovementIdentifierAlgorithm": {
+				"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 module, scan_path_analyzer in ar_frame.scan_path_analyzers.items():
+	print('scan path analyzer type:', type(scan_path_analyzer))
+```