src/output/charts/plot-hist.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2004, 2009 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
  18 #include <config.h>
  19
  20 #include <stdio.h>
  21 #include <plot.h>
  22 #include <math.h>
  23 #include <gsl/gsl_histogram.h>
  24 #include <gsl/gsl_randist.h>
  25 #include <assert.h>
  26
  27 #include <output/charts/plot-hist.h>
  28 #include <output/charts/plot-chart.h>
  29
  30 #include <data/variable.h>
  31 #include <libpspp/hash.h>
  32 #include <output/chart.h>
  33 #include <math/histogram.h>
  34 #include <math/moments.h>
  35
  36 #include "gettext.h"
  37 #define _(msgid) gettext (msgid)
  38
  39 /* Write the legend of the chart */
  40 static void
  41 histogram_write_legend (struct chart *ch, double n, double mean, double stddev)
  42 {
  43   char buf[100];
  44
  45   if (!ch)
  46     return ;
  47
  48   pl_savestate_r (ch->lp);
  49
  50   sprintf (buf, "N = %.2f", n);
  51   pl_move_r (ch->lp, ch->legend_left, ch->data_bottom);
  52   pl_alabel_r (ch->lp, 0, 'b', buf);
  53
  54   sprintf (buf, "Mean = %.1f", mean);
  55   pl_fmove_r (ch->lp,ch->legend_left,ch->data_bottom + ch->font_size * 1.5);
  56   pl_alabel_r (ch->lp, 0, 'b', buf);
  57
  58   sprintf (buf, "Std. Dev = %.2f", stddev);
  59   pl_fmove_r (ch->lp, ch->legend_left, ch->data_bottom + ch->font_size * 1.5 * 2);
  60   pl_alabel_r (ch->lp, 0, 'b', buf);
  61
  62   pl_restorestate_r (ch->lp);
  63 }
  64
  65 static void hist_draw_bar (struct chart *ch, const struct histogram *hist, int bar);
  66
  67
  68 static void
  69 hist_draw_bar (struct chart *ch, const struct histogram *hist, int bar)
  70 {
  71   if (!ch)
  72     return ;
  73
  74   {
  75     double upper;
  76     double lower;
  77     double height;
  78
  79     const size_t bins = gsl_histogram_bins (hist->gsl_hist);
  80     const double x_pos = (ch->data_right - ch->data_left) * bar / (double) bins ;
  81     const double width = (ch->data_right - ch->data_left) / (double) bins ;
  82
  83     assert ( 0 == gsl_histogram_get_range (hist->gsl_hist, bar, &lower, &upper));
  84
  85     assert ( upper >= lower);
  86
  87     height = gsl_histogram_get (hist->gsl_hist, bar) *
  88      (ch->data_top - ch->data_bottom) / gsl_histogram_max_val (hist->gsl_hist);
  89
  90     pl_savestate_r (ch->lp);
  91     pl_move_r (ch->lp,ch->data_left, ch->data_bottom);
  92     pl_fillcolorname_r (ch->lp, ch->fill_colour);
  93     pl_filltype_r (ch->lp,1);
  94
  95
  96     pl_fboxrel_r (ch->lp,
  97                  x_pos, 0,
  98                  x_pos + width, height);
  99
 100     pl_restorestate_r (ch->lp);
 101
 102     draw_tick (ch, TICK_ABSCISSA,
 103                x_pos + width / 2.0, "%g", (upper + lower) / 2.0);
 104   }
 105 }
 106
 107
 108
 109 void
 110 histogram_plot (const struct histogram *hist,
 111                 const char *label,
 112                 const struct moments1 *m)
 113 {
 114   double mean, var, n;
 115
 116   moments1_calculate (m, &n, &mean, &var, NULL,  NULL);
 117
 118   histogram_plot_n (hist, label, n, mean, sqrt(var), m);
 119 }
 120
 121
 122 /* This function is deprecated.  Don't use it in new code */
 123 void
 124 histogram_plot_n (const struct histogram *hist,
 125                   const char *label,
 126                   double n, double mean, double stddev,
 127                   bool show_normal)
 128 {
 129   int i;
 130   int bins;
 131
 132   struct chart *ch = chart_create ();
 133
 134   chart_write_title (ch, _("HISTOGRAM"));
 135
 136   chart_write_ylabel (ch, _("Frequency"));
 137   chart_write_xlabel (ch, label);
 138
 139   if ( ! hist ) /* If this happens, probably all values are SYSMIS */
 140     {
 141       chart_submit (ch);
 142       return;
 143     }
 144   else
 145     {
 146       bins = gsl_histogram_bins (hist->gsl_hist);
 147     }
 148
 149   chart_write_yscale (ch, 0, gsl_histogram_max_val (hist->gsl_hist), 5);
 150
 151   for ( i = 0 ; i < bins ; ++i )
 152     hist_draw_bar (ch, hist, i);
 153
 154   histogram_write_legend (ch, n, mean, stddev);
 155
 156   if (show_normal)
 157     {
 158       /* Draw the normal curve */
 159
 160       double d ;
 161       double x_min, x_max, not_used ;
 162       double abscissa_scale ;
 163       double ordinate_scale ;
 164       double range ;
 165
 166       gsl_histogram_get_range (hist->gsl_hist, 0, &x_min, &not_used);
 167       range = not_used - x_min;
 168       gsl_histogram_get_range (hist->gsl_hist, bins - 1, &not_used, &x_max);
 169
 170       abscissa_scale = (ch->data_right - ch->data_left) / (x_max - x_min);
 171       ordinate_scale = (ch->data_top - ch->data_bottom) /
 172         gsl_histogram_max_val (hist->gsl_hist) ;
 173
 174       pl_move_r (ch->lp, ch->data_left, ch->data_bottom);
 175       for ( d = ch->data_left;
 176             d <= ch->data_right ;
 177             d += (ch->data_right - ch->data_left) / 100.0)
 178         {
 179           const double x = (d - ch->data_left) / abscissa_scale + x_min ;
 180           const double y = n * range *
 181             gsl_ran_gaussian_pdf (x - mean, stddev);
 182
 183           pl_fcont_r (ch->lp,  d,  ch->data_bottom  + y * ordinate_scale);
 184
 185         }
 186       pl_endpath_r (ch->lp);
 187     }
 188
 189   chart_submit (ch);
 190 }
 191
 192