Package software.amazon.awssdk.services.rekognition.model

Class BoundingBox

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<BoundingBox.Builder,​BoundingBox>
    @Generated("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, 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.

    See Also:
    Serialized Form

    • Method Detail

      • width

        public final Float width()

        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.

      • height

        public final Float height()

        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.

      • left

        public final Float left()

        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.

      • top

        public final Float top()

        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.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)