aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide
diff options
context:
space:
mode:
authorThéo de la Hogue2024-05-28 16:17:51 +0200
committerThéo de la Hogue2024-05-28 16:17:51 +0200
commitf4a78005a3fe7e8b0019ad16dd83c76992933f87 (patch)
tree551e6e47f9ee6305ba9aa281a70787a2dd40ea1c /docs/user_guide
parent9146d4dfc26adebf77e50e6c390384c52759f9ce (diff)
downloadargaze-f4a78005a3fe7e8b0019ad16dd83c76992933f87.zip
argaze-f4a78005a3fe7e8b0019ad16dd83c76992933f87.tar.gz
argaze-f4a78005a3fe7e8b0019ad16dd83c76992933f87.tar.bz2
argaze-f4a78005a3fe7e8b0019ad16dd83c76992933f87.tar.xz
Defining load and patch as __main__.py module commands. Updating documentation.
Diffstat (limited to 'docs/user_guide')
-rw-r--r--docs/user_guide/utils/demonstrations_scripts.md10
-rw-r--r--docs/user_guide/utils/ready-made_scripts.md4
2 files changed, 7 insertions, 7 deletions
diff --git a/docs/user_guide/utils/demonstrations_scripts.md b/docs/user_guide/utils/demonstrations_scripts.md
index d83915f..f293980 100644
--- a/docs/user_guide/utils/demonstrations_scripts.md
+++ b/docs/user_guide/utils/demonstrations_scripts.md
@@ -14,7 +14,7 @@ Collection of command-line scripts for demonstration purpose.
Load **random_context.json** file to analyze random gaze positions:
```shell
-python -m argaze ./src/argaze/utils/demo/random_context.json
+python -m argaze load ./src/argaze/utils/demo/random_context.json
```
## OpenCV window context
@@ -22,7 +22,7 @@ python -m argaze ./src/argaze/utils/demo/random_context.json
Load **opencv_window_context.json** file to analyze mouse pointer positions over OpenCV window:
```shell
-python -m argaze ./src/argaze/utils/demo/opencv_window_context.json
+python -m argaze load ./src/argaze/utils/demo/opencv_window_context.json
```
## Tobii Pro Glasses 2
@@ -58,7 +58,7 @@ Edit **tobii_live_stream_context.json** file as to select exisiting IP *address*
Then, load **tobii_live_stream_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
```shell
-python -m argaze ./src/argaze/utils/demo/tobii_live_stream_context.json
+python -m argaze load ./src/argaze/utils/demo/tobii_live_stream_context.json
```
### Post-processing context
@@ -81,7 +81,7 @@ Edit **tobii_post_processing_context.json** file to select an existing Tobii *se
Then, load **tobii_post_processing_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
```shell
-python -m argaze ./src/argaze/utils/demo/tobii_post_processing_context.json
+python -m argaze load ./src/argaze/utils/demo/tobii_post_processing_context.json
```
## Pupil Invisible
@@ -94,5 +94,5 @@ python -m argaze ./src/argaze/utils/demo/tobii_post_processing_context.json
Load **pupillabs_live_stream_context.json** file to find ArUco marker into camera image and, project gaze positions into AOI:
```shell
-python -m argaze ./src/argaze/utils/demo/pupillabs_live_stream_context.json
+python -m argaze load ./src/argaze/utils/demo/pupillabs_live_stream_context.json
```
diff --git a/docs/user_guide/utils/ready-made_scripts.md b/docs/user_guide/utils/ready-made_scripts.md
index 5f521e1..5d34bff 100644
--- a/docs/user_guide/utils/ready-made_scripts.md
+++ b/docs/user_guide/utils/ready-made_scripts.md
@@ -14,7 +14,7 @@ Collection of command-line scripts to provide useful features.
Load and execute any ArContext from a JSON CONFIGURATION file
```shell
-python -m argaze CONFIGURATION
+python -m argaze load CONFIGURATION
```
### Send command
@@ -22,7 +22,7 @@ python -m argaze CONFIGURATION
Use -p option to enable pipe communication at given address:
```shell
-python -m argaze CONFIGURATION -p /tmp/argaze
+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.