Package ai.djl.modality.cv.output

Interface BoundingBox

All Superinterfaces:
Serializable
All Known Implementing Classes:
Landmark, Mask, Rectangle
public interface BoundingBox extends Serializable
An interface representing a bounding box around an object inside an image.

  • Method Summary

    Modifier and Type
    Method
    Description
    Rectangle
    getBounds()
    Returns the bounding Rectangle of this BoundingBox.
    double
    getIoU(BoundingBox box)
    Returns the Intersection over Union (IoU) value between bounding boxes.
    Iterable<Point>
    getPath()
    Returns an iterator object that iterates along the BoundingBox boundary and provides access to the geometry of the BoundingBox outline.
    Point
    getPoint()
    Returns the top left point of the bounding box.

  • Method Details

    • getBounds

      Rectangle getBounds()
      Returns the bounding Rectangle of this BoundingBox.
      Returns:
      a new Rectangle for this BoundingBox

    • getPath

      Iterable<Point> getPath()
      Returns an iterator object that iterates along the BoundingBox boundary and provides access to the geometry of the BoundingBox outline.
      Returns:
      a Iterable object, which independently traverses the geometry of the BoundingBox

    • getPoint

      Point getPoint()
      Returns the top left point of the bounding box.
      Returns:
      the Point of the top left corner

    • getIoU

      double getIoU(BoundingBox box)
      Returns the Intersection over Union (IoU) value between bounding boxes.

      Also known as Jaccard index

      Parameters:
      box - the bounding box to calculate
      Returns:
      the IoU value