{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Rekognition.Types.RegionOfInterest
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Rekognition.Types.RegionOfInterest where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.Rekognition.Types.BoundingBox
import Amazonka.Rekognition.Types.Point

-- | 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.
data RegionOfInterest = RegionOfInterest'
  { -- | The box representing a region of interest on screen.
    RegionOfInterest -> Maybe BoundingBox
boundingBox :: Prelude.Maybe BoundingBox,
    -- | Specifies a shape made up of up to 10 @Point@ objects to define a region
    -- of interest.
    RegionOfInterest -> Maybe [Point]
polygon :: Prelude.Maybe [Point]
  }
  deriving (RegionOfInterest -> RegionOfInterest -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RegionOfInterest -> RegionOfInterest -> Bool
$c/= :: RegionOfInterest -> RegionOfInterest -> Bool
== :: RegionOfInterest -> RegionOfInterest -> Bool
$c== :: RegionOfInterest -> RegionOfInterest -> Bool
Prelude.Eq, ReadPrec [RegionOfInterest]
ReadPrec RegionOfInterest
Int -> ReadS RegionOfInterest
ReadS [RegionOfInterest]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RegionOfInterest]
$creadListPrec :: ReadPrec [RegionOfInterest]
readPrec :: ReadPrec RegionOfInterest
$creadPrec :: ReadPrec RegionOfInterest
readList :: ReadS [RegionOfInterest]
$creadList :: ReadS [RegionOfInterest]
readsPrec :: Int -> ReadS RegionOfInterest
$creadsPrec :: Int -> ReadS RegionOfInterest
Prelude.Read, Int -> RegionOfInterest -> ShowS
[RegionOfInterest] -> ShowS
RegionOfInterest -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RegionOfInterest] -> ShowS
$cshowList :: [RegionOfInterest] -> ShowS
show :: RegionOfInterest -> String
$cshow :: RegionOfInterest -> String
showsPrec :: Int -> RegionOfInterest -> ShowS
$cshowsPrec :: Int -> RegionOfInterest -> ShowS
Prelude.Show, forall x. Rep RegionOfInterest x -> RegionOfInterest
forall x. RegionOfInterest -> Rep RegionOfInterest x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep RegionOfInterest x -> RegionOfInterest
$cfrom :: forall x. RegionOfInterest -> Rep RegionOfInterest x
Prelude.Generic)

-- |
-- Create a value of 'RegionOfInterest' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'boundingBox', 'regionOfInterest_boundingBox' - The box representing a region of interest on screen.
--
-- 'polygon', 'regionOfInterest_polygon' - Specifies a shape made up of up to 10 @Point@ objects to define a region
-- of interest.
newRegionOfInterest ::
  RegionOfInterest
newRegionOfInterest :: RegionOfInterest
newRegionOfInterest =
  RegionOfInterest'
    { $sel:boundingBox:RegionOfInterest' :: Maybe BoundingBox
boundingBox = forall a. Maybe a
Prelude.Nothing,
      $sel:polygon:RegionOfInterest' :: Maybe [Point]
polygon = forall a. Maybe a
Prelude.Nothing
    }

-- | The box representing a region of interest on screen.
regionOfInterest_boundingBox :: Lens.Lens' RegionOfInterest (Prelude.Maybe BoundingBox)
regionOfInterest_boundingBox :: Lens' RegionOfInterest (Maybe BoundingBox)
regionOfInterest_boundingBox = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RegionOfInterest' {Maybe BoundingBox
boundingBox :: Maybe BoundingBox
$sel:boundingBox:RegionOfInterest' :: RegionOfInterest -> Maybe BoundingBox
boundingBox} -> Maybe BoundingBox
boundingBox) (\s :: RegionOfInterest
s@RegionOfInterest' {} Maybe BoundingBox
a -> RegionOfInterest
s {$sel:boundingBox:RegionOfInterest' :: Maybe BoundingBox
boundingBox = Maybe BoundingBox
a} :: RegionOfInterest)

-- | Specifies a shape made up of up to 10 @Point@ objects to define a region
-- of interest.
regionOfInterest_polygon :: Lens.Lens' RegionOfInterest (Prelude.Maybe [Point])
regionOfInterest_polygon :: Lens' RegionOfInterest (Maybe [Point])
regionOfInterest_polygon = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RegionOfInterest' {Maybe [Point]
polygon :: Maybe [Point]
$sel:polygon:RegionOfInterest' :: RegionOfInterest -> Maybe [Point]
polygon} -> Maybe [Point]
polygon) (\s :: RegionOfInterest
s@RegionOfInterest' {} Maybe [Point]
a -> RegionOfInterest
s {$sel:polygon:RegionOfInterest' :: Maybe [Point]
polygon = Maybe [Point]
a} :: RegionOfInterest) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromJSON RegionOfInterest where
  parseJSON :: Value -> Parser RegionOfInterest
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"RegionOfInterest"
      ( \Object
x ->
          Maybe BoundingBox -> Maybe [Point] -> RegionOfInterest
RegionOfInterest'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"BoundingBox")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Polygon" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable RegionOfInterest where
  hashWithSalt :: Int -> RegionOfInterest -> Int
hashWithSalt Int
_salt RegionOfInterest' {Maybe [Point]
Maybe BoundingBox
polygon :: Maybe [Point]
boundingBox :: Maybe BoundingBox
$sel:polygon:RegionOfInterest' :: RegionOfInterest -> Maybe [Point]
$sel:boundingBox:RegionOfInterest' :: RegionOfInterest -> Maybe BoundingBox
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe BoundingBox
boundingBox
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Point]
polygon

instance Prelude.NFData RegionOfInterest where
  rnf :: RegionOfInterest -> ()
rnf RegionOfInterest' {Maybe [Point]
Maybe BoundingBox
polygon :: Maybe [Point]
boundingBox :: Maybe BoundingBox
$sel:polygon:RegionOfInterest' :: RegionOfInterest -> Maybe [Point]
$sel:boundingBox:RegionOfInterest' :: RegionOfInterest -> Maybe BoundingBox
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe BoundingBox
boundingBox
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Point]
polygon

instance Data.ToJSON RegionOfInterest where
  toJSON :: RegionOfInterest -> Value
toJSON RegionOfInterest' {Maybe [Point]
Maybe BoundingBox
polygon :: Maybe [Point]
boundingBox :: Maybe BoundingBox
$sel:polygon:RegionOfInterest' :: RegionOfInterest -> Maybe [Point]
$sel:boundingBox:RegionOfInterest' :: RegionOfInterest -> Maybe BoundingBox
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"BoundingBox" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe BoundingBox
boundingBox,
            (Key
"Polygon" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Point]
polygon
          ]
      )