accessiplot.detection.handler.DetectionHandler

class accessiplot.detection.handler.DetectionHandler(ax, histogram=None)[source]

This is the entry point for generating detection outputs for a given axes object. It takes a matplotlib axes object and runs a set of detections specified by the user when they call self.run_detections(). Additionally when running on a histogram plot, additional context must be passed in to the histogram parameter to be able to get the proper colors and labels.

Parameters:
ax: Axes object

Matplotlib Axes object.

histogram: tuple

A tuple of histogram metadata from calling ax.hist()

Methods

run_detections(run_detections_list)

Run specific list of detections and generate results in a JSON formatted output and store that in self.detections.