Struct sampling::heatmap::CubeHelixParameter

pub struct CubeHelixParameter { /* private fields */ }

Implements color palett from https://arxiv.org/abs/1108.5083

What’s so good about this palett? It is monotonically increasing in perceived brightness. That means, it is well suited for being printed in black and white.

use sampling::heatmap::*;
let mut params = CubeHelixParameter::default();
params.rotation(1.3)
        .gamma(1.1)
        .start_color(0.3)
        .reverse(true);

Implementations

impl CubeHelixParameter

pub fn start_color(&mut self, s: f32) -> &mut Self

Builder pattern - set start color

Will panic if the following is false: 0.0 <= s <= 1.0

pub fn gamma(&mut self, gamma: f32) -> &mut Self

Builder pattern - set gamma

|gamma| < 1 emphasises low intensity values, |gamma| > 1 high intensity ones

gamma has to be finite - will panic otherwise

pub fn reverse(&mut self, reverse: bool) -> &mut Self

Builder pattern - set reverse

reverse: Reverse the cbrange?

pub fn low_high(&mut self, low: f32, high: f32) -> &mut Self

Builder pattern - set low and high value

default: low = 0.0, high = 1.0

Maps grayscale range from [0.0, 1.0] -> [low, high]. These are the brightness values used for calculating the palette later on.

Safety

will panic if

• low >= high
• low < 0
• low >= 1
• high <= 0
• high > 1

pub fn hue(&mut self, hue: f32) -> &mut Self

#Set hue intensity. Builder pattern Valid values are 0.0 <= hue <= 1.0. Important Will panic on invalid hue values!

pub fn rotation(&mut self, rotation: f32) -> &mut Self

#Set rotation. Builder pattern Rotation in color space. The higher the value, the quicker the colors will change in the palett.

Normally the range used is -1.5 <= rotation <= 1.5. Invalid values are Nan, or ±Infinity Important Will panic on invalid rotation values!

pub fn rgb_from_gray(&self, gray: f32) -> [f32; 3]

Calculate color from gray value. Gray value should be in the interval [0.0,1.0].

Will return [red, green, blue], where red, green and blue are in [0.0, 1.0], will return [0,0,0] for NAN gray value.

pub fn approximate_color_rgb(&self, gray: f32) -> ColorRGB

• Calculate color from gray value.
• Gray value should be in the interval [0.0,1.0].
• will return ColorRgb::new(0,0,0) for NAN gray value

will return corresponding (approximate) ColorRgb

pub fn into_gnuplot_palette(self) -> GnuplotPalette

Converts self into the corresponding enum of GnuplotPallet

Trait Implementations

impl Clone for CubeHelixParameter

fn clone(&self) -> CubeHelixParameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CubeHelixParameter

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

Formats the value using the given formatter.

impl Default for CubeHelixParameter

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CubeHelixParameter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CubeHelixParameter> for GnuplotPalette

fn from(parameter: CubeHelixParameter) -> Self

Converts to this type from the input type.

impl Serialize for CubeHelixParameter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CubeHelixParameter