Updated docstrings

colorbynumber/config.py

@@ -1,11 +1,26 @@
 default_config = {
+    # If True, the image will be denoised after simplification.
     "denoise": True,
+
+    # Higher values will result in more aggressive denoising.
     "denoise_h": 100,
+
+    # Padding around the borders of the image.
     "border_padding": 2,
+
+    # Color islands with area less than this threshold will be ignored.
+    # The value is a percentage of the total area of the image.
     "area_perc_threshold": 0.05,
+
+    # If True, all shapes with perimeter to area ratio of less than
+    # arc_length_area_ratio_threshold will be ignored.
     "check_shape_validity": True,
     "arc_length_area_ratio_threshold": 1,
+
+    # Color of the border around around color islands.
     "border_color": (0, 0, 0),
+
+    # Font for the numbers shown in color islands.
     "font_size": 0.5,
     "font_color": (0, 0, 0),
     "font_thickness": 2,

colorbynumber/gen_islands.py

@@ -6,7 +6,12 @@ from .config import default_config
 
 
 class GenerateIslands:
-    def __init__(self, indices_color_choices,):
+    def __init__(self, indices_color_choices):
+        """
+        Args:
+            indices_color_choices: 2D numpy array with the same shape as the image.
+                Shows the color index chosen for each pixel in the image.
+        """
         self.indices_color_choices = indices_color_choices
         
         # List of coordinates for each islands border

colorbynumber/main.py

@@ -8,6 +8,12 @@ from .numbered_islands import create_numbered_islands
 
 class ColorByNumber:
     def __init__(self, image_path, color_list, config = default_config):
+        """
+        Args:
+            image_path: Path to the image file.
+            color_list: List of colors in (R, G, B) format.
+            config: Dictionary of configuration parameters (optional).
+        """
         self.image_path = image_path
         self.color_list = color_list
         self.config = config
@@ -53,12 +59,15 @@ class ColorByNumber:
         Generates a grid of colored squares with labels below them.
 
         Args:
-            colors: List of colors in (R, G, B) format.
-            rows: Number of rows in the grid (optional).
-            cols: Number of columns in the grid (optional).
-
-        Returns:
-            A NumPy array representing the color grid image.
+            cols: Number of columns in the grid.
+            rows: Number of rows in the grid.
+            square_size: Size of each square in the grid.
+            margin: Margin around the grid.
+            gap_horizontal: Horizontal gap between squares.
+            gap_vertical: Vertical gap between squares.
+            font: Font for the labels.
+            font_size: Font size for the labels.
+            border_color: Color of the border around each square.
         """
 
         # Calculate grid dimensions if not provided

colorbynumber/numbered_islands.py

@@ -19,6 +19,7 @@ def _add_text_to_image(image, text, position, font_size, font_color, font_thickn
         position (tuple): The position to add the text.
         font_size (int): The size of the font.
         font_color (tuple): The color of the font.
+        font_thickness (int): The thickness of the font.
     Returns:
         np.array: A new image with the text added.
     """
@@ -44,11 +45,13 @@ def create_numbered_islands(islands, image_shape,
     """Create a new image with the islands numbered.
     
     Args:
-        image (np.array): Numpy image.
         islands (list): A list of tuples. 
-            Each tuple contains the color_id and the coordinates of the pixels in an island.
-    Returns:
-        np.array: A new image with the islands numbered.
+            Each tuple contains the color id and the coordinates of the island border.
+        image_shape (tuple): The shape of the original image.
+        centroid_coords_list (list): A list of centroid coordinates for the islands.
+        config (dict): Configuration dictionary.
+        show_numbers (bool): If True, the numbers will be shown in the islands.
+        binary (bool): If True, the output will be a binary image.
     """
 
     padding = config["border_padding"]
@@ -87,41 +90,3 @@ def create_numbered_islands(islands, image_shape,
         return numbered_islands
 
     return numbered_islands
-
-def _test_create_numbered_islands():
-    image_shape = (853, 1280, 3)
-
-    max_row, max_col = image_shape[0], image_shape[1]
-
-    diagonal_coordinates = [
-        (i,i) for i in range(max_row)
-    ]
-    left_border = [
-        (i, 0) for i in range(max_row)
-    ]
-    bottom_border_left = [
-        (max_row-1, i) for i in range(max_row)
-    ]
-    region_1 = diagonal_coordinates + left_border + bottom_border_left
-
-    bottom_border_right = [
-        (max_row - 1, i) for i in range(max_row, max_col)
-    ]
-    right_border = [
-        (i, max_col - 1) for i in range(max_row)
-    ]
-    top_border = [
-        (0, i) for i in range(max_col)
-    ]
-    region_2 = bottom_border_right + right_border + top_border
-
-
-    numbered_islands = create_numbered_islands(
-        islands = [
-            ('random_color_1', region_1),
-            ('random_color_2', region_2)
-        ],
-        image_shape = image_shape,
-    )
-
-    return numbered_islands