auto-palette 0.9.0

🎨 A Rust library that extracts prominent color palettes from images automatically.
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

use crate::{
    image::{segmentation::label::LabelImage, Pixel},
    math::FloatNumber,
};

/// Trait for segmentation algorithms.
///
/// Implementations receive image `pixels` and split them into a requested
/// number of coherent segments.
///
/// # Type Parameters
/// * `T` - The floating point type.
pub trait Segmentation<T>
where
    T: FloatNumber,
{
    /// Error type for the segmentation algorithm.
    type Err;

    /// Splits the given image into segments.
    ///
    /// # Arguments
    /// * `width` - The width of the image.
    /// * `height` - The height of the image.
    /// * `pixels` - The pixels of the image.
    ///
    /// # Returns
    /// A `LabelImage` containing the segmented image, or an error if segmentation fails.
    #[allow(dead_code)]
    fn segment(
        &self,
        width: usize,
        height: usize,
        pixels: &[Pixel<T>],
    ) -> Result<LabelImage<T>, Self::Err> {
        let mask = vec![true; width * height];
        self.segment_with_mask(width, height, pixels, &mask)
    }

    /// Splits the given image into segments with a mask.
    ///
    /// # Arguments
    /// * `width` - The width of the image.
    /// * `height` - The height of the image.
    /// * `pixels` - The pixels of the image.
    /// * `mask` - The mask to apply to the pixels.
    ///
    /// # Returns
    /// A `LabelImage` containing the segmented image, or an error if segmentation fails.
    fn segment_with_mask(
        &self,
        width: usize,
        height: usize,
        pixels: &[Pixel<T>],
        mask: &[bool],
    ) -> Result<LabelImage<T>, Self::Err>;
}