package bimage

  1. Overview
  2. Docs

Module BimageSource

Image processing library

v0.3.0 — homepage

Sourcemodule type TYPE = Type.TYPE
Sourcemodule type COLOR = Color.COLOR
Sourcemodule type FILTER = Filter.FILTER
Sourceexception Unsupported

Raised when attempting to use Bigarray types other than u8, u16, f32, f64, i32, i64

Sourcemodule Error : sig ... end
Sourcemodule Angle : sig ... end

The Angle type is used instead of a float whenever a function expects an angle argument to avoid ambiguity

Sourcemodule Point : sig ... end

Point is a 2 element float tuple used to perform calculations on (x, y) coordinates

Sourcemodule Color : sig ... end

Color contains methods for creating and inspecting color types

Sourcetype gray = Color.Gray.t

1-channels gray color type

3-channel RGB color type

Sourcetype xyz = [
  1. | `Xyz
]

3-channel XYZ color type

Sourcetype yuv = [
  1. | `Yuv
]

3-channel YUV color type

Sourcetype rgba = Color.Rgba.t

4-channel RGBA image

Sourceval gray : [ `Gray ] Color.t

Gray color

Sourceval rgb : [ `Rgb ] Color.t

RGB color

Sourceval xyz : xyz Color.t

XYZ color

Sourceval yuv : yuv Color.t

YUV color

Sourceval rgba : [ `Rgba ] Color.t

RGBA color

Sourcemodule Type : sig ... end
Sourceval u8 : (int, u8) Type.t
Sourceval u16 : (int, u16) Type.t
Sourceval i32 : (int32, i32) Type.t
Sourceval i64 : (int64, i64) Type.t
Sourceval f32 : (float, f32) Type.t
Sourceval f64 : (float, f64) Type.t
Sourcemodule Data : sig ... end

Data provides some extra operations for Bigarray.Array1

Sourcemodule Pixel : sig ... end

Pixel defines operations on individual pixels, which are stored as floatarray

Sourcemodule Image : sig ... end

Image defines an image type and functions that manipulate images directly

Sourcetype 'c image_u8 = (int, u8, 'c) Image.t
Sourcetype 'c image_u16 = (int, u16, 'c) Image.t
Sourcetype 'c image_i32 = (int32, i32, 'c) Image.t
Sourcetype 'c image_i64 = (int64, i64, 'c) Image.t
Sourcetype 'c image_f32 = (float, f32, 'c) Image.t
Sourcetype 'c image_f64 = (float, f64, 'c) Image.t
Sourcemodule Kernel : sig ... end

Convolution kernels

Sourcemodule Transform : sig ... end
Sourcemodule Input : sig ... end

Input contains methods for working with Expr/Filter inputs

Sourcemodule Expr : sig ... end

Expr define a combinator which can be used to build filters

Sourcemodule Filter : sig ... end

Filter contains functions that can be used to execute expressions

Sourcetype ('a, 'b, 'c) filter = output:('a, 'b, 'c) Image.t -> Input.t -> unit
Sourcemodule Hash : sig ... end

Perceptual hashing