aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline
diff options
context:
space:
mode:
authorThéo de la Hogue2023-10-11 07:36:14 +0200
committerThéo de la Hogue2023-10-11 07:36:14 +0200
commitcbf0dc4a328763970aa41e8d5081473cca7411a9 (patch)
treed020c3fa67d9d58a4aff9978f57b966154d84344 /docs/user_guide/gaze_analysis_pipeline
parentf849add84404d6cfa3be5b5d29b62ceb67622f89 (diff)
downloadargaze-cbf0dc4a328763970aa41e8d5081473cca7411a9.zip
argaze-cbf0dc4a328763970aa41e8d5081473cca7411a9.tar.gz
argaze-cbf0dc4a328763970aa41e8d5081473cca7411a9.tar.bz2
argaze-cbf0dc4a328763970aa41e8d5081473cca7411a9.tar.xz
Improving documentation.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md2
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md2
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/introduction.md8
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md b/docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md
index 3fd15db..66fa12f 100644
--- a/docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md
@@ -1,7 +1,7 @@
Enable AOI analysis
===================
-Once [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) is [configured](configuration_and_execution.md) and [2D AOI are described](aoi_2d_description.md), fixation can be matched with AOI to build an AOI scan path before analyze it.
+Once [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) is [configured](configuration_and_execution.md) and [2D AOI are described](aoi_2d_description.md), fixation can be matched with AOI to build an AOI scan path before analyzing it.
![Layer](../../img/ar_layer.png)
diff --git a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
index c40039c..71d3c33 100644
--- a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
+++ b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
@@ -107,4 +107,4 @@ Timestamped gaze positions have to be passed one by one to [ArFrame.look](../../
At this point, the [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method only process gaze movement identification and scan path analysis without any AOI neither any logging or visualisation supports.
- Read the next chapters to learn how to [describe frame's AOI](aoi_2d_description.md), [add AOI analysis](aoi_analysis.md), [log gaze analysis](logging.md) and [visualize pipeline steps](visualisation.md). \ No newline at end of file
+ Read the next chapters to learn how to [describe AOI](aoi_2d_description.md), [add AOI analysis](aoi_analysis.md), [log gaze analysis](logging.md) and [visualize pipeline steps](visualisation.md). \ No newline at end of file
diff --git a/docs/user_guide/gaze_analysis_pipeline/introduction.md b/docs/user_guide/gaze_analysis_pipeline/introduction.md
index 339dd90..65cc53a 100644
--- a/docs/user_guide/gaze_analysis_pipeline/introduction.md
+++ b/docs/user_guide/gaze_analysis_pipeline/introduction.md
@@ -11,14 +11,14 @@ To build your own gaze analysis pipeline, you need to know:
* [How to edit timestamped gaze positions](timestamped_gaze_positions_edition.md),
* [How to load and execute gaze analysis pipeline](configuration_and_execution.md),
-* [How to describe frame's AOI](aoi_2d_description.md),
+* [How to describe AOI](aoi_2d_description.md),
* [How to enable AOI analysis](aoi_analysis.md),
* [How to visualize pipeline steps outputs](visualisation.md),
* [How to log resulted gaze analysis](logging.md),
-* [How to make heatmap image](heatmap.md).
+* [How to make heatmap image](heatmap.md),
* [How to add a background image](background.md).
More advanced features are also explained like:
-* [How to script gaze analysis pipeline](advanced_topics/scripting.md)
-* [How to load module from another package](advanced_topics/module_loading.md)
+* [How to script gaze analysis pipeline](advanced_topics/scripting.md),
+* [How to load module from another package](advanced_topics/module_loading.md).