Vision.Image.Mutable

Documentation

class Image (Freezed i) => MutableImage i where

Class for images which can be constructed from a mutable image.

Minimal complete definition

mShape, new, new', (read | linearRead), (write | linearWrite), freeze, thaw

Associated Types

type Freezed i

The type of the immutable version of the mutable image i.

Methods

mShape :: i s -> Size

mShape doesn't run in a monad as the size of a mutable image is constant.

new :: PrimMonad m => Size -> m (i (PrimState m))

Creates a new mutable image of the given size. Pixels are initialized with an unknown value.

new' :: PrimMonad m => Size -> ImagePixel (Freezed i) -> m (i (PrimState m))

Creates a new mutable image of the given size and fill it with the given value.

read :: PrimMonad m => i (PrimState m) -> DIM2 -> m (ImagePixel (Freezed i))

Returns the pixel value at Z :. y :. x.

linearRead :: PrimMonad m => i (PrimState m) -> Int -> m (ImagePixel (Freezed i))

Returns the pixel value as if the image was a single dimension vector (row-major representation).

write :: PrimMonad m => i (PrimState m) -> DIM2 -> ImagePixel (Freezed i) -> m ()

Overrides the value of the pixel at Z :. y :. x.

linearWrite :: PrimMonad m => i (PrimState m) -> Int -> ImagePixel (Freezed i) -> m ()

Overrides the value of the pixel at the given index as if the image was a single dimension vector (row-major representation).

freeze :: PrimMonad m => i (PrimState m) -> m (Freezed i)

Returns an immutable copy of the mutable image.

unsafeFreeze :: PrimMonad m => i (PrimState m) -> m (Freezed i)

Returns the immutable version of the mutable image. The mutable image should not be modified thereafter.

thaw :: PrimMonad m => Freezed i -> m (i (PrimState m))

Returns a mutable copy of the immutable image.

Instances

(Pixel p, Storable p) => MutableImage (MutableManifest p)

create :: MutableImage i => (forall s. ST s (i s)) -> Freezed i

Creates an immutable image from an ST action creating a mutable image.

data Storable p => MutableManifest p s

Constructors

MutableManifest

Fields

mmSize :: !Size

mmVector :: !(MVector s p)

Instances

(Pixel p, Storable p) => MutableImage (MutableManifest p)

type Freezed (MutableManifest p) = Manifest p