AOI scan path analyzers
=======================

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

!!! note "Definition"
	An [AOIScanPath](../../../argaze.md/#argaze.GazeFeatures.AOIScanPath) defined as a list of [AOIScanSteps](../../../argaze.md/#argaze.GazeFeatures.AOIScanStep) made by a set of successive fixations/saccades onto a same AOI.

The JSON samples have to be included inside [ArLayer configuration](../aoi_analysis.md) *aoi_scan_path_analyzers* entry to select an algorithm.

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

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

!!! note

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

## Basic metrics

::: argaze.GazeAnalysis.Basic.AOIScanPathAnalyzer

### JSON sample

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

## Entropy

::: argaze.GazeAnalysis.Entropy.AOIScanPathAnalyzer

### JSON sample

```json
"argaze.GazeAnalysis.Entropy.AOIScanPathAnalyzer": {}
```

## K-modified coefficient

::: argaze.GazeAnalysis.KCoefficient.AOIScanPathAnalyzer

### JSON sample

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

## Lempel-Ziv complexity

::: argaze.GazeAnalysis.LempelZivComplexity.AOIScanPathAnalyzer

### JSON sample

```json
"argaze.GazeAnalysis.LempelZivComplexity.AOIScanPathAnalyzer": {}
```

## N-Gram

::: argaze.GazeAnalysis.NGram.AOIScanPathAnalyzer

### JSON sample

```json
"argaze.GazeAnalysis.NGram.AOIScanPathAnalyzer": {
	"n_min": 3,
	"n_max": 5
}
```

## Transition matrix

::: argaze.GazeAnalysis.TransitionMatrix.AOIScanPathAnalyzer

### JSON sample

```json
"argaze.GazeAnalysis.TransitionMatrix.AOIScanPathAnalyzer": {}
```