diff options
| -rw-r--r-- | docs/installation.md | 2 | ||||
| -rw-r--r-- | docs/user_guide/demos.md | 8 | ||||
| -rw-r--r-- | docs/user_guide/ready-made.md | 8 | ||||
| -rw-r--r-- | docs/user_guide/utils/demonstrations_scripts.md | 41 | ||||
| -rw-r--r-- | docs/user_guide/utils/ready-made_scripts.md (renamed from src/argaze/utils/README.md) | 56 | ||||
| -rw-r--r-- | mkdocs.yml | 3 |
6 files changed, 55 insertions, 63 deletions
diff --git a/docs/installation.md b/docs/installation.md index 4b84a19..ea7021b 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -37,7 +37,7 @@ pip install ./dist/argaze-VERSION.whl !!! note - **As Argaze library contributor** + **As Argaze package contributor** *You should prefer to install the package in developer mode to test live code changes:* ``` diff --git a/docs/user_guide/demos.md b/docs/user_guide/demos.md deleted file mode 100644 index 1a53c82..0000000 --- a/docs/user_guide/demos.md +++ /dev/null @@ -1,8 +0,0 @@ -Demonstration scripts -===================== - -{% - include-markdown "../../src/argaze/utils/README.md" - start="<!--demo-start-->" - end="<!--demo-end-->" -%} diff --git a/docs/user_guide/ready-made.md b/docs/user_guide/ready-made.md deleted file mode 100644 index 32c475c..0000000 --- a/docs/user_guide/ready-made.md +++ /dev/null @@ -1,8 +0,0 @@ -Ready-made scripts -================== - -{% - include-markdown "../../src/argaze/utils/README.md" - start="<!--ready-start-->" - end="<!--ready-end-->" -%} diff --git a/docs/user_guide/utils/demonstrations_scripts.md b/docs/user_guide/utils/demonstrations_scripts.md new file mode 100644 index 0000000..5c4ef2b --- /dev/null +++ b/docs/user_guide/utils/demonstrations_scripts.md @@ -0,0 +1,41 @@ +Demonstrations scripts +====================== + +Collection of command-line scripts for demonstration purpose. + +!!! 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.* + +## AR environment demonstration + +Load AR environment from **setup.json** file, detect ArUco markers into camera device (-d DEVICE) frames and estimate envirnoment pose. + +```shell +python ./src/argaze/utils/demo_ar_features_run.py -d DEVICE +``` + +!!! warning + This demonstration assumes that camera calibration step is done and a **calibration.json** has been exported into *./src/argaze/utils/demo_environment/* folder. + +!!! note + Use **A3_demo.pdf** file located in *./src/argaze/utils/demo_environment/* folder ready to be printed on A3 paper sheet. + +## Gaze features demonstration + +Simulate gaze position using mouse pointer to illustrate gaze features. + +```shell +python ./src/argaze/utils/demo_gaze_features_run.py +``` + +## Heatmap demonstration + +Simulate gaze position using mouse pointer to produce heatmap picture. +A picture is saved by pressing escape key. + +```shell +python ./src/argaze/utils/demo_heatmap_run.py +``` diff --git a/src/argaze/utils/README.md b/docs/user_guide/utils/ready-made_scripts.md index 3c7d616..82039c5 100644 --- a/src/argaze/utils/README.md +++ b/docs/user_guide/utils/ready-made_scripts.md @@ -1,71 +1,35 @@ -Collection of command-line high level features scripts. +Ready-made scripts +================== + +Collection of command-line scripts to provide useful features. !!! note - *Consider that all inline commands below needs to be executed into ArGaze root folder.* + *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.* -<!--ready-start--> - -# ArUco Markers factory +## 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 +## 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. - -<!--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. - -``` -python ./src/argaze/utils/demo_ar_features_run.py -d DEVICE -``` - -!!! note - This demonstration assumes that camera calibration step is done and a **calibration.json** has been exported into *./src/argaze/utils/demo_environment/* folder. - -!!! note - Use **A3_demo.pdf** file located in *./src/argaze/utils/demo_environment/* folder ready to be printed on A3 paper sheet. - -# Gaze features demonstration - -Simulate gaze position using mouse pointer to illustrate gaze features. - -``` -python ./src/argaze/utils/demo_gaze_features_run.py -``` - -# Heatmap demonstration - -Simulate gaze position using mouse pointer to produce heatmap picture. -A picture is saved by pressing escape key. - -``` -python ./src/argaze/utils/demo_heatmap_run.py -``` - -<!--demo-end-->
\ No newline at end of file @@ -34,6 +34,9 @@ nav: - user_guide/timestamped_data/saving_and_loading.md - user_guide/timestamped_data/data_synchronisation.md - user_guide/timestamped_data/pandas_dataframe_conversion.md + - utils: + - user_guide/utils/ready-made_scripts.md + - user_guide/utils/demonstrations_scripts.md - Use Cases: - use_cases/simone_a320_cockpit_simulator.md - Code Reference: |