Struct DetectionBox 

pub struct DetectionBox {
    pub x1: f64,
    pub y1: f64,
    pub x2: f64,
    pub y2: f64,
    pub confidence: f64,
    pub class_id: usize,
    pub class_name: Option<String>,
}

A bounding box for object detection, stored as (x1, y1, x2, y2) corner format.

All coordinates use f64 precision. The box additionally carries optional confidence, class id, and class name fields used throughout detection pipelines.

Fields

x1: f64

Top-left x coordinate

y1: f64

Top-left y coordinate

x2: f64

Bottom-right x coordinate

y2: f64

Bottom-right y coordinate

confidence: f64

Detection confidence score in [0, 1]

class_id: usize

Class identifier (0-indexed)

class_name: Option<String>

Optional human-readable class name

Implementations

impl DetectionBox

pub fn new(x1: f64, y1: f64, x2: f64, y2: f64) -> Self

Create a new detection box from corner coordinates.

Coordinates are normalised so that x1 <= x2 and y1 <= y2.

pub fn from_center(cx: f64, cy: f64, w: f64, h: f64) -> Self

Create a detection box from centre coordinates and dimensions.

Arguments

• cx - Centre x
• cy - Centre y
• w - Width (must be non-negative)
• h - Height (must be non-negative)

pub fn with_confidence(self, confidence: f64) -> Self

Builder: set confidence score.

pub fn with_class(self, class_id: usize, class_name: Option<String>) -> Self

Builder: set class id and optional name.

pub fn area(&self) -> f64

Box area.

pub fn center(&self) -> (f64, f64)

Centre of the box as (cx, cy).

pub fn width(&self) -> f64

Width of the box.

pub fn height(&self) -> f64

Height of the box.

pub fn aspect_ratio(&self) -> f64

Aspect ratio (width / height). Returns 0.0 if height is zero.

pub fn intersection_area(&self, other: &DetectionBox) -> f64

Intersection area with another box.

pub fn union_area(&self, other: &DetectionBox) -> f64

Union area with another box.

pub fn iou(&self, other: &DetectionBox) -> f64

Intersection over Union (IoU).

Returns 0.0 when the union area is zero.

pub fn giou(&self, other: &DetectionBox) -> f64

Generalized Intersection over Union (GIoU).

GIoU = IoU - |C \ (A union B)| / |C| where C is the smallest enclosing box. Range: [-1, 1]

pub fn diou(&self, other: &DetectionBox) -> f64

Distance-IoU (DIoU).

DIoU = IoU - d^2 / c^2 where d is the Euclidean distance between centres and c is the diagonal length of the smallest enclosing box.

pub fn ciou(&self, other: &DetectionBox) -> f64

Complete-IoU (CIoU).

CIoU = IoU - d^2/c^2 - alpha * v where v measures aspect-ratio consistency and alpha is a trade-off parameter.

pub fn contains_point(&self, px: f64, py: f64) -> bool

Check whether a point (px, py) lies inside this box (inclusive).

Trait Implementations

impl Clone for DetectionBox

fn clone(&self) -> DetectionBox

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DetectionBox

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DetectionBox

fn eq(&self, other: &DetectionBox) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DetectionBox