https://github.com/image-rs/imageproc

Image processing operations
https://github.com/image-rs/imageproc

image-processing imageproc rust-library

Last synced: about 14 hours ago
JSON representation

Image processing operations

• Host: GitHub
• URL: https://github.com/image-rs/imageproc
• Owner: image-rs
• License: mit
• Created: 2015-09-27T18:11:32.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T12:38:22.000Z (8 months ago)
• Last Synced: 2024-04-14T02:36:28.347Z (8 months ago)
• Topics: image-processing, imageproc, rust-library
• Language: Rust
• Size: 4.04 MB
• Stars: 685
• Watchers: 56
• Forks: 136
• Open Issues: 80
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-rust-cn - image-rs/imageproc - ci.org/image-rs/imageproc.svg?branch=master)](https://travis-ci.org/image-rs/imageproc) (Libraries / Image processing)
• awesome-rust - image-rs/imageproc - ci.org/image-rs/imageproc.svg?branch=master)](https://travis-ci.org/image-rs/imageproc) (Libraries / Image processing)
• awesome-rust - image-rs/imageproc
• awesome-rust-cn - image-rs/imageproc
• awesome-rust-zh - image-rs/imageproc - 一个图像处理库，基于`image` 库。[](https://travis-ci.org/image-rs/imageproc) (库 / 图像处理)
• awesome-rust-list - image-rs/imageproc - rs/imageproc?style=social"/> : An image processing library, based on the [image](https://github.com/image-rs/image) library. (Image and Video Processing)
• awesome-rust-list - image-rs/imageproc - rs/imageproc?style=social"/> : An image processing library, based on the [image](https://github.com/image-rs/image) library. (Image and Video Processing)

README

        
# imageproc

[![crates.io](https://img.shields.io/crates/v/imageproc.svg)](https://crates.io/crates/imageproc)

[![doc-badge]][doc-link]

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/image-rs/imageproc/blob/master/LICENSE)

[![Dependency status](https://deps.rs/repo/github/image-rs/imageproc/status.svg)](https://deps.rs/repo/github/image-rs/imageproc)

An image processing library, based on the

[`image`](https://github.com/image-rs/image) library.

[API documentation][doc-link]

[doc-badge]: https://docs.rs/imageproc/badge.svg

[doc-link]: https://docs.rs/imageproc

## Goals

A performant, well-tested, well-documented library with a consistent API, suitable for use as

the basis of computer vision applications or graphics editors.

## Non-goals

Maximum genericity over image storages or formats, or support for higher-dimensional images.

## Color Space

Functions in this library implicitly assume that pixels colors are

stored in a linear color space like `RGB` as opposed to a non-linear color

space such as `sRGB`.

If you are not familiar with gamma correction then [this article] contains

an introduction and examples of color artefacts resulting

from not using linear color spaces.

[this article]: https://blog.johnnovak.net/2016/09/21/what-every-coder-should-know-about-gamma/

## Parallelism

This library provides both single-threaded and multi-threaded variations of several functions

by using [rayon](https://github.com/rayon-rs/rayon).

Depending on image size and the amount of work performed per pixel the parallel versions may not

always be faster - we recommend benchmarking for your specific use-case.

## Crate Features

### Default Features

- `rayon`: enables multi-threaded versions of several functions

### Optional Features

- `katexit`: enables latex in documentation via

  [katexit](https://github.com/termoshtt/katexit)

- `display-window`: enables `sdl2`

- `sdl2`: enables the displaying of images (using `imageproc::window`) with

  [sdl2](https://github.com/Rust-SDL2/rust-sdl2)

## How to contribute

See [CONTRIBUTING.md](CONTRIBUTING.md).