Package software.amazon.awssdk.services.textract.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>

    The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent 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 document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 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 document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

    See Also:
    Serialized Form

    • Method Detail

      • width

        public final Float width()

        The width of the bounding box as a ratio of the overall document page width.

        Returns:
        The width of the bounding box as a ratio of the overall document page width.

      • height

        public final Float height()

        The height of the bounding box as a ratio of the overall document page height.

        Returns:
        The height of the bounding box as a ratio of the overall document page height.

      • left

        public final Float left()

        The left coordinate of the bounding box as a ratio of overall document page width.

        Returns:
        The left coordinate of the bounding box as a ratio of overall document page width.

      • top

        public final Float top()

        The top coordinate of the bounding box as a ratio of overall document page height.

        Returns:
        The top coordinate of the bounding box as a ratio of overall document page 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)