aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/advanced_topics
diff options
context:
space:
mode:
authorThéo de la Hogue2024-03-11 16:29:09 +0100
committerThéo de la Hogue2024-03-11 16:29:09 +0100
commitf56b287d251afd65e74757c85ff5c78517fa1595 (patch)
tree22cb8405857caa3202775f8728120cc5ba0e8689 /docs/user_guide/gaze_analysis_pipeline/advanced_topics
parent9943b930ec42556bd60e8bb33d56d1ab4a9638b3 (diff)
downloadargaze-f56b287d251afd65e74757c85ff5c78517fa1595.zip
argaze-f56b287d251afd65e74757c85ff5c78517fa1595.tar.gz
argaze-f56b287d251afd65e74757c85ff5c78517fa1595.tar.bz2
argaze-f56b287d251afd65e74757c85ff5c78517fa1595.tar.xz
Harmonizing name of methods returning a boolean status.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/advanced_topics')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md2
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md12
2 files changed, 7 insertions, 7 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md
index 9e0ec4c..4d80c05 100644
--- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md
@@ -37,7 +37,7 @@ Here is an extract from the JSON ArFrame configuration file where a [Linear Regr
...
# If calibration process started
- if ar_frame.gaze_position_calibrator.calibrating:
+ if ar_frame.gaze_position_calibrator.is_calibrating():
# Store calibration data
ar_frame.gaze_position_calibrator.store(timestamp, observed_gaze_position, expected_gaze_position)
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.