@Generated(value="software.amazon.awssdk:codegen") public final class BoundingBox extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BoundingBox.Builder,BoundingBox>
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.
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.
Modifier and Type | Class and Description |
---|---|
static interface |
BoundingBox.Builder |
Modifier and Type | Method and Description |
---|---|
static BoundingBox.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Float |
height()
Height of the bounding box as a ratio of the overall image height.
|
Float |
left()
Left coordinate of the bounding box as a ratio of overall image width.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends BoundingBox.Builder> |
serializableBuilderClass() |
BoundingBox.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
Float |
top()
Top coordinate of the bounding box as a ratio of overall image height.
|
String |
toString()
Returns a string representation of this object.
|
Float |
width()
Width of the bounding box as a ratio of the overall image width.
|
copy
public final Float width()
Width of the bounding box as a ratio of the overall image width.
public final Float height()
Height of the bounding box as a ratio of the overall image height.
public final Float left()
Left coordinate of the bounding box as a ratio of overall image width.
public final Float top()
Top coordinate of the bounding box as a ratio of overall image height.
public BoundingBox.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<BoundingBox.Builder,BoundingBox>
public static BoundingBox.Builder builder()
public static Class<? extends BoundingBox.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.