megadetector 5.0.6__py3-none-any.whl → 5.0.8__py3-none-any.whl

data_management/labelme_to_yolo.py

@@ -11,6 +11,9 @@
 import os
 import json
 
+from multiprocessing.pool import Pool, ThreadPool
+from functools import partial
+
 from md_utils.path_utils import recursive_file_list
 from tqdm import tqdm
 
@@ -21,22 +24,21 @@ def labelme_file_to_yolo_file(labelme_file,
                               category_name_to_category_id,
                               yolo_file=None,
                               required_token=None,
-                              right_edge_quantization_threshold=None,
                               overwrite_behavior='overwrite'):
     """
     Convert the single .json file labelme_file to yolo format, writing the results to the text
     file yolo_file (defaults to s/json/txt).
     
-    If required_token is not None and the labelme_file does not contain the key [required_token],
-    no-ops.
+    If required_token is not None and the dict in labelme_file does not contain the key [required_token],
+    this function no-ops (i.e., does not generate a YOLO file).    
     
-    right_edge_quantization_threshold is an off-by-default hack to handle cases where 
-    boxes that really should be running off the right side of the image only extend like 99%
-    of the way there, due to what appears to be a slight bias inherent to MD.  If a box extends
-    within [right_edge_quantization_threshold] (a small number, from 0 to 1, but probably around 
-    0.02) of the right edge of the image, it will be extended to the far right edge.    
+    overwrite_behavior should be 'skip' or 'overwrite' (default).
     """
     
+    result = {}
+    result['labelme_file'] = labelme_file
+    result['status'] = 'unknown'
+    
     assert os.path.isfile(labelme_file), 'Could not find labelme .json file {}'.format(labelme_file)
     assert labelme_file.endswith('.json'), 'Illegal labelme .json file {}'.format(labelme_file)
     
@@ -45,7 +47,8 @@ def labelme_file_to_yolo_file(labelme_file,
     
     if os.path.isfile(yolo_file):
         if overwrite_behavior == 'skip':
-            return
+            result['status'] = 'skip-exists'
+            return result
         else:
             assert overwrite_behavior == 'overwrite', \
                 'Unrecognized overwrite behavior {}'.format(overwrite_behavior)
@@ -54,7 +57,8 @@ def labelme_file_to_yolo_file(labelme_file,
         labelme_data = json.load(f)
         
     if required_token is not None and required_token not in labelme_data:
-        return
+        result['status'] = 'skip-no-required-token'
+        return result
     
     im_height = labelme_data['imageHeight']
     im_width = labelme_data['imageWidth']
@@ -83,10 +87,12 @@ def labelme_file_to_yolo_file(labelme_file,
         
         if (minx_abs >= (im_width-1)) or (maxx_abs <= 0) or \
             (miny_abs >= (im_height-1)) or (maxy_abs <= 0):
-                print('Skipping invalid shape in {}'.format(labelme_file))
+                print('Skipping invalid shape in {}'.format(labelme_file))                
                 continue
             
-        # Clip to [0,1]
+        # Clip to [0,1]... it's not obvious that the YOLO format doesn't allow bounding
+        # boxes to extend outside the image, but YOLOv5 and YOLOv8 get sad about boxes
+        # that extend outside the image.
         maxx_abs = min(maxx_abs,im_width-1)
         maxy_abs = min(maxy_abs,im_height-1)
         minx_abs = max(minx_abs,0.0)
@@ -97,11 +103,6 @@ def labelme_file_to_yolo_file(labelme_file,
         miny_rel = miny_abs / (im_height-1)
         maxy_rel = maxy_abs / (im_height-1)
         
-        if (right_edge_quantization_threshold is not None):
-            right_edge_distance = 1.0 - maxx_rel
-            if right_edge_distance < right_edge_quantization_threshold:
-                maxx_rel = 1.0
-        
         assert maxx_rel >= minx_rel
         assert maxy_rel >= miny_rel
         
@@ -119,32 +120,45 @@ def labelme_file_to_yolo_file(labelme_file,
     with open(yolo_file,'w') as f:
         for s in yolo_lines:
             f.write(s + '\n')
-        
+    
+    result['status'] = 'converted'
+    return result
+
 
 def labelme_folder_to_yolo(labelme_folder,
                            category_name_to_category_id=None,
                            required_token=None,
-                           right_edge_quantization_threshold=None,
-                           overwrite_behavior='overwrite'):
+                           overwrite_behavior='overwrite',
+                           relative_filenames_to_convert=None,
+                           n_workers=1,
+                           use_threads=True):
     """
     Given a folder with images and labelme .json files, convert the .json files
     to YOLO .txt format.  If category_name_to_category_id is None, first reads
     all the labels in the folder to build a zero-indexed name --> ID mapping.
     
     If required_token is not None and a labelme_file does not contain the key [required_token],
-    it won't be converted.
+    it won't be converted.  Typically used to specify a field that indicates which files have
+    been reviewed.
     
-    right_edge_quantization_threshold is an off-by-default hack to handle cases where 
-    boxes that really should be running off the right side of the image only extend like 99%
-    of the way there, due to what appears to be a slight bias inherent to MD.  If a box extends
-    within [right_edge_quantization_threshold] (a small number, from 0 to 1, but probably around 
-    0.02) of the right edge of the image, it will be extended to the far right edge.    
+    If relative_filenames_to_convert is not None, this should be a list of .json (not image)
+    files that should get converted, relative to the base folder.
     
-    returns category_name_to_category_id, whether it was passed in or constructed.
+    overwrite_behavior should be 'skip' or 'overwrite' (default).
+    
+    returns a dict with:
+        'category_name_to_category_id', whether it was passed in or constructed
+        'image_results': a list of results for each image (converted, skipped, error)
+        
     """
     
-    labelme_files_relative = recursive_file_list(labelme_folder,return_relative_paths=True)
-    labelme_files_relative = [fn for fn in labelme_files_relative if fn.endswith('.json')]
+    if relative_filenames_to_convert is not None:
+        labelme_files_relative = relative_filenames_to_convert
+        assert all([fn.endswith('.json') for fn in labelme_files_relative]), \
+            'relative_filenames_to_convert contains non-json files'
+    else:
+        labelme_files_relative = recursive_file_list(labelme_folder,return_relative_paths=True)
+        labelme_files_relative = [fn for fn in labelme_files_relative if fn.endswith('.json')]
     
     if required_token is None:
         valid_labelme_files_relative = labelme_files_relative
@@ -163,9 +177,9 @@ def labelme_folder_to_yolo(labelme_folder,
                 
             valid_labelme_files_relative.append(fn_relative)
     
-    print('{} of {} files are valid'.format(len(valid_labelme_files_relative),
-                                           len(labelme_files_relative)))
-    
+        print('{} of {} files are valid'.format(len(valid_labelme_files_relative),
+                                                len(labelme_files_relative)))
+        
     del labelme_files_relative
         
     if category_name_to_category_id is None:
@@ -184,26 +198,54 @@ def labelme_folder_to_yolo(labelme_folder,
         # ...for each file
         
     # ...if we need to build a category mapping
-            
-    for fn_relative in tqdm(valid_labelme_files_relative):
-        
-        fn_abs = os.path.join(labelme_folder,fn_relative)
-        labelme_file_to_yolo_file(fn_abs,
-                                  category_name_to_category_id,
-                                  yolo_file=None,
-                                  required_token=required_token,
-                                  right_edge_quantization_threshold=\
-                                      right_edge_quantization_threshold,
-                                  overwrite_behavior=overwrite_behavior)
     
-    # ...for each file
+    image_results = []
+    
+    n_workers = min(n_workers,len(valid_labelme_files_relative))
+    
+    if n_workers <= 1:
+        for fn_relative in tqdm(valid_labelme_files_relative):
+            
+            fn_abs = os.path.join(labelme_folder,fn_relative)
+            image_result = labelme_file_to_yolo_file(fn_abs,
+                                      category_name_to_category_id,
+                                      yolo_file=None,
+                                      required_token=required_token,
+                                      overwrite_behavior=overwrite_behavior)
+            image_results.append(image_result)
+        # ...for each file
+    else:
+        if use_threads:
+            pool = ThreadPool(n_workers)
+        else:
+            pool = Pool(n_workers)
+
+        valid_labelme_files_abs = [os.path.join(labelme_folder,fn_relative) for \
+                                   fn_relative in valid_labelme_files_relative]
+            
+        image_results = list(tqdm(pool.imap(
+            partial(labelme_file_to_yolo_file,
+                    category_name_to_category_id=category_name_to_category_id,
+                    yolo_file=None,
+                    required_token=required_token,
+                    overwrite_behavior=overwrite_behavior),
+                    valid_labelme_files_abs), 
+                    total=len(valid_labelme_files_abs)))
+
+    assert len(valid_labelme_files_relative) == len(image_results)
     
     print('Converted {} labelme .json files to YOLO'.format(
         len(valid_labelme_files_relative)))
     
-    return category_name_to_category_id
+    labelme_to_yolo_results = {}
+    labelme_to_yolo_results['category_name_to_category_id'] = category_name_to_category_id
+    labelme_to_yolo_results['image_results'] = image_results
     
-        
+    return labelme_to_yolo_results
+    
+# ...def labelme_folder_to_yolo(...)        
+
+
 #%% Interactive driver
 
 if False:
@@ -212,18 +254,19 @@ if False:
 
     #%%
 
-    import os
     labelme_file = os.path.expanduser('~/tmp/labels/x.json')
-    yolo_file = None
     required_token = 'saved_by_labelme'
-    right_edge_quantization_threshold = 0.015
     category_name_to_category_id = {'animal':0}
+    labelme_folder = os.path.expanduser('~/tmp/labels')
 
     #%%
     
-    labelme_folder = os.path.expanduser('~/tmp/labels')
-
-
+    category_name_to_category_id = \
+        labelme_folder_to_yolo(labelme_folder,
+                               category_name_to_category_id=category_name_to_category_id,
+                               required_token=required_token,
+                               overwrite_behavior='overwrite')
+    
 #%% Command-line driver
 
-# TODO
+# TODO