aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md
blob: 39268b755476b079a280670bd00c04c87f786a83 (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
58
59
60
61
62
Scan path analyzers
===================

ArGaze provides ready-to-use scan path analysis algorithms.

!!! note "Definition"
	A [ScanPath](../../../argaze.md/#argaze.GazeFeatures.ScanPath) is defined as a list of [ScanSteps](../../../argaze.md/#argaze.GazeFeatures.ScanStep) made by a fixation and a consecutive saccade.

The JSON samples have to be included inside [ArFrame configuration](../configuration_and_execution.md) *scan_path_analyzers* entry to select an algorithm.

```json
"scan_path_analyzers": {
	JSON sample
}
```

Read more about [ScanPathAnalyzer base class in code reference](../../../argaze.md/#argaze.GazeFeatures.ScanPathAnalyzer).

!!! note

	The members indicated as **property** are what returns the analyzer.

## Basic metrics

::: argaze.GazeAnalysis.Basic.ScanPathAnalyzer

### JSON sample

```json
"argaze.GazeAnalysis.Basic.ScanPathAnalyzer": {}
```

## Explore/Exploit ratio

::: argaze.GazeAnalysis.ExploreExploitRatio.ScanPathAnalyzer

### JSON sample

```json
"argaze.GazeAnalysis.ExploreExploitRatio.ScanPathAnalyzer": {
	"short_fixation_duration_threshold": 0
}
```

## K coefficient

::: argaze.GazeAnalysis.KCoefficient.ScanPathAnalyzer

### JSON sample

```json
"argaze.GazeAnalysis.KCoefficient.ScanPathAnalyzer": {}
```

## Nearest neighbor index

::: argaze.GazeAnalysis.NearestNeighborIndex.ScanPathAnalyzer

### JSON sample
```json
"argaze.GazeAnalysis.NearestNeighborIndex.ScanPathAnalyzer": {}
```