From 8f2b87bfec622dd32e90d9bfa17dfcda42add4fe Mon Sep 17 00:00:00 2001
From: Theo De La Hogue
Date: Mon, 25 Sep 2023 14:45:52 +0200
Subject: Improving AOI description documentation.
---
.../gaze_analysis_pipeline/aoi_2d_description.md | 70 ++++++++++++++++++++++
1 file changed, 70 insertions(+)
create mode 100644 docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
(limited to 'docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md')
diff --git a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
new file mode 100644
index 0000000..b2f0b90
--- /dev/null
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
@@ -0,0 +1,70 @@
+Describe 2D AOI
+===============
+
+Once [frame is configured](configuration_and_execution.md), areas of interest need to be described into the same 2D referential.
+
+![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:
+
+* +X is pointing to the right,
+* +Y is pointing to the downward.
+
+!!! warning
+ All AOIs spatial values must be given in **pixels**.
+
+### Edit SVG file description
+
+SVG file format could be exported from most vector graphics editors.
+
+``` xml
+
+```
+
+Here are common SVG file features needed to describe AOIs:
+
+* *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)
+* *rect* and *circle* allow respectively to describe rectangular and circle AOI.
+
+### Edit JSON file description
+
+JSON file format allows to describe AOIs.
+
+``` 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
+ },
+ "RedSquare": {
+ "shape": "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
+ },
+ "PinkCircle": {
+ "shape": "circle",
+ "cx": 1902.02,
+ "cy": 879.316,
+ "radius": 195.313
+ }
+}
+```
--
cgit v1.1
From 12ae7e20aba323624d360567ea424ac2d315fbc7 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Tue, 26 Sep 2023 10:47:43 +0200
Subject: Harmonizing AOI/aoi without s at the end.
---
.../gaze_analysis_pipeline/aoi_2d_description.md | 52 ++++++++++++----------
1 file changed, 28 insertions(+), 24 deletions(-)
(limited to 'docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md')
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.
```
-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
+ }
}
}
```
--
cgit v1.1
From 128ca5fb2d5124784e217f3137bcde8eb0e7446c Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Tue, 26 Sep 2023 11:49:55 +0200
Subject: Harmonizing documentation concepts.
---
docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md')
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 6cca7ce..7229a9d 100644
--- a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
@@ -1,7 +1,7 @@
Describe 2D AOI
================
-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.
+Once [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) is [configured](configuration_and_execution.md), [areas of interest (AOI)](../../argaze.md/#argaze.AreaOfInterest.AOIFeatures.AreaOfInterest) need to be described to know what is looked in frame.
![2D AOI description](../../img/aoi_2d_description.png)
--
cgit v1.1
From 69bcadf8f7b969ddd0fb284e86788cd658b897ab Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Tue, 26 Sep 2023 12:28:34 +0200
Subject: Updating JSON AOI 2D description documentation.
---
.../gaze_analysis_pipeline/aoi_2d_description.md | 39 ++++++----------------
1 file changed, 11 insertions(+), 28 deletions(-)
(limited to 'docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md')
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 7229a9d..0d5dbf0 100644
--- a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
@@ -19,11 +19,9 @@ SVG file format could be exported from most vector graphics editors.
``` xml
```
@@ -39,36 +37,21 @@ JSON file format allows to describe AOI.
``` json
{
- "Triangle" : [[1288.1, 189.466], [1991.24, 3399.34], [584.958, 3399.34]],
- "BlueRectangle": {
- "Rectangle": {
- "x": 1257,
- "y": 1905.18,
- "width": 604.169,
- "height": 988.564
- }
- },
+ "BlueTriangle":[[960, 664], [1113, 971], [806, 971]],
"RedSquare": {
"Rectangle": {
- "x": 623.609,
- "y": 658.357,
- "width": 803.15,
- "height": 803.15
+ "x": 268,
+ "y": 203,
+ "width": 308,
+ "height": 308
}
},
"GreenCircle": {
"Circle": {
- "cx": 675.77,
- "cy": 2163.5,
- "radius": 393.109
+ "cx": 1497,
+ "cy": 356,
+ "radius": 153
}
- },
- "PinkCircle": {
- "Circle": {
- "cx": 1902.02,
- "cy": 879.316,
- "radius": 195.313
- }
}
}
```
--
cgit v1.1
From fbf4c80b9e7dabb6e2bbcb94df44e627de5646dc Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 27 Sep 2023 18:02:34 +0200
Subject: Updating illustrations.
---
.../gaze_analysis_pipeline/aoi_2d_description.md | 26 +++++++++++-----------
1 file changed, 13 insertions(+), 13 deletions(-)
(limited to 'docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md')
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 0d5dbf0..ad8ee74 100644
--- a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
@@ -19,9 +19,9 @@ SVG file format could be exported from most vector graphics editors.
``` xml
```
@@ -37,20 +37,20 @@ JSON file format allows to describe AOI.
``` json
{
- "BlueTriangle":[[960, 664], [1113, 971], [806, 971]],
- "RedSquare": {
+ "GeoSector": [[860, 160], [1380, 100], [1660, 400], [1380, 740], [1440, 960], [920, 920], [680, 800], [640, 560]],
+ "LeftPanel": {
"Rectangle": {
- "x": 268,
- "y": 203,
- "width": 308,
- "height": 308
+ "x": 0,
+ "y": 0,
+ "width": 350,
+ "height": 1080
}
},
- "GreenCircle": {
+ "CircularWidget": {
"Circle": {
- "cx": 1497,
- "cy": 356,
- "radius": 153
+ "cx": 1800,
+ "cy": 120,
+ "radius": 80
}
}
}
--
cgit v1.1
From c12e429190b4f63064c81edfa08fb00b8ed8a28c Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Thu, 28 Sep 2023 23:31:33 +0200
Subject: Improving documentation details.
---
docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md')
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 ad8ee74..4b7ed69 100644
--- a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
+++ b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
@@ -29,7 +29,7 @@ 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)
-* *rect* and *circle* allow respectively to describe rectangular and circle AOI.
+* *rect*, *circle* and *ellipse* allow respectively to describe rectangular, circular and elliptic AOI.
### Edit JSON file description
--
cgit v1.1