plotpy 1.21.0

Rust plotting library using Python (Matplotlib)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

use plotpy::{Curve, Plot, RayEndpoint, StrError};
use std::f64::consts::PI;
use std::fs::File;
use std::io::{BufRead, BufReader};
use std::path::Path;

const OUT_DIR: &str = "/tmp/plotpy/integ_tests";

#[test]
fn test_curve() -> Result<(), StrError> {
    // curve object and options
    let mut curve1 = Curve::new();
    curve1
        .set_line_alpha(0.7)
        .set_line_color("#cd0000")
        .set_line_style("--")
        .set_line_width(2.0)
        .set_marker_color("#1862ab")
        .set_marker_every(2)
        .set_marker_void(false)
        .set_marker_line_color("#cda500")
        .set_marker_line_width(3.0)
        .set_marker_size(15.0)
        .set_marker_style("p");

    // another curve
    let mut curve2 = Curve::new();
    curve2
        .set_line_style("None")
        .set_marker_style("o")
        .set_marker_size(20.0)
        .set_marker_void(true);

    let mut curve3 = Curve::new();
    curve3.set_extra("drawstyle='steps'");

    // draw curves
    let x = &[1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0];
    let y = &[
        1.0, 1.41421356, 1.73205081, 2.0, 2.23606798, 2.44948974, 2.64575131, 2.82842712, 3.0, 3.16227766,
    ];
    let y2 = &[1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 3.5, 3.5, 3.5, 3.5];
    curve1.draw(x, y);
    curve2.draw(x, y2);
    curve3.draw(x, x);

    // draw ray
    let mut ray1 = Curve::new();
    let mut ray2 = Curve::new();
    let mut ray3 = Curve::new();
    let mut ray4 = Curve::new();
    ray1.set_line_color("orange");
    ray2.set_line_color("gold");
    ray3.set_line_color("yellow");
    ray4.set_line_color("#9b7014");
    ray1.draw_ray(2.0, 0.0, RayEndpoint::Coords(8.0, 0.5));
    ray2.draw_ray(2.0, 0.0, RayEndpoint::Slope(0.2));
    ray3.draw_ray(2.0, 0.0, RayEndpoint::Horizontal);
    ray4.draw_ray(2.0, 0.0, RayEndpoint::Vertical);

    // add curves to plot
    let mut plot = Plot::new();
    plot.add(&curve1)
        .add(&curve2)
        .add(&curve3)
        .add(&ray1)
        .add(&ray2)
        .add(&ray3)
        .add(&ray4);

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

    // check number of lines
    let file = File::open(path).map_err(|_| "cannot open file")?;
    let buffered = BufReader::new(file);
    let lines_iter = buffered.lines();
    let n = lines_iter.count();
    assert!(n > 450 && n < 500);
    Ok(())
}

#[test]
fn test_curve_twinx() -> Result<(), StrError> {
    // data
    let np = 201;
    let mut x = vec![0.0; np];
    let mut y1 = vec![0.0; np];
    let mut y2 = vec![0.0; np];
    let dx = 4.0 / (np as f64);
    for i in 0..np {
        x[i] = (i as f64) * dx;
        y1[i] = f64::exp(x[i]);
        y2[i] = f64::sin(2.0 * PI * x[i]);
    }

    // curve
    let mut curve = Curve::new();
    curve.set_line_color("red").draw(&x, &y1);
    curve.set_line_color("blue").draw_with_twin_x(&y2);

    // add curve to plot
    let mut plot = Plot::new();
    plot.add(&curve) // must occur before set twin_x options
        .grid_and_labels("time (s)", "exp function")
        .set_label_x_color("green")
        .set_label_y_color("red")
        .set_label_y_twinx("sin function")
        .set_label_y_twinx_color("blue");

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

    // check number of lines
    let file = File::open(path).map_err(|_| "cannot open file")?;
    let buffered = BufReader::new(file);
    let lines_iter = buffered.lines();
    let c = lines_iter.count();
    assert!(c > 1250 && c < 1300);
    Ok(())
}

#[test]
fn test_curve_points_methods_work() -> Result<(), StrError> {
    // add points
    let mut curve = Curve::new();
    curve
        .points_begin()
        .points_add(0.0, 0.0)
        .points_add(1.0, 1.0)
        .points_add(2.0, 4.0)
        .points_end();

    // add curves to plot
    let mut plot = Plot::new();
    plot.add(&curve);

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

    // check number of lines
    let file = File::open(path).map_err(|_| "cannot open file")?;
    let buffered = BufReader::new(file);
    let lines_iter = buffered.lines();
    assert!(lines_iter.count() > 510);
    Ok(())
}

#[test]
fn test_curve_points_3d_methods_work() -> Result<(), StrError> {
    // add points
    let mut curve = Curve::new();
    curve
        .points_3d_begin()
        .points_3d_add(0.0, 0.0, 0.0)
        .points_3d_add(1.0, 0.0, 0.0)
        .points_3d_add(1.0, 1.0, 0.0)
        .points_3d_add(1.0, 1.0, 1.0)
        .points_3d_end();

    // add curves to plot
    let mut plot = Plot::new();
    plot.add(&curve);

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

    // check number of lines
    let file = File::open(path).map_err(|_| "cannot open file")?;
    let buffered = BufReader::new(file);
    let lines_iter = buffered.lines();
    assert!(lines_iter.count() > 660);
    Ok(())
}

#[test]
fn test_curve_3d() -> Result<(), StrError> {
    // curve object and options
    let mut curve = Curve::new();
    curve
        .set_line_alpha(0.7)
        .set_line_color("#cd0000")
        .set_line_style("--")
        .set_line_width(2.0)
        .set_marker_color("#1862ab")
        .set_marker_every(2)
        .set_marker_void(false)
        .set_marker_line_color("#cda500")
        .set_marker_line_width(3.0)
        .set_marker_size(8.0)
        .set_marker_style("p");

    // draw curves
    let x = &[1.0, 2.0, 3.0, 4.0, 5.0];
    let y = &[1.0, 4.0, 9.0, 16.0, 25.0];
    let z = &[0.0, 0.0, 0.0, 1.0, 1.0];
    curve.draw_3d(x, y, z);

    // add curves to plot
    let mut plot = Plot::new();
    plot.add(&curve);
    plot.set_range_3d(-0.5, 6.0, -0.5, 30.0, -0.5, 1.5); // must be after add curve

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

    // check number of lines
    let file = File::open(path).map_err(|_| "cannot open file")?;
    let buffered = BufReader::new(file);
    let lines_iter = buffered.lines();
    let n_lines = lines_iter.count();
    assert!(n_lines > 800 && n_lines < 900);
    Ok(())
}