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