Struct plotpy::Surface

pub struct Surface { /* fields omitted */ }

Generates a 3D a surface (or wireframe, or both)

Example

// import
use plotpy::{Surface, Plot};
use russell_lab::generate3d;
use std::path::Path;

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

// generate (x,y,z) matrices
let n = 21;
let (x, y, z) = generate3d(-2.0, 2.0, -2.0, 2.0, n, n, |x, y| x * x - y * y);

// configure and draw surface + wireframe
let mut surface = Surface::new();
surface.set_colormap_name("seismic")
    .set_with_colorbar(true)
    .set_with_wireframe(true)
    .set_line_width(0.3);

// draw surface + wireframe
surface.draw(&x, &y, &z);

// add surface to plot
let mut plot = Plot::new();
plot.add(&surface)
    .set_title("horse saddle equation") // must be after add surface
    .set_camera(20.0, 35.0); // must be after add surface

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

Implementations

impl Surface

pub fn new() -> Self

Creates a new Surface object

pub fn draw<'a, T, U>(&mut self, x: &'a T, y: &'a T, z: &'a T) where
    T: AsMatrix<'a, U>,
    U: 'a + Display, 

Draws a surface, or wireframe, or both

Input

• x – matrix with x values
• y – matrix with y values
• z – matrix with z values

Flags

The following flags control what features are not to be drawn:

• surface – draws surface
• wireframe – draws wireframe

Notes

• The type U of the input matrices must be a number.

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

Sets the row stride

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

Sets the column stride

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

Sets option to generate surface

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

Sets option to generate wireframe

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

Sets the colormap index

Options:

• 0 – bwr
• 1 – RdBu
• 2 – hsv
• 3 – jet
• 4 – terrain
• 5 – pink
• 6 – Greys
• >6 – starts over from 0

pub fn set_colormap_name(&mut self, name: &str) -> &mut Self

Sets the colormap name

Options:

• bwr
• RdBu
• hsv
• jet
• terrain
• pink
• Greys
• see more here https://matplotlib.org/stable/tutorials/colors/colormaps.html

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

Sets option to draw a colorbar

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

Sets the colorbar label

pub fn set_number_format_cb(&mut self, format: &str) -> &mut Self

Sets the number format for the labels in the colorbar (cb)

pub fn set_line_color(&mut self, color: &str) -> &mut Self

Sets the color of wireframe lines

pub fn set_line_style(&mut self, style: &str) -> &mut Self

Sets the style of wireframe line

Options:

• “-”, “:”, “--”, “-.”

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

Sets the width of wireframe line

Trait Implementations

impl GraphMaker for Surface

fn get_buffer<'a>(&'a self) -> &'a String