aboutsummaryrefslogtreecommitdiff
path: root/docs/use_cases
diff options
context:
space:
mode:
authorThéo de la Hogue2024-07-09 13:42:21 +0200
committerThéo de la Hogue2024-07-09 13:42:21 +0200
commit94ccab6f91c00b1f669b09445bd5af8c32957e72 (patch)
treea910239e1892ae420ae1f33442d17454c6096902 /docs/use_cases
parent2753c71f0121cd380b67b150e1ea296bd7e39600 (diff)
downloadargaze-94ccab6f91c00b1f669b09445bd5af8c32957e72.zip
argaze-94ccab6f91c00b1f669b09445bd5af8c32957e72.tar.gz
argaze-94ccab6f91c00b1f669b09445bd5af8c32957e72.tar.bz2
argaze-94ccab6f91c00b1f669b09445bd5af8c32957e72.tar.xz
Replacing processing word by capture or playback words.
Diffstat (limited to 'docs/use_cases')
-rw-r--r--docs/use_cases/air_controller_gaze_study/context.md12
-rw-r--r--docs/use_cases/air_controller_gaze_study/introduction.md4
-rw-r--r--docs/use_cases/air_controller_gaze_study/pipeline.md2
-rw-r--r--docs/use_cases/pilot_gaze_monitoring/context.md6
4 files changed, 12 insertions, 12 deletions
diff --git a/docs/use_cases/air_controller_gaze_study/context.md b/docs/use_cases/air_controller_gaze_study/context.md
index ca9adf7..d32095b 100644
--- a/docs/use_cases/air_controller_gaze_study/context.md
+++ b/docs/use_cases/air_controller_gaze_study/context.md
@@ -1,18 +1,18 @@
-Live streaming context
+Data playback context
======================
The context handles incoming eye tracker data before to pass them to a processing pipeline.
-## post_processing_context.json
+## data_playback_context.json
-For this use case we need to read Tobii Pro Glasses 2 records: **ArGaze** provides a [ready-made context](../../user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2.md) class to read data from records made by this device.
+For this use case we need to read Tobii Pro Glasses 2 records: **ArGaze** provides a [ready-made context](../../user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2.md) class to playback data from records made by this device.
-While *segment* entries are specific to the [TobiiProGlasses2.PostProcessing](../../argaze.md/#argaze.utils.contexts.TobiiProGlasses2.PostProcessing) class, *name* and *pipeline* entries are part of the parent [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) class.
+While *segment* entries are specific to the [TobiiProGlasses2.SegmentPlayback](../../argaze.md/#argaze.utils.contexts.TobiiProGlasses2.SegmentPlayback) class, *name* and *pipeline* entries are part of the parent [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) class.
```json
{
- "argaze.utils.contexts.TobiiProGlasses2.PostProcessing": {
- "name": "Tobii Pro Glasses 2 post-processing",
+ "argaze.utils.contexts.TobiiProGlasses2.SegmentPlayback": {
+ "name": "Tobii Pro Glasses 2 segment playback",
"segment": "/Volumes/projects/fbr6k3e/records/4rcbdzk/segments/1",
"pipeline": "post_processing_pipeline.json"
}
diff --git a/docs/use_cases/air_controller_gaze_study/introduction.md b/docs/use_cases/air_controller_gaze_study/introduction.md
index 313e492..b7cccbe 100644
--- a/docs/use_cases/air_controller_gaze_study/introduction.md
+++ b/docs/use_cases/air_controller_gaze_study/introduction.md
@@ -26,14 +26,14 @@ A traffic simulation of moderate difficulty with a maximum of 13 and 16 aircraft
The setup to integrate **ArGaze** to the experiment is defined by 3 main files detailled in the next chapters:
-* The context file that reads gaze data and scene camera video records: [post_processing_context.json](context.md)
+* The context file that playback gaze data and scene camera video records: [data_playback_context.json](context.md)
* The pipeline file that processes gaze data and scene camera video: [post_processing_pipeline.json](pipeline.md)
* The observers file that exports analysis outputs: [observers.py](observers.md)
As any **ArGaze** setup, it is loaded by executing the [*load* command](../../user_guide/utils/main_commands.md):
```shell
-python -m argaze load post_processing_context.json
+python -m argaze load segment_playback_context.json
```
This command opens one GUI window per frame (one for the scene camera, one for the sector screen and one for the info screen) that allow to monitor gaze mapping while processing.
diff --git a/docs/use_cases/air_controller_gaze_study/pipeline.md b/docs/use_cases/air_controller_gaze_study/pipeline.md
index ec1aa59..39d6427 100644
--- a/docs/use_cases/air_controller_gaze_study/pipeline.md
+++ b/docs/use_cases/air_controller_gaze_study/pipeline.md
@@ -1,4 +1,4 @@
-Live processing pipeline
+Post processing pipeline
========================
The pipeline processes camera image and gaze data to enable gaze mapping and gaze analysis.
diff --git a/docs/use_cases/pilot_gaze_monitoring/context.md b/docs/use_cases/pilot_gaze_monitoring/context.md
index 71d2628..477276d 100644
--- a/docs/use_cases/pilot_gaze_monitoring/context.md
+++ b/docs/use_cases/pilot_gaze_monitoring/context.md
@@ -1,11 +1,11 @@
-Live streaming context
-======================
+Data capture context
+====================
The context handles incoming eye tracker data before to pass them to a processing pipeline.
## live_streaming_context.json
-For this use case we need to connect to a Tobii Pro Glasses 2 device: **ArGaze** provides a [ready-made context](../../user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2.md) class to live stream data from this device.
+For this use case we need to connect to a Tobii Pro Glasses 2 device: **ArGaze** provides a [ready-made context](../../user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2.md) class to capture data from this device.
While *address*, *project*, *participant* and *configuration* entries are specific to the [TobiiProGlasses2.LiveStream](../../argaze.md/#argaze.utils.contexts.TobiiProGlasses2.LiveStream) class, *name*, *pipeline* and *observers* entries are part of the parent [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) class.