aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/user_guide/aruco_markers_pipeline/advanced_topics/aruco_detector_configuration.md39
-rw-r--r--docs/user_guide/aruco_markers_pipeline/introduction.md2
-rw-r--r--mkdocs.yml1
3 files changed, 41 insertions, 1 deletions
diff --git a/docs/user_guide/aruco_markers_pipeline/advanced_topics/aruco_detector_configuration.md b/docs/user_guide/aruco_markers_pipeline/advanced_topics/aruco_detector_configuration.md
new file mode 100644
index 0000000..98b0841
--- /dev/null
+++ b/docs/user_guide/aruco_markers_pipeline/advanced_topics/aruco_detector_configuration.md
@@ -0,0 +1,39 @@
+Improve ArUco markers detection
+===============================
+
+As explain in [OpenCV ArUco documentation](https://docs.opencv.org/4.x/d1/dcd/structcv_1_1aruco_1_1DetectorParameters.html), ArUco markers detection is highly configurable.
+
+## Load ArUcoDetector parameters
+
+[ArUcoCamera.detector.parameters](../../../argaze.md/#argaze.ArUcoMarkers.ArUcoDetector.Parameters) can be loaded thanks to a dedicated JSON entry.
+
+Here is an extract from the JSON [ArUcoCamera](../../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) configuration file with ArUco detector parameters:
+
+```json
+{
+ "name": "My FullHD camera",
+ "size": [1920, 1080],
+ "aruco_detector": {
+ "dictionary": "DICT_APRILTAG_16h5",
+ "marker_size": 5,
+ "parameters": {
+ "cornerRefinementMethod": 3,
+ "aprilTagQuadSigma": 2,
+ "aprilTagDeglitch": 1
+ }
+ },
+ ...
+```
+
+## Print ArUcoDetector parameters
+
+```python
+# Assuming ArUcoCamera is loaded
+...
+
+# Print all ArUcoDetector parameters
+print(aruco_camera.aruco_detector.parameters)
+
+# Print only modified ArUcoDetector parameters
+print(f'{aruco_camera.aruco_detector.parameters:modified}')
+```
diff --git a/docs/user_guide/aruco_markers_pipeline/introduction.md b/docs/user_guide/aruco_markers_pipeline/introduction.md
index f5bba18..5a07b49 100644
--- a/docs/user_guide/aruco_markers_pipeline/introduction.md
+++ b/docs/user_guide/aruco_markers_pipeline/introduction.md
@@ -26,4 +26,4 @@ More advanced features are also explained like:
* [How to script ArUco markers pipeline](advanced_topics/scripting.md)
* [How to calibrate optic parameters](advanced_topics/optic_parameters_calibration.md)
-<!-- * [How to improve ArUco markers detection](advanced_topics/aruco_detector_configuration.md) -->
+* [How to improve ArUco markers detection](advanced_topics/aruco_detector_configuration.md)
diff --git a/mkdocs.yml b/mkdocs.yml
index 2e21826..784c9e2 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -33,6 +33,7 @@ nav:
- Advanced Topics:
- user_guide/aruco_markers_pipeline/advanced_topics/scripting.md
- user_guide/aruco_markers_pipeline/advanced_topics/optic_parameters_calibration.md
+ - user_guide/aruco_markers_pipeline/advanced_topics/aruco_detector_configuration.md
# - Areas Of Interest:
# - user_guide/areas_of_interest/introduction.md