diff options
author | Théo de la Hogue | 2023-08-28 15:23:00 +0200 |
---|---|---|
committer | Théo de la Hogue | 2023-08-28 15:23:00 +0200 |
commit | 4358c40d358c811a46b3ec5325d9475c887c4b9e (patch) | |
tree | 8adc5ef53d618b22868cd229c4acc5c487655dc1 /docs/user_guide/gaze_analysis_pipeline/gaze_analysis_logging.md | |
parent | 4e839f353700011457f52b305312ddf0217069a9 (diff) | |
download | argaze-4358c40d358c811a46b3ec5325d9475c887c4b9e.zip argaze-4358c40d358c811a46b3ec5325d9475c887c4b9e.tar.gz argaze-4358c40d358c811a46b3ec5325d9475c887c4b9e.tar.bz2 argaze-4358c40d358c811a46b3ec5325d9475c887c4b9e.tar.xz |
Fixing documentation linking.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/gaze_analysis_logging.md')
-rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/gaze_analysis_logging.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/gaze_analysis_logging.md b/docs/user_guide/gaze_analysis_pipeline/gaze_analysis_logging.md index d79e3a6..422b43b 100644 --- a/docs/user_guide/gaze_analysis_pipeline/gaze_analysis_logging.md +++ b/docs/user_guide/gaze_analysis_pipeline/gaze_analysis_logging.md @@ -1,11 +1,11 @@ Log gaze analysis ================= -[ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) and [ArLayer](../../../argaze/#argaze.ArFeatures.ArLayer) logging are optional pipeline steps. They are executed at each new scan path step to update logs. +[ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) and [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) logging are optional pipeline steps. They are executed at each new scan path step to update logs. ## Enable ArFrame and ArLayer logging -[ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) and [ArLayer](../../../argaze/#argaze.ArFeatures.ArLayer) have a log attribute to enable analysis logging. +[ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) and [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) have a log attribute to enable analysis logging. Here is the JSON ArFrame configuration file example where logging is enabled for the ArFrame and for one ArLayer: @@ -46,9 +46,9 @@ for layer_name, layer in ar_frame.layers.items(): ``` !!! note - [ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) and its [ArLayers](../../../argaze/#argaze.ArFeatures.ArLayer) logging are automatically done each time the [ArFrame.look](../../../argaze/#argaze.ArFeatures.ArFrame.look) method is called. - [ArFrame](../../../argaze/#argaze.ArFeatures.ArFrame) logging records each scan path analysis into a dedicated timestamped data buffer each time a new scan path step happens. - [ArLayer](../../../argaze/#argaze.ArFeatures.ArLayer) logging records each AOI scan path analysis into a dedicated timestamped data buffer each time a new AOI scan path step happens. + [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) and its [ArLayers](../../argaze.md/#argaze.ArFeatures.ArLayer) logging are automatically done each time the [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method is called. + [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) logging records each scan path analysis into a dedicated timestamped data buffer each time a new scan path step happens. + [ArLayer](../../argaze.md/#argaze.ArFeatures.ArLayer) logging records each AOI scan path analysis into a dedicated timestamped data buffer each time a new AOI scan path step happens. ## Export gaze analysis logs to CSV file @@ -74,7 +74,7 @@ for layer_name, layer in ar_frame.layers.items(): ``` -Assuming that [ArGaze.GazeAnalysis.Basic](../../../argaze/#argaze.GazeAnalysis.Basic) scan path analysis module is enabled for 'My FullHD screen' ArFrame, a ***My FullHD screen_argaze.GazeAnalysis.Basic.csv*** file would be created: +Assuming that [ArGaze.GazeAnalysis.Basic](../../argaze.md/#argaze.GazeAnalysis.Basic) scan path analysis module is enabled for 'My FullHD screen' ArFrame, a ***My FullHD screen_argaze.GazeAnalysis.Basic.csv*** file would be created: |timestamped|path_duration|step_fixation_durations_average|steps_number| |:----------|:------------|:------------------------------|:-----------| @@ -86,7 +86,7 @@ Assuming that [ArGaze.GazeAnalysis.Basic](../../../argaze/#argaze.GazeAnalysis.B |7719 |6050 |652.8 |7 | |... |... |... |... | -Assuming that [ArGaze.GazeAnalysis.NGram](../../../argaze/#argaze.GazeAnalysis.NGram) AOI scan path analysis module is enabled for 'MyLayer' ArLayer, a ***My FullHD screen_MyLayer_argaze.GazeAnalysis.NGram.csv*** file would be created: +Assuming that [ArGaze.GazeAnalysis.NGram](../../argaze.md/#argaze.GazeAnalysis.NGram) AOI scan path analysis module is enabled for 'MyLayer' ArLayer, a ***My FullHD screen_MyLayer_argaze.GazeAnalysis.NGram.csv*** file would be created: |timestamped|ngrams_count| |:----------|:-----------| |