Skip to main content

RoiRegion

Struct RoiRegion 

Source
pub struct RoiRegion {
    pub x: i32,
    pub y: i32,
    pub width: u32,
    pub height: u32,
    pub priority: f64,
    pub label: String,
}
Expand description

A rectangular region of interest within a frame.

Fields§

§x: i32

Left edge in pixels.

§y: i32

Top edge in pixels.

§width: u32

Width in pixels.

§height: u32

Height in pixels.

§priority: f64

Priority weight (0.0 = ignore, 1.0 = normal, >1.0 = boosted).

§label: String

Optional label for the region.

Implementations§

Source§

impl RoiRegion

Source

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

Creates a new ROI region with default priority.

Source

pub fn with_priority( x: i32, y: i32, width: u32, height: u32, priority: f64, ) -> Self

Creates a new ROI region with a given priority weight.

Source

pub fn set_label(&mut self, label: &str)

Sets the label for this region.

Source

pub fn area(&self) -> u64

Returns the area of the region in pixels.

Source

pub fn right(&self) -> i32

Returns the right edge coordinate.

Source

pub fn bottom(&self) -> i32

Returns the bottom edge coordinate.

Source

pub fn contains(&self, px: i32, py: i32) -> bool

Checks whether a pixel coordinate falls inside this region.

Source

pub fn overlaps(&self, other: &Self) -> bool

Checks whether two regions overlap.

Source

pub fn intersection_area(&self, other: &Self) -> u64

Returns the intersection area with another region, or 0 if they don’t overlap.

Trait Implementations§

Source§

impl Clone for RoiRegion

Source§

fn clone(&self) -> RoiRegion

Returns a duplicate 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 RoiRegion

Source§

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

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

impl PartialEq for RoiRegion

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for RoiRegion

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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
Source§

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

Source§

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.
Source§

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

Source§

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.