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.Rekognition.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 #

Identifies the bounding box around the label, face, text or personal protective equipment. The left (x-coordinate) and top (y-coordinate) are coordinates representing 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 image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 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 image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left or top values.

See: newBoundingBox smart constructor.

Constructors

BoundingBox'
Fields height :: Maybe Double Height of the bounding box as a ratio of the overall image height. left :: Maybe Double Left coordinate of the bounding box as a ratio of overall image width. width :: Maybe Double Width of the bounding box as a ratio of the overall image width. top :: Maybe Double Top coordinate of the bounding box as a ratio of overall image height.

Instances

Instances details

Eq BoundingBox Source #
Instance details Defined in Amazonka.Rekognition.Types.BoundingBox Methods (==) :: BoundingBox -> BoundingBox -> Bool # (/=) :: BoundingBox -> BoundingBox -> Bool #
Read BoundingBox Source #
Instance details Defined in Amazonka.Rekognition.Types.BoundingBox Methods readsPrec :: Int -> ReadS BoundingBox # readList :: ReadS [BoundingBox] # readPrec :: ReadPrec BoundingBox # readListPrec :: ReadPrec [BoundingBox] #
Show BoundingBox Source #
Instance details Defined in Amazonka.Rekognition.Types.BoundingBox Methods showsPrec :: Int -> BoundingBox -> ShowS # show :: BoundingBox -> String # showList :: [BoundingBox] -> ShowS #
Generic BoundingBox Source #
Instance details Defined in Amazonka.Rekognition.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.Rekognition.Types.BoundingBox Methods rnf :: BoundingBox -> () #
Hashable BoundingBox Source #
Instance details Defined in Amazonka.Rekognition.Types.BoundingBox Methods hashWithSalt :: Int -> BoundingBox -> Int # hash :: BoundingBox -> Int #
ToJSON BoundingBox Source #
Instance details Defined in Amazonka.Rekognition.Types.BoundingBox Methods toJSON :: BoundingBox -> Value # toEncoding :: BoundingBox -> Encoding # toJSONList :: [BoundingBox] -> Value # toEncodingList :: [BoundingBox] -> Encoding #
FromJSON BoundingBox Source #
Instance details Defined in Amazonka.Rekognition.Types.BoundingBox Methods parseJSON :: Value -> Parser BoundingBox # parseJSONList :: Value -> Parser [BoundingBox] #
type Rep BoundingBox Source #
Instance details Defined in Amazonka.Rekognition.Types.BoundingBox type Rep BoundingBox = D1 ('MetaData "BoundingBox" "Amazonka.Rekognition.Types.BoundingBox" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" '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 - Height of the bounding box as a ratio of the overall image height.

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

$sel:width:BoundingBox', boundingBox_width - Width of the bounding box as a ratio of the overall image width.

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

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

Height of the bounding box as a ratio of the overall image height.

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

Left coordinate of the bounding box as a ratio of overall image width.

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

Width of the bounding box as a ratio of the overall image width.

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

Top coordinate of the bounding box as a ratio of overall image height.