aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/utils/ready-made_scripts.md
diff options
context:
space:
mode:
authorThéo de la Hogue2024-07-03 17:14:43 +0200
committerThéo de la Hogue2024-07-03 17:14:43 +0200
commit8fc18a434da400f0fe82707e23838d6cc40a787d (patch)
tree9e42c9f7edb9364e9a0afedab30194820987a907 /docs/user_guide/utils/ready-made_scripts.md
parent7b82b09e87d1475acf5040c67323421699a3ad06 (diff)
downloadargaze-8fc18a434da400f0fe82707e23838d6cc40a787d.zip
argaze-8fc18a434da400f0fe82707e23838d6cc40a787d.tar.gz
argaze-8fc18a434da400f0fe82707e23838d6cc40a787d.tar.bz2
argaze-8fc18a434da400f0fe82707e23838d6cc40a787d.tar.xz
Rewriting eye tracking context and gaze analysis sections.
Diffstat (limited to 'docs/user_guide/utils/ready-made_scripts.md')
-rw-r--r--docs/user_guide/utils/ready-made_scripts.md69
1 files changed, 0 insertions, 69 deletions
diff --git a/docs/user_guide/utils/ready-made_scripts.md b/docs/user_guide/utils/ready-made_scripts.md
deleted file mode 100644
index 892fef8..0000000
--- a/docs/user_guide/utils/ready-made_scripts.md
+++ /dev/null
@@ -1,69 +0,0 @@
-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.*
-
-## Load ArContext JSON configuration
-
-Load and execute any [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) from a JSON CONFIGURATION file
-
-```shell
-python -m argaze load CONFIGURATION
-```
-
-### Send command
-
-Use -p option to enable pipe communication at given address:
-
-```shell
-python -m argaze load CONFIGURATION -p /tmp/argaze
-```
-
-Open another tab in the **same** Terminal window then, you can send any Python command into the pipe.
-
-For example:
-
-* Print context:
-```shell
-echo "print(context)" > /tmp/argaze
-```
-
-* Pause context processing:
-
-```shell
-echo "context.pause()" > /tmp/argaze
-```
-
-* Resume context processing:
-
-```shell
-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
-```
-
-## Estimate ArUco markers pose
-
-This application detects ArUco markers inside a movie frame then, export pose estimation as .obj file into a folder.
-
-Firstly, edit **utils/estimate_markers_pose/context.json** file as to select a movie *path*.
-
-Sencondly, edit **utils/estimate_markers_pose/pipeline.json** file to setup ArUco detector *dictionary*, *pose_size* and *pose_ids* attributes.
-
-Then, launch the application.
-
-```shell
-python -m argaze load ./src/argaze/utils/estimate_markers_pose/context.json
-``` \ No newline at end of file