diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.md | 10 | ||||
| -rw-r--r-- | docs/user_guide/utils/ready-made_scripts.md | 29 |
2 files changed, 34 insertions, 5 deletions
diff --git a/docs/index.md b/docs/index.md index 385275a..d179007 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,11 +2,11 @@ title: What is ArGaze? --- -# Develop post- or real-time gaze processing applications +# Develop post- or real-time gaze analysis applications **Useful links**: [Installation](installation.md) | [Source Repository](https://gitpub.recherche.enac.fr/argaze) | [Issue Tracker](https://git.recherche.enac.fr/projects/argaze/issues) | [Contact](mailto:argaze-contact@recherche.enac.fr) -**ArGaze** is a Python software library that lets you build **custom-made gaze processing pipelines** for **any kind of eye tracker device,** whether for **post- or real-time data processing**. +**ArGaze** is a Python software library that lets you build **custom-made gaze analysis pipelines** for **any kind of eye tracker device,** whether for **post- or real-time data processing**.  @@ -14,9 +14,9 @@ title: What is ArGaze? **ArGaze** provides an extensible modules library, allowing to select application-specific algorithms at each pipeline step: -* **Fixation/Saccade identification**: dispersion threshold identification, velocity threshold identification, ... -* **Area Of Interest (AOI) matching**: focus point inside, deviation circle coverage, ... -* **Scan path analysis**: transition matrix, entropy, explore/exploit ratio, ... +* **Fixation/Saccade identification**: dispersion threshold identification, velocity threshold identification, etc. +* **Area Of Interest (AOI) matching**: focus point inside, deviation circle coverage, etc. +* **Scan path analysis**: transition matrix, entropy, explore/exploit ratio, etc. Once the incoming data is formatted as required, all those gaze analysis features can be used with any screen-based eye tracker devices. diff --git a/docs/user_guide/utils/ready-made_scripts.md b/docs/user_guide/utils/ready-made_scripts.md index 92a4502..a7b3057 100644 --- a/docs/user_guide/utils/ready-made_scripts.md +++ b/docs/user_guide/utils/ready-made_scripts.md @@ -17,6 +17,35 @@ Load and execute any ArContext from a JSON CONFIGURATION file python -m argaze CONFIGURATION ``` +### Send command + +Use -p option to enable pipe communication at given address: + +```shell +python -m argaze post_processing_context.json -p /tmp/argaze +``` + +Then, in another console window, 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 +``` + ## 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. |