Struct UniqueColorCounts

pub struct UniqueColorCounts<Color, Component, const N: usize>
where
    Color: ColorComponents<Component, N>,
{ /* private fields */ }

Deduplicated colors and their frequency counts.

Currently, only colors that implement ColorComponents<u8, 3> are supported.

Implementations

impl<Color, Component, const N: usize> UniqueColorCounts<Color, Component, N>

where Color: ColorComponents<Component, N>,

pub fn colors(&self) -> &[Color]

Returns the slice of unique colors.

pub fn counts(&self) -> &[u32]

Returns a slice for the number of times each unique color was present in the original color slice/image.

pub fn total_count(&self) -> u32

Returns the number of original pixels/colors.

This is equal to the sum of UniqueColorCounts::counts.

pub fn num_colors(&self) -> u32

Returns the number of unique colors.

pub fn new<InputColor>( pixels: ColorSlice<'_, InputColor>, convert_color: impl Fn(InputColor) -> Color, ) -> Self

where InputColor: ColorComponents<u8, 3>,

Creates a new UniqueColorCounts from a ColorSlice.

The convert_color function can be used to convert the color space of the resulting colors. Use the identity function (i.e., |color| color) to skip color space conversion.

pub fn try_from_rgbimage( image: &RgbImage, convert_color: impl Fn(Srgb<u8>) -> Color, ) -> Result<Self, AboveMaxLen<u32>>

Tries to create a new UniqueColorCounts from a RgbImage.

The convert_color function can be used to convert the color space of the resulting colors. Use the identity function (i.e., |srgb| srgb) to skip color space conversion.

Errors

Return an error if the number of pixels in the image are above MAX_PIXELS.

impl<Color, Component, const N: usize> UniqueColorCounts<Color, Component, N>

where Color: ColorComponents<Component, N> + Send,

pub fn new_par<InputColor>( pixels: ColorSlice<'_, InputColor>, convert_color: impl Fn(InputColor) -> Color + Sync, ) -> Self

where InputColor: ColorComponents<u8, 3> + Sync,

Creates a new UniqueColorCounts in parallel from a ColorSlice.

The convert_color function can be used to convert the color space of the resulting colors. Use the identity function (i.e., |color| color) to skip color space conversion.

pub fn try_from_rgbimage_par( image: &RgbImage, convert_color: impl Fn(Srgb<u8>) -> Color + Sync, ) -> Result<Self, AboveMaxLen<u32>>

Tries to create a new UniqueColorCounts in parallel from a RgbImage.

The convert_color function can be used to convert the color space of the resulting colors. Use the identity function (i.e., |srgb| srgb) to skip color space conversion.

Errors

Return an error if the number of pixels in the image are above MAX_PIXELS.

Trait Implementations

impl<Color, Component: Clone, const N: usize> Clone for UniqueColorCounts<Color, Component, N>

where Color: ColorComponents<Component, N> + Clone,

fn clone(&self) -> UniqueColorCounts<Color, Component, N>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Color, Component, const N: usize> ColorCounts<Color, Component, N> for UniqueColorCounts<Color, Component, N>

where Color: ColorComponents<Component, N>,

fn colors(&self) -> &[Color]

The slice of colors to quantize.

fn counts(&self) -> Option<&[u32]>

The number of pixels corresponding to each Color in the slice returned by colors.

fn indices(&self) -> Option<&[u32]>

A slice of indices into the color slice returned by colors. This is used to retain the original color slice/image after deduplication.

fn total_count(&self) -> u32

The total number of pixels/colors in the (original) color slice.

fn color_components(&self) -> &[[Component; N]]

The slice returned by colors casted to a slice of component arrays.

fn num_colors(&self) -> u32

The length of the slice returned by colors as a u32.

fn len(&self) -> usize

The length of the slice returned by colors.

fn is_empty(&self) -> bool

Whether or not the slice returned by colors is empty.

impl<Color, Component: Debug, const N: usize> Debug for UniqueColorCounts<Color, Component, N>

where Color: ColorComponents<Component, N> + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Color, Component, const N: usize> Default for UniqueColorCounts<Color, Component, N>

where Color: ColorComponents<Component, N>,

fn default() -> Self

Returns the “default value” for a type.

impl<Color, Component: PartialEq, const N: usize> PartialEq for UniqueColorCounts<Color, Component, N>

where Color: ColorComponents<Component, N> + PartialEq,

fn eq(&self, other: &UniqueColorCounts<Color, Component, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Color, Component: Eq, const N: usize> Eq for UniqueColorCounts<Color, Component, N>

where Color: ColorComponents<Component, N> + Eq,

impl<Color, Component, const N: usize> StructuralPartialEq for UniqueColorCounts<Color, Component, N>

where Color: ColorComponents<Component, N>,