edge_detection/lib.rs
1#![cfg_attr(all(test, feature = "unstable"), feature(test))]
2#![warn(missing_docs)]
3
4//! An implementation of the Canny edge detection algorithm in Rust. The base for
5//! many computer vision applications.
6//!
7//! # Finding the edges in an image
8//!
9//! ```
10//! let source_image = image::open("testdata/line-simple.png")
11//! .expect("failed to read image")
12//! .to_luma8();
13//! let detection = edge_detection::canny(
14//! source_image,
15//! 1.2, // sigma
16//! 0.2, // strong threshold
17//! 0.01, // weak threshold
18//! );
19//! ```
20//!
21//! See the `canny` function for details on what each parameter means.
22
23mod edge;
24
25pub use crate::edge::*;