diff --git a/docs/en/guides/trackzone.md b/docs/en/guides/trackzone.md new file mode 100644 index 000000000..ec9822138 --- /dev/null +++ b/docs/en/guides/trackzone.md @@ -0,0 +1,160 @@ +--- +comments: true +description: Discover how TrackZone leverages Ultralytics YOLO11 to precisely track objects within specific zones, enabling real-time insights for crowd analysis, surveillance, and targeted monitoring. +keywords: TrackZone, object tracking, YOLO11, Ultralytics, real-time object detection, AI, deep learning, crowd analysis, surveillance, zone-based tracking, resource optimization +--- + +# TrackZone using Ultralytics YOLO11 + +## What is TrackZone? + +TrackZone specializes in monitoring objects within designated areas of a frame instead of the whole frame. Built on [Ultralytics YOLO11](https://github.com/ultralytics/ultralytics/), it integrates object detection and tracking specifically within zones for videos and live camera feeds. YOLO11's advanced algorithms and [deep learning](https://www.ultralytics.com/glossary/deep-learning-dl) technologies make it a perfect choice for real-time use cases, offering precise and efficient object tracking in applications like crowd monitoring and surveillance. + +## Advantages of Object Tracking in Zones (TrackZone) + +- **Targeted Analysis:** Tracking objects within specific zones allows for more focused insights, enabling precise monitoring and analysis of areas of interest, such as entry points or restricted zones. +- **Improved Efficiency:** By narrowing the tracking scope to defined zones, TrackZone reduces computational overhead, ensuring faster processing and optimal performance. +- **Enhanced Security:** Zonal tracking improves surveillance by monitoring critical areas, aiding in the early detection of unusual activity or security breaches. +- **Scalable Solutions:** The ability to focus on specific zones makes TrackZone adaptable to various scenarios, from retail spaces to industrial settings, ensuring seamless integration and scalability. + +## Real World Applications + +| Agriculture | Transportation | +| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| ![Plants Tracking in Field Using Ultralytics YOLO11](https://github.com/ultralytics/docs/releases/download/0/plants-tracking-in-zone-using-ultralytics-yolo11.avif) | ![Vehicles Tracking on Road using Ultralytics YOLO11](https://github.com/ultralytics/docs/releases/download/0/vehicle-tracking-in-zone-using-ultralytics-yolo11.avif) | +| Plants Tracking in Field Using Ultralytics YOLO11 | Vehicles Tracking on Road using Ultralytics YOLO11 | + +!!! example "TrackZone using YOLO11 Example" + + === "CLI" + + ```bash + # Run a trackzone example + yolo solutions trackzone show=True + + # Pass a source video + yolo solutions trackzone show=True source="path/to/video/file.mp4" + + # Pass region coordinates + yolo solutions trackzone show=True region=[(150, 150), (1130, 150), (1130, 570), (150, 570)] + ``` + + === "Python" + + ```python + import cv2 + + from ultralytics import solutions + + cap = cv2.VideoCapture("path/to/video/file.mp4") + assert cap.isOpened(), "Error reading video file" + w, h, fps = (int(cap.get(x)) for x in (cv2.CAP_PROP_FRAME_WIDTH, cv2.CAP_PROP_FRAME_HEIGHT, cv2.CAP_PROP_FPS)) + + # Define region points + region_points = [(150, 150), (1130, 150), (1130, 570), (150, 570)] + + # Video writer + video_writer = cv2.VideoWriter("object_counting_output.avi", cv2.VideoWriter_fourcc(*"mp4v"), fps, (w, h)) + + # Init TrackZone (Object Tracking in Zones, not complete frame) + trackzone = solutions.TrackZone( + show=True, # Display the output + region=region_points, # Pass region points + model="yolo11n.pt", # You can use any model that Ultralytics support, i.e. YOLOv9, YOLOv10 + # line_width=2, # Adjust the line width for bounding boxes and text display + # classes=[0, 2], # If you want to count specific classes i.e. person and car with COCO pretrained model. + ) + + # Process video + while cap.isOpened(): + success, im0 = cap.read() + if not success: + print("Video frame is empty or video processing has been successfully completed.") + break + im0 = trackzone.trackzone(im0) + video_writer.write(im0) + + cap.release() + video_writer.release() + cv2.destroyAllWindows() + ``` + +### Argument `TrackZone` + +Here's a table with the `TrackZone` arguments: + +| Name | Type | Default | Description | +| ------------ | ------ | ---------------------------------------------------- | ---------------------------------------------------- | +| `model` | `str` | `None` | Path to Ultralytics YOLO Model File | +| `region` | `list` | `[(150, 150), (1130, 150), (1130, 570), (150, 570)]` | List of points defining the object tracking region. | +| `line_width` | `int` | `2` | Line thickness for bounding boxes. | +| `show` | `bool` | `False` | Flag to control whether to display the video stream. | + +### Arguments `model.track` + +{% include "macros/track-args.md" %} + +## FAQ + +### How do I track objects in a specific area or zone of a video frame using Ultralytics YOLO11? + +Tracking objects in a defined area or zone of a video frame is straightforward with Ultralytics YOLO11. Simply use the command provided below to initiate tracking. This approach ensures efficient analysis and accurate results, making it ideal for applications like surveillance, crowd management, or any scenario requiring zonal tracking. + +```bash +yolo solutions trackzone source="path/to/video/file.mp4" show=True +``` + +### How can I use TrackZone in Python with Ultralytics YOLO11? + +With just a few lines of code, you can set up object tracking in specific zones, making it easy to integrate into your projects. + +```python +import cv2 + +from ultralytics import solutions + +cap = cv2.VideoCapture("path/to/video/file.mp4") +assert cap.isOpened(), "Error reading video file" +w, h, fps = (int(cap.get(x)) for x in (cv2.CAP_PROP_FRAME_WIDTH, cv2.CAP_PROP_FRAME_HEIGHT, cv2.CAP_PROP_FPS)) + +# Define region points +region_points = [(150, 150), (1130, 150), (1130, 570), (150, 570)] + +# Video writer +video_writer = cv2.VideoWriter("object_counting_output.avi", cv2.VideoWriter_fourcc(*"mp4v"), fps, (w, h)) + +# Init TrackZone (Object Tracking in Zones, not complete frame) +trackzone = solutions.TrackZone( + show=True, # Display the output + region=region_points, # Pass region points + model="yolo11n.pt", +) + +# Process video +while cap.isOpened(): + success, im0 = cap.read() + if not success: + print("Video frame is empty or video processing has been successfully completed.") + break + im0 = trackzone.trackzone(im0) + video_writer.write(im0) + +cap.release() +video_writer.release() +cv2.destroyAllWindows() +``` + +### How do I configure the zone points for video processing using Ultralytics TrackZone? + +Configuring zone points for video processing with Ultralytics TrackZone is simple and customizable. You can directly define and adjust the zones through a Python script, allowing precise control over the areas you want to monitor. + +```python +# Define region points +region_points = [(150, 150), (1130, 150), (1130, 570), (150, 570)] + +# Init TrackZone (Object Tracking in Zones, not complete frame) +trackzone = solutions.TrackZone( + show=True, # Display the output + region=region_points, # Pass region points +) +``` diff --git a/docs/en/reference/solutions/trackzone.md b/docs/en/reference/solutions/trackzone.md new file mode 100644 index 000000000..546d61dcb --- /dev/null +++ b/docs/en/reference/solutions/trackzone.md @@ -0,0 +1,16 @@ +--- +description: Discover Ultralytics' TrackZone solution for real-time object tracking within defined zones. Gain insights into initializing regions, tracking objects exclusively within specific areas, and optimizing video stream processing for region-based object detection. +keywords: Ultralytics, TrackZone, Object Tracking, Zone Tracking, Region Tracking, Python, Real-time Object Tracking, Video Stream Processing, Region-based Detection +--- + +# Reference for `ultralytics/solutions/trackzone.py` + +!!! note + + This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/trackzone.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/solutions/trackzone.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/solutions/trackzone.py) 🛠️. Thank you 🙏! + +
+ +## ::: ultralytics.solutions.trackzone.TrackZone + +

diff --git a/docs/en/solutions/index.md b/docs/en/solutions/index.md index 4046975de..243fbf275 100644 --- a/docs/en/solutions/index.md +++ b/docs/en/solutions/index.md @@ -27,8 +27,10 @@ Here's our curated list of Ultralytics solutions that can be used to create awes - [Distance Calculation](../guides/distance-calculation.md) 🚀: Calculate distances between objects using [bounding box](https://www.ultralytics.com/glossary/bounding-box) centroids in YOLO11, essential for spatial analysis. - [Queue Management](../guides/queue-management.md) 🚀: Implement efficient queue management systems to minimize wait times and improve productivity using YOLO11. - [Parking Management](../guides/parking-management.md) 🚀: Organize and direct vehicle flow in parking areas with YOLO11, optimizing space utilization and user experience. -- [Analytics](../guides/analytics.md) 📊 NEW: Conduct comprehensive data analysis to discover patterns and make informed decisions, leveraging YOLO11 for descriptive, predictive, and prescriptive analytics. +- [Analytics](../guides/analytics.md) 📊: Conduct comprehensive data analysis to discover patterns and make informed decisions, leveraging YOLO11 for descriptive, predictive, and prescriptive analytics. - [Live Inference with Streamlit](../guides/streamlit-live-inference.md) 🚀: Leverage the power of YOLO11 for real-time [object detection](https://www.ultralytics.com/glossary/object-detection) directly through your web browser with a user-friendly Streamlit interface. +- [Live Inference with Streamlit](../guides/streamlit-live-inference.md) 🚀: Leverage the power of YOLO11 for real-time [object detection](https://www.ultralytics.com/glossary/object-detection) directly through your web browser with a user-friendly Streamlit interface. +- [Track Objects in Zone](../guides/trackzone.md) 🎯 NEW: Learn how to track objects within specific zones of video frames using YOLO11 for precise and efficient monitoring. ## Solutions Usage diff --git a/mkdocs.yml b/mkdocs.yml index 0d3320a23..283d52f3d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -326,7 +326,8 @@ nav: - Distance Calculation: guides/distance-calculation.md - Queue Management: guides/queue-management.md - Parking Management: guides/parking-management.md - - Live Inference 🚀 NEW: guides/streamlit-live-inference.md + - Live Inference: guides/streamlit-live-inference.md + - Track Objects in Zone 🚀 NEW: guides/trackzone.md - Guides: - guides/index.md - YOLO Common Issues: guides/yolo-common-issues.md @@ -573,6 +574,7 @@ nav: - speed_estimation: reference/solutions/speed_estimation.md - streamlit_inference: reference/solutions/streamlit_inference.md - region_counter: reference/solutions/region_counter.md + - trackzone: reference/solutions/trackzone.md - trackers: - basetrack: reference/trackers/basetrack.md - bot_sort: reference/trackers/bot_sort.md diff --git a/ultralytics/__init__.py b/ultralytics/__init__.py index 7b73169de..601d1bb36 100644 --- a/ultralytics/__init__.py +++ b/ultralytics/__init__.py @@ -1,6 +1,6 @@ # Ultralytics YOLO 🚀, AGPL-3.0 license -__version__ = "8.3.39" +__version__ = "8.3.40" import os diff --git a/ultralytics/cfg/__init__.py b/ultralytics/cfg/__init__.py index 5f0222a71..e4c239f3d 100644 --- a/ultralytics/cfg/__init__.py +++ b/ultralytics/cfg/__init__.py @@ -41,6 +41,7 @@ SOLUTION_MAP = { "speed": ("SpeedEstimator", "estimate_speed"), "workout": ("AIGym", "monitor"), "analytics": ("Analytics", "process_data"), + "trackzone": ("TrackZone", "trackzone"), "help": None, } @@ -74,13 +75,12 @@ ARGV = sys.argv or ["", ""] # sometimes sys.argv = [] SOLUTIONS_HELP_MSG = f""" Arguments received: {str(['yolo'] + ARGV[1:])}. Ultralytics 'yolo solutions' usage overview: - yolo SOLUTIONS SOLUTION ARGS - - Where SOLUTIONS (required) is a keyword - SOLUTION (optional) is one of {list(SOLUTION_MAP.keys())} - ARGS (optional) are any number of custom 'arg=value' pairs like 'show_in=True' that override defaults. - See all ARGS at https://docs.ultralytics.com/usage/cfg or with 'yolo cfg' + yolo solutions SOLUTION ARGS + Where SOLUTION (optional) is one of {list(SOLUTION_MAP.keys())} + ARGS (optional) are any number of custom 'arg=value' pairs like 'show_in=True' that override defaults + at https://docs.ultralytics.com/usage/cfg + 1. Call object counting solution yolo solutions count source="path/to/video/file.mp4" region=[(20, 400), (1080, 400), (1080, 360), (20, 360)] @@ -95,6 +95,9 @@ SOLUTIONS_HELP_MSG = f""" 5. Generate analytical graphs yolo solutions analytics analytics_type="pie" + + 6. Track Objects Within Specific Zones + yolo solutions trackzone source="path/to/video/file.mp4" region=[(150, 150), (1130, 150), (1130, 570), (150, 570)] """ CLI_HELP_MSG = f""" Arguments received: {str(['yolo'] + ARGV[1:])}. Ultralytics 'yolo' commands use the following syntax: diff --git a/ultralytics/solutions/__init__.py b/ultralytics/solutions/__init__.py index 9de61edce..a2333129b 100644 --- a/ultralytics/solutions/__init__.py +++ b/ultralytics/solutions/__init__.py @@ -10,6 +10,7 @@ from .queue_management import QueueManager from .region_counter import RegionCounter from .speed_estimation import SpeedEstimator from .streamlit_inference import inference +from .trackzone import TrackZone __all__ = ( "AIGym", @@ -23,4 +24,5 @@ __all__ = ( "Analytics", "inference", "RegionCounter", + "TrackZone", ) diff --git a/ultralytics/solutions/trackzone.py b/ultralytics/solutions/trackzone.py new file mode 100644 index 000000000..0492c0a7e --- /dev/null +++ b/ultralytics/solutions/trackzone.py @@ -0,0 +1,68 @@ +# Ultralytics YOLO 🚀, AGPL-3.0 license + +import cv2 +import numpy as np + +from ultralytics.solutions.solutions import BaseSolution +from ultralytics.utils.plotting import Annotator, colors + + +class TrackZone(BaseSolution): + """ + A class to manage region-based object tracking in a video stream. + + This class extends the BaseSolution class and provides functionality for tracking objects within a specific region + defined by a polygonal area. Objects outside the region are excluded from tracking. It supports dynamic initialization + of the region, allowing either a default region or a user-specified polygon. + + Attributes: + region (ndarray): The polygonal region for tracking, represented as a convex hull. + + Methods: + trackzone: Processes each frame of the video, applying region-based tracking. + + Examples: + >>> tracker = TrackZone() + >>> frame = cv2.imread("frame.jpg") + >>> processed_frame = tracker.trackzone(frame) + >>> cv2.imshow("Tracked Frame", processed_frame) + """ + + def __init__(self, **kwargs): + """Initializes the TrackZone class for tracking objects within a defined region in video streams.""" + super().__init__(**kwargs) + default_region = [(150, 150), (1130, 150), (1130, 570), (150, 570)] + self.region = cv2.convexHull(np.array(self.region or default_region, dtype=np.int32)) + + def trackzone(self, im0): + """ + Processes the input frame to track objects within a defined region. + + This method initializes the annotator, creates a mask for the specified region, extracts tracks + only from the masked area, and updates tracking information. Objects outside the region are ignored. + + Args: + im0 (numpy.ndarray): The input image or frame to be processed. + + Returns: + (numpy.ndarray): The processed image with tracking id and bounding boxes annotations. + + Examples: + >>> tracker = TrackZone() + >>> frame = cv2.imread("path/to/image.jpg") + >>> tracker.trackzone(frame) + """ + self.annotator = Annotator(im0, line_width=self.line_width) # Initialize annotator + # Create a mask for the region and extract tracks from the masked image + masked_frame = cv2.bitwise_and(im0, im0, mask=cv2.fillPoly(np.zeros_like(im0[:, :, 0]), [self.region], 255)) + self.extract_tracks(masked_frame) + + cv2.polylines(im0, [self.region], isClosed=True, color=(255, 255, 255), thickness=self.line_width * 2) + + # Iterate over boxes, track ids, classes indexes list and draw bounding boxes + for box, track_id, cls in zip(self.boxes, self.track_ids, self.clss): + self.annotator.box_label(box, label=f"{self.names[cls]}:{track_id}", color=colors(track_id, True)) + + self.display_output(im0) # display output with base class function + + return im0 # return output image for more usage