aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md
diff options
context:
space:
mode:
authorThéo de la Hogue2024-04-17 20:50:24 +0200
committerThéo de la Hogue2024-04-17 20:50:24 +0200
commitcbda49dabd0ab115d75c4d568b748110106220ae (patch)
treeca76bfa92e8298881d1237090692c5e70164d526 /docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md
parentee10651a9aa0d87fa323423d1a7489798e083b90 (diff)
downloadargaze-cbda49dabd0ab115d75c4d568b748110106220ae.zip
argaze-cbda49dabd0ab115d75c4d568b748110106220ae.tar.gz
argaze-cbda49dabd0ab115d75c4d568b748110106220ae.tar.bz2
argaze-cbda49dabd0ab115d75c4d568b748110106220ae.tar.xz
Updating ArUco marker pipeline documentation.
Diffstat (limited to 'docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md')
-rw-r--r--docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md b/docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md
index 729608f..f4bd2d4 100644
--- a/docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md
+++ b/docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md
@@ -103,20 +103,23 @@ The usual [ArFrame visualization parameters](../gaze_analysis_pipeline/visualiza
### Detect ArUco markers, estimate scene pose and project 3D AOI
-Pass each camera image to the [ArUcoCamera.watch](../../argaze.md/#argaze.ArFeatures.ArCamera.watch) method to execute the whole pipeline dedicated to ArUco marker detection, scene pose estimation and 3D AOI projection.
+Pass each camera image with timestamp information to the [ArUcoCamera.watch](../../argaze.md/#argaze.ArFeatures.ArCamera.watch) method to execute the whole pipeline dedicated to ArUco marker detection, scene pose estimation and 3D AOI projection.
!!! warning "Mandatory"
The [ArUcoCamera.watch](../../argaze.md/#argaze.ArFeatures.ArCamera.watch) method must be called from a *try* block to catch pipeline exceptions.
```python
-# Assuming that Full HD (1920x1080) timestamped images are available
+# Assuming that Full HD (1920x1080) images are available with timestamp values
...:
+ # Edit timestamped image
+ timestamped_image = DataFeatures.TimestampedImage(image, timestamp=timestamp)
+
try:
# Detect ArUco markers, estimate scene pose then, project 3D AOI into camera frame
- aruco_camera.watch(image, timestamp=timestamp)
+ aruco_camera.watch(timestamped_image)
# Do something with pipeline exception
except Exception as e: