{-# 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.StartTextDetectionFilters
-- 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)
module Amazonka.Rekognition.Types.StartTextDetectionFilters where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.Rekognition.Types.DetectionFilter
import Amazonka.Rekognition.Types.RegionOfInterest

-- | Set of optional parameters that let you set the criteria text must meet
-- to be included in your response. @WordFilter@ looks at a word\'s height,
-- width and minimum confidence. @RegionOfInterest@ lets you set a specific
-- region of the screen to look for text in.
--
-- /See:/ 'newStartTextDetectionFilters' smart constructor.
data StartTextDetectionFilters = StartTextDetectionFilters'
  { -- | Filter focusing on a certain area of the frame. Uses a @BoundingBox@
    -- object to set the region of the screen.
    StartTextDetectionFilters -> Maybe [RegionOfInterest]
regionsOfInterest :: Prelude.Maybe [RegionOfInterest],
    -- | Filters focusing on qualities of the text, such as confidence or size.
    StartTextDetectionFilters -> Maybe DetectionFilter
wordFilter :: Prelude.Maybe DetectionFilter
  }
  deriving (StartTextDetectionFilters -> StartTextDetectionFilters -> Bool
(StartTextDetectionFilters -> StartTextDetectionFilters -> Bool)
-> (StartTextDetectionFilters -> StartTextDetectionFilters -> Bool)
-> Eq StartTextDetectionFilters
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StartTextDetectionFilters -> StartTextDetectionFilters -> Bool
$c/= :: StartTextDetectionFilters -> StartTextDetectionFilters -> Bool
== :: StartTextDetectionFilters -> StartTextDetectionFilters -> Bool
$c== :: StartTextDetectionFilters -> StartTextDetectionFilters -> Bool
Prelude.Eq, ReadPrec [StartTextDetectionFilters]
ReadPrec StartTextDetectionFilters
Int -> ReadS StartTextDetectionFilters
ReadS [StartTextDetectionFilters]
(Int -> ReadS StartTextDetectionFilters)
-> ReadS [StartTextDetectionFilters]
-> ReadPrec StartTextDetectionFilters
-> ReadPrec [StartTextDetectionFilters]
-> Read StartTextDetectionFilters
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StartTextDetectionFilters]
$creadListPrec :: ReadPrec [StartTextDetectionFilters]
readPrec :: ReadPrec StartTextDetectionFilters
$creadPrec :: ReadPrec StartTextDetectionFilters
readList :: ReadS [StartTextDetectionFilters]
$creadList :: ReadS [StartTextDetectionFilters]
readsPrec :: Int -> ReadS StartTextDetectionFilters
$creadsPrec :: Int -> ReadS StartTextDetectionFilters
Prelude.Read, Int -> StartTextDetectionFilters -> ShowS
[StartTextDetectionFilters] -> ShowS
StartTextDetectionFilters -> String
(Int -> StartTextDetectionFilters -> ShowS)
-> (StartTextDetectionFilters -> String)
-> ([StartTextDetectionFilters] -> ShowS)
-> Show StartTextDetectionFilters
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StartTextDetectionFilters] -> ShowS
$cshowList :: [StartTextDetectionFilters] -> ShowS
show :: StartTextDetectionFilters -> String
$cshow :: StartTextDetectionFilters -> String
showsPrec :: Int -> StartTextDetectionFilters -> ShowS
$cshowsPrec :: Int -> StartTextDetectionFilters -> ShowS
Prelude.Show, (forall x.
 StartTextDetectionFilters -> Rep StartTextDetectionFilters x)
-> (forall x.
    Rep StartTextDetectionFilters x -> StartTextDetectionFilters)
-> Generic StartTextDetectionFilters
forall x.
Rep StartTextDetectionFilters x -> StartTextDetectionFilters
forall x.
StartTextDetectionFilters -> Rep StartTextDetectionFilters x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep StartTextDetectionFilters x -> StartTextDetectionFilters
$cfrom :: forall x.
StartTextDetectionFilters -> Rep StartTextDetectionFilters x
Prelude.Generic)

-- |
-- Create a value of 'StartTextDetectionFilters' 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:
--
-- 'regionsOfInterest', 'startTextDetectionFilters_regionsOfInterest' - Filter focusing on a certain area of the frame. Uses a @BoundingBox@
-- object to set the region of the screen.
--
-- 'wordFilter', 'startTextDetectionFilters_wordFilter' - Filters focusing on qualities of the text, such as confidence or size.
newStartTextDetectionFilters ::
  StartTextDetectionFilters
newStartTextDetectionFilters :: StartTextDetectionFilters
newStartTextDetectionFilters =
  StartTextDetectionFilters' :: Maybe [RegionOfInterest]
-> Maybe DetectionFilter -> StartTextDetectionFilters
StartTextDetectionFilters'
    { $sel:regionsOfInterest:StartTextDetectionFilters' :: Maybe [RegionOfInterest]
regionsOfInterest =
        Maybe [RegionOfInterest]
forall a. Maybe a
Prelude.Nothing,
      $sel:wordFilter:StartTextDetectionFilters' :: Maybe DetectionFilter
wordFilter = Maybe DetectionFilter
forall a. Maybe a
Prelude.Nothing
    }

-- | Filter focusing on a certain area of the frame. Uses a @BoundingBox@
-- object to set the region of the screen.
startTextDetectionFilters_regionsOfInterest :: Lens.Lens' StartTextDetectionFilters (Prelude.Maybe [RegionOfInterest])
startTextDetectionFilters_regionsOfInterest :: (Maybe [RegionOfInterest] -> f (Maybe [RegionOfInterest]))
-> StartTextDetectionFilters -> f StartTextDetectionFilters
startTextDetectionFilters_regionsOfInterest = (StartTextDetectionFilters -> Maybe [RegionOfInterest])
-> (StartTextDetectionFilters
    -> Maybe [RegionOfInterest] -> StartTextDetectionFilters)
-> Lens
     StartTextDetectionFilters
     StartTextDetectionFilters
     (Maybe [RegionOfInterest])
     (Maybe [RegionOfInterest])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartTextDetectionFilters' {Maybe [RegionOfInterest]
regionsOfInterest :: Maybe [RegionOfInterest]
$sel:regionsOfInterest:StartTextDetectionFilters' :: StartTextDetectionFilters -> Maybe [RegionOfInterest]
regionsOfInterest} -> Maybe [RegionOfInterest]
regionsOfInterest) (\s :: StartTextDetectionFilters
s@StartTextDetectionFilters' {} Maybe [RegionOfInterest]
a -> StartTextDetectionFilters
s {$sel:regionsOfInterest:StartTextDetectionFilters' :: Maybe [RegionOfInterest]
regionsOfInterest = Maybe [RegionOfInterest]
a} :: StartTextDetectionFilters) ((Maybe [RegionOfInterest] -> f (Maybe [RegionOfInterest]))
 -> StartTextDetectionFilters -> f StartTextDetectionFilters)
-> ((Maybe [RegionOfInterest] -> f (Maybe [RegionOfInterest]))
    -> Maybe [RegionOfInterest] -> f (Maybe [RegionOfInterest]))
-> (Maybe [RegionOfInterest] -> f (Maybe [RegionOfInterest]))
-> StartTextDetectionFilters
-> f StartTextDetectionFilters
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso
  [RegionOfInterest]
  [RegionOfInterest]
  [RegionOfInterest]
  [RegionOfInterest]
-> Iso
     (Maybe [RegionOfInterest])
     (Maybe [RegionOfInterest])
     (Maybe [RegionOfInterest])
     (Maybe [RegionOfInterest])
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 AnIso
  [RegionOfInterest]
  [RegionOfInterest]
  [RegionOfInterest]
  [RegionOfInterest]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Filters focusing on qualities of the text, such as confidence or size.
startTextDetectionFilters_wordFilter :: Lens.Lens' StartTextDetectionFilters (Prelude.Maybe DetectionFilter)
startTextDetectionFilters_wordFilter :: (Maybe DetectionFilter -> f (Maybe DetectionFilter))
-> StartTextDetectionFilters -> f StartTextDetectionFilters
startTextDetectionFilters_wordFilter = (StartTextDetectionFilters -> Maybe DetectionFilter)
-> (StartTextDetectionFilters
    -> Maybe DetectionFilter -> StartTextDetectionFilters)
-> Lens
     StartTextDetectionFilters
     StartTextDetectionFilters
     (Maybe DetectionFilter)
     (Maybe DetectionFilter)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartTextDetectionFilters' {Maybe DetectionFilter
wordFilter :: Maybe DetectionFilter
$sel:wordFilter:StartTextDetectionFilters' :: StartTextDetectionFilters -> Maybe DetectionFilter
wordFilter} -> Maybe DetectionFilter
wordFilter) (\s :: StartTextDetectionFilters
s@StartTextDetectionFilters' {} Maybe DetectionFilter
a -> StartTextDetectionFilters
s {$sel:wordFilter:StartTextDetectionFilters' :: Maybe DetectionFilter
wordFilter = Maybe DetectionFilter
a} :: StartTextDetectionFilters)

instance Prelude.Hashable StartTextDetectionFilters

instance Prelude.NFData StartTextDetectionFilters

instance Core.ToJSON StartTextDetectionFilters where
  toJSON :: StartTextDetectionFilters -> Value
toJSON StartTextDetectionFilters' {Maybe [RegionOfInterest]
Maybe DetectionFilter
wordFilter :: Maybe DetectionFilter
regionsOfInterest :: Maybe [RegionOfInterest]
$sel:wordFilter:StartTextDetectionFilters' :: StartTextDetectionFilters -> Maybe DetectionFilter
$sel:regionsOfInterest:StartTextDetectionFilters' :: StartTextDetectionFilters -> Maybe [RegionOfInterest]
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"RegionsOfInterest" Text -> [RegionOfInterest] -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              ([RegionOfInterest] -> Pair)
-> Maybe [RegionOfInterest] -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [RegionOfInterest]
regionsOfInterest,
            (Text
"WordFilter" Text -> DetectionFilter -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (DetectionFilter -> Pair) -> Maybe DetectionFilter -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe DetectionFilter
wordFilter
          ]
      )