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., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20
  21 #ifndef CHART_H
  22 #define CHART_H
  23
  24 #include <stdio.h>
  25 #include <plot.h>
  26 #include <gsl/gsl_histogram.h>
  27
  28 #include "var.h"
  29
  30
  31 /* Array of standard colour names */
  32 extern const char *data_colour[];
  33
  34
  35 struct chart {
  36
  37   plPlotter *lp ;
  38   plPlotterParams *pl_params;
  39
  40   /* The geometry of the chart
  41      See diagram at the foot of this file.
  42    */
  43
  44   int data_top   ;
  45   int data_right ;
  46   int data_bottom;
  47   int data_left  ;
  48
  49   int abscissa_top;
  50
  51   int ordinate_right ;
  52
  53   int title_bottom ;
  54
  55   int legend_left ;
  56   int legend_right ;
  57
  58
  59   /* Default font size for the plot (if zero, then use plotter default) */
  60   int font_size;
  61
  62   char fill_colour[10];
  63
  64   /* Stuff Particular to Cartesians */
  65   double ordinate_scale;
  66   double abscissa_scale;
  67   double x_min;
  68   double x_max;
  69   double y_min;
  70   double y_max;
  71
  72 };
  73
  74
  75 int  chart_initialise(struct chart *ch);
  76
  77 void chart_finalise(struct chart *ch);
  78
  79
  80
  81 void chart_write_xlabel(struct chart *ch, const char *label);
  82 void chart_write_ylabel(struct chart *ch, const char *label);
  83
  84 void chart_write_title(struct chart *ch, const char *title, ...);
  85
  86 enum tick_orientation {
  87   TICK_ABSCISSA=0,
  88   TICK_ORDINATE
  89 };
  90
  91 void draw_tick(struct chart *ch, enum tick_orientation orientation,
  92                double position, const char *label, ...);
  93
  94
  95
  96 enum  bar_opts {
  97   BAR_GROUPED =  0,
  98   BAR_STACKED,
  99   BAR_RANGE
 100 };
 101
 102
 103 void draw_barchart(struct chart *ch, const char *title,
 104                    const char *xlabel, const char *ylabel, enum bar_opts opt);
 105
 106 void draw_box_whisker_chart(struct chart *ch, const char *title);
 107
 108
 109
 110 struct normal_curve
 111 {
 112   double N ;
 113   double mean ;
 114   double stddev ;
 115 };
 116
 117
 118 void histogram_write_legend(struct chart *ch, const struct normal_curve *norm);
 119
 120
 121 void histogram_plot(const gsl_histogram *hist, const char *factorname,
 122                     const struct normal_curve *norm, short show_normal);
 123
 124
 125
 126
 127 struct slice {
 128   const char *label;
 129   double magnetude;
 130 };
 131
 132
 133
 134
 135 /* Draw a piechart */
 136 void piechart_plot(const char *title,
 137                    const struct slice *slices, int n_slices);
 138
 139 void draw_scatterplot(struct chart *ch);
 140
 141
 142 void draw_lineplot(struct chart *ch);
 143
 144
 145 /* Set the scale on chart CH.
 146    The scale extends from MIN to MAX .
 147    TICK is the approximate number of tick marks.
 148 */
 149
 150 void chart_write_xscale(struct chart *ch,
 151                         double min, double max, int ticks);
 152
 153 void chart_write_yscale(struct chart *ch,
 154                         double min, double max, int ticks);
 155
 156
 157 void chart_datum(struct chart *ch, int dataset, double x, double y);
 158
 159
 160
 161 enum CHART_DIM
 162   {
 163     CHART_DIM_X,
 164     CHART_DIM_Y
 165   };
 166
 167
 168 void chart_line(struct chart *ch, double slope, double intercept,
 169                 double limit1, double limit2, enum CHART_DIM limit_d);
 170
 171
 172 #endif
 173
 174 #if 0
 175 The anatomy of a chart is as follows.
 176
 177 +-------------------------------------------------------------+
 178 |            +----------------------------------+             |
 179 |            |                                  |             |
 180 |            |          Title                   |             |
 181 |            |                                  |             |
 182 |            +----------------------------------+             |
 183 |+----------++----------------------------------++-----------+|
 184 ||          ||                                  ||           ||
 185 ||          ||                                  ||           ||
 186 ||          ||                                  ||           ||
 187 ||          ||                                  ||           ||
 188 ||          ||                                  ||           ||
 189 ||          ||                                  ||           ||
 190 ||          ||                                  ||           ||
 191 ||          ||                                  ||           ||
 192 ||          ||                                  ||           ||
 193 ||          ||                                  ||           ||
 194 || Ordinate ||            Data                  ||  Legend   ||
 195 ||          ||                                  ||           ||
 196 ||          ||                                  ||           ||
 197 ||          ||                                  ||           ||
 198 ||          ||                                  ||           ||
 199 ||          ||                                  ||           ||
 200 ||          ||                                  ||           ||
 201 ||          ||                                  ||           ||
 202 ||          ||                                  ||           ||
 203 ||          ||                                  ||           ||
 204 ||          ||                                  ||           ||
 205 |+----------++----------------------------------++-----------+|   --
 206 |            +----------------------------------+             | -  ^  data_bottom
 207 |            |          Abscissa                |             | ^  |
 208 |            |                                  |             | | abscissa_top
 209 |            +----------------------------------+             | v  v
 210 +-------------------------------------------------------------+ ----
 211
 212 ordinate_right                                  ||           |
 213 |           |                                   ||           |
 214 |<--------->|                                   ||           |
 215 |            |                                  ||           |
 216 | data_left  |                                  ||           |
 217 |<---------->|                                  ||           |
 218 |                                               ||           |
 219 |               data_right                      ||           |
 220 |<--------------------------------------------->||           |
 221 |                  legend_left                   |           |
 222 |<---------------------------------------------->|           |
 223 |                    legend_right                            |
 224 |<---------------------------------------------------------->|
 225
 226 #endif