Fix test coverage, fix typos

Author: shoumikchow

bbox_visualizer/bbox_visualizer.py

@@ -133,7 +133,7 @@ def add_label(
 
         cv2.putText(img, label, (bbox[0] + 5, bbox[1] - (15 * size)), font, size, text_color, thickness)
     else:
-        label_bg = [bbox[0], bbox[1], bbox[0] + label_width, bbox[1] + label_height + (15 * size)]
+        label_bg = [bbox[0], bbox[1], bbox[0] + text_width, bbox[1] + text_height + (15 * size)]
         if draw_bg:
 
             cv2.rectangle(img, (label_bg[0], label_bg[1]),
@@ -184,7 +184,7 @@ def add_T_label(img,
 
     # draw rectangle with label
     y_bottom = y_top
-    y_top = y_bottom - text_height - 5
+    y_top = y_bottom - label_height - 5
 
     if y_top < 0:
         logging.warning(
@@ -193,14 +193,14 @@ def add_T_label(img,
         return add_label(img, label, bbox)
 
     cv2.line(img, (x_center, bbox[1]), (x_center, line_top), text_bg_color, 3)
-    x_left = x_center - (text_width // 2) - 5
-    x_right = x_center + (text_width // 2) + 5
+    x_left = x_center - (label_width // 2) - 5
+    x_right = x_center + (label_width // 2) + 5
     if draw_bg:
         cv2.rectangle(img, (x_left, y_top - 30), (x_right, y_bottom),
                       text_bg_color, -1)
     cv2.putText(img, label, (x_left + 5, y_bottom - (8 * size)),
                 font, size, text_color, thickness)
-    )
+    
 
 
     return img

examples/test_multiple_objects_example.py

@@ -0,0 +1,54 @@
+"""
+Example script demonstrating bbox-visualizer usage with multiple objects.
+This script shows how to:
+1. Load an image and its annotations
+2. Draw multiple bounding boxes
+3. Add different types of labels (normal, T-label, and flags) for multiple objects
+"""
+
+import json
+import bbox_visualizer as bbv
+import cv2
+
+def main():
+    # Load image and annotation
+    img = cv2.imread('../images/test_images/source_multiple_cats.jpg')
+    if img is None:
+        print("Error: Could not load image. Please check the path.")
+        return
+        
+    try:
+        annotation = json.load(open('../images/test_images/source_multiple_cats.json'))
+    except FileNotFoundError:
+        print("Error: Could not load annotation file. Please check the path.")
+        return
+
+    # Extract labels and bounding boxes from annotation
+    labels = []
+    bboxes = []
+    for shape in annotation['shapes']:
+        labels.append(shape['label'])
+        mins = shape['points'][0]  # [xmin, ymin]
+        maxs = shape['points'][1]  # [xmax, ymax]
+        bboxes.append(mins + maxs)  # [xmin, ymin, xmax, ymax]
+
+    # Draw different visualizations
+    img_with_boxes = bbv.draw_multiple_rectangles(img, bboxes)
+    img_with_boxes_2 = img_with_boxes.copy()
+
+    # Add different types of labels
+    img_with_labels = bbv.add_multiple_labels(img_with_boxes, labels, bboxes)
+    img_with_T_labels = bbv.add_multiple_T_labels(img_with_boxes_2, labels, bboxes)
+    img_with_flags = bbv.draw_multiple_flags_with_labels(img, labels, bboxes)
+
+    # Display results
+    cv2.imshow("Boxes with Labels", img_with_labels)
+    cv2.imshow("Boxes with T-labels", img_with_T_labels)
+    cv2.imshow("Boxes with Flags", img_with_flags)
+
+    print("Press any key to close the windows...")
+    cv2.waitKey(0)
+    cv2.destroyAllWindows()
+
+if __name__ == "__main__":
+    main() 

examples/test_single_object_example.py

@@ -0,0 +1,53 @@
+"""
+Example script demonstrating bbox-visualizer usage with a single object.
+This script shows how to:
+1. Load an image and its annotation
+2. Draw a bounding box
+3. Add different types of labels (normal, T-label, and flag)
+"""
+
+import json
+import bbox_visualizer as bbv
+import cv2
+
+def main():
+    # Load image and annotation
+    img = cv2.imread('../images/test_images/source_bird.jpg')
+    if img is None:
+        print("Error: Could not load image. Please check the path.")
+        return
+        
+    try:
+        annotation = json.load(open('../images/test_images/source_bird.json'))
+    except FileNotFoundError:
+        print("Error: Could not load annotation file. Please check the path.")
+        return
+
+    # Convert to RGB for better visualization
+    img = cv2.cvtColor(img, cv2.COLOR_BGR2RGB)
+
+    # Extract bounding box and label from annotation
+    points = annotation['shapes'][0]['points']
+    label = annotation['shapes'][0]['label']
+    (xmin, ymin), (xmax, ymax) = points
+    bbox = [xmin, ymin, xmax, ymax]
+
+    # Draw different visualizations
+    img_with_box = bbv.draw_rectangle(img, bbox)
+    img_with_box_2 = img_with_box.copy()
+
+    img_label = bbv.add_label(img_with_box, label, bbox)
+    img_T_label = bbv.add_T_label(img_with_box_2, label, bbox)
+    img_flag = bbv.draw_flag_with_label(img, label, bbox)
+
+    # Display results
+    cv2.imshow("Bounding Box", img_with_box)
+    cv2.imshow("With T-label", img_T_label)
+    cv2.imshow("With Flag", img_flag)
+
+    print("Press any key to close the windows...")
+    cv2.waitKey(0)
+    cv2.destroyAllWindows()
+
+if __name__ == "__main__":
+    main() 

requirements_dev.txt

@@ -5,5 +5,6 @@ flake8==3.7.8
 Sphinx==1.8.5
 twine==1.14.0
 pytest==7.4.0
+pytest-cov>=7.0.0
 numpy>=1.19.0
 opencv-python>=4.1.0.25

tests/test_bbox_visualizer.py

@@ -1,6 +1,6 @@
 import pytest
 import numpy as np
-import cv2
+import logging
 from bbox_visualizer import bbox_visualizer
 
 @pytest.fixture
@@ -18,6 +18,28 @@ def sample_label():
     """Create a sample label for testing."""
     return "test"
 
+def test_check_and_modify_bbox(sample_image):
+    """Test bbox validation and modification."""
+    # Test negative coordinates
+    bbox = [-10, -10, 50, 50]
+    result = bbox_visualizer.check_and_modify_bbox(bbox, sample_image.shape)
+    assert result[0] >= 0 and result[1] >= 0
+    
+    # Test coordinates exceeding image size
+    bbox = [10, 10, 200, 200]
+    result = bbox_visualizer.check_and_modify_bbox(bbox, sample_image.shape)
+    assert result[2] <= sample_image.shape[1]
+    assert result[3] <= sample_image.shape[0]
+    
+    # Test with margin
+    bbox = [-10, -10, 200, 200]
+    margin = 5
+    result = bbox_visualizer.check_and_modify_bbox(bbox, sample_image.shape, margin)
+    assert result[0] == margin
+    assert result[1] == margin
+    assert result[2] == sample_image.shape[1] - margin
+    assert result[3] == sample_image.shape[0] - margin
+
 def test_draw_rectangle_basic(sample_image, sample_bbox):
     """Test basic rectangle drawing functionality."""
     result = bbox_visualizer.draw_rectangle(sample_image, sample_bbox)
@@ -35,32 +57,155 @@ def test_draw_rectangle_opaque(sample_image, sample_bbox):
     assert result.shape == sample_image.shape
     assert np.sum(result) > 0
 
-def test_add_label(sample_image, sample_bbox, sample_label):
+def test_add_label(sample_image, sample_bbox, sample_label, caplog):
     """Test adding label to bounding box."""
+    # Test normal case with top=True and enough space
+    bbox_with_space = [10, 30, 50, 70]  # Plenty of space above and below
     result = bbox_visualizer.add_label(
-        sample_image, sample_label, sample_bbox
+        sample_image, sample_label, bbox_with_space, top=True
+    )
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
+    assert np.sum(result) > 0
+    
+    # Test normal case with top=False and enough space
+    result = bbox_visualizer.add_label(
+        sample_image, sample_label, bbox_with_space, top=False
     )
     assert isinstance(result, np.ndarray)
     assert result.shape == sample_image.shape
     assert np.sum(result) > 0
+    
+    # Test with draw_bg=False for both top and bottom positions
+    result = bbox_visualizer.add_label(
+        sample_image, sample_label, bbox_with_space, draw_bg=False, top=True
+    )
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
+    assert np.sum(result) > 0
+    
+    result = bbox_visualizer.add_label(
+        sample_image, sample_label, bbox_with_space, draw_bg=False, top=False
+    )
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
+    assert np.sum(result) > 0
+    
+    # Test label at top when there's not enough space
+    bbox_at_top = [10, 5, 50, 20]  # Very close to top of image
+    result = bbox_visualizer.add_label(
+        sample_image, sample_label, bbox_at_top, top=True
+    )
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
+    
+    # Test label at bottom when there's not enough space
+    bbox_at_bottom = [10, 80, 50, 99]  # Very close to bottom of image
+    result = bbox_visualizer.add_label(
+        sample_image, sample_label, bbox_at_bottom, top=False
+    )
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
 
-def test_add_T_label(sample_image, sample_bbox, sample_label):
+def test_add_T_label(sample_image, sample_bbox, sample_label, caplog):
     """Test adding T-label to bounding box."""
+    # Test normal case with enough space and background
+    bbox_with_space = [40, 80, 60, 95]  # Plenty of space above (at least 50 pixels)
     result = bbox_visualizer.add_T_label(
-        sample_image, sample_label, sample_bbox
+        sample_image, sample_label, bbox_with_space,
+        draw_bg=True, text_bg_color=(255, 0, 0),  # Red background to ensure visibility
+        size=1, thickness=2  # Explicit size and thickness
     )
     assert isinstance(result, np.ndarray)
     assert result.shape == sample_image.shape
     assert np.sum(result) > 0
+    
+    # Test with draw_bg=False
+    result = bbox_visualizer.add_T_label(
+        sample_image, sample_label, bbox_with_space,
+        draw_bg=False, text_color=(0, 255, 0),  # Green text to ensure visibility
+        size=1, thickness=2  # Explicit size and thickness
+    )
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
+    assert np.sum(result) > 0
+    
+    # Test with custom size and thickness
+    result = bbox_visualizer.add_T_label(
+        sample_image, sample_label, bbox_with_space,
+        size=2, thickness=3, text_bg_color=(0, 0, 255),  # Blue background
+        draw_bg=True  # Explicit background drawing
+    )
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
+    assert np.sum(result) > 0
+    
+    # Test with a long label to ensure text width calculation
+    long_label = "This is a very long label"
+    result = bbox_visualizer.add_T_label(
+        sample_image, long_label, bbox_with_space,
+        draw_bg=True, text_bg_color=(255, 255, 0),  # Yellow background
+        size=1, thickness=2  # Explicit size and thickness
+    )
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
+    assert np.sum(result) > 0
+    
+    # Test with a bbox that has enough vertical space but is close to image edges
+    bbox_near_edge = [5, 80, 25, 95]  # Close to left edge but plenty of space above
+    result = bbox_visualizer.add_T_label(
+        sample_image, sample_label, bbox_near_edge,
+        draw_bg=True, text_bg_color=(255, 0, 255),  # Magenta background
+        size=1, thickness=2  # Explicit size and thickness
+    )
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
+    assert np.sum(result) > 0
+    
+    # Test fallback when label would go out of frame at top
+    bbox_at_top = [10, 5, 50, 20]  # Very close to top of image
+    caplog.clear()
+    with caplog.at_level(logging.WARNING):
+        result = bbox_visualizer.add_T_label(
+            sample_image, sample_label, bbox_at_top,
+            draw_bg=True, text_bg_color=(128, 128, 128)  # Gray background
+        )
+    assert "Labelling style 'T' going out of frame. Falling back to normal labeling." in caplog.text
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
+    
+    # Test fallback when label would go out of frame on the right side
+    bbox_at_right = [80, 30, 99, 50]  # Very close to right edge of image
+    caplog.clear()
+    with caplog.at_level(logging.WARNING):
+        result = bbox_visualizer.add_T_label(
+            sample_image, sample_label, bbox_at_right,
+            draw_bg=True, text_bg_color=(128, 128, 128)  # Gray background
+        )
+    assert "Labelling style 'T' going out of frame. Falling back to normal labeling." in caplog.text
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
 
-def test_draw_flag_with_label(sample_image, sample_bbox, sample_label):
+def test_draw_flag_with_label(sample_image, sample_bbox, sample_label, caplog):
     """Test drawing flag with label."""
+    # Test normal case
     result = bbox_visualizer.draw_flag_with_label(
         sample_image, sample_label, sample_bbox
     )
     assert isinstance(result, np.ndarray)
     assert result.shape == sample_image.shape
     assert np.sum(result) > 0
+    
+    # Test fallback when flag would go out of frame
+    bbox_at_top = [10, 0, 50, 10]  # At the very top of image
+    caplog.clear()  # Clear any previous log messages
+    with caplog.at_level(logging.WARNING):
+        result = bbox_visualizer.draw_flag_with_label(
+            sample_image, sample_label, bbox_at_top
+        )
+    assert "Labelling style 'Flag' going out of frame. Falling back to normal labeling." in caplog.text
+    assert isinstance(result, np.ndarray)
+    assert result.shape == sample_image.shape
 
 def test_draw_multiple_rectangles(sample_image):
     """Test drawing multiple rectangles."""
@@ -87,7 +232,6 @@ def test_add_multiple_T_labels(sample_image):
     """Test adding multiple T-labels."""
     bboxes = [[10, 10, 30, 30], [40, 40, 60, 60]]
     labels = ["obj1", "obj2"]
-    # Note: The function internally sets size=1 and thickness=2
     result = bbox_visualizer.add_multiple_T_labels(
         sample_image, labels, bboxes
     )
@@ -99,7 +243,6 @@ def test_draw_multiple_flags_with_labels(sample_image):
     """Test drawing multiple flags with labels."""
     bboxes = [[10, 10, 30, 30], [40, 40, 60, 60]]
     labels = ["obj1", "obj2"]
-    # Note: The function internally sets size=1 and thickness=2
     result = bbox_visualizer.draw_multiple_flags_with_labels(
         sample_image, labels, bboxes
     )
@@ -109,12 +252,17 @@ def test_draw_multiple_flags_with_labels(sample_image):
 
 def test_invalid_bbox_values(sample_image):
     """Test handling of invalid bbox values."""
-    # Testing with invalid bbox coordinates (negative values)
-    invalid_bbox = [-10, -10, 20, 20]
+    # Test with coordinates outside image boundaries
+    invalid_bbox = [-10, -10, 150, 150]
     result = bbox_visualizer.draw_rectangle(sample_image, invalid_bbox)
-    # The function should handle invalid coordinates by clipping them
     assert isinstance(result, np.ndarray)
     assert result.shape == sample_image.shape
+    # Check that bbox was clipped to image boundaries
+    modified_bbox = bbox_visualizer.check_and_modify_bbox(invalid_bbox, sample_image.shape)
+    assert modified_bbox[0] >= 0
+    assert modified_bbox[1] >= 0
+    assert modified_bbox[2] <= sample_image.shape[1]
+    assert modified_bbox[3] <= sample_image.shape[0]
 
 def test_empty_inputs():
     """Test handling of empty inputs for multiple object functions."""