From f141200ca4edc72815a0e7bb47eab89f7cd83512 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Tue, 15 Aug 2023 16:22:12 +0200 Subject: Replacing __str__ representation by letter_sequence property. --- docs/user_guide/gaze_analysis/scan_path.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/user_guide/gaze_analysis/scan_path.md') diff --git a/docs/user_guide/gaze_analysis/scan_path.md b/docs/user_guide/gaze_analysis/scan_path.md index 60e9d31..fba0524 100644 --- a/docs/user_guide/gaze_analysis/scan_path.md +++ b/docs/user_guide/gaze_analysis/scan_path.md @@ -132,18 +132,18 @@ lzc_analyzer = LempelZivComplexity.AOIScanPathAnalyzer() The [AOIScanPath](../../../argaze/#argaze.GazeFeatures.AOIScanPath) class provides some advanced features to analyse it. -#### String representation +#### Letter sequence When a new [AOIScanStep](../../../argaze/#argaze.GazeFeatures.AOIScanStep) is created, the [AOIScanPath](../../../argaze/#argaze.GazeFeatures.AOIScanPath) internally affects a unique letter index related to its AOI to ease pattern analysis. -Then, the [AOIScanPath str](../../../argaze/#argaze.GazeFeatures.AOIScanPath.__str__) representation returns the concatenation of each [AOIScanStep](../../../argaze/#argaze.GazeFeatures.AOIScanStep) letter. +Then, the [AOIScanPath letter_sequence](../../../argaze/#argaze.GazeFeatures.AOIScanPath.letter_sequence) property returns the concatenation of each [AOIScanStep](../../../argaze/#argaze.GazeFeatures.AOIScanStep) letter. The [AOIScanPath get_letter_aoi](../../../argaze/#argaze.GazeFeatures.AOIScanPath.get_letter_aoi) method helps to get back the AOI related to a letter index. ``` python # Assuming the following AOI scan path is built: Foo > Bar > Shu > Foo aoi_scan_path = ... -# String representation should be: 'ABCA' -print(str(aoi_scan_path)) +# Letter sequence representation should be: 'ABCA' +print(aoi_scan_path.letter_sequence) # Output should be: 'Bar' print(aoi_scan_path.get_letter_aoi('B')) -- cgit v1.1