Amazonka.Rekognition.Types.RegionOfInterest

Documentation

data RegionOfInterest

Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a BoundingBox or Polygon to set a region of the screen.

A word, face, or label is included in the region if it is more than half in that region. If there is more than one region, the word, face, or label is compared with all regions of the screen. Any object of interest that is more than half in a region is kept in the results.

See: newRegionOfInterest smart constructor.

Constructors

RegionOfInterest'

Fields

• boundingBox :: Maybe BoundingBox

  The box representing a region of interest on screen.

• polygon :: Maybe [Point]

  Specifies a shape made up of up to 10 Point objects to define a region of interest.

Instances

FromJSON RegionOfInterest

Defined in Amazonka.Rekognition.Types.RegionOfInterest

Methods

parseJSON :: Value -> Parser RegionOfInterest

parseJSONList :: Value -> Parser [RegionOfInterest]

ToJSON RegionOfInterest

Defined in Amazonka.Rekognition.Types.RegionOfInterest

Methods

toJSON :: RegionOfInterest -> Value

toEncoding :: RegionOfInterest -> Encoding

toJSONList :: [RegionOfInterest] -> Value

toEncodingList :: [RegionOfInterest] -> Encoding

Generic RegionOfInterest

Defined in Amazonka.Rekognition.Types.RegionOfInterest

Associated Types

type Rep RegionOfInterest :: Type -> Type

Methods

from :: RegionOfInterest -> Rep RegionOfInterest x

to :: Rep RegionOfInterest x -> RegionOfInterest

Read RegionOfInterest

Defined in Amazonka.Rekognition.Types.RegionOfInterest

Methods

readsPrec :: Int -> ReadS RegionOfInterest

readList :: ReadS [RegionOfInterest]

readPrec :: ReadPrec RegionOfInterest

readListPrec :: ReadPrec [RegionOfInterest]

Show RegionOfInterest

Defined in Amazonka.Rekognition.Types.RegionOfInterest

Methods

showsPrec :: Int -> RegionOfInterest -> ShowS

show :: RegionOfInterest -> String

showList :: [RegionOfInterest] -> ShowS

NFData RegionOfInterest

Defined in Amazonka.Rekognition.Types.RegionOfInterest

Methods

rnf :: RegionOfInterest -> ()

Eq RegionOfInterest

Defined in Amazonka.Rekognition.Types.RegionOfInterest

Methods

(==) :: RegionOfInterest -> RegionOfInterest -> Bool

(/=) :: RegionOfInterest -> RegionOfInterest -> Bool

Hashable RegionOfInterest

Defined in Amazonka.Rekognition.Types.RegionOfInterest

Methods

hashWithSalt :: Int -> RegionOfInterest -> Int

hash :: RegionOfInterest -> Int

type Rep RegionOfInterest

Defined in Amazonka.Rekognition.Types.RegionOfInterest

type Rep RegionOfInterest = D1 ('MetaData "RegionOfInterest" "Amazonka.Rekognition.Types.RegionOfInterest" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "RegionOfInterest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "boundingBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BoundingBox)) :*: S1 ('MetaSel ('Just "polygon") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Point]))))

newRegionOfInterest :: RegionOfInterest

Create a value of RegionOfInterest 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:boundingBox:RegionOfInterest', regionOfInterest_boundingBox - The box representing a region of interest on screen.

$sel:polygon:RegionOfInterest', regionOfInterest_polygon - Specifies a shape made up of up to 10 Point objects to define a region of interest.

regionOfInterest_boundingBox :: Lens' RegionOfInterest (Maybe BoundingBox)

The box representing a region of interest on screen.

regionOfInterest_polygon :: Lens' RegionOfInterest (Maybe [Point])

Specifies a shape made up of up to 10 Point objects to define a region of interest.