aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md52
1 files changed, 28 insertions, 24 deletions
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 b2f0b90..6cca7ce 100644
--- a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
@@ -1,17 +1,17 @@
Describe 2D AOI
-===============
+================
-Once [frame is configured](configuration_and_execution.md), areas of interest need to be described into the same 2D referential.
+Once [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) is [configured](configuration_and_execution.md), areas of interest need to be described to know what is looked in frame.
![2D AOI description](../../img/aoi_2d_description.png)
-According a common computer graphics coordinates convention, all AOIs need to be described from a top left frame corner origin in a coordinate system where:
+According common computer graphics coordinates 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.
!!! warning
- All AOIs spatial values must be given in **pixels**.
+ All AOI spatial values must be given in **pixels**.
### Edit SVG file description
@@ -27,7 +27,7 @@ SVG file format could be exported from most vector graphics editors.
</svg>
```
-Here are common SVG file features needed to describe AOIs:
+Here are common SVG file features needed to describe AOI:
* *id* attribute indicates AOI name.
* *path* element describes any polygon using only [M, L and Z path intructions](https://www.w3.org/TR/SVG2/paths.html#PathData)
@@ -35,36 +35,40 @@ Here are common SVG file features needed to describe AOIs:
### Edit JSON file description
-JSON file format allows to describe AOIs.
+JSON file format allows to describe AOI.
``` json
{
"Triangle" : [[1288.1, 189.466], [1991.24, 3399.34], [584.958, 3399.34]],
"BlueRectangle": {
- "shape": "rectangle",
- "x": 1257,
- "y": 1905.18,
- "width": 604.169,
- "height": 988.564
+ "Rectangle": {
+ "x": 1257,
+ "y": 1905.18,
+ "width": 604.169,
+ "height": 988.564
+ }
},
"RedSquare": {
- "shape": "rectangle",
- "x": 623.609,
- "y": 658.357,
- "width": 803.15,
- "height": 803.15
+ "Rectangle": {
+ "x": 623.609,
+ "y": 658.357,
+ "width": 803.15,
+ "height": 803.15
+ }
},
"GreenCircle": {
- "shape": "circle",
- "cx": 675.77,
- "cy": 2163.5,
- "radius": 393.109
+ "Circle": {
+ "cx": 675.77,
+ "cy": 2163.5,
+ "radius": 393.109
+ }
},
"PinkCircle": {
- "shape": "circle",
- "cx": 1902.02,
- "cy": 879.316,
- "radius": 195.313
+ "Circle": {
+ "cx": 1902.02,
+ "cy": 879.316,
+ "radius": 195.313
+ }
}
}
```