aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/ar_environment
diff options
context:
space:
mode:
authorThéo de la Hogue2023-09-04 22:03:46 +0200
committerThéo de la Hogue2023-09-04 22:03:46 +0200
commitf4d60a6cd1e1d8810cf4b9ad7f63a8718069f73a (patch)
treee8b40f39f80bf7dab027748da9a34b0732a52e76 /docs/user_guide/ar_environment
parent9215d4724912e3eb4a5673ba87cc736abe58be40 (diff)
downloadargaze-f4d60a6cd1e1d8810cf4b9ad7f63a8718069f73a.zip
argaze-f4d60a6cd1e1d8810cf4b9ad7f63a8718069f73a.tar.gz
argaze-f4d60a6cd1e1d8810cf4b9ad7f63a8718069f73a.tar.bz2
argaze-f4d60a6cd1e1d8810cf4b9ad7f63a8718069f73a.tar.xz
First work on new AR pipeline architecture. Class renaming and replacing.
Diffstat (limited to 'docs/user_guide/ar_environment')
-rw-r--r--docs/user_guide/ar_environment/environment_exploitation.md8
-rw-r--r--docs/user_guide/ar_environment/environment_setup.md10
2 files changed, 9 insertions, 9 deletions
diff --git a/docs/user_guide/ar_environment/environment_exploitation.md b/docs/user_guide/ar_environment/environment_exploitation.md
index 28d61b9..9e4b236 100644
--- a/docs/user_guide/ar_environment/environment_exploitation.md
+++ b/docs/user_guide/ar_environment/environment_exploitation.md
@@ -1,19 +1,19 @@
Environment exploitation
========================
-Once loaded, [ArEnvironment](../../argaze.md/#argaze.ArFeatures.ArEnvironment) assets can be exploited as illustrated below:
+Once loaded, [ArCamera](../../argaze.md/#argaze.ArFeatures.ArCamera) assets can be exploited as illustrated below:
```python
# Access to AR environment ArUco detector passing it a image where to detect ArUco markers
-ar_environment.aruco_detector.detect_markers(image)
+ar_camera.aruco_detector.detect_markers(image)
# Access to an AR environment scene
-my_first_scene = ar_environment.scenes['my first AR scene']
+my_first_scene = ar_camera.scenes['my first AR scene']
try:
# Try to estimate AR scene pose from detected markers
- tvec, rmat, consistent_markers = my_first_scene.estimate_pose(ar_environment.aruco_detector.detected_markers)
+ tvec, rmat, consistent_markers = my_first_scene.estimate_pose(ar_camera.aruco_detector.detected_markers)
# Project AR scene into camera image according estimated pose
# Optional visual_hfov argument is set to 160° to clip AOI scene according a cone vision
diff --git a/docs/user_guide/ar_environment/environment_setup.md b/docs/user_guide/ar_environment/environment_setup.md
index f18cc61..1f26d26 100644
--- a/docs/user_guide/ar_environment/environment_setup.md
+++ b/docs/user_guide/ar_environment/environment_setup.md
@@ -1,9 +1,9 @@
Environment Setup
=================
-[ArEnvironment](../../argaze.md/#argaze.ArFeatures.ArEnvironment) setup is loaded from JSON file format.
+[ArCamera](../../argaze.md/#argaze.ArFeatures.ArCamera) setup is loaded from JSON file format.
-Each [ArEnvironment](../../argaze.md/#argaze.ArFeatures.ArEnvironment) defines a unique [ArUcoDetector](../../argaze.md/#argaze.ArUcoMarkers.ArUcoDetector.ArUcoDetector) dedicated to detection of markers from a specific [ArUcoMarkersDictionary](../../argaze.md/#argaze.ArUcoMarkers.ArUcoMarkersDictionary) and with a given size. However, it is possible to load multiple [ArScene](../../argaze.md/#argaze.ArFeatures.ArScene) into a same [ArEnvironment](../../argaze.md/#argaze.ArFeatures.ArEnvironment).
+Each [ArCamera](../../argaze.md/#argaze.ArFeatures.ArCamera) defines a unique [ArUcoDetector](../../argaze.md/#argaze.ArUcoMarkers.ArUcoDetector.ArUcoDetector) dedicated to detection of markers from a specific [ArUcoMarkersDictionary](../../argaze.md/#argaze.ArUcoMarkers.ArUcoMarkersDictionary) and with a given size. However, it is possible to load multiple [ArScene](../../argaze.md/#argaze.ArFeatures.ArScene) into a same [ArCamera](../../argaze.md/#argaze.ArFeatures.ArCamera).
Here is JSON environment file example where it is assumed that mentioned .obj files are located relatively to the environment file on disk.
@@ -54,13 +54,13 @@ Here is JSON environment file example where it is assumed that mentioned .obj fi
},
"scenes": {
"my first AR scene" : {
- "aruco_scene": "./first_scene/markers.obj",
+ "aruco_markers_group": "./first_scene/markers.obj",
"aoi_scene": "./first_scene/aoi.obj",
"angle_tolerance": 15.0,
"distance_tolerance": 2.54
},
"my second AR scene" : {
- "aruco_scene": "./second_scene/markers.obj",
+ "aruco_markers_group": "./second_scene/markers.obj",
"aoi_scene": "./second_scene/aoi.obj",
"angle_tolerance": 15.0,
"distance_tolerance": 2.54
@@ -73,5 +73,5 @@ Here is JSON environment file example where it is assumed that mentioned .obj fi
from argaze import ArFeatures
# Load AR environment
-ar_environment = ArFeatures.ArEnvironment.from_json('./environment.json')
+ar_camera = ArFeatures.ArCamera.from_json('./environment.json')
```