aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/aruco_markers/markers_scene_description.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-06-07 20:02:59 +0200
committerThéo de la Hogue2023-06-07 20:02:59 +0200
commit40ceea01f289acabc0badfd09cd593c46aa0b41d (patch)
treee305e3fcf5d97a74fe8728413507398a2f367e74 /docs/user_guide/aruco_markers/markers_scene_description.md
parent452b49a6c1fc4620ea189b1ffe4228b7ebbb026b (diff)
downloadargaze-40ceea01f289acabc0badfd09cd593c46aa0b41d.zip
argaze-40ceea01f289acabc0badfd09cd593c46aa0b41d.tar.gz
argaze-40ceea01f289acabc0badfd09cd593c46aa0b41d.tar.bz2
argaze-40ceea01f289acabc0badfd09cd593c46aa0b41d.tar.xz
Improving cross reference with code.
Diffstat (limited to 'docs/user_guide/aruco_markers/markers_scene_description.md')
-rw-r--r--docs/user_guide/aruco_markers/markers_scene_description.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/user_guide/aruco_markers/markers_scene_description.md b/docs/user_guide/aruco_markers/markers_scene_description.md
index 9938f23..6dbc4fd 100644
--- a/docs/user_guide/aruco_markers/markers_scene_description.md
+++ b/docs/user_guide/aruco_markers/markers_scene_description.md
@@ -1,11 +1,11 @@
Markers scene description
=========================
-The ArGaze toolkit provides ArUcoScene class to describe where ArUco markers are placed into a 3D model.
+The ArGaze toolkit provides [ArUcoScene](/argaze/#argaze.ArUcoMarkers.ArUcoScene) class to describe where [ArUcoMarkers](/argaze/#argaze.ArUcoMarkers.ArUcoMarker) are placed into a 3D model.
![ArUco scene](../../img/aruco_scene.png)
-ArUco scene is useful to:
+[ArUcoScene](/argaze/#argaze.ArUcoMarkers.ArUcoScene) is useful to:
* filter markers that belongs to this predefined scene,
* check the consistency of detected markers according the place where each marker is expected to be,
@@ -33,7 +33,7 @@ f 5//2 6//2 8//2 7//2
...
```
-ArUco scene description can also be written in a JSON file format.
+[ArUcoScene](/argaze/#argaze.ArUcoMarkers.ArUcoScene) description can also be written in a JSON file format.
``` json
{
@@ -56,7 +56,7 @@ ArUco scene description can also be written in a JSON file format.
}
```
-Here is a sample of code to show the loading of an ArUcoScene OBJ file description:
+Here is a sample of code to show the loading of an [ArUcoScene](/argaze/#argaze.ArUcoMarkers.ArUcoScene) OBJ file description:
``` python
from argaze.ArUcoMarkers import ArUcoScene
@@ -91,7 +91,7 @@ consistent_markers, unconsistent_markers, unconsistencies = aruco_scene.check_ma
## Scene pose estimation
-Several approaches are available to perform ArUco scene pose estimation from markers belonging to the scene.
+Several approaches are available to perform [ArUcoScene](/argaze/#argaze.ArUcoMarkers.ArUcoScene) pose estimation from markers belonging to the scene.
The first approach considers that scene pose can be estimated **from a single marker pose**:
@@ -103,7 +103,7 @@ marker_id, marker = consistent_markers.popitem()
tvec, rmat = self.aruco_scene.estimate_pose_from_single_marker(marker)
```
-The second approach considers that scene pose can be estimated **by averaging several marker poses**:
+The second approach considers that scene pose can be estimated by **averaging several marker poses**:
``` python
# Estimate scene pose from all consistent scene markers