aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThéo de la Hogue2023-08-30 22:26:01 +0200
committerThéo de la Hogue2023-08-30 22:26:01 +0200
commit755bd503a8aa50a2487c347b39f2cbc49a767587 (patch)
tree3e7df2a225e7d334ddd964ff4ddd1b0b2b39806e
parent85025fdaaf2450be7b6eeffdfee9c16aabbfa0b8 (diff)
downloadargaze-755bd503a8aa50a2487c347b39f2cbc49a767587.zip
argaze-755bd503a8aa50a2487c347b39f2cbc49a767587.tar.gz
argaze-755bd503a8aa50a2487c347b39f2cbc49a767587.tar.bz2
argaze-755bd503a8aa50a2487c347b39f2cbc49a767587.tar.xz
Adding cross reference into method documentation.
-rw-r--r--src/argaze/ArFeatures.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/argaze/ArFeatures.py b/src/argaze/ArFeatures.py
index 252870e..e62fe92 100644
--- a/src/argaze/ArFeatures.py
+++ b/src/argaze/ArFeatures.py
@@ -492,7 +492,7 @@ class ArLayer():
def draw(self, image: numpy.array, draw_aoi_scene: dict = None, draw_aoi_matching: dict = None):
"""
- Draw into image
+ Draw into image.
Parameters:
draw_aoi_scene: AreaOfInterest.AOI2DScene.draw parameters (if None, no aoi scene is drawn)
@@ -1010,9 +1010,9 @@ class ArFrame():
Parameters:
background_weight: weight of background overlay
heatmap_weight: weight of heatmap overlay
- draw_scan_path: GazeFeatures.ScanPath.draw parameters (if None, no scan path is drawn)
- draw_layers: dictionary of ArLayer.draw parameters per layer (if None, no layer is drawn)
- draw_gaze_position: GazeFeatures.GazePosition parameters (if None, no gaze position is drawn)
+ draw_scan_path: [GazeFeatures.ScanPath.draw](argaze.md/#argaze.GazeFeatures.ScanPath.draw) parameters (if None, no scan path is drawn)
+ draw_layers: dictionary of [ArLayer.draw](argaze.md/#argaze.ArFeatures.ArLayer.draw) parameters per layer (if None, no layer is drawn)
+ draw_gaze_position: [GazeFeatures.GazePosition.draw](argaze.md/#argaze.GazeFeatures.GazePosition.draw) parameters (if None, no gaze position is drawn)
"""
# Use image_parameters attribute if no parameters