aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/argaze/ArFeatures.py2
-rw-r--r--src/argaze/ArUcoMarkers/ArUcoOpticCalibrator.py8
-rw-r--r--src/argaze/AreaOfInterest/AOI2DScene.py2
-rw-r--r--src/argaze/DataFeatures.py6
-rw-r--r--src/argaze/__init__.py2
5 files changed, 11 insertions, 9 deletions
diff --git a/src/argaze/ArFeatures.py b/src/argaze/ArFeatures.py
index 32d1542..56b6158 100644
--- a/src/argaze/ArFeatures.py
+++ b/src/argaze/ArFeatures.py
@@ -386,7 +386,7 @@ class ArLayer(DataFeatures.SharedObject, DataFeatures.PipelineStepObject):
Parameters:
image: image where to draw.
- draw_aoi_scene: [AOI2DScene.draw][argaze.AreaOfInterest.AOI2DScene.draw] parameters (if None, no aoi scene is drawn)
+ draw_aoi_scene: [AOI2DScene.draw][argaze.AreaOfInterest.AOI2DScene.AOI2DScene.draw] parameters (if None, no aoi scene is drawn)
draw_aoi_matching: [AOIMatcher.draw][argaze.GazeFeatures.AOIMatcher.draw] parameters (which depends on the loaded aoi matcher module,
if None, no aoi matching is drawn)
"""
diff --git a/src/argaze/ArUcoMarkers/ArUcoOpticCalibrator.py b/src/argaze/ArUcoMarkers/ArUcoOpticCalibrator.py
index 459a03e..b90baef 100644
--- a/src/argaze/ArUcoMarkers/ArUcoOpticCalibrator.py
+++ b/src/argaze/ArUcoMarkers/ArUcoOpticCalibrator.py
@@ -19,6 +19,7 @@ __license__ = "GPLv3"
from dataclasses import dataclass, field
from argaze import DataFeatures
+from argaze.ArUcoMarkers import ArUcoBoard
import json
import numpy
@@ -113,17 +114,18 @@ class OpticParameters():
class ArUcoOpticCalibrator():
"""Handle optic calibration process."""
- def __init__(self, ):
+ def __init__(self):
+
# Calibration data
self.__corners_set_number = 0
self.__corners_set = []
self.__corners_set_ids = []
- def calibrate(self, board, dimensions=None) -> OpticParameters:
+ def calibrate(self, board: ArUcoMarkers.ArUcoBoard, dimensions: list = None) -> OpticParameters:
"""Retrieve K and D parameters from stored calibration data.
Parameters:
- board:
+ board: [ArUcoMarkers.ArUcoBoard](argaze.md/#argaze.ArUcoMarkers.ArUcoBoard) instance
dimensions: camera image dimensions
Returns:
diff --git a/src/argaze/AreaOfInterest/AOI2DScene.py b/src/argaze/AreaOfInterest/AOI2DScene.py
index 0affe35..0b71d7e 100644
--- a/src/argaze/AreaOfInterest/AOI2DScene.py
+++ b/src/argaze/AreaOfInterest/AOI2DScene.py
@@ -107,7 +107,7 @@ class AOI2DScene(AOIFeatures.AOIScene):
return AOI2DScene(new_areas)
- def draw(self, image: numpy.array, draw_aoi: dict = None, exclude=None):
+ def draw(self, image: numpy.array, draw_aoi: dict = None, exclude: list = None):
"""Draw AOI polygons on image.
Parameters:
diff --git a/src/argaze/DataFeatures.py b/src/argaze/DataFeatures.py
index 8ffc9d7..c89fdea 100644
--- a/src/argaze/DataFeatures.py
+++ b/src/argaze/DataFeatures.py
@@ -117,7 +117,7 @@ def from_json(filepath: str) -> any:
The directory where configuration file is will be the global working directory.
Parameters:
- configuration_filepath: path to json configuration file
+ filepath: path to json configuration file
"""
logging.debug('DataFeatures.from_json')
@@ -219,11 +219,11 @@ def from_dict(expected_value_type: type, data: dict) -> any:
return expected_value_type(**data)
-def as_dict(obj, filter: bool = True) -> dict:
+def as_dict(obj: any, filter: bool = True) -> dict:
"""Export object as dictionary.
Parameters:
- obj:
+ obj: object to export as dictionary
filter: remove None attribute values.
"""
_dict = {}
diff --git a/src/argaze/__init__.py b/src/argaze/__init__.py
index c492882..7224a85 100644
--- a/src/argaze/__init__.py
+++ b/src/argaze/__init__.py
@@ -12,7 +12,7 @@ def load(filepath: str) -> any:
The directory where configuration file is will be the global working directory.
Parameters:
- configuration_filepath: path to json configuration file
+ filepath: path to json configuration file
"""
from argaze import DataFeatures