diff options
Diffstat (limited to 'docs/user_guide/utils/ready-made_scripts.md')
| -rw-r--r-- | docs/user_guide/utils/ready-made_scripts.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/user_guide/utils/ready-made_scripts.md b/docs/user_guide/utils/ready-made_scripts.md new file mode 100644 index 0000000..82039c5 --- /dev/null +++ b/docs/user_guide/utils/ready-made_scripts.md @@ -0,0 +1,35 @@ +Ready-made scripts +================== + +Collection of command-line scripts to provide useful features. + +!!! note + *Consider that all inline commands below have to be executed at the root of ArGaze package folder.* + +!!! note + *Use -h option to get command arguments documentation.* + +## 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: + +```shell +python ./src/argaze/utils/aruco_markers_dictionary_export.py DICT_APRILTAG_16h5 -s 5 -r 300 -o ./src/argaze/utils/_export/markers +``` + +Export a 7 columns and 5 rows calibration board made of 5cm squares with 3cm markers from *DICT_APRILTAG_16h5* dictionary at 300 dpi into an *./src/argaze/utils/_export* folder: + +```shell +python ./src/argaze/utils/aruco_calibration_board_export.py 7 5 5 3 DICT_APRILTAG_16h5 -r 300 -o ./src/argaze/utils/_export +``` + +## Camera calibration + +Calibrate a camera device (-d DEVICE) using a 7 columns and 5 rows calibration board made of 5cm squares with 3cm markers from *DICT_APRILTAG_16h5* dictionary. Then, export its optical parameters into an *calibration.json* file into *./src/argaze/utils/demo_environment/* folder: + +```shell +python ./src/argaze/utils/camera_calibrate.py 7 5 5 3 DICT_APRILTAG_16h5 -d DEVICE -o ./src/argaze/utils/demo_environment +``` + +!!! 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. |