aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis
diff options
context:
space:
mode:
authorThéo de la Hogue2023-08-15 16:22:12 +0200
committerThéo de la Hogue2023-08-15 16:22:12 +0200
commitf141200ca4edc72815a0e7bb47eab89f7cd83512 (patch)
treed6c23ed442e7b5ad1fd58e8a4edf03e96baf78e6 /docs/user_guide/gaze_analysis
parentf503c3945989953197c74a0aa573b91d098e2bb5 (diff)
downloadargaze-f141200ca4edc72815a0e7bb47eab89f7cd83512.zip
argaze-f141200ca4edc72815a0e7bb47eab89f7cd83512.tar.gz
argaze-f141200ca4edc72815a0e7bb47eab89f7cd83512.tar.bz2
argaze-f141200ca4edc72815a0e7bb47eab89f7cd83512.tar.xz
Replacing __str__ representation by letter_sequence property.
Diffstat (limited to 'docs/user_guide/gaze_analysis')
-rw-r--r--docs/user_guide/gaze_analysis/scan_path.md8
1 files changed, 4 insertions, 4 deletions
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'))