aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/introduction.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-08-10 09:04:31 +0200
committerThéo de la Hogue2023-08-10 09:04:31 +0200
commit293d1cc9b0fe6d7e871511cd716001f5765d9118 (patch)
tree444cff250f3a3e9997288dedf1d88c6dd8499209 /docs/user_guide/gaze_analysis_pipeline/introduction.md
parent80e122453c1120b4211015a3b7625be089db8a9f (diff)
downloadargaze-293d1cc9b0fe6d7e871511cd716001f5765d9118.zip
argaze-293d1cc9b0fe6d7e871511cd716001f5765d9118.tar.gz
argaze-293d1cc9b0fe6d7e871511cd716001f5765d9118.tar.bz2
argaze-293d1cc9b0fe6d7e871511cd716001f5765d9118.tar.xz
Working on gaze analysis pipeline documentation. Still in progress...
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/introduction.md')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/introduction.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/introduction.md b/docs/user_guide/gaze_analysis_pipeline/introduction.md
new file mode 100644
index 0000000..568cba2
--- /dev/null
+++ b/docs/user_guide/gaze_analysis_pipeline/introduction.md
@@ -0,0 +1,19 @@
+Overview
+========
+
+This section explains how to build gaze analysis pipelines for various use cases.
+
+First, let's look at the schema below: it gives an overview of the main notions involved in the following chapters.
+
+![Gaze analysis pipeline](../../img/gaze_analysis_pipeline.png)
+
+To build your own gaze analysis pipeline, you need to know:
+
+* [How to edit timestamped gaze positions](../timestamped_gaze_positions_edition),
+* [How to deal with an ArFrame instance](../ar_frame_configuration_and_execution),
+* [How to setup Areas Of Interest](../ar_frame_aoi_configuration),
+* [How to log resulted gaze analysis](../analysis).
+
+More advanced features are also explained like:
+
+* [How to load plugin from another package](../advanced_topics/plugin_loading)