| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Vision.Image.Class
Synopsis
- class Pixel p where
- type PixelChannel p
- class Storable (ImagePixel i) => MaskedImage i where
- type ImagePixel i
- class MaskedImage i => Image i where
- type ImageChannel i = PixelChannel (ImagePixel i)
- class FromFunction i where
- type FromFunctionPixel i
- class (MaskedImage src, MaskedImage res) => FunctorImage src res where
- (!) :: Image i => i -> Point -> ImagePixel i
- (!?) :: MaskedImage i => i -> Point -> Maybe (ImagePixel i)
- nChannels :: (Pixel (ImagePixel i), MaskedImage i) => i -> Int
- pixel :: MaskedImage i => i -> ImagePixel i
Classes
Determines the number of channels and the type of each pixel of the image and how images are represented.
Minimal complete definition
Associated Types
type PixelChannel p #
Methods
pixNChannels :: p -> Int #
Returns the number of channels of the pixel.
Must not consume p (could be undefined).
pixIndex :: p -> Int -> PixelChannel p #
Instances
class Storable (ImagePixel i) => MaskedImage i where #
Provides an abstraction for images which are not defined for each of their
pixels. The interface is similar to Image except that indexing functions
don't always return.
Image origin (ix2 0 0
Minimal complete definition
Associated Types
type ImagePixel i #
Methods
maskedIndex :: i -> Point -> Maybe (ImagePixel i) #
Returns the pixel's value at 'Z :. y, :. x'.
maskedLinearIndex :: i -> Int -> Maybe (ImagePixel i) #
Returns the pixel's value as if the image was a single dimension vector (row-major representation).
values :: i -> Vector (ImagePixel i) #
Returns the non-masked values of the image.
Instances
| Storable p => MaskedImage (DelayedMask p) # | |
Defined in Vision.Image.Type Associated Types type ImagePixel (DelayedMask p) :: * # Methods shape :: DelayedMask p -> Size # maskedIndex :: DelayedMask p -> Point -> Maybe (ImagePixel (DelayedMask p)) # maskedLinearIndex :: DelayedMask p -> Int -> Maybe (ImagePixel (DelayedMask p)) # values :: DelayedMask p -> Vector (ImagePixel (DelayedMask p)) # | |
| Storable p => MaskedImage (Delayed p) # | |
Defined in Vision.Image.Type Associated Types type ImagePixel (Delayed p) :: * # Methods maskedIndex :: Delayed p -> Point -> Maybe (ImagePixel (Delayed p)) # maskedLinearIndex :: Delayed p -> Int -> Maybe (ImagePixel (Delayed p)) # | |
| Storable p => MaskedImage (Manifest p) # | |
Defined in Vision.Image.Type Associated Types type ImagePixel (Manifest p) :: * # Methods maskedIndex :: Manifest p -> Point -> Maybe (ImagePixel (Manifest p)) # maskedLinearIndex :: Manifest p -> Int -> Maybe (ImagePixel (Manifest p)) # | |
class MaskedImage i => Image i where #
Provides an abstraction over the internal representation of an image.
Image origin (ix2 0 0
Minimal complete definition
Methods
index :: i -> Point -> ImagePixel i #
Returns the pixel value at 'Z :. y :. x'.
linearIndex :: i -> Int -> ImagePixel i #
Returns the pixel value as if the image was a single dimension vector (row-major representation).
vector :: i -> Vector (ImagePixel i) #
Returns every pixel values as if the image was a single dimension vector (row-major representation).
Instances
| Storable p => Image (Delayed p) # | |
Defined in Vision.Image.Type Methods index :: Delayed p -> Point -> ImagePixel (Delayed p) # linearIndex :: Delayed p -> Int -> ImagePixel (Delayed p) # | |
| Storable p => Image (Manifest p) # | |
Defined in Vision.Image.Type Methods index :: Manifest p -> Point -> ImagePixel (Manifest p) # linearIndex :: Manifest p -> Int -> ImagePixel (Manifest p) # | |
type ImageChannel i = PixelChannel (ImagePixel i) #
class FromFunction i where #
Provides ways to construct an image from a function.
Minimal complete definition
Associated Types
type FromFunctionPixel i #
Methods
fromFunction :: Size -> (Point -> FromFunctionPixel i) -> i #
Generates an image by calling the given function for each pixel of the constructed image.
fromFunctionLine :: Size -> (Int -> a) -> (a -> Point -> FromFunctionPixel i) -> i #
Generates an image by calling the last function for each pixel of the constructed image.
The first function is called for each line, generating a line invariant value.
This function is faster for some image representations as some recurring computation can be cached.
fromFunctionCol :: Storable b => Size -> (Int -> b) -> (b -> Point -> FromFunctionPixel i) -> i #
Generates an image by calling the last function for each pixel of the constructed image.
The first function is called for each column, generating a column invariant value.
This function *can* be faster for some image representations as some
recurring computations can be cached. However, it may requires a vector
allocation for these values. If the column invariant is cheap to
compute, prefer fromFunction.
Arguments
| :: Storable b | |
| => Size | |
| -> (Int -> a) | Line function |
| -> (Int -> b) | Column function |
| -> (a -> b -> Point -> FromFunctionPixel i) | Pixel function |
| -> i |
Generates an image by calling the last function for each pixel of the constructed image.
The two first functions are called for each line and for each column, respectively, generating common line and column invariant values.
This function is faster for some image representations as some recurring
computation can be cached. However, it may requires a vector
allocation for column values. If the column invariant is cheap to
compute, prefer fromFunctionLine.
Instances
class (MaskedImage src, MaskedImage res) => FunctorImage src res where #
Defines a class for images on which a function can be applied. The class is
different from Functor as there could be some constraints and
transformations the pixel and image types.
Minimal complete definition
Methods
map :: (ImagePixel src -> ImagePixel res) -> src -> res #
Instances
| (MaskedImage src, Storable p) => FunctorImage src (DelayedMask p) # | |
Defined in Vision.Image.Type Methods map :: (ImagePixel src -> ImagePixel (DelayedMask p)) -> src -> DelayedMask p # | |
| (Image src, Storable p) => FunctorImage src (Delayed p) # | |
Defined in Vision.Image.Type Methods map :: (ImagePixel src -> ImagePixel (Delayed p)) -> src -> Delayed p # | |
| (Image src, Storable p) => FunctorImage src (Manifest p) # | |
Defined in Vision.Image.Type Methods map :: (ImagePixel src -> ImagePixel (Manifest p)) -> src -> Manifest p # | |
Functions
(!?) :: MaskedImage i => i -> Point -> Maybe (ImagePixel i) #
Alias of maskedIndex.
nChannels :: (Pixel (ImagePixel i), MaskedImage i) => i -> Int #
Returns the number of channels of an image.
pixel :: MaskedImage i => i -> ImagePixel i #
Returns an undefined instance of a pixel of the image. This is sometime
useful to satisfy the type checker as in a call to pixNChannels :
nChannels img = pixNChannels (pixel img)