megadetector 5.0.9__py3-none-any.whl → 5.0.11__py3-none-any.whl

api/batch_processing/postprocessing/repeat_detection_elimination/find_repeat_detections.py

@@ -1,211 +0,0 @@
-r"""
-
-find_repeat_detections.py
-
-If you want to use this script, we recommend that you read the RDE user's guide:
-
-https://github.com/agentmorris/MegaDetector/tree/master/api/batch_processing/postprocessing/repeat_detection_elimination
-
-Really, don't try to run this script without reading the user's guide, you'll think 
-it's more magical than it is. 
-
-This script looks through a sequence of detections in the API output json file, and finds 
-candidates that might be "repeated false positives", i.e. that random branch that the 
-detector thinks is an animal/person/vehicle.
-
-Typically after running this script, you would do a manual step to remove 
-true positives, then run remove_repeat_detections to produce a final output file.
-
-There's no way that statement was self-explanatory; see the user's guide.
-
-This script is just a command-line driver for repeat_detections_core.py.
-
-"""
-
-#%% Constants and imports
-
-import argparse
-import os
-import sys
-
-from md_utils import ct_utils
-from api.batch_processing.postprocessing.repeat_detection_elimination import repeat_detections_core
-
-
-#%% Interactive driver
-
-if False:
-    
-    #%%
-
-    baseDir = ''
-
-    options = repeat_detections_core.RepeatDetectionOptions()
-    options.bRenderHtml = True
-    options.imageBase = baseDir
-    options.outputBase = os.path.join(baseDir, 'repeat_detections')
-    options.filenameReplacements = {}  # E.g., {'20190430cameratraps\\':''}
-
-    options.confidenceMin = 0.15
-    options.confidenceMax = 1.01
-    options.iouThreshold = 0.85
-    options.occurrenceThreshold = 8
-    options.maxSuspiciousDetectionSize = 0.2
-
-    options.filterFileToLoad = ''
-    options.filterFileToLoad = os.path.join(baseDir,r'..\detectionIndex.json')
-
-    options.debugMaxDir = -1
-    options.debugMaxRenderDir = -1
-    options.debugMaxRenderDetection = -1
-    options.debugMaxRenderInstance = -1
-
-    options.bParallelizeComparisons = False
-    options.bParallelizeRendering = False
-    options.excludeClasses = [2]
-
-    inputFilename = os.path.join(baseDir, 'blah.json')
-    outputFilename = os.path.join(baseDir, 'blah.json')
-
-    results = repeat_detections_core.find_repeat_detections(inputFilename, outputFilename, options)
-
-
-#%% Command-line driver
-
-def main():
-    
-    defaultOptions = repeat_detections_core.RepeatDetectionOptions()
-
-    parser = argparse.ArgumentParser()
-    
-    parser.add_argument('inputFile', type=str, help='MD results .json file to process')
-    
-    parser.add_argument('--outputFile', action='store', type=str, default=None,
-                        help='.json file to write filtered results to... do not use this if you are going to ' + \
-                             'do manual review of the repeat detection images (which you should)')
-        
-    parser.add_argument('--imageBase', action='store', type=str, default='',
-                        help='Image base dir, relevant if renderHtml is True or if ' + \
-                             '"omitFilteringFolder" is not set')
-                            
-    parser.add_argument('--outputBase', action='store', type=str, default='',
-                        help='HTML or filtering folder output dir')
-    
-    parser.add_argument('--confidenceMin', action='store', type=float,
-                        default=defaultOptions.confidenceMin,
-                        help='Detection confidence threshold; don\'t process anything below this')
-    
-    parser.add_argument('--confidenceMax', action='store', type=float,
-                        default=defaultOptions.confidenceMax,
-                        help='Detection confidence threshold; don\'t process anything above this')
-    
-    parser.add_argument('--iouThreshold', action='store', type=float,
-                        default=defaultOptions.iouThreshold,
-                        help='Detections with IOUs greater than this are considered ' + \
-                             '"the same detection"')
-        
-    parser.add_argument('--occurrenceThreshold', action='store', type=int,
-                        default=defaultOptions.occurrenceThreshold,
-                        help='More than this many near-identical detections in a group ' + \
-                             '(e.g. a folder) is considered suspicious')
-        
-    parser.add_argument('--minSuspiciousDetectionSize', action='store', type=float,
-                        default=defaultOptions.minSuspiciousDetectionSize,
-                        help='Detections smaller than this fraction of image area are not ' + \
-                             'considered suspicious')
-
-    parser.add_argument('--maxSuspiciousDetectionSize', action='store', type=float,
-                        default=defaultOptions.maxSuspiciousDetectionSize,
-                        help='Detections larger than this fraction of image area are not ' + \
-                             'considered suspicious')
-
-    parser.add_argument('--maxImagesPerFolder', action='store', type=int,
-                        default=defaultOptions.maxImagesPerFolder,
-                        help='Ignore folders with more than this many images in them')
-    
-    parser.add_argument('--excludeClasses', action='store', nargs='+', type=int,
-                        default=None,
-                        help='List of integer classes we don\'t want to treat as suspicious, separated by spaces.')
-    
-    parser.add_argument('--pass_detections_to_processes_method', action='store', type=str,
-                        default=defaultOptions.pass_detections_to_processes_method,
-                        help='Pass detections information to/from workers via "memory" (default) or "files"')
-    
-    parser.add_argument('--nWorkers', action='store', type=int,
-                        default=defaultOptions.nWorkers,
-                        help='Level of parallelism for rendering and IOU computation')
-    
-    parser.add_argument('--parallelizationUsesProcesses', action='store_false', 
-                        dest='parallelizationUsesThreads',
-                        help='Parallelize with processes (defaults to threads)')    
-    
-    parser.add_argument('--filterFileToLoad', action='store', type=str, default='',  
-                        help='Path to detectionIndex.json, which should be inside a ' + \
-                             'folder of images that are manually verified to _not_ ' + \
-                             'contain valid animals')
-
-    parser.add_argument('--omitFilteringFolder', action='store_false',
-                        dest='bWriteFilteringFolder',
-                        help='Should we create a folder of rendered detections for post-filtering?')
-    
-    parser.add_argument('--debugMaxDir', action='store', type=int, default=-1, 
-                        help='For debugging only, limit the number of directories we process')
-    parser.add_argument('--debugMaxRenderDir', action='store', type=int, default=-1,
-                        help='For debugging only, limit the number of directories we render')
-    parser.add_argument('--debugMaxRenderDetection', action='store', type=int, default=-1,
-                        help='For debugging only, limit the number of detections we process per folder')
-    parser.add_argument('--debugMaxRenderInstance', action='store', type=int, default=-1,
-                        help='For debugging only, limit the number of instances we process per detection')
-
-    parser.add_argument('--forceSerialComparisons', action='store_false',
-                        dest='bParallelizeComparisons',
-                        help='Disable parallelization during the comparison stage')
-    parser.add_argument('--forceSerialRendering', action='store_false',
-                        dest='bParallelizeRendering',
-                        help='Disable parallelization during the rendering stage')
-    
-    parser.add_argument('--maxOutputImageWidth', action='store', type=int,
-                        default=defaultOptions.maxOutputImageWidth,
-                        help='Maximum output size for thumbnail images') 
-    
-    parser.add_argument('--lineThickness', action='store', type=int,
-                        default=defaultOptions.lineThickness,
-                        help='Line thickness thumbnail images')    
-    
-    parser.add_argument('--boxExpansion', action='store', type=int,
-                        default=defaultOptions.boxExpansion,
-                        help='Box expansion for thumbnail images')
-        
-    parser.add_argument('--nDirLevelsFromLeaf', type=int,
-                        default=defaultOptions.nDirLevelsFromLeaf,
-                        help='Number of levels from the leaf folders to use for repeat ' + \
-                             'detection (0 == leaves)')
-
-    parser.add_argument('--bRenderOtherDetections', action='store_true',
-                        help='Show non-target detections in light gray on each image')
-    
-    parser.add_argument('--bRenderDetectionTiles', action='store_true',
-                        help='Should we render a grid showing every instance (up to a limit) for each detection?')
-    
-    parser.add_argument('--detectionTilesPrimaryImageWidth', type=int,
-                        default=defaultOptions.detectionTilesPrimaryImageWidth,
-                        help='The width of the main image when rendering images with detection tiles')
-
-    parser.add_argument('--renderHtml', action='store_true',
-                        dest='bRenderHtml', help='Should we render HTML output?')
-    
-    if len(sys.argv[1:]) == 0:
-        parser.print_help()
-        parser.exit()
-
-    args = parser.parse_args()
-
-    # Convert to an options object
-    options = repeat_detections_core.RepeatDetectionOptions()
-
-    ct_utils.args_to_object(args, options)
-
-    repeat_detections_core.find_repeat_detections(args.inputFile, args.outputFile, options)
-
-if __name__ == '__main__':
-    main()

api/batch_processing/postprocessing/repeat_detection_elimination/remove_repeat_detections.py

@@ -1,82 +0,0 @@
-"""
-
-remove_repeat_detections.py
-
-Used after running find_repeat_detections, then manually filtering the results,
-to create a final filtered output file.
-
-If you want to use this script, we recommend that you read the RDE user's guide:
-
-https://github.com/agentmorris/MegaDetector/tree/master/api/batch_processing/postprocessing/repeat_detection_elimination
-
-"""
-
-#%% Constants and imports
-
-import argparse
-import os
-from api.batch_processing.postprocessing.repeat_detection_elimination import repeat_detections_core
-
-
-#%% Main function
-
-def remove_repeat_detections(inputFile,outputFile,filteringDir):
-    """
-    Given an index file that was produced in a first pass through find_repeat_detections,
-    and a folder of images (from which the user has deleted images they don't want removed),
-    remove the identified repeat detections from a set of MD results and write to a new file.
-    
-    Args:
-        inputFile (str): .json file of MD results, from which we should remove repeat detections
-        outputFile (str): output .json file to which we should write MD results (with repeat 
-            detections removed)
-        filteringDir (str): the folder produced by find_repeat_detections, containing a 
-            detectionIndex.json file        
-    """
-    
-    assert os.path.isfile(inputFile), "Can't find file {}".format(inputFile)
-    assert os.path.isdir(filteringDir), "Can't find folder {}".format(filteringDir)
-    options = repeat_detections_core.RepeatDetectionOptions()
-    if os.path.isfile(filteringDir):
-        options.filterFileToLoad = filteringDir
-    else:
-        assert os.path.isdir(filteringDir), '{} is not a valid folder'.format(filteringDir)
-        options.filterFileToLoad = \
-            os.path.join(filteringDir,repeat_detections_core.detection_index_file_name_base)
-    repeat_detections_core.find_repeat_detections(inputFile, outputFile, options)
-
-
-#%% Interactive driver
-
-if False:
-    
-    #%%
-    
-    inputFile = r''
-    outputFile = r''
-    filteringDir = r''
-    remove_repeat_detections(inputFile,outputFile,filteringDir)
-
-
-#%% Command-line driver
-
-import sys
-
-def main():
-    
-    parser = argparse.ArgumentParser()
-    parser.add_argument('inputFile', help='.json file containing the original, unfiltered API results')
-    parser.add_argument('outputFile', help='.json file to which you want to write the final, ' + \
-                        'filtered API results')
-    parser.add_argument('filteringDir', help='directory where you looked at lots of images and ' + \
-                        'decided which ones were really false positives')
-    
-    if len(sys.argv[1:]) == 0:
-        parser.print_help()
-        parser.exit()
-
-    args = parser.parse_args()
-    remove_repeat_detections(args.inputFile, args.outputFile, args.filteringDir)
-
-if __name__ == '__main__':
-    main()