Merge pull request #23 from fernaper/development

v1.0.0 Multiple selection!

Author: fernaper

README.md

@@ -13,6 +13,7 @@ You will need to install:
 
 * opencv >= 3.6.2
 * numpy >= 1.13.3
+* python-constraint >= 1.4.0
 
 You can simply execute:
 `pip install -r requirements.txt`

opencv_draw_tools/SelectZone.py

@@ -4,6 +4,8 @@
 import sys
 import cv2
 
+import tags_constraint
+
 """
     You can change it.
     If IGNORE_ERRORS are True, opencv_draw_tools tried to solve the problems or
@@ -29,7 +31,50 @@ def get_lighter_color(color):
     add = min(add,30)
     return (color[0] + add, color[1] + add, color[2] + add)
 
-def add_tags(frame, position, tags, tag_position=None, alpha=0.75, color=(20, 20, 20), margin=5, font_info=(cv2.FONT_HERSHEY_COMPLEX_SMALL, 0.75, (255,255,255), 1)):
+def get_shape_tags(position, tags, margin=5,
+                   font_info=(cv2.FONT_HERSHEY_COMPLEX_SMALL, 0.75, (255,255,255), 1)):
+    """Get information about how much the list of tags will occupy (width and height)
+    with the current configuration.
+
+    Keyword arguments:
+    position -- touple with 4 elements (x1, y1, x2, y2)
+                This elements must be between 0 and frame height/width.
+    tags -- list of strings/tags you want to check shape.
+    margin -- extra margin in pixels to be separeted with the selected zone. (default 5)
+    font_info -- touple with 4 elements (font, font_scale, font_color, thickness)
+                 font -- opencv font (default cv2.FONT_HARSHEY_COMPLEX_SMALL)
+                 font_scale -- scale of the fontm between 0 and 1 (default 0.75)
+                 font_color -- color of the tags text, touple with 3 elements BGR (default (255,255,255) -> white)
+                          BGR = Blue - Green - Red
+                 thickness -- thickness of the text in pixels (default 1)
+    Return:
+    Return shape of the given tags with the given font information
+
+    """
+    font, font_scale, font_color, thickness = font_info
+    x1, y1, x2, y2 = position
+
+    aux_tags = []
+    for tag in tags:
+        line = [x+'\n' for x in tag.split('\n')]
+        line[0] = line[0][:-1]
+        for element in line:
+            aux_tags.append(element)
+    tags = aux_tags
+
+    text_width = -1
+    text_height = -1
+    line_height = -1
+    for tag in tags:
+        size = cv2.getTextSize(tag, font, font_scale, thickness)
+        text_width = max(text_width,size[0][0])
+        text_height = max(text_height, size[0][1])
+        line_height = max(line_height, text_height + size[1] + margin)
+
+    return (text_width + margin * 3, (margin + text_height)*(len(tags) - 1) + 2*text_height + margin*(len(tags)-1))
+
+def add_tags(frame, position, tags, tag_position=None, alpha=0.75, color=(20, 20, 20),
+             margin=5, font_info=(cv2.FONT_HERSHEY_COMPLEX_SMALL, 0.75, (255,255,255), 1)):
     """Add tags to selected zone.
 
     It was originally intended as an auxiliary method to add details to the select_zone()
@@ -40,7 +85,7 @@ def add_tags(frame, position, tags, tag_position=None, alpha=0.75, color=(20, 20
     position -- touple with 4 elements (x1, y1, x2, y2)
                 This elements must be between 0 and 1 in case it is normalized
                 or between 0 and frame height/width.
-    tags -- list of strings/tags you want to associate to the selected zone
+    tags -- list of strings/tags you want to associate to the selected zone.
     tag_position -- position where you want to add the tags, relatively to the selected zone (default None)
                     If None provided it will auto select the zone where it fits better:
                         - First try to put the text on the Bottom Rigth corner
@@ -95,7 +140,8 @@ def add_tags(frame, position, tags, tag_position=None, alpha=0.75, color=(20, 20
         fits_right = x2 + text_width + margin*3 <= f_width
         fits_left = x1 - (text_width + margin*3) >= 0
         fits_below = (text_height + margin)*len(tags) - margin <= y2 - thickness
-        fits_inside = x1 + text_width + margin*3 <= x2 - thickness and y1 + (margin*2 + text_height)*len(tags) + text_height - margin <= y2 - thickness
+        fits_inside = x1 + text_width + margin*3 <= x2 - thickness and \
+                      y1 + (margin*2 + text_height)*len(tags) + text_height - margin <= y2 - thickness
 
         if fits_right and fits_below:
             tag_position = 'bottom_right'
@@ -115,12 +161,12 @@ def add_tags(frame, position, tags, tag_position=None, alpha=0.75, color=(20, 20
 
     # Add triangle to know to whom each tag belongs
     if tag_position == 'bottom_right':
-        pt1 = (x2 + margin - 1, y2 - (margin*2 + text_height)*len(tags) - text_height - margin)
-        pt2 = (pt1[0], pt1[1] + text_height + margin*2)
+        pt1 = (x2 + margin - 1, y2 - (margin + text_height)*len(tags) - text_height - margin * (len(tags)-1))
+        pt2 = (pt1[0], pt1[1] + text_height + margin)
         pt3 = (pt1[0] - margin + 1, pt1[1] + int(text_height/2)+margin)
     elif tag_position == 'bottom_left':
-        pt1 = (x1 - margin + 1, y2 - (margin*2 + text_height)*len(tags) - text_height - margin)
-        pt2 = (pt1[0], pt1[1] + text_height + margin*2)
+        pt1 = (x1 - margin + 1, y2 - (margin + text_height)*len(tags) - text_height - margin * (len(tags)-1))
+        pt2 = (pt1[0], pt1[1] + text_height + margin)
         pt3 = (pt1[0] + margin - 1, pt1[1] + int(text_height/2)+margin)
     elif tag_position == 'top':
         pt1 = (x1 + margin + int(text_width/3), y1 - margin*2 + 1)
@@ -138,35 +184,38 @@ def add_tags(frame, position, tags, tag_position=None, alpha=0.75, color=(20, 20
         extra_adjustment = 2 if tag[-1] == '\n' else 1
         if tag_position == 'top':
             cv2.rectangle(overlay, (x1 + margin, y1 - (margin + text_height)*reverse_i - margin * (reverse_i-1) - text_height - margin * (extra_adjustment - 1 )),
-                         (x1 + text_width + margin*3, y1 - (margin + text_height)*reverse_i - margin * (reverse_i) + text_height), color,-1)
+                          (x1 + text_width + margin*3, y1 - (margin + text_height)*reverse_i - margin * (reverse_i) + text_height), color,-1)
         elif tag_position == 'inside':
-            cv2.rectangle(overlay, (x1 + margin, y1 + (margin*2 + text_height)*(i+1) - text_height - margin - extra_adjustment),
-                         (x1 + text_width + margin*3, y1 + (margin*2 + text_height)*(i+1) + text_height - margin), color,-1)
+            cv2.rectangle(overlay, (x1 + margin, y1 + (margin*2 + text_height)*(i+1) + margin*i - text_height - margin * extra_adjustment),
+                          (x1 + text_width + margin*3, y1 + (margin*2 + text_height)*(i+1) + margin*i + text_height - margin), color,-1)
         elif tag_position == 'bottom_left':
-            cv2.rectangle(overlay, (x1 - (text_width + margin*3), y2 - (margin*2 + text_height)*reverse_i - text_height - margin * extra_adjustment),
-                         (x1 - margin, y2 - (margin*2 + text_height)*reverse_i + text_height - margin), color,-1)
+            cv2.rectangle(overlay, (x1 - (text_width + margin*3), y2 - (margin + text_height)*reverse_i - margin * (reverse_i-1) - text_height - margin * (extra_adjustment - 1)),
+                          (x1 - margin, y2 - (margin + text_height)*reverse_i - margin * (reverse_i) + text_height), color,-1)
         elif tag_position == 'bottom_right':
-            cv2.rectangle(overlay, (x2 + margin, y2 - (margin*2 + text_height)*reverse_i - text_height - margin * extra_adjustment),
-                             (x2 + text_width + margin*3, y2 - (margin*2 + text_height)*reverse_i + text_height - margin), color,-1)
-        if tag_position != 'top':
-            y1 += margin
-            y2 += margin
+            cv2.rectangle(overlay, (x2 + margin, y2 - (margin + text_height)*reverse_i - margin * (reverse_i-1) - text_height - margin * (extra_adjustment - 1)),
+                          (x2 + text_width + margin*3, y2 - (margin + text_height)*reverse_i - margin * (reverse_i) + text_height), color,-1)
+
     cv2.addWeighted(overlay, alpha, frame, 1 - alpha, 0, frame)
     x1, y1, x2, y2 = position
     for i, tag in enumerate(tags):
         reverse_i = len(tags) - i
         extra_adjustment = int(margin*( 0.5 if tag[-1] == '\n' else 0))
         if tag_position == 'top':
-            cv2.putText(frame, tag.replace('\n',''), (x1 + margin*2, y1 - (margin + text_height)*reverse_i - margin * (reverse_i-1) + int(margin/2) - extra_adjustment), font, font_scale, font_color, thickness)
+            cv2.putText(frame, tag.replace('\n',''),
+                        (x1 + margin*2, y1 - (margin + text_height)*reverse_i - margin * (reverse_i-1) + int(margin/2) - extra_adjustment),
+                        font, font_scale, font_color, thickness)
         elif tag_position == 'inside':
-            cv2.putText(frame, tag.replace('\n',''), (x1 + margin*2, y1 + (margin*2 + text_height)*(i+1) - extra_adjustment), font, font_scale, font_color, thickness)
+            cv2.putText(frame, tag.replace('\n',''),
+                        (x1 + margin*2, y1 + (margin*2 + text_height)*(i+1) + margin*i - extra_adjustment),
+                        font, font_scale, font_color, thickness)
         elif tag_position == 'bottom_left':
-            cv2.putText(frame, tag.replace('\n',''), (x1 - (text_width + margin*2), y2 - (margin*2 + text_height)*reverse_i - extra_adjustment), font, font_scale, font_color, thickness)
+            cv2.putText(frame, tag.replace('\n',''),
+                        (x1 - (text_width + margin*2), y2 - (margin + text_height)*reverse_i - margin * (reverse_i-1) + int(margin/2) - extra_adjustment),
+                        font, font_scale, font_color, thickness)
         elif tag_position == 'bottom_right':
-            cv2.putText(frame, tag.replace('\n',''), (x2 + margin*2, y2 - (margin*2 + text_height)*reverse_i - extra_adjustment), font, font_scale, font_color, thickness)
-        if tag_position != 'top':
-            y1 += margin
-            y2 += margin
+            cv2.putText(frame, tag.replace('\n',''),
+                        (x2 + margin*2, y2 - (margin + text_height)*reverse_i - margin * (reverse_i-1) + int(margin/2) - extra_adjustment),
+                        font, font_scale, font_color, thickness)
 
     return frame
 
@@ -186,7 +235,8 @@ def add_peephole(frame, position, alpha=0.5, color=(110,70,45), thickness=2, lin
              1 means totally visible and 0 totally invisible
     color -- color of the selected zone, touple with 3 elements BGR (default (110,70,45) -> dark blue)
              BGR = Blue - Green - Red
-    normalized -- boolean parameter, if True, position provided normalized (between 0 and 1) else you shold provide concrete values (default False)
+    normalized -- boolean parameter, if True, position provided normalized (between 0 and 1)
+                  else you shold provide concrete values (default False)
     thickness -- thickness of the drawing in pixels (default 2)
     corners -- boolean parameter, if True, also draw the corners of the rectangle
 
@@ -228,7 +278,8 @@ def adjust_position(shape, position, normalized=False, thickness=0):
     position -- touple with 4 elements (x1, y1, x2, y2)
                 This elements must be between 0 and 1 in case it is normalized
                 or between 0 and frame height/width.
-    normalized -- boolean parameter, if True, position provided normalized (between 0 and 1) else you shold provide concrete values (default False)
+    normalized -- boolean parameter, if True, position provided normalized (between 0 and 1)
+                  else you shold provide concrete values (default False)
     thickness -- thickness of the drawing in pixels (default 0)
 
     Return:
@@ -270,7 +321,8 @@ def adjust_position(shape, position, normalized=False, thickness=0):
     y1 = int(min(max(y1, thickness), y2 - thickness))
     return (x1, y1, x2, y2)
 
-def select_zone(frame, position, tags=[], tag_position=None, alpha=0.9, color=(110,70,45), normalized=False, thickness=2, filled=False, peephole=True):
+def select_zone(frame, position, tags=[], tag_position=None, alpha=0.9, color=(110,70,45),
+                normalized=False, thickness=2, filled=False, peephole=True, margin=5):
     """Draw better rectangles to select zones.
 
     Keyword arguments:
@@ -289,10 +341,12 @@ def select_zone(frame, position, tags=[], tag_position=None, alpha=0.9, color=(1
              1 means totally visible and 0 totally invisible
     color -- color of the selected zone, touple with 3 elements BGR (default (110,70,45) -> dark blue)
              BGR = Blue - Green - Red
-    normalized -- boolean parameter, if True, position provided normalized (between 0 and 1) else you should provide concrete values (default False)
+    normalized -- boolean parameter, if True, position provided normalized (between 0 and 1)
+                  else you should provide concrete values (default False)
     thickness -- thickness of the drawing in pixels (default 2)
     filled -- boolean parameter, if True, will draw a filled rectangle with one-third opacity compared to the rectangle (default False)
     peephole -- boolean parameter, if True, also draw additional effect, so it looks like a peephole
+    margin -- extra margin in pixels to be separeted with the selected zone (default 5)
 
     Return:
     A new drawed Frame
@@ -311,7 +365,56 @@ def select_zone(frame, position, tags=[], tag_position=None, alpha=0.9, color=(1
     cv2.rectangle(overlay, (x1, y1), (x2, y2), color,thickness=thickness)
     cv2.addWeighted(overlay, alpha, frame, 1 - alpha, 0, frame)
 
-    frame = add_tags(frame, position, tags, tag_position=tag_position)
+    frame = add_tags(frame, position, tags, tag_position=tag_position, margin=margin)
+    return frame
+
+def select_multiple_zones(frame, all_selected_zones, all_tags=None, alpha=0.9, color=(110,70,45),
+                normalized=False, thickness=2, filled=False, peephole=True, margin=5):
+    """Draw better rectangles to select multiple zones at the same time.
+    It will put tags to the rectangles as better as possible, avoiding (if it is possible) overwritten information.
+
+    Keyword arguments:
+    frame -- opencv frame object where you want to draw
+    all_selected_zones -- list of touple with 4 elements (x1, y1, x2, y2)
+                          This elements must be between 0 and 1 in case it is normalized
+                          or between 0 and frame height/width in other case.
+    all_tags -- list of lists of strings/tags you want to associate to the selected zone.
+                The first element of the list is associated with the first element of all_selected_zones.
+                Therefore, both lists should have the same lenght. (default None)
+    alpha -- transparency of the selected zone on the image (default 0.9)
+             1 means totally visible and 0 totally invisible
+    color -- color of the selected zones, touple with 3 elements BGR (default (110,70,45) -> dark blue)
+             BGR = Blue - Green - Red
+    normalized -- boolean parameter, if True, position provided normalized (between 0 and 1)
+                  else you should provide concrete values (default False)
+    thickness -- thickness of the drawing in pixels (default 2)
+    filled -- boolean parameter, if True, will draw a filled rectangle with one-third opacity compared to the rectangle (default False)
+    peephole -- boolean parameter, if True, also draw additional effect, so it looks like a peephole
+    margin -- extra margin in pixels to be separeted with the selected zone (default 5)
+
+    Return:
+    A new drawed Frame
+
+    """
+    all_selected_zones = [adjust_position(frame.shape[:2], zone, normalized=normalized, thickness=thickness) for zone in all_selected_zones]
+    if not all_tags:
+        for zone in all_selected_zones:
+            frame = select_zone(frame, zone, alpha=alpha, color=color, normalized=normalized,
+                                thickness=thickness, filled=filled, peephole=peephole)
+    else:
+        f_height, f_width = frame.shape[:2]
+        all_tags_shapes = []
+        for i, zone in enumerate(all_selected_zones):
+            all_tags_shapes.append(get_shape_tags(zone, all_tags[i], margin=margin))
+        # Here you could pass the frame if you want to see where tags_constraint thinks the tags will be.           Just: frame=frame     \/
+        best_position = tags_constraint.get_possible_positions(f_width, f_height, all_selected_zones, all_tags_shapes, margin=margin, frame=[])
+        for i, zone in enumerate(all_selected_zones):
+            if best_position:
+                position = best_position[i]
+            else:
+                position = None
+            frame = select_zone(frame, zone, tags=all_tags[i], tag_position=position, alpha=alpha, color=color,
+                                thickness=thickness, filled=filled, peephole=peephole, margin=margin)
     return frame
 
 def webcam_test():
@@ -326,9 +429,12 @@ def webcam_test():
         frame = cv2.flip(frame, 1)
         if ret:
             keystroke = cv2.waitKey(1)
-            position = (0.33,0.2,0.66,0.8)
-            tags = ['MIT License', '(C) Copyright\n    Fernando\n    Perez\n    Gutierrez']
-            frame = select_zone(frame, position, tags=tags, color=(130,58,14), thickness=2, filled=True, normalized=True)
+            position1 = (0.33,0.2,0.66,0.8)
+            tags1 = ['MIT License', '(C) Copyright\n    Fernando\n    Perez\n    Gutierrez\n hola\n', 'mundo']
+            position2 = (0.22,0.4,0.3,0.88)
+            tags2 = ['Release', 'v1.0.0']
+            frame = select_multiple_zones(frame, [position1,position2], all_tags=[tags1,tags2], color=(14,28,200),
+                                thickness=2, filled=True, normalized=True)
             cv2.imshow(window_name, frame)
             # True if escape 'esc' is pressed
             if keystroke == 27:
@@ -343,6 +449,9 @@ def get_complete_help():
     * select_zone:
     {}
 
+    * select_multiple_zones:
+    {}
+
     * add_peephole:
     {}
 
@@ -362,7 +471,7 @@ def get_complete_help():
     * webcam_test:
     {}
 
-    '''.format(select_zone.__doc__, add_peephole.__doc__,
+    '''.format(select_zone.__doc__, select_multiple_zones.__doc__, add_peephole.__doc__,
                add_tags.__doc__, get_lighter_color.__doc__, adjust_position.__doc__,
                webcam_test.__doc__)
 

opencv_draw_tools/__init__.py

@@ -6,7 +6,7 @@
 Copyright (c) 2019 Fernando Perez
 For more information visit: https://github.com/fernaper/opencv-draw-tools
 Also you can write complete_help to view full information'''
-__version__ =  '0.2.0'
+__version__ =  '1.0.0'
 
 complete_help = '''
 {} - v{}