aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user_guide')
-rw-r--r--docs/user_guide/eye_tracking_context/introduction.md5
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md8
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/introduction.md1
3 files changed, 7 insertions, 7 deletions
diff --git a/docs/user_guide/eye_tracking_context/introduction.md b/docs/user_guide/eye_tracking_context/introduction.md
index 8fe6c81..a6208b2 100644
--- a/docs/user_guide/eye_tracking_context/introduction.md
+++ b/docs/user_guide/eye_tracking_context/introduction.md
@@ -10,9 +10,10 @@ To use a ready-made eye tracking context, you only need to know:
More advanced features are also explained like:
* [How to script context](./advanced_topics/scripting.md),
-* [How to define a context](./advanced_topics/context_definition.md)
+* [How to define a context](./advanced_topics/context_definition.md),
+* [How to edit timestamped gaze positions](advanced_topics/timestamped_gaze_positions_edition.md)
To get deeper in how context works, the schema below mentions *enter* and *exit* methods which are related to the notion of [Python context manager](https://docs.python.org/3/reference/datamodel.html#context-managers).
-![ArContext class](../../../img/eye_tracker_context.png)
+![ArContext class](../../img/eye_tracker_context.png)
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
index f3ec6cd..264e866 100644
--- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
@@ -68,11 +68,11 @@ from argaze import ArFeatures
## Pipeline execution
-Timestamped [GazePositions](../../argaze.md/#argaze.GazeFeatures.GazePosition) have to be passed one by one to the [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method to execute the whole instantiated pipeline.
+Timestamped [GazePositions](../../../argaze.md/#argaze.GazeFeatures.GazePosition) have to be passed one by one to the [ArFrame.look](../../../argaze.md/#argaze.ArFeatures.ArFrame.look) method to execute the whole instantiated pipeline.
!!! warning "Mandatory"
- The [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method must be called from a *try* block to catch pipeline exceptions.
+ The [ArFrame.look](../../../argaze.md/#argaze.ArFeatures.ArFrame.look) method must be called from a *try* block to catch pipeline exceptions.
```python
# Assuming that timestamped gaze positions are available
@@ -208,11 +208,11 @@ ar_frame_image = ar_frame.image(**image_parameters)
...
```
-Then, [ArFrame.image](../../argaze.md/#argaze.ArFeatures.ArFrame.image) method can be called in various situations.
+Then, [ArFrame.image](../../../argaze.md/#argaze.ArFeatures.ArFrame.image) method can be called in various situations.
### Live window display
-While timestamped gaze positions are processed by [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method, it is possible to display the [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) image thanks to the [OpenCV package](https://pypi.org/project/opencv-python/).
+While timestamped gaze positions are processed by [ArFrame.look](../../../argaze.md/#argaze.ArFeatures.ArFrame.look) method, it is possible to display the [ArFrame](../../../argaze.md/#argaze.ArFeatures.ArFrame) image thanks to the [OpenCV package](https://pypi.org/project/opencv-python/).
```python
import cv2
diff --git a/docs/user_guide/gaze_analysis_pipeline/introduction.md b/docs/user_guide/gaze_analysis_pipeline/introduction.md
index 29eeed5..1b06ff6 100644
--- a/docs/user_guide/gaze_analysis_pipeline/introduction.md
+++ b/docs/user_guide/gaze_analysis_pipeline/introduction.md
@@ -22,7 +22,6 @@ To build your own gaze analysis pipeline, you need to know:
More advanced features are also explained like:
-* [How to edit timestamped gaze positions](advanced_topics/timestamped_gaze_positions_edition.md),
* [How to script gaze analysis pipeline](advanced_topics/scripting.md),
* [How to load module from another package](advanced_topics/module_loading.md).
* [How to calibrate gaze position](advanced_topics/gaze_position_calibration.md).