Struct scarlet::colormap::GradientColorMap

pub struct GradientColorMap<T: ColorPoint> {
    pub start: T,
    pub end: T,
    pub normalization: NormalizeMapping,
    pub padding: (f64, f64),
}

A gradient colormap: a continuous, evenly-spaced shift between two colors A and B such that 0 maps to A, 1 maps to B, and any number in between maps to a weighted mix of them in a given coordinate space. Uses the gradient functions in the ColorPoint trait to complete this. Out-of-range values are simply clamped to the correct range: calling this on negative numbers will return A, and calling this on numbers larger than 1 will return B.

Fields

start: T

The start of the gradient. Calling this colormap on 0 or any negative number returns this color.

end: T

The end of the gradient. Calling this colormap on 1 or any larger number returns this color.

normalization: NormalizeMapping

Any additional added nonlinearity imposed on the gradient: for example, a cube root mapping emphasizes differences in the low end of the range.

padding: (f64, f64)

Any desired padding: offsets introduced that artificially shift the limits of the range. Expressed as (new_min, new_max), where both are floats and new_min < new_max. For example, having padding of (1/8, 1) would remove the lower eighth of the color map while keeping the overall map smooth and continuous. Padding of (0., 1.) is the default and normal behavior.

Implementations

impl<T: ColorPoint> GradientColorMap<T>

pub fn new_linear(start: T, end: T) -> GradientColorMap<T>

Constructs a new linear GradientColorMap, without padding, from two colors.

pub fn new_cbrt(start: T, end: T) -> GradientColorMap<T>

Constructs a new cube root GradientColorMap, without padding, from two colors.

Trait Implementations

impl<T: Clone + ColorPoint> Clone for GradientColorMap<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ColorPoint> ColorMap<T> for GradientColorMap<T>

fn transform_single(&self, x: f64) -> T

Maps a given number between 0 and 1 to a given output Color. This should never fail or panic except for NaN and similar: there should be some Color that marks out-of-range data.

fn transform<U: IntoIterator<Item = f64>>(&self, inputs: U) -> Vec<T>

Maps a given collection of numbers between 0 and 1 to an iterator of Colors. Does not evaluate lazily, because the colormap could have some sort of state that changes between iterations otherwise.

impl<T: Debug + ColorPoint> Debug for GradientColorMap<T>

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

Formats the value using the given formatter.