ultralytics 8.3.11__py3-none-any.whl → 8.3.13__py3-none-any.whl

ultralytics/solutions/analytics.py

@@ -1,6 +1,5 @@
 # Ultralytics YOLO 🚀, AGPL-3.0 license
 
-import warnings
 from itertools import cycle
 
 import cv2
@@ -9,299 +8,187 @@ import numpy as np
 from matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas
 from matplotlib.figure import Figure
 
+from ultralytics.solutions.solutions import BaseSolution  # Import a parent class
 
-class Analytics:
+
+class Analytics(BaseSolution):
     """A class to create and update various types of charts (line, bar, pie, area) for visual analytics."""
 
-    def __init__(
-        self,
-        type,
-        writer,
-        im0_shape,
-        title="ultralytics",
-        x_label="x",
-        y_label="y",
-        bg_color="white",
-        fg_color="black",
-        line_color="yellow",
-        line_width=2,
-        points_width=10,
-        fontsize=13,
-        view_img=False,
-        save_img=True,
-        max_points=50,
-    ):
-        """
-        Initialize the Analytics class with various chart types.
+    def __init__(self, **kwargs):
+        """Initialize the Analytics class with various chart types."""
+        super().__init__(**kwargs)
 
-        Args:
-            type (str): Type of chart to initialize ('line', 'bar', 'pie', or 'area').
-            writer (object): Video writer object to save the frames.
-            im0_shape (tuple): Shape of the input image (width, height).
-            title (str): Title of the chart.
-            x_label (str): Label for the x-axis.
-            y_label (str): Label for the y-axis.
-            bg_color (str): Background color of the chart.
-            fg_color (str): Foreground (text) color of the chart.
-            line_color (str): Line color for line charts.
-            line_width (int): Width of the lines in line charts.
-            points_width (int): Width of line points highlighter
-            fontsize (int): Font size for chart text.
-            view_img (bool): Whether to display the image.
-            save_img (bool): Whether to save the image.
-            max_points (int): Specifies when to remove the oldest points in a graph for multiple lines.
-        """
-        self.bg_color = bg_color
-        self.fg_color = fg_color
-        self.view_img = view_img
-        self.save_img = save_img
-        self.title = title
-        self.writer = writer
-        self.max_points = max_points
-        self.line_color = line_color
-        self.x_label = x_label
-        self.y_label = y_label
-        self.points_width = points_width
-        self.line_width = line_width
-        self.fontsize = fontsize
+        self.type = self.CFG["analytics_type"]  # extract type of analytics
+        self.x_label = "Classes" if self.type in {"bar", "pie"} else "Frame#"
+        self.y_label = "Total Counts"
+
+        # Predefined data
+        self.bg_color = "#00F344"  # background color of frame
+        self.fg_color = "#111E68"  # foreground color of frame
+        self.title = "Ultralytics Solutions"  # window name
+        self.max_points = 45  # maximum points to be drawn on window
+        self.fontsize = 25  # text font size for display
+        figsize = (19.2, 10.8)  # Set output image size 1920 * 1080
+        self.color_cycle = cycle(["#DD00BA", "#042AFF", "#FF4447", "#7D24FF", "#BD00FF"])
 
-        # Set figure size based on image shape
-        figsize = (im0_shape[0] / 100, im0_shape[1] / 100)
+        self.total_counts = 0  # count variable for storing total counts i.e for line
+        self.clswise_count = {}  # dictionary for classwise counts
 
-        if type in {"line", "area"}:
-            # Initialize line or area plot
+        # Ensure line and area chart
+        if self.type in {"line", "area"}:
             self.lines = {}
             self.fig = Figure(facecolor=self.bg_color, figsize=figsize)
-            self.canvas = FigureCanvas(self.fig)
+            self.canvas = FigureCanvas(self.fig)  # Set common axis properties
             self.ax = self.fig.add_subplot(111, facecolor=self.bg_color)
-            if type == "line":
-                (self.line,) = self.ax.plot([], [], color=self.line_color, linewidth=self.line_width)
-
-        elif type in {"bar", "pie"}:
+            if self.type == "line":
+                (self.line,) = self.ax.plot([], [], color="cyan", linewidth=self.line_width)
+        elif self.type in {"bar", "pie"}:
             # Initialize bar or pie plot
             self.fig, self.ax = plt.subplots(figsize=figsize, facecolor=self.bg_color)
+            self.canvas = FigureCanvas(self.fig)  # Set common axis properties
             self.ax.set_facecolor(self.bg_color)
-            color_palette = [
-                (31, 119, 180),
-                (255, 127, 14),
-                (44, 160, 44),
-                (214, 39, 40),
-                (148, 103, 189),
-                (140, 86, 75),
-                (227, 119, 194),
-                (127, 127, 127),
-                (188, 189, 34),
-                (23, 190, 207),
-            ]
-            self.color_palette = [(r / 255, g / 255, b / 255, 1) for r, g, b in color_palette]
-            self.color_cycle = cycle(self.color_palette)
             self.color_mapping = {}
+            self.ax.axis("equal") if type == "pie" else None  # Ensure pie chart is circular
 
-            # Ensure pie chart is circular
-            self.ax.axis("equal") if type == "pie" else None
-
-        # Set common axis properties
-        self.ax.set_title(self.title, color=self.fg_color, fontsize=self.fontsize)
-        self.ax.set_xlabel(x_label, color=self.fg_color, fontsize=self.fontsize - 3)
-        self.ax.set_ylabel(y_label, color=self.fg_color, fontsize=self.fontsize - 3)
-        self.ax.tick_params(axis="both", colors=self.fg_color)
+    def process_data(self, im0, frame_number):
+        """
+        Process the image data, run object tracking.
 
-    def update_area(self, frame_number, counts_dict):
+        Args:
+            im0 (ndarray): Input image for processing.
+            frame_number (int): Video frame # for plotting the data.
+        """
+        self.extract_tracks(im0)  # Extract tracks
+
+        if self.type == "line":
+            for box in self.boxes:
+                self.total_counts += 1
+            im0 = self.update_graph(frame_number=frame_number)
+            self.total_counts = 0
+        elif self.type == "pie" or self.type == "bar" or self.type == "area":
+            self.clswise_count = {}
+            for box, cls in zip(self.boxes, self.clss):
+                if self.names[int(cls)] in self.clswise_count:
+                    self.clswise_count[self.names[int(cls)]] += 1
+                else:
+                    self.clswise_count[self.names[int(cls)]] = 1
+            im0 = self.update_graph(frame_number=frame_number, count_dict=self.clswise_count, plot=self.type)
+        else:
+            raise ModuleNotFoundError(f"{self.type} chart is not supported ❌")
+        return im0
+
+    def update_graph(self, frame_number, count_dict=None, plot="line"):
         """
-        Update the area graph with new data for multiple classes.
+        Update the graph (line or area) with new data for single or multiple classes.
 
         Args:
             frame_number (int): The current frame number.
-            counts_dict (dict): Dictionary with class names as keys and counts as values.
+            count_dict (dict, optional): Dictionary with class names as keys and counts as values for multiple classes.
+                                          If None, updates a single line graph.
+            plot (str): Type of the plot i.e. line, bar or area.
         """
-        x_data = np.array([])
-        y_data_dict = {key: np.array([]) for key in counts_dict.keys()}
-
-        if self.ax.lines:
-            x_data = self.ax.lines[0].get_xdata()
-            for line, key in zip(self.ax.lines, counts_dict.keys()):
-                y_data_dict[key] = line.get_ydata()
-
-        x_data = np.append(x_data, float(frame_number))
-        max_length = len(x_data)
-
-        for key in counts_dict.keys():
-            y_data_dict[key] = np.append(y_data_dict[key], float(counts_dict[key]))
-            if len(y_data_dict[key]) < max_length:
-                y_data_dict[key] = np.pad(y_data_dict[key], (0, max_length - len(y_data_dict[key])), "constant")
-
-        # Remove the oldest points if the number of points exceeds max_points
-        if len(x_data) > self.max_points:
-            x_data = x_data[1:]
-            for key in counts_dict.keys():
-                y_data_dict[key] = y_data_dict[key][1:]
-
-        self.ax.clear()
-
-        colors = ["#E1FF25", "#0BDBEB", "#FF64DA", "#111F68", "#042AFF"]
-        color_cycle = cycle(colors)
-
-        for key, y_data in y_data_dict.items():
-            color = next(color_cycle)
-            self.ax.fill_between(x_data, y_data, color=color, alpha=0.6)
-            self.ax.plot(
-                x_data,
-                y_data,
-                color=color,
-                linewidth=self.line_width,
-                marker="o",
-                markersize=self.points_width,
-                label=f"{key} Data Points",
-            )
-
+        if count_dict is None:
+            # Single line update
+            x_data = np.append(self.line.get_xdata(), float(frame_number))
+            y_data = np.append(self.line.get_ydata(), float(self.total_counts))
+
+            if len(x_data) > self.max_points:
+                x_data, y_data = x_data[-self.max_points :], y_data[-self.max_points :]
+
+            self.line.set_data(x_data, y_data)
+            self.line.set_label("Counts")
+            self.line.set_color("#7b0068")  # Pink color
+            self.line.set_marker("*")
+            self.line.set_markersize(self.line_width * 5)
+        else:
+            labels = list(count_dict.keys())
+            counts = list(count_dict.values())
+            if plot == "area":
+                color_cycle = cycle(["#DD00BA", "#042AFF", "#FF4447", "#7D24FF", "#BD00FF"])
+                # Multiple lines or area update
+                x_data = self.ax.lines[0].get_xdata() if self.ax.lines else np.array([])
+                y_data_dict = {key: np.array([]) for key in count_dict.keys()}
+                if self.ax.lines:
+                    for line, key in zip(self.ax.lines, count_dict.keys()):
+                        y_data_dict[key] = line.get_ydata()
+
+                x_data = np.append(x_data, float(frame_number))
+                max_length = len(x_data)
+                for key in count_dict.keys():
+                    y_data_dict[key] = np.append(y_data_dict[key], float(count_dict[key]))
+                    if len(y_data_dict[key]) < max_length:
+                        y_data_dict[key] = np.pad(y_data_dict[key], (0, max_length - len(y_data_dict[key])), "constant")
+                if len(x_data) > self.max_points:
+                    x_data = x_data[1:]
+                    for key in count_dict.keys():
+                        y_data_dict[key] = y_data_dict[key][1:]
+
+                self.ax.clear()
+                for key, y_data in y_data_dict.items():
+                    color = next(color_cycle)
+                    self.ax.fill_between(x_data, y_data, color=color, alpha=0.7)
+                    self.ax.plot(
+                        x_data,
+                        y_data,
+                        color=color,
+                        linewidth=self.line_width,
+                        marker="o",
+                        markersize=self.line_width * 5,
+                        label=f"{key} Data Points",
+                    )
+            if plot == "bar":
+                self.ax.clear()  # clear bar data
+                for label in labels:  # Map labels to colors
+                    if label not in self.color_mapping:
+                        self.color_mapping[label] = next(self.color_cycle)
+                colors = [self.color_mapping[label] for label in labels]
+                bars = self.ax.bar(labels, counts, color=colors)
+                for bar, count in zip(bars, counts):
+                    self.ax.text(
+                        bar.get_x() + bar.get_width() / 2,
+                        bar.get_height(),
+                        str(count),
+                        ha="center",
+                        va="bottom",
+                        color=self.fg_color,
+                    )
+                # Create the legend using labels from the bars
+                for bar, label in zip(bars, labels):
+                    bar.set_label(label)  # Assign label to each bar
+                self.ax.legend(loc="upper left", fontsize=13, facecolor=self.fg_color, edgecolor=self.fg_color)
+            if plot == "pie":
+                total = sum(counts)
+                percentages = [size / total * 100 for size in counts]
+                start_angle = 90
+                self.ax.clear()
+
+                # Create pie chart and create legend labels with percentages
+                wedges, autotexts = self.ax.pie(
+                    counts, labels=labels, startangle=start_angle, textprops={"color": self.fg_color}, autopct=None
+                )
+                legend_labels = [f"{label} ({percentage:.1f}%)" for label, percentage in zip(labels, percentages)]
+
+                # Assign the legend using the wedges and manually created labels
+                self.ax.legend(wedges, legend_labels, title="Classes", loc="center left", bbox_to_anchor=(1, 0, 0.5, 1))
+                self.fig.subplots_adjust(left=0.1, right=0.75)  # Adjust layout to fit the legend
+
+        # Common plot settings
+        self.ax.set_facecolor("#f0f0f0")  # Set to light gray or any other color you like
         self.ax.set_title(self.title, color=self.fg_color, fontsize=self.fontsize)
         self.ax.set_xlabel(self.x_label, color=self.fg_color, fontsize=self.fontsize - 3)
         self.ax.set_ylabel(self.y_label, color=self.fg_color, fontsize=self.fontsize - 3)
-        legend = self.ax.legend(loc="upper left", fontsize=13, facecolor=self.bg_color, edgecolor=self.fg_color)
 
-        # Set legend text color
+        # Add and format legend
+        legend = self.ax.legend(loc="upper left", fontsize=13, facecolor=self.bg_color, edgecolor=self.bg_color)
         for text in legend.get_texts():
             text.set_color(self.fg_color)
 
-        self.canvas.draw()
-        im0 = np.array(self.canvas.renderer.buffer_rgba())
-        self.write_and_display(im0)
-
-    def update_line(self, frame_number, total_counts):
-        """
-        Update the line graph with new data.
-
-        Args:
-            frame_number (int): The current frame number.
-            total_counts (int): The total counts to plot.
-        """
-        # Update line graph data
-        x_data = self.line.get_xdata()
-        y_data = self.line.get_ydata()
-        x_data = np.append(x_data, float(frame_number))
-        y_data = np.append(y_data, float(total_counts))
-        self.line.set_data(x_data, y_data)
+        # Redraw graph, update view, capture, and display the updated plot
         self.ax.relim()
         self.ax.autoscale_view()
         self.canvas.draw()
         im0 = np.array(self.canvas.renderer.buffer_rgba())
-        self.write_and_display(im0)
-
-    def update_multiple_lines(self, counts_dict, labels_list, frame_number):
-        """
-        Update the line graph with multiple classes.
-
-        Args:
-            counts_dict (int): Dictionary include each class counts.
-            labels_list (int): list include each classes names.
-            frame_number (int): The current frame number.
-        """
-        warnings.warn("Display is not supported for multiple lines, output will be stored normally!")
-        for obj in labels_list:
-            if obj not in self.lines:
-                (line,) = self.ax.plot([], [], label=obj, marker="o", markersize=self.points_width)
-                self.lines[obj] = line
-
-            x_data = self.lines[obj].get_xdata()
-            y_data = self.lines[obj].get_ydata()
-
-            # Remove the initial point if the number of points exceeds max_points
-            if len(x_data) >= self.max_points:
-                x_data = np.delete(x_data, 0)
-                y_data = np.delete(y_data, 0)
-
-            x_data = np.append(x_data, float(frame_number))  # Ensure frame_number is converted to float
-            y_data = np.append(y_data, float(counts_dict.get(obj, 0)))  # Ensure total_count is converted to float
-            self.lines[obj].set_data(x_data, y_data)
-
-        self.ax.relim()
-        self.ax.autoscale_view()
-        self.ax.legend()
-        self.canvas.draw()
-
-        im0 = np.array(self.canvas.renderer.buffer_rgba())
-        self.view_img = False  # for multiple line view_img not supported yet, coming soon!
-        self.write_and_display(im0)
-
-    def write_and_display(self, im0):
-        """
-        Write and display the line graph
-        Args:
-            im0 (ndarray): Image for processing.
-        """
         im0 = cv2.cvtColor(im0[:, :, :3], cv2.COLOR_RGBA2BGR)
-        cv2.imshow(self.title, im0) if self.view_img else None
-        self.writer.write(im0) if self.save_img else None
-
-    def update_bar(self, count_dict):
-        """
-        Update the bar graph with new data.
-
-        Args:
-            count_dict (dict): Dictionary containing the count data to plot.
-        """
-        # Update bar graph data
-        self.ax.clear()
-        self.ax.set_facecolor(self.bg_color)
-        labels = list(count_dict.keys())
-        counts = list(count_dict.values())
-
-        # Map labels to colors
-        for label in labels:
-            if label not in self.color_mapping:
-                self.color_mapping[label] = next(self.color_cycle)
-
-        colors = [self.color_mapping[label] for label in labels]
-
-        bars = self.ax.bar(labels, counts, color=colors)
-        for bar, count in zip(bars, counts):
-            self.ax.text(
-                bar.get_x() + bar.get_width() / 2,
-                bar.get_height(),
-                str(count),
-                ha="center",
-                va="bottom",
-                color=self.fg_color,
-            )
-
-        # Display and save the updated graph
-        canvas = FigureCanvas(self.fig)
-        canvas.draw()
-        buf = canvas.buffer_rgba()
-        im0 = np.asarray(buf)
-        self.write_and_display(im0)
-
-    def update_pie(self, classes_dict):
-        """
-        Update the pie chart with new data.
-
-        Args:
-            classes_dict (dict): Dictionary containing the class data to plot.
-        """
-        # Update pie chart data
-        labels = list(classes_dict.keys())
-        sizes = list(classes_dict.values())
-        total = sum(sizes)
-        percentages = [size / total * 100 for size in sizes]
-        start_angle = 90
-        self.ax.clear()
-
-        # Create pie chart without labels inside the slices
-        wedges, autotexts = self.ax.pie(sizes, autopct=None, startangle=start_angle, textprops={"color": self.fg_color})
-
-        # Construct legend labels with percentages
-        legend_labels = [f"{label} ({percentage:.1f}%)" for label, percentage in zip(labels, percentages)]
-        self.ax.legend(wedges, legend_labels, title="Classes", loc="center left", bbox_to_anchor=(1, 0, 0.5, 1))
-
-        # Adjust layout to fit the legend
-        self.fig.tight_layout()
-        self.fig.subplots_adjust(left=0.1, right=0.75)
-
-        # Display and save the updated chart
-        im0 = self.fig.canvas.draw()
-        im0 = np.array(self.fig.canvas.renderer.buffer_rgba())
-        self.write_and_display(im0)
-
+        self.display_output(im0)
 
-if __name__ == "__main__":
-    Analytics("line", writer=None, im0_shape=None)
+        return im0  # Return the image

ultralytics/solutions/distance_calculation.py

@@ -4,55 +4,21 @@ import math
 
 import cv2
 
-from ultralytics.utils.checks import check_imshow
+from ultralytics.solutions.solutions import BaseSolution  # Import a parent class
 from ultralytics.utils.plotting import Annotator, colors
 
 
-class DistanceCalculation:
+class DistanceCalculation(BaseSolution):
     """A class to calculate distance between two objects in a real-time video stream based on their tracks."""
 
-    def __init__(
-        self,
-        names,
-        view_img=False,
-        line_thickness=2,
-        line_color=(255, 0, 255),
-        centroid_color=(104, 31, 17),
-    ):
-        """
-        Initializes the DistanceCalculation class with the given parameters.
-
-        Args:
-            names (dict): Dictionary of classes names.
-            view_img (bool, optional): Flag to indicate if the video stream should be displayed. Defaults to False.
-            line_thickness (int, optional): Thickness of the lines drawn on the image. Defaults to 2.
-            line_color (tuple, optional): Color of the lines drawn on the image (BGR format). Defaults to (255, 255, 0).
-            centroid_color (tuple, optional): Color of the centroids drawn (BGR format). Defaults to (255, 0, 255).
-        """
-        # Visual & image information
-        self.im0 = None
-        self.annotator = None
-        self.view_img = view_img
-        self.line_color = line_color
-        self.centroid_color = centroid_color
-
-        # Prediction & tracking information
-        self.names = names
-        self.boxes = None
-        self.line_thickness = line_thickness
-        self.trk_ids = None
-
-        # Distance calculation information
-        self.centroids = []
+    def __init__(self, **kwargs):
+        """Initializes the DistanceCalculation class with the given parameters."""
+        super().__init__(**kwargs)
 
         # Mouse event information
         self.left_mouse_count = 0
         self.selected_boxes = {}
 
-        # Check if environment supports imshow
-        self.env_check = check_imshow(warn=True)
-        self.window_name = "Ultralytics Solutions"
-
     def mouse_event_for_distance(self, event, x, y, flags, param):
         """
         Handles mouse events to select regions in a real-time video stream.
@@ -67,7 +33,7 @@ class DistanceCalculation:
         if event == cv2.EVENT_LBUTTONDOWN:
             self.left_mouse_count += 1
             if self.left_mouse_count <= 2:
-                for box, track_id in zip(self.boxes, self.trk_ids):
+                for box, track_id in zip(self.boxes, self.track_ids):
                     if box[0] < x < box[2] and box[1] < y < box[3] and track_id not in self.selected_boxes:
                         self.selected_boxes[track_id] = box
 
@@ -75,30 +41,21 @@ class DistanceCalculation:
             self.selected_boxes = {}
             self.left_mouse_count = 0
 
-    def start_process(self, im0, tracks):
+    def calculate(self, im0):
         """
         Processes the video frame and calculates the distance between two bounding boxes.
 
         Args:
             im0 (ndarray): The image frame.
-            tracks (list): List of tracks obtained from the object tracking process.
 
         Returns:
             (ndarray): The processed image frame.
         """
-        self.im0 = im0
-        if tracks[0].boxes.id is None:
-            if self.view_img:
-                self.display_frames()
-            return im0
+        self.annotator = Annotator(im0, line_width=self.line_width)  # Initialize annotator
+        self.extract_tracks(im0)  # Extract tracks
 
-        self.boxes = tracks[0].boxes.xyxy.cpu()
-        clss = tracks[0].boxes.cls.cpu().tolist()
-        self.trk_ids = tracks[0].boxes.id.int().cpu().tolist()
-
-        self.annotator = Annotator(self.im0, line_width=self.line_thickness)
-
-        for box, cls, track_id in zip(self.boxes, clss, self.trk_ids):
+        # Iterate over bounding boxes, track ids and classes index
+        for box, track_id, cls in zip(self.boxes, self.track_ids, self.clss):
             self.annotator.box_label(box, color=colors(int(cls), True), label=self.names[int(cls)])
 
             if len(self.selected_boxes) == 2:
@@ -115,25 +72,11 @@ class DistanceCalculation:
             pixels_distance = math.sqrt(
                 (self.centroids[0][0] - self.centroids[1][0]) ** 2 + (self.centroids[0][1] - self.centroids[1][1]) ** 2
             )
-            self.annotator.plot_distance_and_line(pixels_distance, self.centroids, self.line_color, self.centroid_color)
+            self.annotator.plot_distance_and_line(pixels_distance, self.centroids)
 
         self.centroids = []
 
-        if self.view_img and self.env_check:
-            self.display_frames()
-
-        return im0
-
-    def display_frames(self):
-        """Displays the current frame with annotations."""
-        cv2.namedWindow(self.window_name)
-        cv2.setMouseCallback(self.window_name, self.mouse_event_for_distance)
-        cv2.imshow(self.window_name, self.im0)
-
-        if cv2.waitKey(1) & 0xFF == ord("q"):
-            return
-
+        self.display_output(im0)  # display output with base class function
+        cv2.setMouseCallback("Ultralytics Solutions", self.mouse_event_for_distance)
 
-if __name__ == "__main__":
-    names = {0: "person", 1: "car"}  # example class names
-    distance_calculation = DistanceCalculation(names)
+        return im0  # return output image for more usage

ultralytics/solutions/object_counter.py

@@ -112,13 +112,13 @@ class ObjectCounter(BaseSolution):
         # Iterate over bounding boxes, track ids and classes index
         for box, track_id, cls in zip(self.boxes, self.track_ids, self.clss):
             # Draw bounding box and counting region
-            self.annotator.box_label(box, label=self.names[cls], color=colors(track_id, True))
+            self.annotator.box_label(box, label=self.names[cls], color=colors(cls, True))
             self.store_tracking_history(track_id, box)  # Store track history
             self.store_classwise_counts(cls)  # store classwise counts in dict
 
             # Draw tracks of objects
             self.annotator.draw_centroid_and_tracks(
-                self.track_line, color=colors(int(track_id), True), track_thickness=self.line_width
+                self.track_line, color=colors(int(cls), True), track_thickness=self.line_width
             )
 
             # store previous position of track for object counting

ultralytics/utils/metrics.py

@@ -598,7 +598,7 @@ def ap_per_class(
         # AP from recall-precision curve
         for j in range(tp.shape[1]):
             ap[ci, j], mpre, mrec = compute_ap(recall[:, j], precision[:, j])
-            if plot and j == 0:
+            if j == 0:
                 prec_values.append(np.interp(x, mrec, mpre))  # precision at mAP@0.5
 
     prec_values = np.array(prec_values)  # (nc, 1000)