{-# 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.DetectTextFilters
-- 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.DetectTextFilters 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

-- | A set of optional parameters that you can use to set the criteria that
-- the 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 image to look for text in.
--
-- /See:/ 'newDetectTextFilters' smart constructor.
data DetectTextFilters = DetectTextFilters'
  { -- | A Filter focusing on a certain area of the image. Uses a @BoundingBox@
    -- object to set the region of the image.
    DetectTextFilters -> Maybe [RegionOfInterest]
regionsOfInterest :: Prelude.Maybe [RegionOfInterest],
    DetectTextFilters -> Maybe DetectionFilter
wordFilter :: Prelude.Maybe DetectionFilter
  }
  deriving (DetectTextFilters -> DetectTextFilters -> Bool
(DetectTextFilters -> DetectTextFilters -> Bool)
-> (DetectTextFilters -> DetectTextFilters -> Bool)
-> Eq DetectTextFilters
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DetectTextFilters -> DetectTextFilters -> Bool
$c/= :: DetectTextFilters -> DetectTextFilters -> Bool
== :: DetectTextFilters -> DetectTextFilters -> Bool
$c== :: DetectTextFilters -> DetectTextFilters -> Bool
Prelude.Eq, ReadPrec [DetectTextFilters]
ReadPrec DetectTextFilters
Int -> ReadS DetectTextFilters
ReadS [DetectTextFilters]
(Int -> ReadS DetectTextFilters)
-> ReadS [DetectTextFilters]
-> ReadPrec DetectTextFilters
-> ReadPrec [DetectTextFilters]
-> Read DetectTextFilters
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DetectTextFilters]
$creadListPrec :: ReadPrec [DetectTextFilters]
readPrec :: ReadPrec DetectTextFilters
$creadPrec :: ReadPrec DetectTextFilters
readList :: ReadS [DetectTextFilters]
$creadList :: ReadS [DetectTextFilters]
readsPrec :: Int -> ReadS DetectTextFilters
$creadsPrec :: Int -> ReadS DetectTextFilters
Prelude.Read, Int -> DetectTextFilters -> ShowS
[DetectTextFilters] -> ShowS
DetectTextFilters -> String
(Int -> DetectTextFilters -> ShowS)
-> (DetectTextFilters -> String)
-> ([DetectTextFilters] -> ShowS)
-> Show DetectTextFilters
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DetectTextFilters] -> ShowS
$cshowList :: [DetectTextFilters] -> ShowS
show :: DetectTextFilters -> String
$cshow :: DetectTextFilters -> String
showsPrec :: Int -> DetectTextFilters -> ShowS
$cshowsPrec :: Int -> DetectTextFilters -> ShowS
Prelude.Show, (forall x. DetectTextFilters -> Rep DetectTextFilters x)
-> (forall x. Rep DetectTextFilters x -> DetectTextFilters)
-> Generic DetectTextFilters
forall x. Rep DetectTextFilters x -> DetectTextFilters
forall x. DetectTextFilters -> Rep DetectTextFilters x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DetectTextFilters x -> DetectTextFilters
$cfrom :: forall x. DetectTextFilters -> Rep DetectTextFilters x
Prelude.Generic)

-- |
-- Create a value of 'DetectTextFilters' 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', 'detectTextFilters_regionsOfInterest' - A Filter focusing on a certain area of the image. Uses a @BoundingBox@
-- object to set the region of the image.
--
-- 'wordFilter', 'detectTextFilters_wordFilter' - Undocumented member.
newDetectTextFilters ::
  DetectTextFilters
newDetectTextFilters :: DetectTextFilters
newDetectTextFilters =
  DetectTextFilters' :: Maybe [RegionOfInterest]
-> Maybe DetectionFilter -> DetectTextFilters
DetectTextFilters'
    { $sel:regionsOfInterest:DetectTextFilters' :: Maybe [RegionOfInterest]
regionsOfInterest =
        Maybe [RegionOfInterest]
forall a. Maybe a
Prelude.Nothing,
      $sel:wordFilter:DetectTextFilters' :: Maybe DetectionFilter
wordFilter = Maybe DetectionFilter
forall a. Maybe a
Prelude.Nothing
    }

-- | A Filter focusing on a certain area of the image. Uses a @BoundingBox@
-- object to set the region of the image.
detectTextFilters_regionsOfInterest :: Lens.Lens' DetectTextFilters (Prelude.Maybe [RegionOfInterest])
detectTextFilters_regionsOfInterest :: (Maybe [RegionOfInterest] -> f (Maybe [RegionOfInterest]))
-> DetectTextFilters -> f DetectTextFilters
detectTextFilters_regionsOfInterest = (DetectTextFilters -> Maybe [RegionOfInterest])
-> (DetectTextFilters
    -> Maybe [RegionOfInterest] -> DetectTextFilters)
-> Lens
     DetectTextFilters
     DetectTextFilters
     (Maybe [RegionOfInterest])
     (Maybe [RegionOfInterest])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DetectTextFilters' {Maybe [RegionOfInterest]
regionsOfInterest :: Maybe [RegionOfInterest]
$sel:regionsOfInterest:DetectTextFilters' :: DetectTextFilters -> Maybe [RegionOfInterest]
regionsOfInterest} -> Maybe [RegionOfInterest]
regionsOfInterest) (\s :: DetectTextFilters
s@DetectTextFilters' {} Maybe [RegionOfInterest]
a -> DetectTextFilters
s {$sel:regionsOfInterest:DetectTextFilters' :: Maybe [RegionOfInterest]
regionsOfInterest = Maybe [RegionOfInterest]
a} :: DetectTextFilters) ((Maybe [RegionOfInterest] -> f (Maybe [RegionOfInterest]))
 -> DetectTextFilters -> f DetectTextFilters)
-> ((Maybe [RegionOfInterest] -> f (Maybe [RegionOfInterest]))
    -> Maybe [RegionOfInterest] -> f (Maybe [RegionOfInterest]))
-> (Maybe [RegionOfInterest] -> f (Maybe [RegionOfInterest]))
-> DetectTextFilters
-> f DetectTextFilters
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

-- | Undocumented member.
detectTextFilters_wordFilter :: Lens.Lens' DetectTextFilters (Prelude.Maybe DetectionFilter)
detectTextFilters_wordFilter :: (Maybe DetectionFilter -> f (Maybe DetectionFilter))
-> DetectTextFilters -> f DetectTextFilters
detectTextFilters_wordFilter = (DetectTextFilters -> Maybe DetectionFilter)
-> (DetectTextFilters
    -> Maybe DetectionFilter -> DetectTextFilters)
-> Lens
     DetectTextFilters
     DetectTextFilters
     (Maybe DetectionFilter)
     (Maybe DetectionFilter)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DetectTextFilters' {Maybe DetectionFilter
wordFilter :: Maybe DetectionFilter
$sel:wordFilter:DetectTextFilters' :: DetectTextFilters -> Maybe DetectionFilter
wordFilter} -> Maybe DetectionFilter
wordFilter) (\s :: DetectTextFilters
s@DetectTextFilters' {} Maybe DetectionFilter
a -> DetectTextFilters
s {$sel:wordFilter:DetectTextFilters' :: Maybe DetectionFilter
wordFilter = Maybe DetectionFilter
a} :: DetectTextFilters)

instance Prelude.Hashable DetectTextFilters

instance Prelude.NFData DetectTextFilters

instance Core.ToJSON DetectTextFilters where
  toJSON :: DetectTextFilters -> Value
toJSON DetectTextFilters' {Maybe [RegionOfInterest]
Maybe DetectionFilter
wordFilter :: Maybe DetectionFilter
regionsOfInterest :: Maybe [RegionOfInterest]
$sel:wordFilter:DetectTextFilters' :: DetectTextFilters -> Maybe DetectionFilter
$sel:regionsOfInterest:DetectTextFilters' :: DetectTextFilters -> 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
          ]
      )