Struct BoundingBox

#[non_exhaustive]
pub struct BoundingBox {
    pub width: Option<f32>,
    pub height: Option<f32>,
    pub left: Option<f32>,
    pub top: Option<f32>,
}

Identifies the bounding box around the label, face, text, object of interest, or personal protective equipment. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The top and left values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left or top values.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

width: Option<f32>

Width of the bounding box as a ratio of the overall image width.

height: Option<f32>

Height of the bounding box as a ratio of the overall image height.

left: Option<f32>

Left coordinate of the bounding box as a ratio of overall image width.

top: Option<f32>

Top coordinate of the bounding box as a ratio of overall image height.

Implementations

impl BoundingBox

pub fn width(&self) -> Option<f32>

Width of the bounding box as a ratio of the overall image width.

pub fn height(&self) -> Option<f32>

Height of the bounding box as a ratio of the overall image height.

pub fn left(&self) -> Option<f32>

Left coordinate of the bounding box as a ratio of overall image width.

pub fn top(&self) -> Option<f32>

Top coordinate of the bounding box as a ratio of overall image height.

impl BoundingBox

pub fn builder() -> BoundingBoxBuilder

Creates a new builder-style object to manufacture BoundingBox.

Trait Implementations

impl Clone for BoundingBox

fn clone(&self) -> BoundingBox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoundingBox

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

Formats the value using the given formatter.

impl PartialEq for BoundingBox

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

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

const 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 BoundingBox