Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zshipko/ocaml-bimage
Composable image processing library for OCaml
https://github.com/zshipko/ocaml-bimage
Last synced: 24 days ago
JSON representation
Composable image processing library for OCaml
- Host: GitHub
- URL: https://github.com/zshipko/ocaml-bimage
- Owner: zshipko
- License: isc
- Created: 2018-07-04T05:55:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T21:03:47.000Z (2 months ago)
- Last Synced: 2024-10-14T01:41:59.720Z (about 1 month ago)
- Language: C++
- Homepage:
- Size: 31.9 MB
- Stars: 38
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.md
Awesome Lists containing this project
README
bimage — Image processing library
-------------------------------------------------------------------------------
%%VERSION%%
bimage is an image processing library for OCaml.
## Features
- Simple image type based on bigarrays
- Supports u8, u16, i32, i64, f32, f64 datatypes
- Composable image operations
- Image I/O using OpenImageIO (`bimage-io`)
- Image I/O using ImageMagick/GraphicsMagick and stb_image (`bimage-unix`)
- GLFW window support (`bimage-display`)
bimage is distributed under the ISC license.
Homepage: https://github.com/zshipko/ocaml-bimage
## Installation
bimage can be installed with `opam`:
```
$ opam install bimage
```
bimage-io can be installed by running:
```
$ opam install bimage-io
```
Additionally, `bimage-unix`, which provides `stb-image` and `ImageMagick` bindings, can be installed by running:
```
$ opam install bimage-unix
```
If you don't use `opam` consult the [`opam`](opam) file for build
instructions.
## Getting started
- `Type.t`: Defines the type of an image: `u8`, `u16`, `f32`, `f64`, `i32` or `i64`
- `Color.t`: Defines the color of an image: `gray`, `rgb`, `rgba`, `xyz` and `yuv`
* It's possible to extend the color type by implementing [COLOR](https://github.com/zshipko/ocaml-bimage/blob/master/src/color.ml)
- `Image.t`: Image type
- `Kernel.t`: Convolution kernels
- `Transform.t`: Image transformations
- `Expr.t`: Expression combinator
* Building blocks for image processing filters
- `Filter.t`: Executable image filter
* Makes `Expr.t` executable
There is a corresponding file for each of these types in [src/](https://github.com/zshipko/ocaml-bimage/tree/master/src).
## Examples
See [examples/](https://github.com/zshipko/ocaml-bimage/tree/master/examples) for usage examples
## Documentation
The documentation and API reference is generated from the source
interfaces. It can be consulted [online][doc] or via `odig doc
bimage`.
[doc]: https://zshipko.github.io/ocaml-bimage/
## Tests
In the distribution sample programs and tests are located in the
[`test`](test) directory. They can be built and run
with:
dune runtest