Merge branch 'develop'

Author: xd009642

Cargo.toml

@@ -2,7 +2,7 @@
 name = "ndarray-vision"
 version = "0.1.0"
 authors = ["xd009642 <danielmckenna93@gmail.com>"]
-description = "A computer vision library built ontop of ndarray"
+description = "A computer vision library built on top of ndarray"
 repository = "https://github.com/xd009642/ndarray-vision"
 readme = "README.md"
 license = "MIT/Apache-2.0"
@@ -12,4 +12,9 @@ edition = "2018"
 
 [dependencies]
 ndarray = "0.12"
+ndarray-stats = "0.1"
 num-traits = "0.2"
+
+[dev-dependencies]
+ndarray-rand = "0.9.0"
+rand = "0.6.5"

README.md

@@ -1,11 +1,21 @@
 # ndarray-vision
 
+[![Build Status](https://travis-ci.org/xd009642/ndarray-vision.svg?branch=master)](https://travis-ci.org/xd009642/ndarray-vision)
+[![License:MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Coverage Status](https://coveralls.io/repos/github/xd009642/ndarray-vision/badge.svg?branch=master)](https://coveralls.io/github/xd009642/ndarray-vision?branch=master)
+
 This project is a computer vision library built on top of ndarray. This project
-is a work in progress. It is possible to load an image apply filters and save
-it back, however it is currently largely non-functional.
+is a work in progress. Basic image encoding/decoding and processing are
+currently implemented.
+
+See the examples and tests for basic usage.
 
 # Features
 
-* RGB and HSV conversions
-* Image convolutions and some filters (box linear, gaussian)
+* Conversions between Grayscale, RGB, HSV and CIEXYZ
+* Image convolutions and common kernels (box linear, gaussian, laplace)
+* Median filtering
+* Sobel operator
+* Canny Edge Detection
+* Histogram Equalisation
 * Encoding and decoding PPM (binary or plaintext)

examples/basic.rs

@@ -23,9 +23,10 @@ fn main() {
 
         let mut image: Image<f64, _> = image.into_type();
 
-        let _ = image.conv2d_inplace(boxkern.view()).expect("Poorly sized kernel");
+        let _ = image
+            .conv2d_inplace(boxkern.view())
+            .expect("Poorly sized kernel");
         // There's no u8: From<f64> so I've done this to hack things
-        image.data *= 255.0f64;
 
         let mut lena = PathBuf::from(&root);
         lena.push("images/lenablur.ppm");

examples/edges.rs

@@ -0,0 +1,50 @@
+use ndarray_vision::core::*;
+use ndarray_vision::format::netpbm::*;
+use ndarray_vision::format::*;
+use ndarray_vision::processing::*;
+use std::env::current_exe;
+use std::path::PathBuf;
+
+fn canny_edges(img: &Image<f64, Gray>) -> Image<f64, Gray> {
+    let x = CannyBuilder::<f64>::new()
+        .lower_threshold(0.3)
+        .upper_threshold(0.5)
+        .blur((5, 5), [0.4, 0.4])
+        .build();
+    let res = img.canny_edge_detector(x).expect("Failed to run canny");
+
+    Image::from_data(res.data.mapv(|x| if x { 1.0 } else { 0.0 }))
+}
+
+fn main() {
+    if let Ok(mut root) = current_exe() {
+        root.pop();
+        root.pop();
+        root.pop();
+        root.pop();
+        let mut lena = PathBuf::from(&root);
+        lena.push("images/lena.ppm");
+
+        let decoder = PpmDecoder::default();
+        let image: Image<u8, _> = decoder.decode_file(lena).expect("Couldn't open Lena.ppm");
+
+        let image: Image<f64, _> = image.into_type();
+        let image: Image<_, Gray> = image.into();
+
+        let canny = canny_edges(&image);
+
+        let image = image.apply_sobel().expect("Error in sobel");
+        // back to RGB
+        let image: Image<_, RGB> = image.into();
+        let mut lena = PathBuf::from(&root);
+        lena.push("images/lena-sobel.ppm");
+
+        let ppm = PpmEncoder::new_plaintext_encoder();
+        ppm.encode_file(&image, lena).expect("Unable to encode ppm");
+
+        let mut lena = PathBuf::from(&root);
+        lena.push("images/lena-canny.ppm");
+        ppm.encode_file(&canny.into(), lena)
+            .expect("Unable to encode ppm");
+    }
+}