aws-cdk-lib.aws_rekognition.CfnStreamProcessor.BoundingBoxProperty

interface BoundingBoxProperty

LanguageType name
.NETAmazon.CDK.AWS.Rekognition.CfnStreamProcessor.BoundingBoxProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrekognition#CfnStreamProcessor_BoundingBoxProperty
Javasoftware.amazon.awscdk.services.rekognition.CfnStreamProcessor.BoundingBoxProperty
Pythonaws_cdk.aws_rekognition.CfnStreamProcessor.BoundingBoxProperty
TypeScript aws-cdk-lib » aws_rekognition » CfnStreamProcessor » BoundingBoxProperty

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 { aws_rekognition as rekognition } from 'aws-cdk-lib';
const boundingBoxProperty: rekognition.CfnStreamProcessor.BoundingBoxProperty = {
  height: 123,
  left: 123,
  top: 123,
  width: 123,
};

Properties

NameTypeDescription
heightnumberHeight of the bounding box as a ratio of the overall image height.
leftnumberLeft coordinate of the bounding box as a ratio of overall image width.
topnumberTop coordinate of the bounding box as a ratio of overall image height.
widthnumberWidth of the bounding box as a ratio of the overall image width.

height

Type: number

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


left

Type: number

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


top

Type: number

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


width

Type: number

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