diff options
| author | Théo de la Hogue | 2024-01-29 17:42:48 +0100 |
|---|---|---|
| committer | Théo de la Hogue | 2024-01-29 17:42:48 +0100 |
| commit | c9d22c293cc7d6862125e4653ca195f9b6850d23 (patch) | |
| tree | 4d9a5951e62ad3e0c09e5a75569d56f64ce52874 | |
| parent | e0344a225e8bb636da9678942b582b2658ae97aa (diff) | |
| download | argaze-c9d22c293cc7d6862125e4653ca195f9b6850d23.zip argaze-c9d22c293cc7d6862125e4653ca195f9b6850d23.tar.gz argaze-c9d22c293cc7d6862125e4653ca195f9b6850d23.tar.bz2 argaze-c9d22c293cc7d6862125e4653ca195f9b6850d23.tar.xz | |
Fixing scripting documentation.
| -rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md | 14 |
1 files changed, 7 insertions, 7 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 e206a96..7952e9f 100644 --- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md +++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md @@ -121,20 +121,20 @@ Let's understand the meaning of each data. ### *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 given [GazePosition](../../../argaze.md/#argaze.GazeFeatures.GazePosition). +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* -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). +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 [UnvalidGazeMovement](../../../argaze.md/#argaze.GazeFeatures.UnvalidGazeMovement). 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. +In that case, the last 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. +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* -This flag allows to now when new scan path analysis are available. +This flag allows to know when new scan path analysis are available. ### *ar_frame.analysis()* @@ -142,11 +142,11 @@ This an iterator to access to all scan path analysis. ### *ar_layer.last_looked_aoi_name* -The name of the last aoi matching a gaze movement returned by [AoiMatcher](../../../argaze.md/#argaze.GazeFeatures.AoiMatcher) if one is instanciated else, it is a None value. +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* -This flag allows to now when new aoi scan path analysis are available. +This flag allows to know when new aoi scan path analysis are available. ### *ar_layer.analysis()* |