rimg 0.1.0

RImg aims to be a Rust implementation of CImg, the C++ Image Template Image Processing Toolkit
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

pub struct Img<T> {
    width: usize,
    heigth: usize,
    depth: usize,
    spectrum: usize,
    data: Vec<T>,
}

impl<T: Copy> Img<T> {
    /// Creates a new Image instance
    /// 
    /// ## Examples
    /// 
    /// ```
    /// # use rimg::Img;
    /// // creates a 256x256 sized RGB image filled in black
    /// let _img = Img::new(256, 256, 1, 3, 0);
    /// ```
    pub fn new(width: usize, heigth: usize, depth: usize, spectrum: usize, value: T) -> Img<T> {
        let data_size = width * heigth * depth * spectrum;
        let mut data: Vec<T> = Vec::with_capacity(data_size);
        for _i in 0..data_size {
            data.push(value);
        }
        Img::<T> {
            width,
            heigth,
            depth,
            spectrum,
            data
        }
    }

    /// Returns the image heigth.
    /// 
    /// ## Examples
    /// 
    /// ```
    /// # use rimg::Img;
    /// # let img = Img::new(256, 256, 1, 3, 0);
    /// assert_eq!(256, img.heigth());
    /// ```
    pub fn heigth(&self) -> usize {
        self.heigth
    }

    /// Returns the image width.
    /// 
    /// ## Examples
    /// 
    /// ```
    /// # use rimg::Img;
    /// # let img = Img::new(256, 256, 1, 3, 0);
    /// assert_eq!(256, img.width());
    /// ```
    pub fn width(&self) -> usize {
        self.width
    }

    /// Returns the image depth.
    /// 
    /// ## Examples
    /// 
    /// ```
    /// # use rimg::Img;
    /// # let img = Img::new(256, 256, 1, 3, 0);
    /// assert_eq!(1, img.depth());
    /// ```
    pub fn depth(&self) -> usize {
        self.depth
    }

    /// Returns the image spectrum.
    /// 
    /// ## Examples
    /// 
    /// ```
    /// # use rimg::Img;
    /// # let img = Img::new(256, 256, 1, 3, 0);
    /// assert_eq!(3, img.spectrum());
    /// ```
    pub fn spectrum(&self) -> usize {
        self.spectrum
    }
}

#[cfg(test)]
mod tests {
    use crate::Img;

    fn create_img() -> Img<u8> {
        Img::new(128, 256, 1, 3, 0)
    }

    #[test]
    fn test_width() {
        let img = create_img();
        assert_eq!(128, img.width());
    }

    #[test]
    fn test_heigth() {
        let img = create_img();
        assert_eq!(256, img.heigth());
    }

    #[test]
    fn test_depth() {
        let img = create_img();
        assert_eq!(1, img.depth());
    }

    #[test]
    fn test_spectrum() {
        let img = create_img();
        assert_eq!(3, img.spectrum());
    }
}