diff options
| author | Théo de la Hogue | 2022-03-29 13:30:06 +0200 |
|---|---|---|
| committer | Théo de la Hogue | 2022-03-29 13:30:06 +0200 |
| commit | eeb0d3e69dfde4849611b2ae6dac0d03da7d220b (patch) | |
| tree | ebac4f93b42df6dfa47e0620b75ac05ae79ad7d4 /src | |
| parent | 2557e40a9d21806a8eee02eb92d404de36c85410 (diff) | |
| download | argaze-eeb0d3e69dfde4849611b2ae6dac0d03da7d220b.zip argaze-eeb0d3e69dfde4849611b2ae6dac0d03da7d220b.tar.gz argaze-eeb0d3e69dfde4849611b2ae6dac0d03da7d220b.tar.bz2 argaze-eeb0d3e69dfde4849611b2ae6dac0d03da7d220b.tar.xz | |
Updating utils documention
Diffstat (limited to 'src')
| -rw-r--r-- | src/argaze/utils/README.md | 6 | ||||
| -rw-r--r-- | src/argaze/utils/export_aruco_markers.py | 2 | ||||
| -rw-r--r-- | src/argaze/utils/export_tobii_segment_fixations.py | 2 |
3 files changed, 8 insertions, 2 deletions
diff --git a/src/argaze/utils/README.md b/src/argaze/utils/README.md index 8659903..0bc3216 100644 --- a/src/argaze/utils/README.md +++ b/src/argaze/utils/README.md @@ -6,6 +6,12 @@ Use -help to get arguments documentation. Consider that all inline commands below needs to be executed into ArGaze root folder. +- Ask for command help (replace UTILS_SCRIPT) + +``` +python ./src/argaze/utils/UTILS_SCRIPT.py -h +``` + - Export 50 4x4 markers at 300 dpi into an export/markers folder: ``` diff --git a/src/argaze/utils/export_aruco_markers.py b/src/argaze/utils/export_aruco_markers.py index e76b95e..2f6fe73 100644 --- a/src/argaze/utils/export_aruco_markers.py +++ b/src/argaze/utils/export_aruco_markers.py @@ -11,7 +11,7 @@ def main(): # manage arguments parser = argparse.ArgumentParser(description=main.__doc__) parser.add_argument('-o', '--output', metavar='OUT', type=str, default='.', help='destination path') - parser.add_argument('-d', '--dictionary', metavar='DICT', type=str, default='DICT_4X4_50', help='aruco marker dictionnary') + parser.add_argument('-d', '--dictionary', metavar='DICT', type=str, default='DICT_4X4_50', help='aruco marker dictionnary (DICT_4X4_50, DICT_4X4_100, DICT_4X4_250, DICT_4X4_1000, DICT_5X5_50, DICT_5X5_100, DICT_5X5_250, DICT_5X5_1000, DICT_6X6_50, DICT_6X6_100, DICT_6X6_250, DICT_6X6_1000, DICT_7X7_50, DICT_7X7_100, DICT_7X7_250, DICT_7X7_1000, DICT_ARUCO_ORIGINAL)') parser.add_argument('-r', '--resolution', metavar='RES', type=int, default=300, help='picture resolution in dpi') args = parser.parse_args() diff --git a/src/argaze/utils/export_tobii_segment_fixations.py b/src/argaze/utils/export_tobii_segment_fixations.py index 56d147c..c20fe5d 100644 --- a/src/argaze/utils/export_tobii_segment_fixations.py +++ b/src/argaze/utils/export_tobii_segment_fixations.py @@ -15,7 +15,7 @@ def main(): # manage arguments parser = argparse.ArgumentParser(description=main.__doc__.split('-')[0]) - parser.add_argument('-s', '--segment_path', metavar='SEGMENT_PATH', type=str, default=None, help='segment path') + parser.add_argument('-s', '--segment_path', metavar='SEGMENT_PATH', type=str, default=None, help='path to a tobii segment folder') parser.add_argument('-d', '--dispersion_threshold', metavar='DISPERSION_THRESHOLD', type=int, default=10, help='dispersion threshold in pixel') parser.add_argument('-t', '--duration_threshold', metavar='DURATION_THRESHOLD', type=int, default=100, help='duration threshold in millisecond') parser.add_argument('-o', '--output', metavar='OUT', type=str, default=None, help='destination path (segment folder by default)') |