aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md
blob: ad8ee74d08f2f1cf639277d67ed9fd86e34e81cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
Describe 2D AOI
================

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)

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 AOI spatial values must be given in **pixels**.

### Edit SVG file description

SVG file format could be exported from most vector graphics editors.

``` xml
<svg>
    <path id="GeoSector" d="M860,160L1380,100L1660,400L1380,740L1440,960L920,920L680,800L640,560L860,160Z"/>
    <rect id="LeftPanel" x="0" y="0" width="350" height="1080"/>
    <circle id="CircularWidget" cx="1800" cy="120" r="80"/>
</svg>
```

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.

### Edit JSON file description

JSON file format allows to describe AOI.

``` json
{
    "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
        }
    }
}
```