Struct Image 

pub struct Image { /* private fields */ }

Generates an image plot (imshow)

See Matplotlib’s documentation

Examples

use plotpy::{Image, Plot, StrError};

fn main() -> Result<(), StrError> {
    // set values
    let data = [
        [0.8, 2.4, 2.5, 3.9, 0.0, 4.0, 0.0],
        [2.4, 0.0, 4.0, 1.0, 2.7, 0.0, 0.0],
        [1.1, 2.4, 0.8, 4.3, 1.9, 4.4, 0.0],
        [0.6, 0.0, 0.3, 0.0, 3.1, 0.0, 0.0],
        [0.7, 1.7, 0.6, 2.6, 2.2, 6.2, 0.0],
        [1.3, 1.2, 0.0, 0.0, 0.0, 3.2, 5.1],
        [0.1, 2.0, 0.0, 1.4, 0.0, 1.9, 6.3],
    ];

    // image plot and options
    let mut img = Image::new();
    img.set_colormap_name("hsv").draw(&data);

    // save figure
    let mut plot = Plot::new();
    plot.add(&img);
    plot.save("/tmp/plotpy/doc_tests/doc_image_1.svg")?;
    Ok(())
}

See also integration test in the tests directory.

Implementations

impl Image

pub fn new() -> Self

Creates a new Image object

pub fn draw<'a, T, U>(&mut self, data: &'a T)

where T: AsMatrix<'a, U>, U: 'a + Display + Num,

(imshow) Displays data as an image

Arguments

• data - 2D matrix-like data structure

See https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html

pub fn draw_rgb_or_rgba<T>(&mut self, data: &Vec<Vec<Vec<T>>>)

where T: Display + Num,

(imshow) Displays data as an image with RGB or RGB(A) values

Arguments

• data - 3D vector with shape (height, width, 3) for RGB or (height, width, 4) for RGBA The inner-most vector contains the color channels.

See https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html

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

Colormap names:

• see https://matplotlib.org/stable/tutorials/colors/colormaps.html

Will use colormap_index instead if colormap_name is empty.

pub fn set_extra(&mut self, extra: &str) -> &mut Self

Trait Implementations

impl GraphMaker for Image

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

Returns the text buffer with Python3 commands

fn clear_buffer(&mut self)

Clear the text buffer with Python commands