diff options
| author | Théo de la Hogue | 2023-09-06 17:50:31 +0200 |
|---|---|---|
| committer | Théo de la Hogue | 2023-09-06 17:50:31 +0200 |
| commit | 5a2f3b420303db6df3f9e68abcfb9bb937b6ccd7 (patch) | |
| tree | cae05652f4a07eaefc4ebb403d73f6382893a884 /docs/user_guide/gaze_analysis_pipeline | |
| parent | e1803530ca3b07dc0f2fdce68805e44195e38fa3 (diff) | |
| download | argaze-5a2f3b420303db6df3f9e68abcfb9bb937b6ccd7.zip argaze-5a2f3b420303db6df3f9e68abcfb9bb937b6ccd7.tar.gz argaze-5a2f3b420303db6df3f9e68abcfb9bb937b6ccd7.tar.bz2 argaze-5a2f3b420303db6df3f9e68abcfb9bb937b6ccd7.tar.xz | |
More work on ArUco markers pipeline documentation.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline')
| -rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md | 4 | ||||
| -rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/ar_layer.md | 7 |
2 files changed, 3 insertions, 8 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md b/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md index cdc7fe0..d649a4b 100644 --- a/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md +++ b/docs/user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md @@ -9,7 +9,7 @@ The [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) class defines a rectan The [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) internal pipeline is entirely customizable from a JSON configuration file thanks to [ArFrame.from_json](../../argaze.md/#argaze.ArFeatures.ArFrame.from_json) class method. -Here is a simple JSON ArFrame configuration file example: +Here is a simple JSON [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) configuration file example: ```json { @@ -50,7 +50,7 @@ The name of the [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame). Basically ### Size -The size of the [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) defines the dimension of the rectangular area where gaze positions are projected. Be aware that gaze positions have to be in the same range of value. +The size of the [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) defines the dimension of the rectangular area where gaze positions are projected. Be aware that gaze positions have to be in the same range of value to be projected in. !!! warning **ArGaze doesn't impose any spatial unit.** Gaze positions can either be integer or float, pixels, millimeters or what ever you need. The only concern is that all spatial values used in further configurations have to be all the same unit. diff --git a/docs/user_guide/gaze_analysis_pipeline/ar_layer.md b/docs/user_guide/gaze_analysis_pipeline/ar_layer.md index 893e50c..9261e97 100644 --- a/docs/user_guide/gaze_analysis_pipeline/ar_layer.md +++ b/docs/user_guide/gaze_analysis_pipeline/ar_layer.md @@ -18,7 +18,6 @@ Here is an extract from the JSON ArFrame configuration file with a sample where ... "layers": { "MyLayer": { - "aoi_color": [0, 0, 255], "aoi_scene" : { "upper_left_area": [[0, 0], [960, 0], [960, 540], [0, 540]], "upper_right_area": [[960, 0], [1920, 0], [1920, 540], [960, 540]], @@ -52,14 +51,10 @@ Here is an extract from the JSON ArFrame configuration file with a sample where Now, let's understand the meaning of each JSON entry. -### Name +### "MyLayer" The name of the [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer). Basically useful for visualisation purpose. -### AOI Color - -The color of [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer)'s AOI. Basically useful for visualisation purpose. - ### AOI Scene The [AOIScene](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.AOIScene) defines a set of 2D [AreaOfInterest](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.AreaOfInterest) registered by name. |