From 705c4bf4441c9b08847d97cd1d23e34b5381603a Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Mon, 8 Apr 2024 16:18:53 +0200 Subject: Fixing documentation --- docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md | 4 ++-- docs/user_guide/gaze_analysis_pipeline/introduction.md | 2 +- docs/user_guide/gaze_analysis_pipeline/visualisation.md | 2 +- src/argaze/DataFeatures.py | 4 ++-- 4 files changed, 6 insertions(+), 6 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 784a411..7fbbef0 100644 --- a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md +++ b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md @@ -119,6 +119,6 @@ Timestamped gaze positions have to be passed one by one to [ArFrame.look](../../ ``` !!! 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 logging 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 visualisation supports. - Read the next chapters to learn how to [describe AOI](aoi_2d_description.md), [add AOI analysis](aoi_analysis.md), [log gaze analysis](logging.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](visualisation.md). \ No newline at end of file diff --git a/docs/user_guide/gaze_analysis_pipeline/introduction.md b/docs/user_guide/gaze_analysis_pipeline/introduction.md index 16574e1..70cae71 100644 --- a/docs/user_guide/gaze_analysis_pipeline/introduction.md +++ b/docs/user_guide/gaze_analysis_pipeline/introduction.md @@ -14,7 +14,7 @@ To build your own gaze analysis pipeline, you need to know: * [How to describe AOI](aoi_2d_description.md), * [How to enable AOI analysis](aoi_analysis.md), * [How to visualize pipeline steps outputs](visualisation.md), -* [How to log resulted gaze analysis](logging.md), +* [How to record resulted gaze analysis](recording.md), * [How to make heatmap image](heatmap.md), * [How to add a background image](background.md). diff --git a/docs/user_guide/gaze_analysis_pipeline/visualisation.md b/docs/user_guide/gaze_analysis_pipeline/visualisation.md index b8156a5..a197f0c 100644 --- a/docs/user_guide/gaze_analysis_pipeline/visualisation.md +++ b/docs/user_guide/gaze_analysis_pipeline/visualisation.md @@ -113,4 +113,4 @@ if __name__ == '__main__': !!! note "Export to video file" - Video exportation is detailed in [gaze analysis logging chapter](logging.md). \ No newline at end of file + Video exportation is detailed in [gaze analysis recording chapter](recording.md). \ No newline at end of file diff --git a/src/argaze/DataFeatures.py b/src/argaze/DataFeatures.py index 19c45fe..7189001 100644 --- a/src/argaze/DataFeatures.py +++ b/src/argaze/DataFeatures.py @@ -75,11 +75,11 @@ def get_class(class_path: str) -> object: return m -def get_class_path(o: object): +def get_class_path(o: object) -> str: """Get 'path.to.class' class path from object. Parameters: - object: any object instance. + o: any object instance. Returns: class_path: object 'path.to.class' class. -- cgit v1.1