imageproc 0.26.0

Image processing operations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! The kernel type for filter operations

/// An borrowed 2D kernel, used to filter images via convolution.
#[derive(Debug, Copy, Clone)]
pub struct Kernel<'a, K>
where
    K: Copy,
{
    pub(crate) data: &'a [K],
    pub(crate) width: u32,
    pub(crate) height: u32,
}

impl<'a, K> Kernel<'a, K>
where
    K: Copy,
{
    /// Construct a kernel from a slice and its dimensions. The input slice is
    /// in row-major order.
    ///
    /// # Panics
    /// 1. If `width == 0 || height == 0`.
    /// 2. If `width * height != data.len() as u32`.
    pub const fn new(data: &'a [K], width: u32, height: u32) -> Kernel<'a, K> {
        assert!(width > 0 && height > 0, "width and height must be non-zero");
        assert!(width * height == data.len() as u32);
        Kernel {
            data,
            width,
            height,
        }
    }

    /// Get the value in the kernel at the given `x` and `y` position.
    ///
    /// # Panics
    ///
    /// If the `y * kernel.width + x` is outside of the kernel data.
    #[inline]
    pub fn get(&self, x: u32, y: u32) -> K {
        debug_assert!(x < self.width);
        debug_assert!(y < self.height);
        let at = usize::try_from(y * self.width + x).unwrap();
        self.data[at]
    }

    /// Get the value in the kernel at the given `x` and `y` position, without
    /// doing bounds checking.
    ///
    /// # Safety
    /// The caller must ensure that `y * self.width + x` is in bounds of the
    /// kernel data.
    #[inline]
    pub unsafe fn get_unchecked(&self, x: u32, y: u32) -> K {
        unsafe {
            debug_assert!(x < self.width);
            debug_assert!(y < self.height);
            let at = usize::try_from(y * self.width + x).unwrap();
            debug_assert!(at < self.data.len());
            *self.data.get_unchecked(at)
        }
    }
}

/// The sobel horizontal 3x3 kernel.
pub const SOBEL_HORIZONTAL_3X3: Kernel<'static, i32> =
    Kernel::new(&[-1, 0, 1, -2, 0, 2, -1, 0, 1], 3, 3);
/// The sobel vertical 3x3 kernel.
pub const SOBEL_VERTICAL_3X3: Kernel<'static, i32> =
    Kernel::new(&[-1, -2, -1, 0, 0, 0, 1, 2, 1], 3, 3);

/// The scharr horizontal 3x3 kernel.
pub const SCHARR_HORIZONTAL_3X3: Kernel<'static, i32> =
    Kernel::new(&[-3, 0, 3, -10, 0, 10, -3, 0, 3], 3, 3);
/// The scharr vertical 3x3 kernel.
pub const SCHARR_VERTICAL_3X3: Kernel<'static, i32> =
    Kernel::new(&[-3, -10, -3, 0, 0, 0, 3, 10, 3], 3, 3);

/// The prewitt horizontal 3x3 kernel.
pub const PREWITT_HORIZONTAL_3X3: Kernel<'static, i32> =
    Kernel::new(&[-1, 0, 1, -1, 0, 1, -1, 0, 1], 3, 3);
/// The prewitt vertical 3x3 kernel.
pub const PREWITT_VERTICAL_3X3: Kernel<'static, i32> =
    Kernel::new(&[-1, -1, -1, 0, 0, 0, 1, 1, 1], 3, 3);

/// The roberts horizontal 3x3 kernel.
pub const ROBERTS_HORIZONTAL_2X2: Kernel<'static, i32> = Kernel::new(&[1, 0, 0, -1], 2, 2);
/// The roberts vertical 3x3 kernel.
pub const ROBERTS_VERTICAL_2X2: Kernel<'static, i32> = Kernel::new(&[0, 1, -1, -0], 2, 2);

/// The laplacian 3x3 kernel.
pub const LAPLACIAN_3X3: Kernel<'static, i16> = Kernel::new(&[0, 1, 0, 1, -4, 1, 0, 1, 0], 3, 3);