Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Textract.Types.BoundingBox

Description

Synopsis

data BoundingBox = BoundingBox' {
- height :: Maybe Double
- left :: Maybe Double
- width :: Maybe Double
- top :: Maybe Double
}
newBoundingBox :: BoundingBox
boundingBox_height :: Lens' BoundingBox (Maybe Double)
boundingBox_left :: Lens' BoundingBox (Maybe Double)
boundingBox_width :: Lens' BoundingBox (Maybe Double)
boundingBox_top :: Lens' BoundingBox (Maybe Double)

Documentation

data BoundingBox Source #

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: newBoundingBox smart constructor.

Constructors

BoundingBox'

Fields

height :: Maybe Double
The height of the bounding box as a ratio of the overall document page height.
left :: Maybe Double
The left coordinate of the bounding box as a ratio of overall document page width.
width :: Maybe Double
The width of the bounding box as a ratio of the overall document page width.
top :: Maybe Double
The top coordinate of the bounding box as a ratio of overall document page height.

Instances

Instances details

Eq BoundingBox Source #
Instance details Defined in Amazonka.Textract.Types.BoundingBox Methods (==) :: BoundingBox -> BoundingBox -> Bool # (/=) :: BoundingBox -> BoundingBox -> Bool #
Read BoundingBox Source #
Instance details Defined in Amazonka.Textract.Types.BoundingBox Methods readsPrec :: Int -> ReadS BoundingBox # readList :: ReadS [BoundingBox] # readPrec :: ReadPrec BoundingBox # readListPrec :: ReadPrec [BoundingBox] #
Show BoundingBox Source #
Instance details Defined in Amazonka.Textract.Types.BoundingBox Methods showsPrec :: Int -> BoundingBox -> ShowS # show :: BoundingBox -> String # showList :: [BoundingBox] -> ShowS #
Generic BoundingBox Source #
Instance details Defined in Amazonka.Textract.Types.BoundingBox Associated Types type Rep BoundingBox :: Type -> Type # Methods from :: BoundingBox -> Rep BoundingBox x # to :: Rep BoundingBox x -> BoundingBox #
NFData BoundingBox Source #
Instance details Defined in Amazonka.Textract.Types.BoundingBox Methods rnf :: BoundingBox -> () #
Hashable BoundingBox Source #
Instance details Defined in Amazonka.Textract.Types.BoundingBox Methods hashWithSalt :: Int -> BoundingBox -> Int # hash :: BoundingBox -> Int #
FromJSON BoundingBox Source #
Instance details Defined in Amazonka.Textract.Types.BoundingBox Methods parseJSON :: Value -> Parser BoundingBox # parseJSONList :: Value -> Parser [BoundingBox] #
type Rep BoundingBox Source #
Instance details Defined in Amazonka.Textract.Types.BoundingBox type Rep BoundingBox = D1 ('MetaData "BoundingBox" "Amazonka.Textract.Types.BoundingBox" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "BoundingBox'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "left") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "top") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newBoundingBox :: BoundingBox Source #

Create a value of BoundingBox with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:height:BoundingBox', boundingBox_height - The height of the bounding box as a ratio of the overall document page height.

$sel:left:BoundingBox', boundingBox_left - The left coordinate of the bounding box as a ratio of overall document page width.

$sel:width:BoundingBox', boundingBox_width - The width of the bounding box as a ratio of the overall document page width.

$sel:top:BoundingBox', boundingBox_top - The top coordinate of the bounding box as a ratio of overall document page height.

boundingBox_height :: Lens' BoundingBox (Maybe Double) Source #

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

boundingBox_left :: Lens' BoundingBox (Maybe Double) Source #

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

boundingBox_width :: Lens' BoundingBox (Maybe Double) Source #

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

boundingBox_top :: Lens' BoundingBox (Maybe Double) Source #

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