software.amazon.awscdk.services.rekognition

Interface CfnStreamProcessor.BoundingBoxProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStreamProcessor.BoundingBoxProperty.Jsii$Proxy

Enclosing class:

CfnStreamProcessor

@Stability(value=Stable)
public static interface CfnStreamProcessor.BoundingBoxProperty
extends software.amazon.jsii.JsiiSerializable

Identifies the bounding box around the label, face, text, 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. For more information, see BoundingBox .

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rekognition.*;
 BoundingBoxProperty boundingBoxProperty = BoundingBoxProperty.builder()
         .height(123)
         .left(123)
         .top(123)
         .width(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnStreamProcessor.BoundingBoxProperty.Builder A builder for CfnStreamProcessor.BoundingBoxProperty
static class	CfnStreamProcessor.BoundingBoxProperty.Jsii$Proxy An implementation for CfnStreamProcessor.BoundingBoxProperty

Method Summary

Modifier and Type	Method and Description
static CfnStreamProcessor.BoundingBoxProperty.Builder	builder()
Number	getHeight() Height of the bounding box as a ratio of the overall image height.
Number	getLeft() Left coordinate of the bounding box as a ratio of overall image width.
Number	getTop() Top coordinate of the bounding box as a ratio of overall image height.
Number	getWidth() Width of the bounding box as a ratio of the overall image width.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHeight

@Stability(value=Stable)
 @NotNull
Number getHeight()

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

getLeft

@Stability(value=Stable)
 @NotNull
Number getLeft()

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

getTop

@Stability(value=Stable)
 @NotNull
Number getTop()

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

getWidth

@Stability(value=Stable)
 @NotNull
Number getWidth()

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

builder

@Stability(value=Stable)
static CfnStreamProcessor.BoundingBoxProperty.Builder builder()

Returns:

a CfnStreamProcessor.BoundingBoxProperty.Builder of CfnStreamProcessor.BoundingBoxProperty