diff options
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md')
| -rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md | 54 |
1 files changed, 28 insertions, 26 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md index ed8a5d1..a307147 100644 --- a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md +++ b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md @@ -7,28 +7,30 @@ The [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) class defines a rectan ## Load JSON configuration file -An [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) pipeline can be loaded from a JSON configuration file thanks to [argaze.load](../../argaze.md/#argaze.load) package method. +An [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) pipeline can be loaded from a JSON configuration file thanks to the [argaze.load](../../argaze.md/#argaze.load) package method. Here is a simple JSON [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) configuration file example: ```json { - "name": "My FullHD screen", - "size": [1920, 1080], - "gaze_movement_identifier": { - "argaze.GazeAnalasis.DispersionThresholdIdentification.GazeMovementIdentifier": { - "deviation_max_threshold": 50, - "duration_min_threshold": 200 + "argaze.ArFeatures.ArFrame": { + "name": "My FullHD screen", + "size": [1920, 1080], + "gaze_movement_identifier": { + "argaze.GazeAnalysis.DispersionThresholdIdentification.GazeMovementIdentifier": { + "deviation_max_threshold": 50, + "duration_min_threshold": 200 + } + }, + "scan_path": { + "duration_max": 30000 + }, + "scan_path_analyzers": { + "argaze.GazeAnalysis.Basic.ScanPathAnalyzer": {}, + "argaze.GazeAnalysis.ExploreExploitRatio.ScanPathAnalyzer": { + "short_fixation_duration_threshold": 0 + } } - }, - "scan_path": { - "duration_max": 30000 - }, - "scan_path_analyzers": { - "argaze.GazeAnalasis.Basic.ScanPathAnalyzer": {}, - "argaze.GazeAnalasis.ExploreExploitRatio.ScanPathAnalyzer": { - "short_fixation_duration_threshold": 0 - } } } ``` @@ -49,7 +51,7 @@ Now, let's understand the meaning of each JSON entry. ### *name* -The name of the [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame). Basically useful for visualisation purpose. +The name of the [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame). Basically useful for visualization purposes. ### *size* @@ -107,18 +109,18 @@ Timestamped gaze positions have to be passed one by one to [ArFrame.look](../../ # Assuming that timestamped gaze positions are available ... - try: + try: - # Look ArFrame at a timestamped gaze position - ar_frame.look(timestamped_gaze_position) + # Look ArFrame at a timestamped gaze position + ar_frame.look(timestamped_gaze_position) - # Do something with pipeline exception - except Exception as e: - - ... + # Do something with pipeline exception + except Exception as e: + + ... ``` !!! note "" - At this point, the [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method only process gaze movement identification and scan path analysis without any AOI neither any recording or visualisation supports. + At this point, the [ArFrame.look](../../argaze.md/#argaze.ArFeatures.ArFrame.look) method only process gaze movement identification and scan path analysis without any AOI neither any recording or visualization supports. - Read the next chapters to learn how to [describe AOI](aoi_2d_description.md), [add AOI analysis](aoi_analysis.md), [record gaze analysis](recording.md) and [visualize pipeline steps](visualisation.md).
\ No newline at end of file + Read the next chapters to learn how to [describe AOI](aoi_2d_description.md), [add AOI analysis](aoi_analysis.md), [record gaze analysis](recording.md) and [visualize pipeline steps](visualization.md).
\ No newline at end of file |