1 files changed, 161 insertions, 0 deletions
diff --git a/src/argaze/ArUcoMarker/ArUcoMarkerDictionary.py b/src/argaze/ArUcoMarker/ArUcoMarkerDictionary.py
new file mode 100644
index 0000000..ed423f1
--- /dev/null
+++ b/src/argaze/ArUcoMarker/ArUcoMarkerDictionary.py
@@ -0,0 +1,161 @@
+""" 
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+You should have received a copy of the GNU General Public License along with
+this program. If not, see <https://www.gnu.org/licenses/>.
+"""
+
+__author__ = "Théo de la Hogue"
+__credits__ = []
+__copyright__ = "Copyright 2023, Ecole Nationale de l'Aviation Civile (ENAC)"
+__license__ = "GPLv3"
+
+import cv2.aruco as aruco
+
+all_aruco_markers_dictionaries = {
+    'DICT_4X4_50': aruco.DICT_4X4_50,
+    'DICT_4X4_100': aruco.DICT_4X4_100,
+    'DICT_4X4_250': aruco.DICT_4X4_250,
+    'DICT_4X4_1000': aruco.DICT_4X4_1000,
+    'DICT_5X5_50': aruco.DICT_5X5_50,
+    'DICT_5X5_100': aruco.DICT_5X5_100,
+    'DICT_5X5_250': aruco.DICT_5X5_250,
+    'DICT_5X5_1000': aruco.DICT_5X5_1000,
+    'DICT_6X6_50': aruco.DICT_6X6_50,
+    'DICT_6X6_100': aruco.DICT_6X6_100,
+    'DICT_6X6_250': aruco.DICT_6X6_250,
+    'DICT_6X6_1000': aruco.DICT_6X6_1000,
+    'DICT_7X7_50': aruco.DICT_7X7_50,
+    'DICT_7X7_100': aruco.DICT_7X7_100,
+    'DICT_7X7_250': aruco.DICT_7X7_250,
+    'DICT_7X7_1000': aruco.DICT_7X7_1000,
+    'DICT_ARUCO_ORIGINAL': aruco.DICT_ARUCO_ORIGINAL,
+    'DICT_APRILTAG_16h5': aruco.DICT_APRILTAG_16h5,
+    'DICT_APRILTAG_25h9': aruco.DICT_APRILTAG_25h9,
+    'DICT_APRILTAG_36h10': aruco.DICT_APRILTAG_36h10,
+    'DICT_APRILTAG_36h11': aruco.DICT_APRILTAG_36h11
+}
+"""Dictionary to list all built-in ArUco markers dictionaries from OpenCV ArUco package."""
+
+class ArUcoMarkerDictionary():
+    """Handle an ArUco markers dictionary."""
+
+    def __init__(self, name: str = 'DICT_ARUCO_ORIGINAL'):
+
+        self.__name = name
+
+        if all_aruco_markers_dictionaries.get(self.__name, None) is None:
+            raise NameError(f'Bad ArUco markers dictionary name: {self.__name}')
+
+    @property
+    def name(self):
+        """Dictionary name"""
+
+        return self.__name
+
+    def __str__(self) -> str:
+        """String display"""
+
+        output = f'{self.name}\n'
+        return output
+
+    @property
+    def markers(self) -> aruco.Dictionary:
+        """Get all markers from dictionary."""
+
+        return aruco.getPredefinedDictionary(all_aruco_markers_dictionaries[self.name])
+
+    @property
+    def format(self) -> str:
+        """Get markers format."""
+
+        dict_name_split = self.name.split('_')
+        dict_type = dict_name_split[1]
+
+        # DICT_ARUCO_ORIGINAL case
+        if dict_type == 'ARUCO':
+            return '5X5'
+
+        # DICT_APRILTAG case
+        elif dict_type == 'APRILTAG':
+
+            april_tag_format = dict_name_split[2]
+
+            if april_tag_format == '16h5':
+                return '4X4'
+
+            elif april_tag_format == '25h9':
+                return '5X5'
+
+            elif april_tag_format == '36h10':
+                return '6X6'
+
+            elif april_tag_format == '36h11':
+                return '6X6'
+  
+        # other cases
+        else:
+            return dict_type
+
+    @property
+    def number(self) -> int:
+        """Get number of markers inside dictionary."""
+
+        dict_name_split = self.name.split('_')
+        dict_type = dict_name_split[1]
+
+        # DICT_ARUCO_ORIGINAL case
+        if dict_type == 'ARUCO':
+            return 1024
+
+        # DICT_APRILTAG case
+        elif dict_type == 'APRILTAG':
+
+            april_tag_format = dict_name_split[2]
+
+            if april_tag_format == '16h5':
+
+                return 30
+
+            elif april_tag_format == '25h9':
+
+                return 30
+
+            elif april_tag_format == '36h10':
+
+                return 2320
+
+            elif april_tag_format == '36h11':
+
+                return 587
+  
+        # other cases
+        else:
+
+            return int(dict_name_split[2])
+
+    def create_marker(self, i, size):
+        """Create a marker."""
+
+        if i >= 0 and i < self.number:
+
+            from argaze.ArUcoMarker import ArUcoMarker
+
+            return ArUcoMarker.ArUcoMarker(self, i, size)
+
+        else:
+
+            raise ValueError(f'Bad index: {i}')
+
+    def save(self, destination_folder, size, dpi):
+        """Save all markers dictionary into separated .png files."""
+
+        for i in range(self.number):
+
+            self.create_marker(i, size).save(destination_folder, dpi)