aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/aruco_markers_pipeline
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/aruco_markers_pipeline
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/aruco_markers_pipeline')
-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
3 files changed, 9 insertions, 9 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: