aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThéo de la Hogue2024-04-10 17:55:57 +0200
committerThéo de la Hogue2024-04-10 17:55:57 +0200
commit80183213819a8b8a67630181fdc8e1effea0456e (patch)
treeef240ee6360c34f2a07deb1d7c6a549177027805
parent0f3226984d8a8e334a5506c3b40021391fa5321d (diff)
downloadargaze-80183213819a8b8a67630181fdc8e1effea0456e.zip
argaze-80183213819a8b8a67630181fdc8e1effea0456e.tar.gz
argaze-80183213819a8b8a67630181fdc8e1effea0456e.tar.bz2
argaze-80183213819a8b8a67630181fdc8e1effea0456e.tar.xz
grammar and orthographic corrections
-rw-r--r--docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md2
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md12
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md88
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md2
4 files changed, 53 insertions, 51 deletions
diff --git a/docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md b/docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md
index 8726872..d5672ea 100644
--- a/docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md
+++ b/docs/user_guide/aruco_marker_pipeline/configuration_and_execution.md
@@ -66,7 +66,7 @@ with argaze.load('./configuration.json') as aruco_camera:
Now, let's understand the meaning of each JSON entry.
-### *argaze.ArUcoMarkers.ArUcoCamera.ArUcoCamera*
+### argaze.ArUcoMarkers.ArUcoCamera.ArUcoCamera
The loaded object class name.
diff --git a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
index 4b7ed69..9759c23 100644
--- a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
@@ -5,10 +5,10 @@ Once [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) is [configured](confi
![2D AOI description](../../img/aoi_2d_description.png)
-According common computer graphics coordinates convention, all AOI need to be described from a top left frame corner origin with a coordinate system where:
+According to common computer graphics coordinate convention, all AOI need to be described from a top left frame corner origin with a coordinate system where:
* +X is pointing to the right,
-* +Y is pointing to the downward.
+* +Y is pointing downward.
!!! warning
All AOI spatial values must be given in **pixels**.
@@ -25,15 +25,15 @@ SVG file format could be exported from most vector graphics editors.
</svg>
```
-Here are common SVG file features needed to describe AOI:
+Here are some common SVG file features needed to describe AOI:
-* *id* attribute indicates AOI name.
+* *id* attribute indicates an AOI name.
* *path* element describes any polygon using only [M, L and Z path intructions](https://www.w3.org/TR/SVG2/paths.html#PathData)
-* *rect*, *circle* and *ellipse* allow respectively to describe rectangular, circular and elliptic AOI.
+* *rect*, *circle* and *ellipse* allow, respectively, to describe rectangular, circular and elliptic AOI.
### Edit JSON file description
-JSON file format allows to describe AOI.
+JSON file format allows describing AOI.
``` json
{
diff --git a/docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md b/docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md
index fb69f88..fa7a71e 100644
--- a/docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_analysis.md
@@ -7,49 +7,51 @@ Once [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) is [configured](confi
## Add ArLayer to ArFrame JSON configuration file
-The [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) class defines a space where to make matching of fixations with AOI and inside which those matchings need to be analyzed.
+The [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) class defines a space where to match fixations with AOI and inside which those matches need to be analyzed.
Here is an extract from the JSON [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) configuration file with a sample where one layer is added:
```json
{
- "name": "My FullHD screen",
- "size": [1920, 1080],
- ...
- "layers": {
- "MyLayer": {
- "aoi_scene" : {
- "GeoSector": [[860, 160], [1380, 100], [1660, 400], [1380, 740], [1440, 960], [920, 920], [680, 800], [640, 560]],
- "LeftPanel": {
- "Rectangle": {
- "x": 0,
- "y": 0,
- "width": 350,
- "height": 1080
- }
- },
- "CircularWidget": {
- "Circle": {
- "cx": 1800,
- "cy": 120,
- "radius": 80
- }
- }
- },
- "aoi_matcher": {
- "argaze.GazeAnalysis.DeviationCircleCoverage.AOIMatcher": {
- "coverage_threshold": 0.5
- }
- },
- "aoi_scan_path": {
- "duration_max": 30000
- },
- "aoi_scan_path_analyzers": {
- "argaze.GazeAnalysis.Basic.AOIScanPathAnalyzer": {},
- "argaze.GazeAnalysis.TransitionMatrix.AOIScanPathAnalyzer": {},
- "argaze.GazeAnalysis.NGram.AOIScanPathAnalyzer": {
- "n_min": 3,
- "n_max": 5
+ "argaze.ArFeatures.ArFrame": {
+ "name": "My FullHD screen",
+ "size": [1920, 1080],
+ ...
+ "layers": {
+ "MyLayer": {
+ "aoi_scene" : {
+ "GeoSector": [[860, 160], [1380, 100], [1660, 400], [1380, 740], [1440, 960], [920, 920], [680, 800], [640, 560]],
+ "LeftPanel": {
+ "Rectangle": {
+ "x": 0,
+ "y": 0,
+ "width": 350,
+ "height": 1080
+ }
+ },
+ "CircularWidget": {
+ "Circle": {
+ "cx": 1800,
+ "cy": 120,
+ "radius": 80
+ }
+ }
+ },
+ "aoi_matcher": {
+ "argaze.GazeAnalysis.DeviationCircleCoverage.AOIMatcher": {
+ "coverage_threshold": 0.5
+ }
+ },
+ "aoi_scan_path": {
+ "duration_max": 30000
+ },
+ "aoi_scan_path_analyzers": {
+ "argaze.GazeAnalysis.Basic.AOIScanPathAnalyzer": {},
+ "argaze.GazeAnalysis.TransitionMatrix.AOIScanPathAnalyzer": {},
+ "argaze.GazeAnalysis.NGram.AOIScanPathAnalyzer": {
+ "n_min": 3,
+ "n_max": 5
+ }
}
}
}
@@ -59,7 +61,7 @@ Here is an extract from the JSON [ArFrame](../../argaze.md/#argaze.ArFeatures.Ar
!!! note
- Timestamped gaze movements identified by parent [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) are passed one by one to each [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer). So, the execution of all [ArLayers](../../argaze.md/#argaze.ArFeatures.ArLayer) is done during parent [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method call as explained in [previous chapter](configuration_and_execution.md).
+ Timestamped gaze movements identified by the parent [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) are passed one by one to each [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer). So, the execution of all [ArLayers](../../argaze.md/#argaze.ArFeatures.ArLayer) is done during the parent [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method call, as explained in the [previous chapter](configuration_and_execution.md).
Now, let's understand the meaning of each JSON entry.
@@ -79,7 +81,7 @@ The set of 2D AOI into the layer as defined at [2D AOI description chapter](aoi_
### *aoi_matcher*
-The first [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) pipeline step aims to make match identified gaze movement with a layer's AOI.
+The first [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) pipeline step aims to match identified gaze movement with the layer's AOI.
![AOI matcher](../../img/aoi_matcher.png)
@@ -92,7 +94,7 @@ In the example file, the chosen matching algorithm is the [Deviation Circle Cove
### *aoi_scan_path*
-The second [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) pipeline step aims to build a [AOIScanPath](../../argaze.md/#argaze.GazeFeatures.AOIScanPath) defined as a list of [AOIScanSteps](../../argaze.md/#argaze.GazeFeatures.AOIScanStep) made by a set of successive fixations/saccades onto a same AOI.
+The second [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) pipeline step aims to build an [AOIScanPath](../../argaze.md/#argaze.GazeFeatures.AOIScanPath) defined as a list of [AOIScanSteps](../../argaze.md/#argaze.GazeFeatures.AOIScanStep) made by a set of successive fixations/saccades onto the same AOI.
![AOI scan path](../../img/aoi_scan_path.png)
@@ -101,7 +103,7 @@ Once gaze movements are matched to AOI, they are automatically appended to the A
The [AOIScanPath.duration_max](../../argaze.md/#argaze.GazeFeatures.AOIScanPath.duration_max) attribute is the duration from which older AOI scan steps are removed each time new AOI scan steps are added.
!!! note "Optional"
- JSON *aoi_scan_path* entry is not mandatory. If aoi_scan_path_analyzers entry is not empty, the [AOIScanPath](../../argaze.md/#argaze.GazeFeatures.AOIScanPath) step is automatically enabled.
+ JSON *aoi_scan_path* entry is not mandatory. If *aoi_scan_path_analyzers* entry is not empty, the [AOIScanPath](../../argaze.md/#argaze.GazeFeatures.AOIScanPath) step is automatically enabled.
### *aoi_scan_path_analyzers*
@@ -109,4 +111,4 @@ Finally, the last [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) pipeline
Each analysis algorithm can be selected by instantiating a particular [AOIScanPathAnalyzer from the GazeAnalysis submodule](pipeline_modules/aoi_scan_path_analyzers.md) or [from another Python package](advanced_topics/module_loading.md).
-In the example file, the chosen analysis algorithms are the [Basic](../../argaze.md/#argaze.GazeAnalysis.Basic) module, the [TransitionMatrix](../../argaze.md/#argaze.GazeAnalysis.TransitionMatrix) module and the [NGram](../../argaze.md/#argaze.GazeAnalysis.NGram) module which has two specific *n_min* and *n_max* attributes.
+In the example file, the chosen analysis algorithms are the [Basic](../../argaze.md/#argaze.GazeAnalysis.Basic) module, the [TransitionMatrix](../../argaze.md/#argaze.GazeAnalysis.TransitionMatrix) module and the [NGram](../../argaze.md/#argaze.GazeAnalysis.NGram) module, which has two specific *n_min* and *n_max* attributes.
diff --git a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
index 13c1c22..7eba8a7 100644
--- a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
+++ b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
@@ -49,7 +49,7 @@ with argaze.load('./configuration.json') as ar_frame:
Now, let's understand the meaning of each JSON entry.
-### *argaze.ArFeatures.ArFrame*
+### argaze.ArFeatures.ArFrame
The loaded object class name.