megadetector 5.0.28__py3-none-any.whl → 10.0.0__py3-none-any.whl

megadetector/postprocessing/combine_batch_outputs.py

@@ -27,14 +27,15 @@ the results of multiple model versions, see merge_detections.py.
 import argparse
 import sys
 import json
+from megadetector.utils import ct_utils
 
 
 #%% Merge functions
 
 def combine_batch_output_files(input_files,
-                             output_file=None,
-                             require_uniqueness=True,
-                             verbose=True):
+                               output_file=None,
+                               require_uniqueness=True,
+                               verbose=True):
     """
     Merges the list of MD results files [input_files] into a single
     dictionary, optionally writing the result to [output_file].
@@ -42,18 +43,19 @@ def combine_batch_output_files(input_files,
     Args:
         input_files (list of str): paths to JSON detection files
         output_file (str, optional): path to write merged JSON
-        require_uniqueness (bool): whether to require that the images in
+        require_uniqueness (bool, optional): whether to require that the images in
             each list of images be unique
-            
+        verbose (bool, optional): enable additional debug output
+
     Returns:
-        dict: merged dictionaries loaded from [input_files], identical to what's 
+        dict: merged dictionaries loaded from [input_files], identical to what's
         written to [output_file] if [output_file] is not None
     """
-    
+
     def print_if_verbose(s):
         if verbose:
             print(s)
-            
+
     input_dicts = []
     for fn in input_files:
         print_if_verbose('Loading results from {}'.format(fn))
@@ -66,8 +68,7 @@ def combine_batch_output_files(input_files,
 
     print_if_verbose('Writing output to {}'.format(output_file))
     if output_file is not None:
-        with open(output_file, 'w') as f:
-            json.dump(merged_dict, f, indent=1)
+        ct_utils.write_json(output_file, merged_dict)
 
     return merged_dict
 
@@ -78,16 +79,16 @@ def combine_batch_output_dictionaries(input_dicts, require_uniqueness=True):
     See module header comment for details on merge rules.
 
     Args:
-        input_dicts (list of dicts): list of dicts in which each dict represents the 
+        input_dicts (list of dicts): list of dicts in which each dict represents the
             contents of a MD output file
-        require_uniqueness (bool): whether to require that the images in
+        require_uniqueness (bool, optional): whether to require that the images in
             each input dict be unique; if this is True and image filenames are
             not unique, an error is raised.
 
-    Returns
+    Returns:
         dict: merged MD results
     """
-    
+
     # Map image filenames to detections, we'll convert to a list later
     images = {}
     info = {}
@@ -183,17 +184,17 @@ def combine_api_shard_files(input_files, output_file=None):
     """
     Merges the list of .json-formatted API shard files [input_files] into a single
     list of dictionaries, optionally writing the result to [output_file].
-    
+
     This operates on mostly-deprecated API shard files, not MegaDetector results files.
     If you don't know what an API shard file is, you don't want this function.
-    
+
     Args:
         input_files (list of str): files to merge
         output_file (str, optional): file to which we should write merged results
-        
+
     Returns:
         dict: merged results
-        
+
     :meta private:
     """
 
@@ -215,8 +216,7 @@ def combine_api_shard_files(input_files, output_file=None):
 
     print('Writing output')
     if output_file is not None:
-        with open(output_file, 'w') as f:
-            json.dump(detections, f, indent=1)
+        ct_utils.write_json(output_file, detections)
 
     return detections
 
@@ -225,8 +225,8 @@ def combine_api_shard_files(input_files, output_file=None):
 
 #%% Command-line driver
 
-def main():
-    
+def main(): # noqa
+
     parser = argparse.ArgumentParser()
     parser.add_argument(
         'input_paths', nargs='+',
@@ -234,7 +234,7 @@ def main():
     parser.add_argument(
         'output_path',
         help='Output .json file')
-    
+
     if len(sys.argv[1:]) == 0:
         parser.print_help()
         parser.exit()