Struct plotpy::Plot

pub struct Plot { /* fields omitted */ }

Driver structure that calls Python

Example

// import
use plotpy::{Curve, Plot};
use russell_lab::Vector;
use std::path::Path;

// directory to save figures
const OUT_DIR: &str = "/tmp/plotpy/doc_tests";

// generate (x,y) points
let n = 11;
let x = Vector::linspace(-1.0, 1.0, n);
let y1 = x.get_copy();
let y2 = x.get_mapped(|v| f64::abs(v));
let y3 = x.get_mapped(|v| f64::exp(1.0 + v) - 1.0);
let y4 = x.get_mapped(|v| f64::sqrt(1.0 + v));

// configure and draw curves
let mut curve1 = Curve::new();
let mut curve2 = Curve::new();
let mut curve3 = Curve::new();
let mut curve4 = Curve::new();
curve1.set_label("y = x");
curve2.set_label("y = |x|").set_line_color("#cd0000");
curve3.set_label("y = exp(1+x)-1").set_line_color("#e79955");
curve4.set_label("y = sqrt(1+x)").set_line_color("#b566ab");
curve1.draw(&x, &y1);
curve2.draw(&x, &y2);
curve3.draw(&x, &y3);
curve4.draw(&x, &y4);

// configure plot
let mut plot = Plot::new();
plot.set_super_title("FOUR CURVES").set_gaps(0.35, 0.5);

// add curve to subplot
plot.set_subplot(2, 2, 1)
    .set_title("first")
    .add(&curve1)
    .grid_labels_legend("x", "y")
    .set_equal_axes(true);

// add curve to subplot
plot.set_subplot(2, 2, 2)
    .set_title("second")
    .add(&curve2)
    .grid_labels_legend("x", "y");

// add curve to subplot
plot.set_subplot(2, 2, 3)
    .set_title("third")
    .add(&curve3)
    .set_range(-1.0, 1.0, 0.0, 6.0)
    .grid_labels_legend("x", "y");

// add curve to subplot
plot.set_subplot(2, 2, 4)
    .set_title("fourth")
    .add(&curve4)
    .grid_labels_legend("x", "y");

// save figure
let path = Path::new(OUT_DIR).join("doc_plot.svg");
plot.save(&path)?;

Implementations

impl Plot

pub fn new() -> Self

Creates new Plot object

pub fn add(&mut self, graph: &dyn GraphMaker) -> &mut Self

Adds new graph entity

pub fn save<S>(&self, figure_path: &S) -> Result<(), &'static str> where
    S: AsRef<OsStr> + ?Sized, 

Calls python3 and saves the python script and figure

Input

• figure_path – may be a String, &str, or Path

pub fn print_log_file<S>(&self, figure_path: &S) -> Result<(), &'static str> where
    S: AsRef<OsStr> + ?Sized, 

Prints the log file created by the save command

Note: the log file is only generated when python fails

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

Clears current figure

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

Adds legend to plot (see Legend for further options)

pub fn grid_and_labels(&mut self, xlabel: &str, ylabel: &str) -> &mut Self

Adds grid and labels

pub fn grid_labels_legend(&mut self, xlabel: &str, ylabel: &str) -> &mut Self

Adds grid, labels, and legend

pub fn write_extra(&mut self, commands: &str) -> &mut Self

Writes extra Python/Matplotlib commands to buffer

Note

The other of commands matter (as usual in a Python/Matplotlib script).

pub fn set_subplot(&mut self, row: usize, col: usize, index: usize) -> &mut Self

Configures subplots

Arguments

• row - number of rows in the subplot grid
• col - number of columns in the subplot grid
• index - activate current subplot; indices start at one (1-based)

pub fn set_title(&mut self, title: &str) -> &mut Self

Adds a title to the plot or sub-plot

pub fn set_super_title(&mut self, title: &str) -> &mut Self

Adds a title to all sub-plots

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

Sets the horizontal gap between subplots

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

Sets the vertical gap between subplots

pub fn set_gaps(&mut self, horizontal: f64, vertical: f64) -> &mut Self

Sets the horizontal and vertical gap between subplots

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

Sets same scale for both axes

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

Set option to hide axes

pub fn set_range(
    &mut self,
    xmin: f64,
    xmax: f64,
    ymin: f64,
    ymax: f64
) -> &mut Self

Sets axes limits

pub fn set_range_from_vec(&mut self, limits: &[f64]) -> &mut Self

Sets axes limits from vector

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

Sets minimum x

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

Sets maximum x

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

Sets minimum y

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

Sets maximum y

pub fn set_xrange(&mut self, xmin: f64, xmax: f64) -> &mut Self

Sets x-range (i.e. limits)

pub fn set_yrange(&mut self, ymin: f64, ymax: f64) -> &mut Self

Sets y-range (i.e. limits)

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

Sets number of ticks along x

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

Sets number of ticks along y

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

Sets a log10 x-scale

Note

set_log_x(true) must be called before adding curves.

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

Sets a log10 y-scale

Note

set_log_y(true) must be called before adding curves.

pub fn set_label_x(&mut self, label: &str) -> &mut Self

Sets the label for the x-axis

pub fn set_label_y(&mut self, label: &str) -> &mut Self

Sets the label for the y-axis

pub fn set_labels(&mut self, xlabel: &str, ylabel: &str) -> &mut Self

Sets the labels of x and y axis

pub fn set_camera(&mut self, elev: f64, azimuth: f64) -> &mut Self

Sets camera in 3d graph. Sets the elevation and azimuth of the axes.

Input

• elev – is the elevation angle in the z plane
• azimuth – is the azimuth angle in the x,y plane

pub fn set_frame_border(
    &mut self,
    left: bool,
    right: bool,
    bottom: bool,
    top: bool
) -> &mut Self

Sets option to hide (or show) frame borders

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

Sets visibility of all frame borders

pub fn set_figure_size(
    &mut self,
    width_points: f64,
    proportion: f64
) -> &mut Self

Sets the figure size

Note

This function must be called right at the beginning.