Get Started

VisionEye View Object Mapping using Ultralytics YOLO26

What is VisionEye Object Mapping?#

Ultralytics YOLO26 VisionEye lets computers identify and pinpoint objects, simulating the observational precision of the human eye. This functionality enables computers to discern and focus on specific objects, much like the way the human eye observes details from a particular viewpoint.

VisionEye object mapping with YOLO tracking

Map Objects with YOLO26#

VisionEye fixes a single observation point in the frame and draws a ray from it to every tracked object, so you can visualize how a scene looks from one viewpoint. Set vision_point to the observer's pixel coordinates, then run the solution over your video with the Python API or the CLI.

VisionEye Mapping using Ultralytics YOLO
# Monitor objects position with visioneye
yolo solutions visioneye show=True

# Pass a source video
yolo solutions visioneye source="path/to/video.mp4"

# Monitor the specific classes
yolo solutions visioneye classes="[0, 5]"

VisionEye Arguments#

Here's a table with the VisionEye arguments:

ArgumentTypeDefaultDescription
modelstrNonePath to an Ultralytics YOLO model file.
vision_pointtuple[int, int](20, 20)The point where vision will track objects and draw paths using VisionEye Solution.
line_widthint2Line thickness for the boxes, keypoints and counts the solution draws.
verboseboolTrueEnables the solution's per-frame log of input shape, class counts and processing speed. The tracking call itself is always silent.

You can also utilize various track arguments within the VisionEye solution:

ArgumentTypeDefaultDescription
trackerstr'tracktrack.yaml'Specifies the tracking algorithm to use. Built-in options: botsort.yaml, bytetrack.yaml, ocsort.yaml, deepocsort.yaml, fasttrack.yaml, tracktrack.yaml.
conffloat0.25Sets the confidence threshold for detections; lower values allow more objects to be tracked but may include false positives.
ioufloat0.5Sets the Intersection over Union (IoU) threshold for filtering overlapping detections.
classeslistNoneFilters results by class index. For example, classes=[0, 2, 3] only tracks the specified classes.
devicestrNoneSpecifies the device for inference (e.g., cpu, cuda:0 or 0). Allows users to select between CPU, a specific GPU, or other compute devices for model execution.
imgszint or tuple640Target inference image size: an integer for a square or a (height, width) pair. Shapes are adjusted to the model stride.
max_detint300Maximum number of detections kept per frame before tracking, limiting the objects a solution processes in dense scenes.
quantizeint or strNoneInference precision: 16 (FP16) or 32/unset (FP32) for PyTorch and TorchScript models off CPU; other formats use the precision their artifact and runtime select. Replaces the deprecated half arg.

Furthermore, some visualization arguments are supported, as listed below:

ArgumentTypeDefaultDescription
showboolFalseIf True, displays the annotated images or videos in a window. Useful for immediate visual feedback during development or testing.
show_confboolTrueDisplays the confidence score for each detection alongside the label. Gives insight into the model's certainty for each detection.
show_labelsboolTrueDisplays labels for each detection in the visual output. Provides immediate understanding of detected objects.

How VisionEye Works#

VisionEye works by establishing a fixed vision point in the frame and drawing lines from this point to detected objects. This simulates how human vision focuses on multiple objects from a single viewpoint. The solution uses object tracking to maintain consistent identification of objects across frames, creating a visual representation of the spatial relationship between the observer (vision point) and the objects in the scene.

The process method in the VisionEye class performs several key operations:

  1. Extracts tracks (bounding boxes, classes, and track IDs) from the input image
  2. Creates an annotator to draw bounding boxes and labels
  3. For each detected object, draws a box label and creates a vision line from the vision point
  4. Returns the annotated image with tracking statistics

This approach is particularly useful for applications requiring spatial awareness and object relationship visualization, such as surveillance systems, autonomous navigation, and interactive installations.

Applications of VisionEye#

VisionEye object mapping has numerous practical applications across various industries:

  • Security and Surveillance: Monitor multiple objects of interest from a fixed camera position
  • Retail Analytics: Track customer movement patterns in relation to store displays
  • Sports Analysis: Analyze player positioning and movement from a coach's perspective
  • Autonomous Vehicles: Visualize how a vehicle "sees" and prioritizes objects in its environment
  • Human-Computer Interaction: Create more intuitive interfaces that respond to spatial relationships

By combining VisionEye with other Ultralytics solutions like distance calculation or speed estimation, you can build comprehensive systems that not only track objects but also understand their spatial relationships and behaviors.

FAQ#

  • To start using VisionEye Object Mapping with Ultralytics YOLO26, first install the Ultralytics package via pip. Then, you can use the sample code provided in the documentation to set up object detection with VisionEye. Here's a simple example to get you started:

    import cv2
    
    from ultralytics import solutions
    
    cap = cv2.VideoCapture("path/to/video.mp4")
    assert cap.isOpened(), "Error reading video file"
    
    # Video writer
    w, h, fps = (int(cap.get(x)) for x in (cv2.CAP_PROP_FRAME_WIDTH, cv2.CAP_PROP_FRAME_HEIGHT, cv2.CAP_PROP_FPS))
    video_writer = cv2.VideoWriter("vision-eye-mapping.avi", cv2.VideoWriter_fourcc(*"mp4v"), fps, (w, h))
    
    # Init vision eye object
    visioneye = solutions.VisionEye(
        show=True,  # display the output
        model="yolo26n.pt",  # use any model that Ultralytics supports, e.g., yolo26s.pt
        classes=[0, 2],  # generate visioneye view for specific classes
    )
    
    # 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
    
        results = visioneye(im0)
    
        print(results)  # access the output
    
        video_writer.write(results.plot_im)  # write the video file
    
    cap.release()
    video_writer.release()
    cv2.destroyAllWindows()  # destroy all opened windows
  • Ultralytics YOLO26 combines speed, accuracy, and ease of integration, which makes it well suited to object mapping and tracking. Key advantages include:

    1. Real-Time Performance: Delivers high accuracy in real-time object detection.
    2. Flexibility: Supports detection, tracking, and distance calculation in a single pipeline.
    3. Community and Support: Extensive documentation and active GitHub community for troubleshooting and enhancements.
    4. Ease of Use: Intuitive API simplifies complex tasks, allowing for rapid deployment and iteration.

    For more information on applications and benefits, check out the Ultralytics YOLO26 documentation.

  • Ultralytics YOLO26 integrates with various machine learning tools like Comet and ClearML for experiment tracking, collaboration, and reproducibility. Follow the detailed guides on integrating YOLO26 with Comet and integrating YOLO26 with ClearML to get started.

    For further exploration and integration examples, check our Ultralytics Integrations Guide.

Comments60

Ask a question, share your results, or help someone else.

  1. TranDHoaGitHub

    Hey, you can adjust the viewing angle of the eyes and make it measure the distance from the center of an object instead of from the edge.

    1. Glenn JocherUltralytics

      VisionEye already draws the ray from vision_point to the bounding-box centroid (not the edge) via SolutionAnnotator.visioneye() as shown in the VisionEye guide and the SolutionAnnotator visioneye() reference; there isn’t a separate “viewing angle” parameter today since it’s a 2D overlay, so the intended control is moving vision_point, and if you need an actual distance value (vs just a line), please use the Distance Calculation solution and share your desired behavior here (plus a short clip/frame + vision_point) so the team can advise the cleanest extension.

    1. Glenn JocherUltralytics

      @dixroby the requirements.txt file typically includes dependencies like torch, opencv-python, and other libraries necessary for running Ultralytics YOLO models. For a detailed list, please check the file directly in the repository.

  2. FarrelCulbertGitHub

    Hi, I would like to know if this is only compatible with YOLOv8, or can I use it with all models?

    1. Glenn JocherUltralytics(edited)

      @FarrelCulbert VisionEye Object Mapping is not limited to YOLOv8: it works with the tracking-capable Ultralytics models you pass via model=, including YOLO26 (recommended) and YOLO11. For more detailed information and examples, you can refer to the VisionEye documentation at https://docs.ultralytics.com/guides/vision-eye/.

  3. skp4595GitHub

    rather than taking video as input fro testing, I want to test for an image, how can I do that? guide me on this.

    1. Glenn JocherUltralytics(edited)

      Hi there!

      Great question! If you want to test an image instead of a video using Ultralytics YOLO, it's quite straightforward. Below is a simple example to guide you through the process:

      Testing on an Image

      First, ensure you have the latest versions of torch and ultralytics installed. If not, please update them:

      pip install --upgrade torch ultralytics

      Next, you can use the following code to test an image:

      import cv2
      from ultralytics import YOLO
      from ultralytics.utils.plotting import Annotator, colors
      
      # Load the model
      model = YOLO("yolo26n.pt")
      
      # Load the image
      image_path = "path/to/your/image.jpg"
      im0 = cv2.imread(image_path)
      
      # Perform prediction
      results = model.predict(im0)
      boxes = results[0].boxes.xyxy.cpu()
      clss = results[0].boxes.cls.cpu().tolist()
      
      # Annotate the image
      annotator = Annotator(im0, line_width=2)
      names = model.model.names
      
      for box, cls in zip(boxes, clss):
          annotator.box_label(box, label=names[int(cls)], color=colors(int(cls)))
      
      # Display the annotated image
      cv2.imshow("YOLO Image Prediction", im0)
      cv2.waitKey(0)
      cv2.destroyAllWindows()
      Explanation
      1. Load the Model: We load the YOLO model.
      2. Load the Image: Read the image using OpenCV.
      3. Perform Prediction: Use the model to predict objects in the image.
      4. Annotate the Image: Draw bounding boxes and labels on the image.
      5. Display the Image: Show the annotated image using OpenCV.

      This should help you get started with testing images. If you encounter any issues or have further questions, feel free to ask! 😊

      For more detailed information, you can refer to the VisionEye Object Mapping Guide.

      Happy coding! 🚀

  4. skp4595GitHub

    I want to run VisionEye Object Mapping using YOLOv8 code on KITTI data set. the KITTI dataset is labeled as <class_name1, truncation, occlusion, observation angle alpha, bbox cordinantes, Dimension of object, Location, rotation_y, score > for each image. While model training, I'm getting this error train: WARNING ⚠️ /content/dataset/train/images/005936.png: ignoring corrupt image/label: could not convert string to float: 'Car' train: WARNING ⚠️ /content/dataset/train/images/005937.png: ignoring corrupt image/label: could not convert string to float: 'Pedestrian' train: WARNING ⚠️ /content/dataset/train/images/005938.png: ignoring corrupt image/label: could not convert string to float: 'Truck'

    with these args { EPOCHS = 5 !yolo
    task=detect
    mode=train
    model=yolov8s.pt
    imgsz=640
    data=depth_estimation_using_YOLOv8.yaml
    epochs={EPOCHS}
    batch=16
    name=yolov8s
    exist_ok=True
    amp=False } how do I fix this?

    1. skp4595GitHub

      how is this model trained? some details on dataset would be great help

    2. Paula DerrengerUltralytics(edited)

      Hi! The model is trained using the YOLOv8 framework. You can train it on custom datasets like KITTI by converting the dataset to the YOLO format. The dataset should have labels in the format <class_id> <x_center> <y_center> <width> <height>.

      For more details on VisionEye Object Mapping, check out the Ultralytics VisionEye guide. If you have any specific questions, feel free to ask! 🚀

      Here's a sample training command:

      yolo task=detect mode=train model=yolo26s.pt data=your_dataset.yaml epochs=5 batch=16

      Happy training! 😊

      1
  5. skp4595GitHub

    what does this mean "It calculates this distance by analyzing the size and position of the object within the frame, using the camera's field of view and other calibration parameters if available"? what do you mean by 'other calibration parameter if possible'? The model is not a blackbox. Is it? there must be some calibration, some ground truth from where model must have learned. please explain this.

    1. Glenn JocherUltralytics(edited)

      Hello! Great questions about the VisionEye Object Mapping using Ultralytics YOLOv8.

      1. Distance Calculation: The phrase "It calculates this distance by analyzing the size and position of the object within the frame, using the camera's field of view and other calibration parameters if available" was inaccurate. The VisionEye distance example does not estimate camera-to-object distance from object size or field of view. It computes the pixel distance between the vision point and the bounding-box centroid and divides it by the pixel_per_meter value you set, so you calibrate that scale yourself.

      2. Other Calibration Parameters: The example uses none of these. You would need data such as camera intrinsic parameters (focal length, optical centers), extrinsic parameters (orientation and position of the camera), object size references, or a depth sensor only if you build a true camera-to-object distance estimate yourself.

      3. Model Transparency: YOLOv8 models are not black boxes in the sense that their architecture and training processes are open for examination and modification. They learn from labeled data (ground truth) where objects are manually annotated in images, teaching the model how to recognize similar objects in new images.

      For further details or specific implementations, feel free to check out our guide on VisionEye Object Mapping at Ultralytics VisionEye Guide. If you have more questions or need clarification, don't hesitate to reach out! 😊

    1. Paula DerrengerUltralytics(edited)

      Hey there! 😊 It sounds like you're encountering some version compatibility issues. For Ultralytics YOLOv8, we generally recommend using Python 3.8 or newer as it strikes a good balance between being up-to-date and maintaining compatibility with most dependencies.

      If you're using a Python version older than 3.7, you might run into issues, and it's a good idea to update to at least version 3.7 or newer if possible. Here's a quick way to check your current Python version from your terminal:

      python --version
      # or if you have Python 3 installed as 'python3'
      python3 --version

      And if you need to update Python, the official Python Downloads page is a great place to start.

      If you're still facing issues after checking your Python version, could you please provide more details about the error messages you're seeing? This information can help us pinpoint the problem more accurately. Thanks!

    2. Paula DerrengerUltralytics

      @mirhasnainsiba hi there! 👋 It seems there might be a discrepancy with the distance calculation in your setup. Typically, the distance calculated by the model would depend on the scale set in your system (for example, pixel_per_meter in the example). If the object is being reported as 61m away while it's actually about 1m away, you might want to adjust this scale factor accordingly. Here's a brief example:

      pixel_per_meter = 100  # Adjust this value based on your actual scale

      This adjustment helps calibrate the distance calculation to more accurately reflect real-world distances. If you continue to experience issues, double-check the calibration process or consider revisiting the portion of your code responsible for calculating distances. If further assistance is needed, feel free to reach out! 🛠️

    3. Paula DerrengerUltralytics

      Hey there! 😊 Thanks for reaching out. If you're observing an object distance as 61m while it's almost 1m away, you might want to adjust the pixel_per_meter scaling factor in your VisionEye implementation. This adjustment is crucial for accurate distance calculation.

      Here's a simplified approach:

      pixel_per_meter = 100 # This is just an example value. 
      # You'll need to calibrate this based on your specific setup and camera properties.

      By fine-tuning this variable, you can achieve more accurate distance measurements. Calibration involves comparing known distances with the pixel distances detected by your model to find the most suitable pixel_per_meter value. 🛠️

      Hope this helps! Let us know if you have any further questions or if there are more details you'd like to dive into.

    1. Paula DerrengerUltralytics

      Hey there! 🌟

      The video files used in our examples are not provided in the repository. You can use any video file that you have access to by placing it in an accessible directory and then modifying the "path/to/video/file.mp4" placeholder in the code snippets to point to your video file's location.

      For example:

      cap = cv2.VideoCapture("your/video/path/here.mp4")

      Just replace "your/video/path/here.mp4" with the actual path to your video. If you're looking for sample videos, online resources like Pexels Video or Pixabay Videos offer free footage that you might find useful for your projects.

      If you have any more questions or need further assistance, don't hesitate to reach out. Happy coding! 🚀

      1
    2. Paula DerrengerUltralytics

      Hey! Thank you for checking out the VisionEye Object Mapping with Ultralytics YOLOv8. 🚀 If you're keen to dive into VisionEye Object Mapping for pinpoint precision or even integrate object tracking and distance calculation, the provided Python examples can guide you seamlessly through the process.

      Just remember to replace "path/to/video/file.mp4" with the specific path to your video file, and you’re all set to explore the amazing capabilities of YOLOv8 with VisionEye!

      For pinpoint object mapping:

      model = YOLO("yolov8n.pt")  # Adjust model as needed
      cap = cv2.VideoCapture("your/video/path.mp4")  # Your video path here

      For any additional queries or discussions, feel free to drop a message in our GitHub Issue Section. Happy coding! 🎉

  6. AdadAlShababGitHub

    Hi, I just wanted to know about "VisionEye View with Distance". What does this 'Distance' means? I mean does it measure the distance from the camera to object? Please let me know. TIA.

    1. Paula DerrengerUltralytics(edited)

      @AdadAlShabab hey there! 👋

      No, the "Distance" in the VisionEye example is not a camera-to-object distance. It is the pixel distance between the vision point and the detected object's bounding-box centroid, divided by a pixel_per_meter scale that you set and calibrate yourself. Here's a simplified example of how you might calculate distance in a custom script:

      import cv2
      import math
      from ultralytics import YOLO
      
      model = YOLO("yolo26s.pt")
      cap = cv2.VideoCapture("path/to/video.mp4")
      
      while True:
          ret, im0 = cap.read()
          if not ret:
              break
      
          results = model.track(im0, persist=True)
          for box in results[0].boxes.xyxy.cpu():
              # Example: Calculate distance based on object size or position here
              # This is a placeholder for actual distance calculation logic
              distance = calculate_distance(box)
              print(f"Distance: {distance} meters")

      In this example, calculate_distance would be a function you define based on your specific distance estimation method. Keep in mind, accurate distance measurement might require camera calibration and knowing the actual size of the object or using depth sensors in conjunction with the camera.

      Hope this helps! Let us know if you have any more questions. 😊

    2. AdadAlShababGitHub

      Hi @pderrenger. Thanks a lot for your reply. I just wanted to know how can I divide the results by 10 ( ex: distance/10)? I'm dropping the code, please let me know in which line/lines I should make the changes? TIA.

      Code:

      if results[0].boxes.id is not None:
          track_ids = results[0].boxes.id.int().cpu().tolist()
      
          for box, track_id in zip(boxes, track_ids):
              annotator.box_label(box, label=str(track_id), color=bbox_clr)
              annotator.visioneye(box, center_point)
      
              x1, y1 = int((box[0] + box[2]) // 2), int((box[1] + box[3]) // 2)    # Bounding box centroid
      
              distance = (math.sqrt((x1 - center_point[0]) ** 2 + (y1 - center_point[1]) ** 2))/pixel_per_meter
      
              text_size, _ = cv2.getTextSize(f"Distance: {distance:.2f} m", cv2.FONT_HERSHEY_SIMPLEX,1.2, 3)
              cv2.rectangle(im0, (x1, y1 - text_size[1] - 10),(x1 + text_size[0] + 10, y1), txt_background, -1)
              cv2.putText(im0, f"Distance: {distance:.2f} m",(x1, y1 - 5), cv2.FONT_HERSHEY_SIMPLEX, 1.2,txt_color, 3)
    3. Paula DerrengerUltralytics

      Hi @AdadAlShabab! 👋

      To divide the calculated distance by 10, you can adjust the line where distance is calculated. Here's how you can modify it:

      distance = (math.sqrt((x1 - center_point[0]) ** 2 + (y1 - center_point[1]) ** 2)) / pixel_per_meter / 10

      This change will effectively scale down the calculated distance by a factor of 10. Just add / 10 at the end of the existing distance calculation line in your code.

      Hope this helps! Let me know if there's anything else you need. 😊

    4. skp4595GitHub

      what does this mean "It calculates this distance by analyzing the size and position of the object within the frame, using the camera's field of view and other calibration parameters if available"? what do you mean by 'other calibration parameter if possible'? The model is not a blackbox. Is it? there must be some calibration, some ground truth from where model must have learned. please explain this.

    5. skp4595GitHub

      why are we dividing "distance " by 'pixel_per_meter' ? what is the logic or explaination for this ?

    6. Paula DerrengerUltralytics

      Hey there! 👋

      The division by pixel_per_meter is used to convert the measured pixel distance into real-world units like meters. This conversion factor helps translate the scale of the image to actual distances based on how many pixels represent one meter in the image. It's essential for applications where you need to know the physical separation between objects or from the camera to an object, not just the distance in pixels.

      If you have more questions or need further clarification, feel free to ask! 😊

    7. skp4595GitHub

      you mean to say, if there's 1 unit Euclidean distance between two pixels in an image, than it'd be 10m in real world scenarios? And this scale can be adjusted according to our will as per "pixel_per_meter = 10" this code. Isn't it?

      if so, how is this calibration done? where's the ground truth?

    8. Paula DerrengerUltralytics

      Hey there! 👋

      Yes, exactly! If the pixel_per_meter is set to 10, it means that 1 pixel in the image corresponds to 0.1 meters in the real world. You can adjust this scale to fit the specific context or calibration of your camera setup.

      Calibration is typically done by measuring known distances in the real world and adjusting the pixel_per_meter value so that the distances in the image accurately reflect these measurements. Ground truth data for calibration might come from physical measurements or known dimensions within the scene.

      If you have any more questions or need further clarification, feel free to ask! 😊

    9. Paula DerrengerUltralytics(edited)

      You're welcome! 😊

      The "VisionEye View with Distance" feature calculates the pixel distance between a reference point and the detected object's centroid, not a true camera-to-object distance. The pixel_per_meter value is used to convert pixel measurements to real-world distances. Calibration involves setting this value based on known distances in your scene.

      To divide the distance by 10, modify the distance calculation line like this:

      distance = (math.sqrt((x1 - center_point[0]) ** 2 + (y1 - center_point[1]) ** 2)) / pixel_per_meter / 10

      For more details, check out the VisionEye guide.

      1
  7. leongjy2005GitHub

    Traceback (most recent call last): File "d:\Random_YOLO8_Tutorials\Human_Detection\visioneye.py", line 28, in annotator.visioneye(box, center_point) ^^^^^^^^^^^^^^^^^^^ AttributeError: 'Annotator' object has no attribute 'visioneye'

    1. Glenn JocherUltralytics(edited)

      @leongjy2005 visioneye is not a method of the base Annotator; it lives on SolutionAnnotator. Use from ultralytics.solutions.solutions import SolutionAnnotator and annotator = SolutionAnnotator(im0, line_width=2), or use the solutions.VisionEye solution from the VisionEye guide.

      1