aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThéo de la Hogue2023-09-19 15:47:51 +0200
committerThéo de la Hogue2023-09-19 15:47:51 +0200
commit62e6c081b26141add3d2b6fe2a335f7e14cee861 (patch)
tree2feadd0c76d1aac6f2dc54e8692222b6ca8cffa9 /docs
parent9726f081357c64937377385a29139b7cfe50a898 (diff)
downloadargaze-62e6c081b26141add3d2b6fe2a335f7e14cee861.zip
argaze-62e6c081b26141add3d2b6fe2a335f7e14cee861.tar.gz
argaze-62e6c081b26141add3d2b6fe2a335f7e14cee861.tar.bz2
argaze-62e6c081b26141add3d2b6fe2a335f7e14cee861.tar.xz
Replacing filter_in_progress_fixation by filter_in_progress_identification.
Diffstat (limited to 'docs')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
index 2db69fc..81efa40 100644
--- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
@@ -110,7 +110,7 @@ Let's understand the meaning of each returned data.
A [GazeMovement](../../../argaze.md/#argaze.GazeFeatures.GazeMovement) once it have been identified by [ArFrame.gaze_movement_identifier](../../../argaze.md/#argaze.ArFeatures.ArFrame) object from incoming consecutive timestamped gaze positions. If no gaze movement have been identified, it returns an [UnvalidGazeMovement](../../../argaze.md/#argaze.GazeFeatures.UnvalidGazeMovement).
-This could also be the current gaze movement if [ArFrame.filter_in_progress_fixation](../../../argaze.md/#argaze.ArFeatures.ArFrame) attribute is false.
+This could also be the current gaze movement if [ArFrame.filter_in_progress_identification](../../../argaze.md/#argaze.ArFeatures.ArFrame) attribute is false.
In that case, the returned gaze movement *finished* flag is false.
Then, the returned gaze movement type can be tested thanks to [GazeFeatures.is_fixation](../../../argaze.md/#argaze.GazeFeatures.is_fixation) and [GazeFeatures.is_saccade](../../../argaze.md/#argaze.GazeFeatures.is_saccade) functions.