From 7c9827ba0c1e965c64eaf3ead1ce7b662d82d20c Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Tue, 14 Mar 2023 09:45:35 +0100
Subject: Improving ArFeatures and general library overview.

---
 src/argaze/ArFeatures.py | 23 ++++++++++++-----------
 src/argaze/__init__.py   |  2 +-
 2 files changed, 13 insertions(+), 12 deletions(-)

(limited to 'src')

diff --git a/src/argaze/ArFeatures.py b/src/argaze/ArFeatures.py
index e66b1ac..e517302 100644
--- a/src/argaze/ArFeatures.py
+++ b/src/argaze/ArFeatures.py
@@ -89,25 +89,26 @@ class SceneProjectionFailed(Exception):
 
 @dataclass
 class ArScene():
-	"""Define an Augmented Reality scene based ArUco markers and AOI scenes."""
+	"""Define an Augmented Reality scene with ArUco markers and AOI scenes."""
 
 	aruco_scene: ArUcoScene.ArUcoScene = field(init=False, default_factory=ArUcoScene.ArUcoScene)
-	"""ArUco scene ..."""
+	"""ArUco markers 3D scene description used to estimate scene pose from detected markers: see `estimate_pose` function below."""
 
 	aoi_scene: AOI3DScene.AOI3DScene = field(init=False, default_factory=AOI3DScene.AOI3DScene)
-	"""AOI 3D scene ..."""
-
-	angle_tolerance: float
-	"""Angle error tolerance allowed to validate marker pose in degree."""
-
-	distance_tolerance: float
-	"""Distance error tolerance allowed to validate marker pose in centimeter."""
+	"""AOI 3D scene description that will be projected onto estimated scene once its pose will be estimated : see `project` function below."""
 
 	aruco_axis: dict
-	"""Dictionary of orthogonal axis where each axis is defined by list of 3 markers identifier (first is origin)."""
+	"""Optional dictionary to define orthogonal axis where each axis is defined by list of 3 markers identifier (first is origin). \
+	This pose estimation strategy is used by `estimate_pose` function when at least 3 markers are detected."""
 
 	aruco_aoi: dict
-	"""Dictionary of AOI defined by list of markers identifier and markers corners index tuples."""
+	"""Optional dictionary of AOI defined by list of markers identifier and markers corners index tuples: see `build_aruco_aoi_scene` function below."""
+
+	angle_tolerance: float
+	"""Optional angle error tolerance to validate marker pose in degree used into `estimate_pose` function."""
+
+	distance_tolerance: float
+	"""Optional distance error tolerance to validate marker pose in centimeter used into `estimate_pose` function."""
 
 	def __init__(self, ar_environment: ArEnvironment, **kwargs):
 
diff --git a/src/argaze/__init__.py b/src/argaze/__init__.py
index d74219d..1162ba7 100644
--- a/src/argaze/__init__.py
+++ b/src/argaze/__init__.py
@@ -2,4 +2,4 @@
 .. include:: ../../README.md
 """
 __docformat__ = "restructuredtext"
-__all__ = ['utils','ArUcoMarkers','AreaOfInterest','ArFeatures','GazeFeatures','DataStructures','GazeAnalysis','TobiiGlassesPro2']
\ No newline at end of file
+__all__ = ['ArFeatures','GazeFeatures','GazeAnalysis','ArUcoMarkers','AreaOfInterest','DataStructures','TobiiGlassesPro2','utils']
\ No newline at end of file
-- 
cgit v1.1