Adding `lutz` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add lutz

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

lutz = "1.4.1"

The lutz library will be automatically available globally. Read the lutz library documentation.

Back to the crate overview.

Readme

Lutz

This is a Rust implementation of "An Algorithm for the Real Time Analysis of Digitised Images" by R. K. Lutz.

It's a single-pass algorithm for connected-component labeling that allows to find 8-connected objects in a binary (monochrome) image.

Usage

Crate expects the user to implement its lutz::Image trait. A possible implementation for a struct wrapping an image::GrayImage type:

struct Image {
    img: image::GrayImage,
    threshold: u8,
}

impl lutz::Image for Image {
    fn width(&self) -> u32 {
        self.img.width()
    }

    fn height(&self) -> u32 {
        self.img.height()
    }

    fn has_pixel(&self, x: u32, y: u32) -> bool {
        self.img.get_pixel(x, y).0[0] > self.threshold
    }
}

Once constructed, a reference to such image should be passed to the lutz function. It will return an iterator over detected objects, each represented as a Vec<Pixel> of its pixel coordinates:

for obj_pixels in lutz::lutz(&img) {
    println!("{:?}", obj_pixels);
}

Adding lutz library as a dependency

Adding `lutz` library as a dependency