From f93d3e2b011fe1c1de93d0094ca45584ddd49936 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Mon, 28 Aug 2023 15:05:01 +0200
Subject: Improving gaze analysis pipeline documentation.

---
 .../advanced_topics/module_loading.md              | 45 +++++++++++++++++++++
 .../advanced_topics/plugin_loading.md              | 46 ----------------------
 2 files changed, 45 insertions(+), 46 deletions(-)
 create mode 100644 docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
 delete mode 100644 docs/user_guide/gaze_analysis_pipeline/advanced_topics/plugin_loading.md

(limited to 'docs/user_guide/gaze_analysis_pipeline/advanced_topics')

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))
+```
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))
-```
-- 
cgit v1.1