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
220
221
222
223
|
use std::marker::PhantomData;
use crate::element::{Drawable, PointCollection};
use crate::style::ShapeStyle;
use plotters_backend::{BackendCoord, DrawingBackend, DrawingErrorKind};
/**
Used to reuse code between horizontal and vertical error bars.
This is used internally by Plotters and should probably not be included in user code.
See [`ErrorBar`] for more information and examples.
*/
pub trait ErrorBarOrient<K, V> {
type XType;
type YType;
fn make_coord(key: K, val: V) -> (Self::XType, Self::YType);
fn ending_coord(coord: BackendCoord, w: u32) -> (BackendCoord, BackendCoord);
}
/**
Used for the production of horizontal error bars.
This is used internally by Plotters and should probably not be included in user code.
See [`ErrorBar`] for more information and examples.
*/
pub struct ErrorBarOrientH<K, V>(PhantomData<(K, V)>);
/**
Used for the production of vertical error bars.
This is used internally by Plotters and should probably not be included in user code.
See [`ErrorBar`] for more information and examples.
*/
pub struct ErrorBarOrientV<K, V>(PhantomData<(K, V)>);
impl<K, V> ErrorBarOrient<K, V> for ErrorBarOrientH<K, V> {
type XType = V;
type YType = K;
fn make_coord(key: K, val: V) -> (V, K) {
(val, key)
}
fn ending_coord(coord: BackendCoord, w: u32) -> (BackendCoord, BackendCoord) {
(
(coord.0, coord.1 - w as i32 / 2),
(coord.0, coord.1 + w as i32 / 2),
)
}
}
impl<K, V> ErrorBarOrient<K, V> for ErrorBarOrientV<K, V> {
type XType = K;
type YType = V;
fn make_coord(key: K, val: V) -> (K, V) {
(key, val)
}
fn ending_coord(coord: BackendCoord, w: u32) -> (BackendCoord, BackendCoord) {
(
(coord.0 - w as i32 / 2, coord.1),
(coord.0 + w as i32 / 2, coord.1),
)
}
}
/**
An error bar, which visualizes the minimum, average, and maximum of a dataset.
Unlike [`crate::series::Histogram`], the `ErrorBar` code does not classify or aggregate data.
These operations must be done before building error bars.
# Examples
```
use plotters::prelude::*;
let data = [(1.0, 3.3), (2., 2.1), (3., 1.5), (4., 1.9), (5., 1.0)];
let drawing_area = SVGBackend::new("error_bars_vertical.svg", (300, 200)).into_drawing_area();
drawing_area.fill(&WHITE).unwrap();
let mut chart_builder = ChartBuilder::on(&drawing_area);
chart_builder.margin(10).set_left_and_bottom_label_area_size(20);
let mut chart_context = chart_builder.build_cartesian_2d(0.0..6.0, 0.0..6.0).unwrap();
chart_context.configure_mesh().draw().unwrap();
chart_context.draw_series(data.map(|(x, y)| {
ErrorBar::new_vertical(x, y - 0.4, y, y + 0.3, BLUE.filled(), 10)
})).unwrap();
chart_context.draw_series(data.map(|(x, y)| {
ErrorBar::new_vertical(x, y + 1.0, y + 1.9, y + 2.4, RED, 10)
})).unwrap();
```
This code produces two series of five error bars each, showing minima, maxima, and average values:
[`ErrorBar::new_vertical()`] is used to create vertical error bars. Here is an example using
[`ErrorBar::new_horizontal()`] instead:
*/
pub struct ErrorBar<K, V, O: ErrorBarOrient<K, V>> {
style: ShapeStyle,
width: u32,
key: K,
values: [V; 3],
_p: PhantomData<O>,
}
impl<K, V> ErrorBar<K, V, ErrorBarOrientV<K, V>> {
/**
Creates a vertical error bar.
`
- `key`: Horizontal position of the bar
- `min`: Minimum of the data
- `avg`: Average of the data
- `max`: Maximum of the data
- `style`: Color, transparency, and fill of the error bar. See [`ShapeStyle`] for more information and examples.
- `width`: Width of the error marks in backend coordinates.
See [`ErrorBar`] for more information and examples.
*/
pub fn new_vertical<S: Into<ShapeStyle>>(
key: K,
min: V,
avg: V,
max: V,
style: S,
width: u32,
) -> Self {
Self {
style: style.into(),
width,
key,
values: [min, avg, max],
_p: PhantomData,
}
}
}
impl<K, V> ErrorBar<K, V, ErrorBarOrientH<K, V>> {
/**
Creates a horizontal error bar.
- `key`: Vertical position of the bar
- `min`: Minimum of the data
- `avg`: Average of the data
- `max`: Maximum of the data
- `style`: Color, transparency, and fill of the error bar. See [`ShapeStyle`] for more information and examples.
- `width`: Width of the error marks in backend coordinates.
See [`ErrorBar`] for more information and examples.
*/
pub fn new_horizontal<S: Into<ShapeStyle>>(
key: K,
min: V,
avg: V,
max: V,
style: S,
width: u32,
) -> Self {
Self {
style: style.into(),
width,
key,
values: [min, avg, max],
_p: PhantomData,
}
}
}
impl<'a, K: Clone, V: Clone, O: ErrorBarOrient<K, V>> PointCollection<'a, (O::XType, O::YType)>
for &'a ErrorBar<K, V, O>
{
type Point = (O::XType, O::YType);
type IntoIter = Vec<Self::Point>;
fn point_iter(self) -> Self::IntoIter {
self.values
.iter()
.map(|v| O::make_coord(self.key.clone(), v.clone()))
.collect()
}
}
impl<K, V, O: ErrorBarOrient<K, V>, DB: DrawingBackend> Drawable<DB> for ErrorBar<K, V, O> {
fn draw<I: Iterator<Item = BackendCoord>>(
&self,
points: I,
backend: &mut DB,
_: (u32, u32),
) -> Result<(), DrawingErrorKind<DB::ErrorType>> {
let points: Vec<_> = points.take(3).collect();
let (from, to) = O::ending_coord(points[0], self.width);
backend.draw_line(from, to, &self.style)?;
let (from, to) = O::ending_coord(points[2], self.width);
backend.draw_line(from, to, &self.style)?;
backend.draw_line(points[0], points[2], &self.style)?;
backend.draw_circle(points[1], self.width / 2, &self.style, self.style.filled)?;
Ok(())
}
}
#[cfg(test)]
#[test]
fn test_preserve_stroke_width() {
let v = ErrorBar::new_vertical(100, 20, 50, 70, WHITE.filled().stroke_width(5), 3);
let h = ErrorBar::new_horizontal(100, 20, 50, 70, WHITE.filled().stroke_width(5), 3);
use crate::prelude::*;
let da = crate::create_mocked_drawing_area(300, 300, |m| {
m.check_draw_line(|_, w, _, _| {
assert_eq!(w, 5);
});
});
da.draw(&h).expect("Drawing Failure");
da.draw(&v).expect("Drawing Failure");
}
|
