Recent spread-sheet-widget to version 0.2
[pspp] / src / output / charts / boxplot-cairo.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2009, 2011 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include "output/cairo-chart.h"
20
21 #include <math.h>
22
23 #include "math/box-whisker.h"
24 #include "math/chart-geometry.h"
25 #include "output/charts/boxplot.h"
26
27 /* Draw an OUTLIER on the plot CH
28  * at CENTRELINE
29  */
30 static void
31 draw_case (cairo_t *cr, const struct xrchart_geometry *geom, double centreline,
32            const struct outlier *outlier)
33 {
34   double y = geom->axis[SCALE_ORDINATE].data_min + (outlier->value - geom->axis[SCALE_ORDINATE].min) * geom->axis[SCALE_ORDINATE].scale;
35   xrchart_draw_marker (cr, centreline, y,
36                      outlier->extreme ? XRMARKER_ASTERISK : XRMARKER_CIRCLE,
37                      20);
38
39   cairo_move_to (cr, centreline + 10, y);
40   xrchart_label (cr, 'l', 'c', geom->font_size, ds_cstr (&outlier->label));
41 }
42
43 static void
44 boxplot_draw_box (cairo_t *cr, const struct xrchart_geometry *geom,
45                   double box_centre,
46                   double box_width,
47                   const struct box_whisker *bw,
48                   const char *name)
49 {
50   double whisker[2];
51   double hinge[3];
52   struct ll *ll;
53
54   const struct ll_list *outliers;
55
56   const double box_left = box_centre - box_width / 2.0;
57
58   const double box_right = box_centre + box_width / 2.0;
59
60   double box_bottom;
61   double box_top;
62   double bottom_whisker;
63   double top_whisker;
64
65   box_whisker_whiskers (bw, whisker);
66   box_whisker_hinges (bw, hinge);
67
68   box_bottom = geom->axis[SCALE_ORDINATE].data_min + (hinge[0] - geom->axis[SCALE_ORDINATE].min ) * geom->axis[SCALE_ORDINATE].scale;
69
70   box_top = geom->axis[SCALE_ORDINATE].data_min + (hinge[2] - geom->axis[SCALE_ORDINATE].min ) * geom->axis[SCALE_ORDINATE].scale;
71
72   bottom_whisker = geom->axis[SCALE_ORDINATE].data_min + (whisker[0] - geom->axis[SCALE_ORDINATE].min) *
73     geom->axis[SCALE_ORDINATE].scale;
74
75   top_whisker = geom->axis[SCALE_ORDINATE].data_min + (whisker[1] - geom->axis[SCALE_ORDINATE].min) * geom->axis[SCALE_ORDINATE].scale;
76
77   /* Draw the box */
78   cairo_rectangle (cr,
79                    box_left,
80                    box_bottom,
81                    box_right - box_left,
82                    box_top - box_bottom);
83   cairo_save (cr);
84   cairo_set_source_rgb (cr,
85                         geom->fill_colour.red / 255.0,
86                         geom->fill_colour.green / 255.0,
87                         geom->fill_colour.blue / 255.0);
88   cairo_fill (cr);
89   cairo_restore (cr);
90   cairo_stroke (cr);
91
92   /* Draw the median */
93   cairo_save (cr);
94   cairo_set_line_width (cr, cairo_get_line_width (cr) * 5);
95   cairo_move_to (cr,
96                  box_left,
97                  geom->axis[SCALE_ORDINATE].data_min + (hinge[1] - geom->axis[SCALE_ORDINATE].min) * geom->axis[SCALE_ORDINATE].scale);
98   cairo_line_to (cr,
99                  box_right,
100                  geom->axis[SCALE_ORDINATE].data_min + (hinge[1] - geom->axis[SCALE_ORDINATE].min) * geom->axis[SCALE_ORDINATE].scale);
101   cairo_stroke (cr);
102   cairo_restore (cr);
103
104   /* Draw the bottom whisker */
105   cairo_move_to (cr, box_left, bottom_whisker);
106   cairo_line_to (cr, box_right, bottom_whisker);
107   cairo_stroke (cr);
108
109   /* Draw top whisker */
110   if (! isnan (top_whisker) )
111     {
112       cairo_move_to (cr, box_left, top_whisker);
113       cairo_line_to (cr, box_right, top_whisker);
114       cairo_stroke (cr);
115     }
116
117   /* Draw centre line. */
118   if (! isnan (bottom_whisker) && ! isnan (box_bottom))
119     {
120       /* (bottom half) */
121       cairo_move_to (cr, box_centre, bottom_whisker);
122       cairo_line_to (cr, box_centre, box_bottom);
123       cairo_stroke (cr);
124     }
125
126   if (! isnan (top_whisker) && ! isnan (box_top))
127     {
128       /* (top half) */
129       cairo_move_to (cr, box_centre, top_whisker);
130       cairo_line_to (cr, box_centre, box_top);
131       cairo_stroke (cr);
132     }
133
134   outliers = box_whisker_outliers (bw);
135   for (ll = ll_head (outliers);
136        ll != ll_null (outliers); ll = ll_next (ll))
137     {
138       const struct outlier *outlier = ll_data (ll, struct outlier, ll);
139       draw_case (cr, geom, box_centre, outlier);
140     }
141
142   /* Draw  tick  mark on x axis */
143   draw_tick (cr, geom, SCALE_ABSCISSA, false,
144              box_centre - geom->axis[SCALE_ABSCISSA].data_min, "%s", name);
145 }
146
147 void
148 xrchart_draw_boxplot (const struct chart_item *chart_item, cairo_t *cr,
149                       struct xrchart_geometry *geom)
150 {
151   const struct boxplot *boxplot = to_boxplot (chart_item);
152   double box_width;
153   size_t i;
154
155   xrchart_write_yscale (cr, geom, boxplot->y_min, boxplot->y_max);
156   xrchart_write_title (cr, geom, "%s", chart_item->title);
157
158   box_width = (geom->axis[SCALE_ABSCISSA].data_max - geom->axis[SCALE_ABSCISSA].data_min) / boxplot->n_boxes / 2.0;
159   for (i = 0; i < boxplot->n_boxes; i++)
160     {
161       const struct boxplot_box *box = &boxplot->boxes[i];
162       const double box_centre = (i * 2 + 1) * box_width + geom->axis[SCALE_ABSCISSA].data_min;
163       boxplot_draw_box (cr, geom, box_centre, box_width, box->bw, box->label);
164     }
165 }