Struct RegionOfInterest

#[non_exhaustive]
pub struct RegionOfInterest {
    pub bounding_box: Option<BoundingBox>,
    pub polygon: Option<Vec<Point>>,
}

Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a BoundingBox or Polygon to set a region of the screen.

A word, face, or label is included in the region if it is more than half in that region. If there is more than one region, the word, face, or label is compared with all regions of the screen. Any object of interest that is more than half in a region is kept in the results.

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.

bounding_box: Option<BoundingBox>

The box representing a region of interest on screen.

polygon: Option<Vec<Point>>

Specifies a shape made up of up to 10 Point objects to define a region of interest.

Implementations

impl RegionOfInterest

pub fn bounding_box(&self) -> Option<&BoundingBox>

The box representing a region of interest on screen.

pub fn polygon(&self) -> &[Point]

Specifies a shape made up of up to 10 Point objects to define a region of interest.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .polygon.is_none().

impl RegionOfInterest

pub fn builder() -> RegionOfInterestBuilder

Creates a new builder-style object to manufacture RegionOfInterest.

Trait Implementations

impl Clone for RegionOfInterest

fn clone(&self) -> RegionOfInterest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegionOfInterest

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

Formats the value using the given formatter.

impl PartialEq for RegionOfInterest

fn eq(&self, other: &RegionOfInterest) -> 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 RegionOfInterest