diff options
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md')
| -rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md | 22 |
1 files changed, 11 insertions, 11 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 4935847..19d277f 100644 --- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md +++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md @@ -74,21 +74,21 @@ Calling [ArFrame.look](../../../argaze.md/#argaze.ArFeatures.ArFrame.look) metho try: # Look ArFrame at a timestamped gaze position - ar_frame.look(timestamp, gaze_position): + ar_frame.look(timestamped_gaze_position): # Do something with last gaze position - ... ar_frame.last_gaze_position + ... 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.is_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): + if GazeFeatures.is_fixation(ar_frame.last_gaze_movement()): ... # Do something with identified saccade - elif GazeFeatures.is_saccade(ar_frame.last_gaze_movement): + elif GazeFeatures.is_saccade(ar_frame.last_gaze_movement()): ... @@ -103,7 +103,7 @@ Calling [ArFrame.look](../../../argaze.md/#argaze.ArFeatures.ArFrame.look) metho for layer_name, ar_layer in ar_frame.layers.items(): # Do something with last looked aoi name - ... ar_frame.last_looked_aoi_name + ... ar_frame.last_looked_aoi_name() if ar_layer.is_analysis_available(): @@ -119,11 +119,11 @@ Calling [ArFrame.look](../../../argaze.md/#argaze.ArFeatures.ArFrame.look) metho Let's understand the meaning of each data. -### *ar_frame.last_gaze_position* +### *ar_frame.last_gaze_position()* This is the last calibrated [GazePosition](../../../argaze.md/#argaze.GazeFeatures.GazePosition) returned by [GazePositionCalibrator](../../../argaze.md/#argaze.GazeFeatures.GazePositionCalibrator) if one is instanciated else, it is the last given [GazePosition](../../../argaze.md/#argaze.GazeFeatures.GazePosition). -### *ar_frame.last_gaze_movement* +### *ar_frame.last_gaze_movement()* Last [GazeMovement](../../../argaze.md/#argaze.GazeFeatures.GazeMovement) 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 empty [GazeMovement](../../../argaze.md/#argaze.GazeFeatures.GazeMovement). @@ -134,19 +134,19 @@ Then, the last gaze movement type can be tested thanks to [GazeFeatures.is_fixat ### *ar_frame.is_analysis_available()* -This method allows to know when new scan path analysis are available. +To know when new scan path analysis is available. ### *ar_frame.analysis()* This an iterator to access to all scan path analysis. -### *ar_layer.last_looked_aoi_name* +### *ar_layer.last_looked_aoi_name()* 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.is_analysis_available()* -This flag allows to know when new aoi scan path analysis are available. +To know when new aoi scan path analysis is available. ### *ar_layer.analysis()* |