Struct rscolorq::Params

pub struct Params<T: SpatialQuant> { /* fields omitted */ }

Input parameter struct for spatial color quantization and simulated annealing. The parameters can be validated with verify_parameters before quantization.

If a palette is supplied to the struct, the dithering will be performed with fixed colors and will override the palette_size field.

Implementations

impl<T: SpatialQuant> Params<T>

pub fn new() -> Self

Crate a new input parameter struct.

pub fn initial_temp(&mut self, initial_temp: f64) -> &mut Self

Set the initial temperature. This must be greater than 0 and greater than the final temperature.

pub fn final_temp(&mut self, final_temp: f64) -> &mut Self

Set the final temperature. This value must be greater than 0 and less than the initial temperature.

pub fn palette_size(&mut self, palette_size: u8) -> &mut Self

Set the desired palette size. This parameter must be greater than 2.

pub fn iters_per_level(&mut self, iters_per_level: usize) -> &mut Self

Set the iterations per level. This parameter must be greater than 0.

pub fn repeats_per_temp(&mut self, repeats_per_temp: usize) -> &mut Self

Set the amount of repeats per temperature. This parameter must be greater than 0.

pub fn seed(&mut self, seed: Option<u64>) -> &mut Self

Set the random number generator seed.

pub fn filter_size(&mut self, filter_size: FilterSize) -> &mut Self

Set the filter size for quantization. The default is 3.

pub fn dithering_level(&mut self, dithering_level: f64) -> &mut Self

Set the dithering level manually, default is 0.8. The range should be between roughly 0.5 and 1.5, higher numbers will result in higher frequency noise.

Dithering level must be greater than 0.

pub fn dithering_level_auto(
    &mut self,
    width: u32,
    height: u32,
    palette_size: usize
) -> &mut Self

Calculate and set the dithering level automatically based on image size and palette size.

Dithering level must be greater than 0.

pub fn palette(&mut self, palette: Vec<T>) -> Result<&mut Self, QuantError>

Supply the palette colors to use for dithering. Length must be at least two.

pub fn verify_parameters(&self) -> Result<(), QuantError>

Returns an error if any of the parameters are incorrectly set.

Trait Implementations

impl<T: Clone + SpatialQuant> Clone for Params<T>

fn clone(&self) -> Params<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + SpatialQuant> Debug for Params<T>

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

Formats the value using the given formatter.

impl<T: SpatialQuant> Default for Params<T>

fn default() -> Self

Returns the “default value” for a type.