Struct sampling::heatmap::GnuplotSettings

pub struct GnuplotSettings {
    pub x_label: String,
    pub x_axis: Option<GnuplotAxis>,
    pub y_label: String,
    pub y_axis: Option<GnuplotAxis>,
    pub title: String,
    pub terminal: GnuplotTerminal,
    pub palette: GnuplotPalette,
    pub cb_range: Option<(f64, f64)>,
    pub size: String,
}

Settings for gnuplot

• implements default
• implements builder pattern for itself

Fields

x_label: String

x label for gnuplot

x_axis: Option<GnuplotAxis>

how to format the labels of the x axis?

y_label: String

y label for gnuplot

y_axis: Option<GnuplotAxis>

how to format the labels of the y axis?

title: String

title for gnuplot

terminal: GnuplotTerminal

which terminal to use for gnuplot

palette: GnuplotPalette

Color palette for heatmap

cb_range: Option<(f64, f64)>

Define the cb range if this option is set

size: String

Size of the terminal

• Anything gnuplot accepts (e.g. “2cm, 2.9cm”) is acceptable

Note

the code does not check, if your input for size makes any sense

Implementations

impl GnuplotSettings

pub fn size<S: Into<String>>(&mut self, size: S) -> &mut Self

Builder pattern - set size of terminal

• Anything gnuplot accepts (e.g. “2cm, 2.9cm”) is acceptable

Note

the code does not check, if your input for size makes any sense

pub fn cb_range(&mut self, range_start: f64, range_end: f64) -> &mut Self

Builder pattern - set cb_range

pub fn remove_cb_range(&mut self) -> &mut Self

Builder pattern - remove cb_range

pub fn x_label<S: Into<String>>(&mut self, x_label: S) -> &mut Self

Builder pattern - set x_label

pub fn y_label<S: Into<String>>(&mut self, y_label: S) -> &mut Self

Builder pattern - set y_label

pub fn title<S: Into<String>>(&mut self, title: S) -> &mut Self

Builder pattern - set title

pub fn get_title(&self) -> &str

currently set title

pub fn terminal(&mut self, terminal: GnuplotTerminal) -> &mut Self

Builder pattern - set terminal

pub fn palette(&mut self, palette: GnuplotPalette) -> &mut Self

Builder pattern - set color palette

pub fn new() -> Self

Create new, default, GnuplotSettings

pub fn x_axis(&mut self, axis: GnuplotAxis) -> &mut Self

Set x_axis - See GnuplotAxis or try it out

pub fn remove_x_axis(&mut self) -> &mut Self

Remove x_axis

pub fn y_axis(&mut self, axis: GnuplotAxis) -> &mut Self

Set y_axis - See GnuplotAxis or try it out

pub fn remove_y_axis(&mut self) -> &mut Self

Remove y_axis

pub fn write_heatmap<F, W>( &self, writer: W, closure: F, x_len: usize, y_len: usize ) -> Result<()>

where W: Write, F: FnOnce(&mut W) -> Result<()>,

Write a heatmap with the given gnuplot Settings

• closure has to write the heatmap. It must write y_len rows with x_len values each, where the latter values are seperated by a space. This data will be used for the heatmap.
• x_len: The number of entrys in each column, that you promise the closure will write
• y_len: The number of columns you promise that the closure will write

pub fn write_heatmap_external_matrix<W, P>( &self, writer: W, matrix_width: usize, matrix_height: usize, matrix_path: P ) -> Result<()>

where W: Write, P: AsRef<Path>,

Same as write_heatmap but it assumes that the heatmap matrix is available in the file “heatmap”

Trait Implementations

impl Clone for GnuplotSettings

fn clone(&self) -> GnuplotSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GnuplotSettings

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

Formats the value using the given formatter.

impl Default for GnuplotSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GnuplotSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GnuplotSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.