BoundingBox (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rekognition.model.BoundingBox

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BoundingBox
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Identifies the bounding box around the object or face. 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.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

BoundingBox()

Constructors
Constructor and Description
`BoundingBox()`

Method Summary

All Methods Instance Methods Concrete Methods
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; useful for testing and debugging.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BoundingBox
```
public BoundingBox()
```
- Method Detail
  - setWidth
```
public void setWidth(Float width)
```
    Width of the bounding box as a ratio of the overall image width.
    
    Parameters:
    
    width - Width of the bounding box as a ratio of the overall image width.
  - getWidth
```
public Float getWidth()
```
    Width of the bounding box as a ratio of the overall image width.
    
    Returns:
    
    Width of the bounding box as a ratio of the overall image width.
  - withWidth
```
public BoundingBox withWidth(Float width)
```
    Width of the bounding box as a ratio of the overall image width.
    
    Parameters:
    
    width - Width of the bounding box as a ratio of the overall image width.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHeight
```
public void setHeight(Float height)
```
    Height of the bounding box as a ratio of the overall image height.
    
    Parameters:
    
    height - Height of the bounding box as a ratio of the overall image height.
  - getHeight
```
public Float getHeight()
```
    Height of the bounding box as a ratio of the overall image height.
    
    Returns:
    
    Height of the bounding box as a ratio of the overall image height.
  - withHeight
```
public BoundingBox withHeight(Float height)
```
    Height of the bounding box as a ratio of the overall image height.
    
    Parameters:
    
    height - Height of the bounding box as a ratio of the overall image height.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLeft
```
public void setLeft(Float left)
```
    Left coordinate of the bounding box as a ratio of overall image width.
    
    Parameters:
    
    left - Left coordinate of the bounding box as a ratio of overall image width.
  - getLeft
```
public Float getLeft()
```
    Left coordinate of the bounding box as a ratio of overall image width.
    
    Returns:
    
    Left coordinate of the bounding box as a ratio of overall image width.
  - withLeft
```
public BoundingBox withLeft(Float left)
```
    Left coordinate of the bounding box as a ratio of overall image width.
    
    Parameters:
    
    left - Left coordinate of the bounding box as a ratio of overall image width.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTop
```
public void setTop(Float top)
```
    Top coordinate of the bounding box as a ratio of overall image height.
    
    Parameters:
    
    top - Top coordinate of the bounding box as a ratio of overall image height.
  - getTop
```
public Float getTop()
```
    Top coordinate of the bounding box as a ratio of overall image height.
    
    Returns:
    
    Top coordinate of the bounding box as a ratio of overall image height.
  - withTop
```
public BoundingBox withTop(Float top)
```
    Top coordinate of the bounding box as a ratio of overall image height.
    
    Parameters:
    
    top - Top coordinate of the bounding box as a ratio of overall image height.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BoundingBox clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class BoundingBox

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BoundingBox

Method Detail

setWidth

getWidth

withWidth

setHeight

getHeight

withHeight

setLeft

getLeft

withLeft

setTop

getTop

withTop

toString

equals

hashCode

clone

marshall