src/chart.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 2004 Free Software Foundation, Inc.
   3    Written by John Darrington <john@darrington.wattle.id.au>
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18    02110-1301, USA. */
  19
  20
  21 #ifndef CHART_H
  22 #define CHART_H
  23
  24 #include <config.h>
  25 #include <stdio.h>
  26 #include <gsl/gsl_histogram.h>
  27 #include "var.h"
  28
  29 #ifndef NO_CHARTS
  30 #include <plot.h>
  31 #endif
  32
  33
  34 /* Array of standard colour names */
  35 extern const char *data_colour[];
  36
  37
  38 struct chart {
  39
  40 #ifndef NO_CHARTS
  41   plPlotter *lp ;
  42   plPlotterParams *pl_params;
  43 #else
  44   void *lp;
  45 #endif
  46   char *filename;
  47
  48   /* The geometry of the chart
  49      See diagram at the foot of this file.
  50    */
  51
  52   int data_top   ;
  53   int data_right ;
  54   int data_bottom;
  55   int data_left  ;
  56
  57   int abscissa_top;
  58
  59   int ordinate_right ;
  60
  61   int title_bottom ;
  62
  63   int legend_left ;
  64   int legend_right ;
  65
  66
  67   /* Default font size for the plot (if zero, then use plotter default) */
  68   int font_size;
  69
  70   char fill_colour[10];
  71
  72   /* Stuff Particular to Cartesians (and Boxplots ) */
  73   double ordinate_scale;
  74   double abscissa_scale;
  75   double x_min;
  76   double x_max;
  77   double y_min;
  78   double y_max;
  79
  80 };
  81
  82
  83 struct chart * chart_create(void);
  84 void chart_submit(struct chart *ch);
  85
  86 double chart_rounded_tick(double tick);
  87
  88 void chart_write_xlabel(struct chart *ch, const char *label);
  89 void chart_write_ylabel(struct chart *ch, const char *label);
  90
  91 void chart_write_title(struct chart *ch, const char *title, ...);
  92
  93 enum tick_orientation {
  94   TICK_ABSCISSA=0,
  95   TICK_ORDINATE
  96 };
  97
  98 void draw_tick(struct chart *ch, enum tick_orientation orientation,
  99                double position, const char *label, ...);
 100
 101
 102
 103 enum  bar_opts {
 104   BAR_GROUPED =  0,
 105   BAR_STACKED,
 106   BAR_RANGE
 107 };
 108
 109
 110 void draw_barchart(struct chart *ch, const char *title,
 111                    const char *xlabel, const char *ylabel, enum bar_opts opt);
 112
 113 void draw_box_whisker_chart(struct chart *ch, const char *title);
 114
 115
 116
 117 struct normal_curve
 118 {
 119   double N ;
 120   double mean ;
 121   double stddev ;
 122 };
 123
 124
 125 void histogram_write_legend(struct chart *ch, const struct normal_curve *norm);
 126
 127
 128 /* Plot a gsl_histogram */
 129 void histogram_plot(const gsl_histogram *hist, const char *factorname,
 130                     const struct normal_curve *norm, short show_normal);
 131
 132
 133 /* Create a gsl_histogram and set it's parameters based upon
 134    x_min, x_max and bins.
 135    The caller is responsible for freeing the histogram.
 136 */
 137 gsl_histogram * histogram_create(double bins, double x_min, double x_max) ;
 138
 139
 140
 141
 142
 143 struct slice {
 144   const char *label;
 145   double magnetude;
 146 };
 147
 148
 149
 150
 151 /* Draw a piechart */
 152 void piechart_plot(const char *title,
 153                    const struct slice *slices, int n_slices);
 154
 155 void draw_scatterplot(struct chart *ch);
 156
 157
 158 void draw_lineplot(struct chart *ch);
 159
 160
 161 /* Set the scale on chart CH.
 162    The scale extends from MIN to MAX .
 163    TICK is the approximate number of tick marks.
 164 */
 165
 166 void chart_write_xscale(struct chart *ch,
 167                         double min, double max, int ticks);
 168
 169 void chart_write_yscale(struct chart *ch,
 170                         double min, double max, int ticks);
 171
 172
 173 void chart_datum(struct chart *ch, int dataset, double x, double y);
 174
 175 struct metrics;
 176
 177
 178 void  boxplot_draw_boxplot(struct chart *ch,
 179                            double box_centre,
 180                            double box_width,
 181                            struct metrics *m,
 182                            const char *name);
 183
 184
 185 void boxplot_draw_yscale(struct chart *ch , double y_max, double y_min);
 186
 187
 188 enum CHART_DIM
 189   {
 190     CHART_DIM_X,
 191     CHART_DIM_Y
 192   };
 193
 194
 195 void chart_line(struct chart *ch, double slope, double intercept,
 196                 double limit1, double limit2, enum CHART_DIM limit_d);
 197
 198
 199 #endif
 200
 201 #if 0
 202 The anatomy of a chart is as follows.
 203
 204 +-------------------------------------------------------------+
 205 |            +----------------------------------+             |
 206 |            |                                  |             |
 207 |            |          Title                   |             |
 208 |            |                                  |             |
 209 |            +----------------------------------+             |
 210 |+----------++----------------------------------++-----------+|
 211 ||          ||                                  ||           ||
 212 ||          ||                                  ||           ||
 213 ||          ||                                  ||           ||
 214 ||          ||                                  ||           ||
 215 ||          ||                                  ||           ||
 216 ||          ||                                  ||           ||
 217 ||          ||                                  ||           ||
 218 ||          ||                                  ||           ||
 219 ||          ||                                  ||           ||
 220 ||          ||                                  ||           ||
 221 || Ordinate ||            Data                  ||  Legend   ||
 222 ||          ||                                  ||           ||
 223 ||          ||                                  ||           ||
 224 ||          ||                                  ||           ||
 225 ||          ||                                  ||           ||
 226 ||          ||                                  ||           ||
 227 ||          ||                                  ||           ||
 228 ||          ||                                  ||           ||
 229 ||          ||                                  ||           ||
 230 ||          ||                                  ||           ||
 231 ||          ||                                  ||           ||
 232 |+----------++----------------------------------++-----------+|   --
 233 |            +----------------------------------+             | -  ^  data_bottom
 234 |            |          Abscissa                |             | ^  |
 235 |            |                                  |             | | abscissa_top
 236 |            +----------------------------------+             | v  v
 237 +-------------------------------------------------------------+ ----
 238
 239 ordinate_right                                  ||           |
 240 |           |                                   ||           |
 241 |<--------->|                                   ||           |
 242 |            |                                  ||           |
 243 | data_left  |                                  ||           |
 244 |<---------->|                                  ||           |
 245 |                                               ||           |
 246 |               data_right                      ||           |
 247 |<--------------------------------------------->||           |
 248 |                  legend_left                   |           |
 249 |<---------------------------------------------->|           |
 250 |                    legend_right                            |
 251 |<---------------------------------------------------------->|
 252
 253 #endif