diff options
author | Théo de la Hogue | 2023-12-03 07:37:14 +0100 |
---|---|---|
committer | Théo de la Hogue | 2023-12-03 07:37:14 +0100 |
commit | 710d73e2afcc422f371a018628ac04684d8d88fd (patch) | |
tree | 4c482df4873be7d39152fcf7d4fee6d7961415ea /src/argaze/GazeFeatures.py | |
parent | aede4215c10ddfa7154099a40204460444011dff (diff) | |
download | argaze-710d73e2afcc422f371a018628ac04684d8d88fd.zip argaze-710d73e2afcc422f371a018628ac04684d8d88fd.tar.gz argaze-710d73e2afcc422f371a018628ac04684d8d88fd.tar.bz2 argaze-710d73e2afcc422f371a018628ac04684d8d88fd.tar.xz |
Minor fixes in documentation and annotation.
Diffstat (limited to 'src/argaze/GazeFeatures.py')
-rw-r--r-- | src/argaze/GazeFeatures.py | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/src/argaze/GazeFeatures.py b/src/argaze/GazeFeatures.py index 46e9f17..a4cf244 100644 --- a/src/argaze/GazeFeatures.py +++ b/src/argaze/GazeFeatures.py @@ -664,6 +664,7 @@ class ScanStep(): """Define a scan step as a fixation and a consecutive saccade. !!! warning + Scan step have to start by a fixation and then end by a saccade. """ @@ -874,8 +875,10 @@ class AOIScanStepError(Exception): @dataclass(frozen=True) class AOIScanStep(): """Define a aoi scan step as a set of successive gaze movements onto a same AOI. - .. warning:: - Aoi scan step have to start by a fixation and then end by a saccade.""" + + !!! warning + + Aoi scan step have to start by a fixation and then end by a saccade.""" movements: TimeStampedGazeMovements """All movements over an AOI and the last saccade that comes out.""" @@ -948,7 +951,11 @@ AOIScanPathType = TypeVar('AOIScanPathType', bound="AOIScanPathType") # Type definition for type annotation convenience class AOIScanPath(list): - """List of aoi scan steps over successive aoi.""" + """List of aoi scan steps over successive aoi. + + Parameters: + duration_max: duration from which older aoi scan steps are removed each time new aoi scan steps are added. 0 means no maximal duration. + """ def __init__(self, expected_aoi: list[str] = [], duration_max: int|float = 0): |