From f56b287d251afd65e74757c85ff5c78517fa1595 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Mon, 11 Mar 2024 16:29:09 +0100 Subject: Harmonizing name of methods returning a boolean status. --- .../gaze_analysis_pipeline/advanced_topics/scripting.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md') 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 11e561e..4935847 100644 --- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md +++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md @@ -80,7 +80,7 @@ Calling [ArFrame.look](../../../argaze.md/#argaze.ArFeatures.ArFrame.look) metho ... ar_frame.last_gaze_position # Check if a gaze movement has been identified - if ar_frame.last_gaze_movement and ar_frame.last_gaze_movement.finished: + if ar_frame.last_gaze_movement and ar_frame.last_gaze_movement.is_finished(): # Do something with identified fixation if GazeFeatures.is_fixation(ar_frame.last_gaze_movement): @@ -93,7 +93,7 @@ Calling [ArFrame.look](../../../argaze.md/#argaze.ArFeatures.ArFrame.look) metho ... # Do something with scan path analysis - if ar_frame.analysis_available: + if ar_frame.is_analysis_available(): for scan_path_analyzer_name, scan_path_analysis in ar_frame.analysis(): @@ -105,7 +105,7 @@ Calling [ArFrame.look](../../../argaze.md/#argaze.ArFeatures.ArFrame.look) metho # Do something with last looked aoi name ... ar_frame.last_looked_aoi_name - if ar_layer.analysis_available: + if ar_layer.is_analysis_available(): for aoi_scan_path_analyzer_name, aoi_scan_path_analysis in ar_layer.analysis(): @@ -132,9 +132,9 @@ In that case, the last gaze movement *finished* flag is false. Then, the last 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. -### *ar_frame.analysis_available* +### *ar_frame.is_analysis_available()* -This flag allows to know when new scan path analysis are available. +This method allows to know when new scan path analysis are available. ### *ar_frame.analysis()* @@ -144,7 +144,7 @@ This an iterator to access to all scan path analysis. The name of the last aoi matching done by [AoiMatcher](../../../argaze.md/#argaze.GazeFeatures.AoiMatcher) if one is instanciated else, it is a None value. -### *ar_layer.analysis_available* +### *ar_layer.is_analysis_available()* This flag allows to know when new aoi scan path analysis are available. -- cgit v1.1