-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Blockhash perceptual image hash algorithm
--   
--   This is a perceptual image hash calculation tool based on algorithm
--   descibed in Block Mean Value Based Image Perceptual Hashing by Bian
--   Yang, Fan Gu and Xiamu Niu.
@package blockhash
@version 0.1.0.0


-- | Perceptual image hash calculation tool based on algorithm descibed in
--   Block Mean Value Based Image Perceptual Hashing by Bian Yang, Fan Gu
--   and Xiamu Niu.
module Data.Blockhash
data Image
Image :: Int -> Int -> Vector Word8 -> Image
[imageWidth] :: Image -> Int
[imageHeight] :: Image -> Int
[imagePixels] :: Image -> Vector Word8
newtype Hash
Hash :: Vector Char -> Hash
[unHash] :: Hash -> Vector Char

-- | Calculate the hamming distance for two hashes in hex format
hammingDistance :: Hash -> Hash -> Int

-- | Calculate perceptual hash for an RGBA image
blockhash :: Image -> Int -> Method -> Hash
data Method

-- | Precise method puts weighted pixel values to blocks according to pixel
--   area falling within a given block and provides more accurate results
--   in case width and height are not divisible by the number of bits.
Precise :: Method

-- | Quick method uses rounded block sizes and is less accurate in case
--   image width and height are not divisible by the number of bits.
Quick :: Method
instance GHC.Enum.Bounded Data.Blockhash.Method
instance GHC.Enum.Enum Data.Blockhash.Method
instance GHC.Show.Show Data.Blockhash.Method
instance GHC.Classes.Eq Data.Blockhash.Method
instance GHC.Show.Show Data.Blockhash.Image
instance GHC.Show.Show Data.Blockhash.Hash