aboutsummaryrefslogtreecommitdiff
path: root/src/argaze/utils
diff options
context:
space:
mode:
authorThéo de la Hogue2023-06-06 17:47:16 +0200
committerThéo de la Hogue2023-06-06 17:47:16 +0200
commitbd9cd27c9d44c072164f564ffffeb22e37106b89 (patch)
tree3c8a1c818ce99fdd0fe90e9798d9c0c99a2efd49 /src/argaze/utils
parent8352274b19ae10cecbdb87f96606bc28157427c8 (diff)
downloadargaze-bd9cd27c9d44c072164f564ffffeb22e37106b89.zip
argaze-bd9cd27c9d44c072164f564ffffeb22e37106b89.tar.gz
argaze-bd9cd27c9d44c072164f564ffffeb22e37106b89.tar.bz2
argaze-bd9cd27c9d44c072164f564ffffeb22e37106b89.tar.xz
Updating documentation format.
Diffstat (limited to 'src/argaze/utils')
-rw-r--r--src/argaze/utils/README.md10
-rw-r--r--src/argaze/utils/__init__.py3
2 files changed, 10 insertions, 3 deletions
diff --git a/src/argaze/utils/README.md b/src/argaze/utils/README.md
index d5af45a..3c7d616 100644
--- a/src/argaze/utils/README.md
+++ b/src/argaze/utils/README.md
@@ -6,6 +6,8 @@ Collection of command-line high level features scripts.
!!! note
*Use -h option to get command arguments documentation.*
+<!--ready-start-->
+
# ArUco Markers factory
Export all markers from *DICT_APRILTAG_16h5* dictionary as 5 cm pictures with 300 dpi resolution into an *./src/argaze/utils/_export/markers* folder:
@@ -31,6 +33,10 @@ python ./src/argaze/utils/camera_calibrate.py 7 5 5 3 DICT_APRILTAG_16h5 -d DEVI
!!! note
Use **A3_DICT_APRILTAG_16h5_3cm_35cmx25cm.pdf** file located in *./src/argaze/ArUcoMarkers/utils/* folder ready to be printed on A3 paper sheet.
+<!--ready-end-->
+
+<!--demo-start-->
+
# AR environment demonstration
Load AR environment from **setup.json** file, detect ArUco markers into camera device (-d DEVICE) frames and estimate envirnoment pose.
@@ -60,4 +66,6 @@ A picture is saved by pressing escape key.
```
python ./src/argaze/utils/demo_heatmap_run.py
-``` \ No newline at end of file
+```
+
+<!--demo-end--> \ No newline at end of file
diff --git a/src/argaze/utils/__init__.py b/src/argaze/utils/__init__.py
index 8134e6f..94deb78 100644
--- a/src/argaze/utils/__init__.py
+++ b/src/argaze/utils/__init__.py
@@ -1,5 +1,4 @@
"""
-{!./src/argaze/utils/README.md!}
+Collection of command-line high level features scripts.
"""
-__docformat__ = "restructuredtext"
__all__ = ['MiscFeatures'] \ No newline at end of file