From 694143512b3d1fe50631a5207035aa07e0c3b7d4 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Mon, 21 Nov 2022 16:58:30 +0100
Subject: Improving attribute documentation.

---
 src/argaze/ArUcoMarkers/ArUcoCamera.py | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'src')

diff --git a/src/argaze/ArUcoMarkers/ArUcoCamera.py b/src/argaze/ArUcoMarkers/ArUcoCamera.py
index 40090cb..92cde9f 100644
--- a/src/argaze/ArUcoMarkers/ArUcoCamera.py
+++ b/src/argaze/ArUcoMarkers/ArUcoCamera.py
@@ -16,8 +16,8 @@ class ArUcoCamera():
 
         self.__dimensions = [0, 0]  # dimensions of frame where to apply optical parameters (in pixel)
 
-        self.__K = []               # camera matrix (focal lengths and principal point)
-        self.__D = []               # distortion coefficients
+        self.__K = []               # intrinsic parameters matrix (focal lengths and principal point)
+        self.__D = []               # distortion coefficients vector
 
         # define calibration data
         self.__corners_set_number = 0
@@ -56,18 +56,18 @@ class ArUcoCamera():
 
     @property
     def K(self) -> numpy.array:
-        """Get camera matrix."""
+        """Get camera intrinsic parameters matrix."""
 
         return self.__K
 
     @property
     def D(self) -> numpy.array:
-        """Get camera distorsion coefficients."""
+        """Get camera distorsion coefficients vector."""
 
         return self.__D
 
     def calibrate(self, board, frame_width, frame_height):
-        """Retrieve camera optical parameters from stored calibration data."""
+        """Retrieve camera K and D from stored calibration data."""
 
         if self.__corners_set_number > 0:
 
-- 
cgit v1.1