@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class BoundingBox extends Object implements Serializable, Cloneable, StructuredPojo
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.
| Constructor and Description |
|---|
BoundingBox() |
| Modifier and Type | Method and Description |
|---|---|
BoundingBox |
clone() |
boolean |
equals(Object obj) |
Float |
getHeight()
Height of the bounding box as a ratio of the overall image height.
|
Float |
getLeft()
Left coordinate of the bounding box as a ratio of overall image width.
|
Float |
getTop()
Top coordinate of the bounding box as a ratio of overall image height.
|
Float |
getWidth()
Width of the bounding box as a ratio of the overall image width.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setHeight(Float height)
Height of the bounding box as a ratio of the overall image height.
|
void |
setLeft(Float left)
Left coordinate of the bounding box as a ratio of overall image width.
|
void |
setTop(Float top)
Top coordinate of the bounding box as a ratio of overall image height.
|
void |
setWidth(Float width)
Width of the bounding box as a ratio of the overall image width.
|
String |
toString()
Returns a string representation of this object.
|
BoundingBox |
withHeight(Float height)
Height of the bounding box as a ratio of the overall image height.
|
BoundingBox |
withLeft(Float left)
Left coordinate of the bounding box as a ratio of overall image width.
|
BoundingBox |
withTop(Float top)
Top coordinate of the bounding box as a ratio of overall image height.
|
BoundingBox |
withWidth(Float width)
Width of the bounding box as a ratio of the overall image width.
|
public void setWidth(Float width)
Width of the bounding box as a ratio of the overall image width.
width - Width of the bounding box as a ratio of the overall image width.public Float getWidth()
Width of the bounding box as a ratio of the overall image width.
public BoundingBox withWidth(Float width)
Width of the bounding box as a ratio of the overall image width.
width - Width of the bounding box as a ratio of the overall image width.public void setHeight(Float height)
Height of the bounding box as a ratio of the overall image height.
height - Height of the bounding box as a ratio of the overall image height.public Float getHeight()
Height of the bounding box as a ratio of the overall image height.
public BoundingBox withHeight(Float height)
Height of the bounding box as a ratio of the overall image height.
height - Height of the bounding box as a ratio of the overall image height.public void setLeft(Float left)
Left coordinate of the bounding box as a ratio of overall image width.
left - Left coordinate of the bounding box as a ratio of overall image width.public Float getLeft()
Left coordinate of the bounding box as a ratio of overall image width.
public BoundingBox withLeft(Float left)
Left coordinate of the bounding box as a ratio of overall image width.
left - Left coordinate of the bounding box as a ratio of overall image width.public void setTop(Float top)
Top coordinate of the bounding box as a ratio of overall image height.
top - Top coordinate of the bounding box as a ratio of overall image height.public Float getTop()
Top coordinate of the bounding box as a ratio of overall image height.
public BoundingBox withTop(Float top)
Top coordinate of the bounding box as a ratio of overall image height.
top - Top coordinate of the bounding box as a ratio of overall image height.public String toString()
toString in class ObjectObject.toString()public BoundingBox clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.