aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide
diff options
context:
space:
mode:
authorThéo de la Hogue2023-09-26 10:47:43 +0200
committerThéo de la Hogue2023-09-26 10:47:43 +0200
commit12ae7e20aba323624d360567ea424ac2d315fbc7 (patch)
treefd76adc669febf6ec19526c6f8278d2d853e8646 /docs/user_guide
parent08791230814241baf2283c07cc6b16b00dcccca4 (diff)
downloadargaze-12ae7e20aba323624d360567ea424ac2d315fbc7.zip
argaze-12ae7e20aba323624d360567ea424ac2d315fbc7.tar.gz
argaze-12ae7e20aba323624d360567ea424ac2d315fbc7.tar.bz2
argaze-12ae7e20aba323624d360567ea424ac2d315fbc7.tar.xz
Harmonizing AOI/aoi without s at the end.
Diffstat (limited to 'docs/user_guide')
-rw-r--r--docs/user_guide/aruco_markers_pipeline/aoi_3d_description.md8
-rw-r--r--docs/user_guide/aruco_markers_pipeline/aoi_3d_projection.md8
-rw-r--r--docs/user_guide/aruco_markers_pipeline/introduction.md2
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md52
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md (renamed from docs/user_guide/gaze_analysis_pipeline/aoi_2d_analysis.md)4
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md2
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/introduction.md2
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md2
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md2
9 files changed, 43 insertions, 39 deletions
diff --git a/docs/user_guide/aruco_markers_pipeline/aoi_3d_description.md b/docs/user_guide/aruco_markers_pipeline/aoi_3d_description.md
index 13f9c86..a2bb8d7 100644
--- a/docs/user_guide/aruco_markers_pipeline/aoi_3d_description.md
+++ b/docs/user_guide/aruco_markers_pipeline/aoi_3d_description.md
@@ -7,14 +7,14 @@ In the example scene, each screen is considered as an area of interest more the
![3D AOI description](../../img/aoi_3d_description.png)
-All AOIs need to be described from same origin than markers in a [right-handed 3D axis](https://robotacademy.net.au/lesson/right-handed-3d-coordinate-frame/) where:
+All AOI need to be described from same origin than markers in a [right-handed 3D axis](https://robotacademy.net.au/lesson/right-handed-3d-coordinate-frame/) where:
* +X is pointing to the right,
* +Y is pointing to the top,
* +Z is pointing to the backward.
!!! warning
- All AOIs spatial values must be given in **centimeters**.
+ All AOI spatial values must be given in **centimeters**.
### Edit OBJ file description
@@ -43,7 +43,7 @@ s off
f 9 10 11
```
-Here are common OBJ file features needed to describe AOIs:
+Here are common OBJ file features needed to describe AOI:
* Object lines (starting with *o* key) indicate AOI name.
* Vertice lines (starting with *v* key) indicate AOI vertices.
@@ -51,7 +51,7 @@ Here are common OBJ file features needed to describe AOIs:
### Edit JSON file description
-JSON file format allows to describe AOIs vertices.
+JSON file format allows to describe AOI vertices.
``` json
{
diff --git a/docs/user_guide/aruco_markers_pipeline/aoi_3d_projection.md b/docs/user_guide/aruco_markers_pipeline/aoi_3d_projection.md
index bdebd6c..d7df765 100644
--- a/docs/user_guide/aruco_markers_pipeline/aoi_3d_projection.md
+++ b/docs/user_guide/aruco_markers_pipeline/aoi_3d_projection.md
@@ -1,7 +1,7 @@
Project AOI into camera frame
=============================
-Once [ArUcoScene pose is estimated](pose_estimation.md) and [3D AOIs are described](aoi_3d_description.md), AOIs can be projected into [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) frame.
+Once [ArUcoScene pose is estimated](pose_estimation.md) and [3D AOI are described](aoi_3d_description.md), AOI can be projected into [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) frame.
![3D AOI projection](../../img/aruco_camera_aoi_projection.png)
@@ -46,7 +46,7 @@ The name of the [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer). Basically
The [AOIScene](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.AOIScene) defines a set of 3D [AreaOfInterest](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.AreaOfInterest) registered by name.
-## Add ArLayer to ArUcoCamera to project 3D AOIs
+## Add ArLayer to ArUcoCamera to project 3D AOI
Here is the previous extract where one layer is added to the [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) and displayed:
@@ -103,11 +103,11 @@ The name of the [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer). Basically
[ArUcoScene](../../argaze.md/#argaze.ArUcoMarkers.ArUcoScene) layers are projected into their dedicated [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) layers when calling the [ArUcoCamera.watch](../../argaze.md/#argaze.ArFeatures.ArCamera.watch) method.
-## Add 2D AOIs analysis
+## Add 2D AOI analysis
When a scene layer is projected into a camera layer, it means that the 3D [ArLayer.aoi_scene](../../argaze.md/#argaze.ArFeatures.ArLayer.aoi_scene) description of the scene becomes the 2D camera's [ArLayer.aoi_scene](../../argaze.md/#argaze.ArFeatures.ArLayer.aoi_scene) description of the camera.
-Therefore, it means that [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) benefits from all the services described in [2D AOIs analysis pipeline section](../gaze_analysis_pipeline/aoi_2d_analysis.md).
+Therefore, it means that [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) benefits from all the services described in [2D AOI analysis pipeline section](../gaze_analysis_pipeline/aoi_analysis.md).
Here is the previous extract where AOI matcher, AOI scan path and AOI scan path analyzers are added to the [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) layer:
diff --git a/docs/user_guide/aruco_markers_pipeline/introduction.md b/docs/user_guide/aruco_markers_pipeline/introduction.md
index 917245d..dc3aa4a 100644
--- a/docs/user_guide/aruco_markers_pipeline/introduction.md
+++ b/docs/user_guide/aruco_markers_pipeline/introduction.md
@@ -19,7 +19,7 @@ To build your own ArUco markers pipeline, you need to know:
* [How to describe scene's AOI](aoi_3d_description.md),
* [How to load and execute ArUco markers pipeline](configuration_and_execution.md),
* [How to estimate scene pose](pose_estimation.md),
-* [How to project AOIs into camera frame](aoi_3d_projection.md),
+* [How to project AOI into camera frame](aoi_3d_projection.md),
* [How to define an AOI as a frame](aoi_frame.md)
More advanced features are also explained like:
diff --git a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
index b2f0b90..6cca7ce 100644
--- a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
@@ -1,17 +1,17 @@
Describe 2D AOI
-===============
+================
-Once [frame is configured](configuration_and_execution.md), areas of interest need to be described into the same 2D referential.
+Once [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) is [configured](configuration_and_execution.md), areas of interest need to be described to know what is looked in frame.
![2D AOI description](../../img/aoi_2d_description.png)
-According a common computer graphics coordinates convention, all AOIs need to be described from a top left frame corner origin in a coordinate system where:
+According common computer graphics coordinates convention, all AOI need to be described from a top left frame corner origin with a coordinate system where:
* +X is pointing to the right,
* +Y is pointing to the downward.
!!! warning
- All AOIs spatial values must be given in **pixels**.
+ All AOI spatial values must be given in **pixels**.
### Edit SVG file description
@@ -27,7 +27,7 @@ SVG file format could be exported from most vector graphics editors.
</svg>
```
-Here are common SVG file features needed to describe AOIs:
+Here are common SVG file features needed to describe AOI:
* *id* attribute indicates AOI name.
* *path* element describes any polygon using only [M, L and Z path intructions](https://www.w3.org/TR/SVG2/paths.html#PathData)
@@ -35,36 +35,40 @@ Here are common SVG file features needed to describe AOIs:
### Edit JSON file description
-JSON file format allows to describe AOIs.
+JSON file format allows to describe AOI.
``` json
{
"Triangle" : [[1288.1, 189.466], [1991.24, 3399.34], [584.958, 3399.34]],
"BlueRectangle": {
- "shape": "rectangle",
- "x": 1257,
- "y": 1905.18,
- "width": 604.169,
- "height": 988.564
+ "Rectangle": {
+ "x": 1257,
+ "y": 1905.18,
+ "width": 604.169,
+ "height": 988.564
+ }
},
"RedSquare": {
- "shape": "rectangle",
- "x": 623.609,
- "y": 658.357,
- "width": 803.15,
- "height": 803.15
+ "Rectangle": {
+ "x": 623.609,
+ "y": 658.357,
+ "width": 803.15,
+ "height": 803.15
+ }
},
"GreenCircle": {
- "shape": "circle",
- "cx": 675.77,
- "cy": 2163.5,
- "radius": 393.109
+ "Circle": {
+ "cx": 675.77,
+ "cy": 2163.5,
+ "radius": 393.109
+ }
},
"PinkCircle": {
- "shape": "circle",
- "cx": 1902.02,
- "cy": 879.316,
- "radius": 195.313
+ "Circle": {
+ "cx": 1902.02,
+ "cy": 879.316,
+ "radius": 195.313
+ }
}
}
```
diff --git a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_analysis.md b/docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md
index 66763ad..cce3fcb 100644
--- a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_analysis.md
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md
@@ -1,7 +1,7 @@
-Enable 2D AOIs analysis
+Enable AOI analysis
===================
-The [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) class defines a space where to make matching of gaze movements with AOIs and inside which those matchings need to be analyzed.
+The [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) class defines a space where to make matching of gaze movements with AOI and inside which those matchings need to be analyzed.
![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 7657935..bb8eeaa 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 [add AOI analysis](aoi_2d_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 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
diff --git a/docs/user_guide/gaze_analysis_pipeline/introduction.md b/docs/user_guide/gaze_analysis_pipeline/introduction.md
index d33d308..76a146c 100644
--- a/docs/user_guide/gaze_analysis_pipeline/introduction.md
+++ b/docs/user_guide/gaze_analysis_pipeline/introduction.md
@@ -12,7 +12,7 @@ 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 enable AOIs analysis](aoi_2d_analysis.md),
+* [How to enable AOI analysis](aoi_analysis.md),
* [How to visualize ArFrame and ArLayers](visualisation.md),
* [How to log resulted gaze analysis](logging.md),
* [How to make heatmap image](heatmap.md).
diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md
index 8ba751f..61338cc 100644
--- a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md
+++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md
@@ -3,7 +3,7 @@ AOI matchers
ArGaze provides ready-to-use AOI matching algorithms.
-Here are JSON samples to include the chosen module inside [ArLayer configuration](../aoi_2d_analysis.md) *aoi_matcher* entry.
+Here are JSON samples to include the chosen module inside [ArLayer configuration](../aoi_analysis.md) *aoi_matcher* entry.
## Deviation circle coverage
diff --git a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md
index e395750..ad1832d 100644
--- a/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md
+++ b/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md
@@ -3,7 +3,7 @@ AOI scan path analyzers
ArGaze provides ready-to-use AOI scan path analysis algorithms.
-Here are JSON samples to include a chosen module inside [ArLayer configuration](../aoi_2d_analysis.md) *aoi_scan_path_analyzers* entry.
+Here are JSON samples to include a chosen module inside [ArLayer configuration](../aoi_analysis.md) *aoi_scan_path_analyzers* entry.
## Basic metrics