aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/utils/ready-made_scripts.md
diff options
context:
space:
mode:
authorThéo de la Hogue2024-06-26 10:59:43 +0200
committerThéo de la Hogue2024-06-26 10:59:43 +0200
commit986c7e8d0b16f2b8e7f28824b3e1fbd5d5b2236e (patch)
treee27e28167e277136e5b2aa35acc9f3a592d502b5 /docs/user_guide/utils/ready-made_scripts.md
parentdb4c1466c70e69de8d19cb4b01dd1f31bfc36978 (diff)
downloadargaze-986c7e8d0b16f2b8e7f28824b3e1fbd5d5b2236e.zip
argaze-986c7e8d0b16f2b8e7f28824b3e1fbd5d5b2236e.tar.gz
argaze-986c7e8d0b16f2b8e7f28824b3e1fbd5d5b2236e.tar.bz2
argaze-986c7e8d0b16f2b8e7f28824b3e1fbd5d5b2236e.tar.xz
Renaming patch function into edit function. Documenting the edit function.
Diffstat (limited to 'docs/user_guide/utils/ready-made_scripts.md')
-rw-r--r--docs/user_guide/utils/ready-made_scripts.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/user_guide/utils/ready-made_scripts.md b/docs/user_guide/utils/ready-made_scripts.md
index 5d34bff..bc35d59 100644
--- a/docs/user_guide/utils/ready-made_scripts.md
+++ b/docs/user_guide/utils/ready-made_scripts.md
@@ -9,9 +9,9 @@ Collection of command-line scripts to provide useful features.
!!! note
*Use -h option to get command arguments documentation.*
-## ArContext handler
+## Load ArContext JSON configuration
-Load and execute any ArContext from a JSON CONFIGURATION file
+Load and execute any [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) from a JSON CONFIGURATION file
```shell
python -m argaze load CONFIGURATION
@@ -46,6 +46,14 @@ echo "context.pause()" > /tmp/argaze
echo "context.resume()" > /tmp/argaze
```
+## Edit JSON configuration
+
+Modify the content of JSON CONFIGURATION file with another JSON CHANGES file then, save the result into an OUTPUT file
+
+```shell
+python -m argaze edit CONFIGURATION CHANGES OUTPUT
+```
+
## ArUco markers group exporter
Detect DICTIONARY and SIZE ArUco markers inside a MOVIE frame then, export detected ArUco markers group as .obj file into an OUTPUT folder.