From 181278a40c65cb2fef6f643d9e1a56cf272a1725 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Wed, 10 Apr 2024 21:01:07 +0200 Subject: Updating aruco markers documentation. --- .../aruco_detector_configuration.md | 23 ++++++++++++---------- .../advanced_topics/scripting.md | 18 ++++++++++------- 2 files changed, 24 insertions(+), 17 deletions(-) (limited to 'docs/user_guide/aruco_marker_pipeline/advanced_topics') diff --git a/docs/user_guide/aruco_marker_pipeline/advanced_topics/aruco_detector_configuration.md b/docs/user_guide/aruco_marker_pipeline/advanced_topics/aruco_detector_configuration.md index 410e2d7..7d666ba 100644 --- a/docs/user_guide/aruco_marker_pipeline/advanced_topics/aruco_detector_configuration.md +++ b/docs/user_guide/aruco_marker_pipeline/advanced_topics/aruco_detector_configuration.md @@ -11,16 +11,19 @@ Here is an extract from the JSON [ArUcoCamera](../../../argaze.md/#argaze.ArUcoM ```json { - "name": "My FullHD camera", - "size": [1920, 1080], - "aruco_detector": { - "dictionary": "DICT_APRILTAG_16h5", - "parameters": { - "adaptiveThreshConstant": 10, - "useAruco3Detection": 1 - } - }, - ... + "argaze.ArUcoMarkers.ArUcoCamera.ArUcoCamera": { + "name": "My FullHD camera", + "size": [1920, 1080], + "aruco_detector": { + "dictionary": "DICT_APRILTAG_16h5", + "parameters": { + "adaptiveThreshConstant": 10, + "useAruco3Detection": 1 + } + }, + ... + } +} ``` ## Print ArUcoDetector parameters diff --git a/docs/user_guide/aruco_marker_pipeline/advanced_topics/scripting.md b/docs/user_guide/aruco_marker_pipeline/advanced_topics/scripting.md index 4a2f9ba..c9a06a6 100644 --- a/docs/user_guide/aruco_marker_pipeline/advanced_topics/scripting.md +++ b/docs/user_guide/aruco_marker_pipeline/advanced_topics/scripting.md @@ -6,11 +6,15 @@ This could be particularly useful for realtime AR interaction applications. ## Load ArUcoCamera configuration from dictionary -First of all, [ArUcoCamera](../../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) configuration can be loaded from a python dictionary. +An [ArUcoCamera](../../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) configuration can be loaded from a Python dictionary. ```python +from argaze import DataFeatures from argaze.ArUcoMarkers import ArUcoCamera +# Set working directory to enable relative file path loading +DataFeatures.set_working_directory('path/to/folder') + # Edit a dict with ArUcoCamera configuration configuration = { "name": "My FullHD camera", @@ -47,10 +51,10 @@ configuration = { } # Load ArUcoCamera -aruco_camera = ArUcoCamera.ArUcoCamera.from_dict(configuration) +with ArUcoCamera.ArUcoCamera(**configuration) as aruco_camera: -# Do something with ArUcoCamera -... + # Do something with ArUcoCamera + ... ``` ## Access to ArUcoCamera and ArScenes attributes @@ -65,9 +69,9 @@ from argaze import ArFeatures # Assuming the ArUcoCamera is loaded ... -# Iterate over each ArUcoCamera scene -for name, aruco_scene in aruco_camera.scenes.items(): - ... + # Iterate over each ArUcoCamera scene + for name, aruco_scene in aruco_camera.scenes.items(): + ... ``` ## Pipeline execution outputs -- cgit v1.1