astrup 0.0.9

A simple plotting library
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

//! ## Scatter
//!
//! Module that defines the Scatter struct
//!

use cairo::Context;
use ndarray::AsArray;
use palette::Rgba;

use ::{utils, chart, frame};

/// Scatter chart
///
/// A type used to visualise data with points. Each point coordinate is determined by the input
/// data arrays.
#[derive(Clone, Debug)]
pub struct Scatter {
    data_points: Vec<chart::point::Point>,
    global_frame: frame::Frame,
    data_frame: frame::Frame,
    color: Rgba,
    shape: chart::point::Shape,
    point_size: f64,
}

impl Scatter {
    /// Create and return a new Scatter chart
    pub fn new<'a, I: AsArray<'a, f64>>(x_data_coords: I, y_data_coords: I) -> Scatter {
        let x_view: Vec<_> = x_data_coords.into().iter().map(|v| utils::NonNan::new(*v).unwrap()).collect();
        let y_view: Vec<_> = y_data_coords.into().iter().map(|v| utils::NonNan::new(*v).unwrap()).collect();
        let ref x_data_min = x_view.iter().min().expect("Could not find x min");
        let ref x_data_max = x_view.iter().max().expect("Could not find x max");
        let ref y_data_min = y_view.iter().min().expect("Could not find y min");
        let ref y_data_max = y_view.iter().max().expect("Could not find y max");

        let color = Rgba::new(0.1, 0.1, 0.8, 0.9);
        let shape = chart::point::Shape::Circle;
        let point_size = 0.01;
        let mut data_points = Vec::<chart::point::Point>::new();
        for (ref x, ref y) in x_view.iter().zip(y_view.iter()) {
            let mut point = chart::point::Point::new(x.val(), y.val());
            point.set_color(color);
            point.set_shape(shape.clone());
            point.set_size(point_size);
            data_points.push(chart::point::Point::new(x.val(), y.val()));
        }
        Scatter {
            data_points: data_points,
            global_frame: frame::Frame::new(),
            data_frame: frame::Frame::from_sides(x_data_min.val(), x_data_max.val(),
                                                 y_data_min.val(), y_data_max.val()),
            color: color,
            shape: shape,
            point_size: point_size,
        }
    }

    /// Set the scatter point color
    pub fn set_color(mut self, color: Rgba) -> Self {
        self.color = color;
        self
    }

    /// Set the scatter point color
    pub fn set_color_rgb(mut self, red: f32, green: f32, blue: f32) -> Self {
        let red = red.max(0.0);
        let red = red.min(1.0);
        let green = green.max(0.0);
        let green = green.min(1.0);
        let blue = blue.max(0.0);
        let blue = blue.min(1.0);
        self.color = Rgba::new(red, green, blue, 1.0);
        self
    }

    /// Set the scatter point color
    pub fn set_color_rgba(mut self, red: f32, green: f32, blue: f32, alpha: f32) -> Self {
        let red = red.max(0.0);
        let red = red.min(1.0);
        let green = green.max(0.0);
        let green = green.min(1.0);
        let blue = blue.max(0.0);
        let blue = blue.min(1.0);
        let alpha = alpha.max(0.0);
        let alpha = alpha.min(1.0);
        self.color = Rgba::new(red, green, blue, alpha);
        self
    }

    /// Set the scatter point size
    pub fn set_point_size(mut self, size: f64) -> Self {
        self.point_size = size;
        self
    }

    /// Set the shape of the scatter point. Circle, tick, or square.
    ///
    /// TODO: Circle is currently filled. This is perhaps not the expected shape.
    ///
    /// | Input                              | Shape  |
    /// | ---------------------------------- | ------ |
    /// | "Circle" or "circle" or "c" or "o" | Circle |
    /// | "Square" or "square" or "s"        | Square |
    /// | "Tick" or "tick" or "t"            | Tick   |
    /// | Any other &str                     | Circle |
    pub fn set_shape(mut self, shape_id: &str) -> Self {
        // TODO: Move this to draw and get rid of enum??
        self.shape = match shape_id {
            "Circle" | "circle" | "c" | "o" => chart::point::Shape::Circle,
            "Square" | "square" | "s" => chart::point::Shape::Square,
            "Tick" | "tick" | "t" => chart::point::Shape::Tick,
            _ => chart::point::Shape::Circle,
        };
        self
    }
}

impl utils::Drawable for Scatter {
    fn scale_size(&mut self, factor: f64) {
        self.point_size *= factor;
    }

    fn fit(&mut self, canvas_global_frame: &frame::Frame, canvas_data_frame: &frame::Frame) {
        self.global_frame = canvas_global_frame.clone();
        self.data_frame = canvas_data_frame.clone();

        for data_point in self.data_points.iter_mut() {
            data_point.set_color(self.color);
            data_point.set_shape(self.shape.clone());
            data_point.set_size(self.point_size);
            data_point.fit(canvas_global_frame, canvas_data_frame);
        }
    }

    fn draw(&self, cr: &Context, fig_rel_height: f64, fig_rel_width: f64) {
        for data_point in self.data_points.iter() {
            let canvas_x = utils::map_range(data_point.x_coord(),
                                            self.data_frame.left(), self.data_frame.right(),
                                            self.global_frame.left(), self.global_frame.right());
            let canvas_y = utils::map_range(data_point.y_coord(),
                                            self.data_frame.bottom(), self.data_frame.top(),
                                            self.global_frame.bottom(), self.global_frame.top());
            let mut canvas_point = data_point.clone();
            canvas_point.set_x_coord(canvas_x);
            canvas_point.set_y_coord(canvas_y);
            canvas_point.draw(cr, fig_rel_height, fig_rel_width);
        }
    }
}

impl utils::Plottable for Scatter {
    fn data_frame(&self) -> frame::Frame {
        self.data_frame.clone()
    }

    fn data_x_min(&self) -> f64 {
        self.data_frame.left()
    }

    fn data_x_max(&self) -> f64 {
        self.data_frame.right()
    }

    fn data_y_min(&self) -> f64 {
        self.data_frame.bottom()
    }

    fn data_y_max(&self) -> f64 {
        self.data_frame.top()
    }

    fn set_data_frame(&mut self, new_data_frame: frame::Frame) {
        self.data_frame = new_data_frame;
    }
}