amazonka-comprehend-2.0: Amazon Comprehend SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Comprehend.Types.BoundingBox

Description

 
Synopsis

Documentation

data BoundingBox Source #

The bounding box around the detected page or around an 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).

For additional information, see BoundingBox in the Amazon Textract API reference.

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.

  • top :: Maybe Double

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

  • width :: Maybe Double

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

Instances

Instances details
FromJSON BoundingBox Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BoundingBox

Methods

parseJSON :: Value -> Parser BoundingBox #

parseJSONList :: Value -> Parser [BoundingBox] #

Generic BoundingBox Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BoundingBox

Associated Types

type Rep BoundingBox :: Type -> Type #

Methods

from :: BoundingBox -> Rep BoundingBox x #

to :: Rep BoundingBox x -> BoundingBox #

Read BoundingBox Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BoundingBox

Methods

readsPrec :: Int -> ReadS BoundingBox #

readList :: ReadS [BoundingBox] #

readPrec :: ReadPrec BoundingBox #

readListPrec :: ReadPrec [BoundingBox] #

Show BoundingBox Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BoundingBox

Methods

showsPrec :: Int -> BoundingBox -> ShowS #

show :: BoundingBox -> String #

showList :: [BoundingBox] -> ShowS #

NFData BoundingBox Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BoundingBox

Methods

rnf :: BoundingBox -> () #

Eq BoundingBox Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BoundingBox

Methods

(==) :: BoundingBox -> BoundingBox -> Bool #

(/=) :: BoundingBox -> BoundingBox -> Bool #

Hashable BoundingBox Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BoundingBox

Methods

hashWithSalt :: Int -> BoundingBox -> Int #

hash :: BoundingBox -> Int #

type Rep BoundingBox Source # 
Instance details

Defined in Amazonka.Comprehend.Types.BoundingBox

type Rep BoundingBox = D1 ('MetaData "BoundingBox" "Amazonka.Comprehend.Types.BoundingBox" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" '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 "top") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "width") '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:top:BoundingBox', boundingBox_top - The top coordinate of the bounding box as a ratio of overall document page height.

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

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_top :: Lens' BoundingBox (Maybe Double) Source #

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

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

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