software.amazon.awssdk.services.textract.model

Class BoundingBox

java.lang.Object

software.amazon.awssdk.services.textract.model.BoundingBox

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BoundingBox.Builder,BoundingBox>

@Generated(value="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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BoundingBox.Builder

Method Summary

Modifier and Type	Method and Description
static BoundingBox.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Float	height() The height of the bounding box as a ratio of the overall document page height.
Float	left() The left coordinate of the bounding box as a ratio of overall document page width.
List<SdkField<?>>	sdkFields()
static Class<? extends BoundingBox.Builder>	serializableBuilderClass()
BoundingBox.Builder	toBuilder()
Float	top() The top coordinate of the bounding box as a ratio of overall document page height.
String	toString() Returns a string representation of this object.
Float	width() The width of the bounding box as a ratio of the overall document page width.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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.

toBuilder

public BoundingBox.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BoundingBox.Builder,BoundingBox>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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