aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThéo de la Hogue2024-07-17 18:15:27 +0200
committerThéo de la Hogue2024-07-17 18:15:27 +0200
commit0914b4d34483586ade32018dde640e1006a4a0d5 (patch)
tree5e6e4ad5041dfbb36be697f377dbd49edab5c097
parentfafbcd501396cad95acc39a8089abd3df7ead836 (diff)
downloadargaze-0914b4d34483586ade32018dde640e1006a4a0d5.zip
argaze-0914b4d34483586ade32018dde640e1006a4a0d5.tar.gz
argaze-0914b4d34483586ade32018dde640e1006a4a0d5.tar.bz2
argaze-0914b4d34483586ade32018dde640e1006a4a0d5.tar.xz
Adding files to prepare new use case documenation.
-rw-r--r--docs/use_cases/gaze_based_candidate_selection/context.md7
-rw-r--r--docs/use_cases/gaze_based_candidate_selection/introduction.md12
-rw-r--r--docs/use_cases/gaze_based_candidate_selection/observers.md6
-rw-r--r--docs/use_cases/gaze_based_candidate_selection/pipeline.md6
-rw-r--r--mkdocs.yml5
5 files changed, 36 insertions, 0 deletions
diff --git a/docs/use_cases/gaze_based_candidate_selection/context.md b/docs/use_cases/gaze_based_candidate_selection/context.md
new file mode 100644
index 0000000..96547ea
--- /dev/null
+++ b/docs/use_cases/gaze_based_candidate_selection/context.md
@@ -0,0 +1,7 @@
+Data playback context
+======================
+
+The context handles incoming eye tracker data before to pass them to a processing pipeline.
+
+## data_playback_context.json
+
diff --git a/docs/use_cases/gaze_based_candidate_selection/introduction.md b/docs/use_cases/gaze_based_candidate_selection/introduction.md
new file mode 100644
index 0000000..da8d6f9
--- /dev/null
+++ b/docs/use_cases/gaze_based_candidate_selection/introduction.md
@@ -0,0 +1,12 @@
+Post-processing screen-based eye tracker data
+=================================================
+
+**ArGaze** enabled ...
+
+The following use case has integrated ...
+
+## Background
+
+## Environment
+
+## Setup
diff --git a/docs/use_cases/gaze_based_candidate_selection/observers.md b/docs/use_cases/gaze_based_candidate_selection/observers.md
new file mode 100644
index 0000000..a1f1fce
--- /dev/null
+++ b/docs/use_cases/gaze_based_candidate_selection/observers.md
@@ -0,0 +1,6 @@
+Metrics and video recording
+===========================
+
+Observers are attached to pipeline steps to be notified when a method is called.
+
+## observers.py
diff --git a/docs/use_cases/gaze_based_candidate_selection/pipeline.md b/docs/use_cases/gaze_based_candidate_selection/pipeline.md
new file mode 100644
index 0000000..6fae01a
--- /dev/null
+++ b/docs/use_cases/gaze_based_candidate_selection/pipeline.md
@@ -0,0 +1,6 @@
+Post processing pipeline
+========================
+
+The pipeline processes gaze data to enable gaze analysis.
+
+## post_processing_pipeline.json
diff --git a/mkdocs.yml b/mkdocs.yml
index 84f18e4..8aadb7d 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -62,6 +62,11 @@ nav:
- use_cases/air_controller_gaze_study/context.md
- use_cases/air_controller_gaze_study/pipeline.md
- use_cases/air_controller_gaze_study/observers.md
+ #- Gaze-based candidate selection:
+ # - use_cases/gaze_based_candidate_selection/introduction.md
+ # - use_cases/gaze_based_candidate_selection/context.md
+ # - use_cases/gaze_based_candidate_selection/pipeline.md
+ # - use_cases/gaze_based_candidate_selection/observers.md
- Code Reference:
- argaze.md
- Contributor Guide: