pub struct BBox {
    pub x: i32,
    pub y: i32,
    pub width: u32,
    pub height: u32,
}
Expand description

Struct for representing a bounding box

Fields§

§x: i32

X coordinate of the top-left corner of the bounding box

§y: i32

Y coordinate of the top-left corner of the bounding box

§width: u32

Width of the bounding box

§height: u32

Height of the bounding box

Implementations§

source§

impl BBox

source

pub fn new(x: i32, y: i32, width: u32, height: u32) -> BBox

Creates a new bounding box with the specified coordinates and dimensions

source

pub fn left(&self) -> i32

Returns the left coordinate of the bounding box

source

pub fn right(&self) -> i32

Returns the right coordinate of the bounding box

source

pub fn top(&self) -> i32

Returns the top coordinate of the bounding box

source

pub fn bottom(&self) -> i32

Returns the bottom coordinate of the bounding box

source

pub fn intersect_width(&self, other: &BBox) -> u32

Calculates the width of the intersection between two bounding boxes

Examples
use object_detector_rust::bbox::BBox;

let bbox1 = BBox {
    x: 0,
    y: 0,
    width: 100,
    height: 100,
};
let bbox2 = BBox {
    x: 50,
    y: 0,
    width: 100,
    height: 100,
};
let bbox3 = BBox {
    x: 150,
    y: 0,
    width: 100,
    height: 100,
};
let bbox4 = BBox {
    x: -50,
    y: 0,
    width: 100,
    height: 100,
};

assert_eq!(bbox1.intersect_width(&bbox2), 50);
assert_eq!(bbox1.intersect_width(&bbox3), 0);
assert_eq!(bbox1.intersect_width(&bbox4), 50);
assert_eq!(bbox2.intersect_width(&bbox3), 0);
assert_eq!(bbox2.intersect_width(&bbox4), 0);
assert_eq!(bbox3.intersect_width(&bbox4), 0);
source

pub fn intersect_height(&self, other: &BBox) -> u32

Calculates the height of the intersection between two bounding boxes

Examples
use object_detector_rust::bbox::BBox;

let bbox1 = BBox {
    x: 0,
    y: 0,
    width: 100,
    height: 100,
};
let bbox2 = BBox {
    x: 0,
    y: 50,
    width: 100,
    height: 100,
};
let bbox3 = BBox {
    x: 0,
    y: 150,
    width: 100,
    height: 100,
};
let bbox4 = BBox {
    x: 0,
    y: -50,
    width: 100,
    height: 100,
};

assert_eq!(bbox1.intersect_height(&bbox2), 50);
assert_eq!(bbox1.intersect_height(&bbox3), 0);
assert_eq!(bbox1.intersect_height(&bbox4), 50);
assert_eq!(bbox2.intersect_height(&bbox3), 0);
assert_eq!(bbox2.intersect_height(&bbox4), 0);
assert_eq!(bbox3.intersect_height(&bbox4), 0);
source

pub fn intersect_area(&self, other: &BBox) -> u32

Calculates the area of the intersection between two bounding boxes

Examples
use object_detector_rust::bbox::BBox;

let bbox1 = BBox {
    x: 0,
    y: 0,
    width: 100,
    height: 100,
};
let bbox2 = BBox {
    x: 50,
    y: 50,
    width: 100,
    height: 100,
};
let bbox3 = BBox {
    x: 150,
    y: 150,
    width: 100,
    height: 100,
};

assert_eq!(bbox1.intersect_area(&bbox2), 2500);
assert_eq!(bbox1.intersect_area(&bbox3), 0);
assert_eq!(bbox2.intersect_area(&bbox3), 0);
source

pub fn self_area(&self) -> u32

Calculates the area of the bounding box

Examples
use object_detector_rust::bbox::BBox;

let bbox = BBox {
    x: 0,
    y: 0,
    width: 100,
    height: 100,
};

assert_eq!(bbox.self_area(), 10000);
source

pub fn union_area(&self, other: &BBox) -> u32

Calculates the area of the union between two bounding boxes

Examples
use object_detector_rust::bbox::BBox;

let bbox1 = BBox {
    x: 0,
    y: 0,
    width: 100,
    height: 100,
};
let bbox2 = BBox {
    x: 50,
    y: 50,
    width: 100,
    height: 100,
};

assert_eq!(bbox1.union_area(&bbox2), 17500);
source

pub fn overlap(&self, other: &BBox) -> f32

Calculates the overlap between two bounding boxes as the ratio of their intersecting area to their union area

Examples
use object_detector_rust::bbox::BBox;

let bbox1 = BBox {
    x: 0,
    y: 0,
    width: 100,
    height: 100,
};
let bbox2 = BBox {
    x: 50,
    y: 50,
    width: 100,
    height: 100,
};
let bbox3 = BBox {
    x: 150,
    y: 150,
    width: 100,
    height: 100,
};

assert!(bbox1.overlap(&bbox2) > 0.14);
assert_eq!(bbox1.overlap(&bbox3), 0.0);
assert_eq!(bbox2.overlap(&bbox3), 0.0);
source

pub fn merge(&self, other: &BBox) -> BBox

Merges two bounding boxes into a single bounding box that encloses both

Examples
use object_detector_rust::bbox::BBox;

let bbox1 = BBox {
    x: 0,
    y: 0,
    width: 100,
    height: 100,
};
let bbox2 = BBox {
    x: 50,
    y: 50,
    width: 100,
    height: 100,
};
let bbox3 = BBox {
    x: -50,
    y: -50,
    width: 100,
    height: 100,
};

assert_eq!(bbox1.merge(&bbox2), BBox {
    x: 0,
    y: 0,
    width: 150,
    height: 150,
});
assert_eq!(bbox1.merge(&bbox3), BBox {
    x: -50,
    y: -50,
    width: 150,
    height: 150,
});

Trait Implementations§

source§

impl Clone for BBox

source§

fn clone(&self) -> BBox

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for BBox

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for BBox

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl PartialEq<BBox> for BBox

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for BBox

source§

impl StructuralPartialEq for BBox

Auto Trait Implementations§

§

impl RefUnwindSafe for BBox

§

impl Send for BBox

§

impl Sync for BBox

§

impl Unpin for BBox

§

impl UnwindSafe for BBox

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Srcwhere Scheme: ApproxScheme,

§

type Err = NoError

The error type produced by a failed conversion.
§

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Convert the given value into an approximately equivalent representation.
§

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Srcwhere Dst: ApproxFrom<Src, Scheme>, Scheme: ApproxScheme,

§

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

The error type produced by a failed conversion.
§

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Convert the subject into an approximately equivalent representation.
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T, Dst> ConvAsUtil<Dst> for T

§

fn approx(self) -> Result<Dst, Self::Err>where Self: Sized + ApproxInto<Dst, DefaultApprox>,

Approximate the subject with the default scheme.
§

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err>where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Approximate the subject with a specific scheme.
§

impl<T> ConvUtil for T

§

fn approx_as<Dst>(self) -> Result<Dst, Self::Err>where Self: Sized + ApproxInto<Dst, DefaultApprox>,

Approximate the subject to a given type with the default scheme.
§

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Approximate the subject to a given type with a specific scheme.
§

fn into_as<Dst>(self) -> Dstwhere Self: Sized + Into<Dst>,

Convert the subject to a given type.
§

fn try_as<Dst>(self) -> Result<Dst, Self::Err>where Self: Sized + TryInto<Dst>,

Attempt to convert the subject to a given type.
§

fn value_as<Dst>(self) -> Result<Dst, Self::Err>where Self: Sized + ValueInto<Dst>,

Attempt a value conversion of the subject to a given type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<Src> TryFrom<Src> for Src

§

type Err = NoError

The error type produced by a failed conversion.
§

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Convert the given value into the subject type.
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<Src, Dst> TryInto<Dst> for Srcwhere Dst: TryFrom<Src>,

§

type Err = <Dst as TryFrom<Src>>::Err

The error type produced by a failed conversion.
§

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Convert the subject into the destination type.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<Src> ValueFrom<Src> for Src

§

type Err = NoError

The error type produced by a failed conversion.
§

fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Convert the given value into an exactly equivalent representation.
§

impl<Src, Dst> ValueInto<Dst> for Srcwhere Dst: ValueFrom<Src>,

§

type Err = <Dst as ValueFrom<Src>>::Err

The error type produced by a failed conversion.
§

fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Convert the subject into an exactly equivalent representation.
source§

impl<T> Scalar for Twhere T: 'static + Clone + PartialEq<T> + Debug,