Class: Aws::Textract::Types::BoundingBox

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-textract/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#heightFloat

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

Returns:

  • (Float)


680
681
682
683
684
685
686
687
# File 'lib/aws-sdk-textract/types.rb', line 680

class BoundingBox < Struct.new(
  :width,
  :height,
  :left,
  :top)
  SENSITIVE = []
  include Aws::Structure
end

#leftFloat

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

Returns:

  • (Float)


680
681
682
683
684
685
686
687
# File 'lib/aws-sdk-textract/types.rb', line 680

class BoundingBox < Struct.new(
  :width,
  :height,
  :left,
  :top)
  SENSITIVE = []
  include Aws::Structure
end

#topFloat

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

Returns:

  • (Float)


680
681
682
683
684
685
686
687
# File 'lib/aws-sdk-textract/types.rb', line 680

class BoundingBox < Struct.new(
  :width,
  :height,
  :left,
  :top)
  SENSITIVE = []
  include Aws::Structure
end

#widthFloat

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

Returns:

  • (Float)


680
681
682
683
684
685
686
687
# File 'lib/aws-sdk-textract/types.rb', line 680

class BoundingBox < Struct.new(
  :width,
  :height,
  :left,
  :top)
  SENSITIVE = []
  include Aws::Structure
end