Class BoundingBox

java.lang.Object
software.amazon.awssdk.services.textract.model.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:

  • Method Details

    • 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.

    • toBuilder

      public BoundingBox.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BoundingBox.Builder,BoundingBox>
      Returns:
      a builder for type T

    • builder

      public static BoundingBox.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BoundingBox.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.