ebfcd3f107e6984a0a929053000600a6525bb2a9
[pspp-builds.git] / src / plot-hist.c
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 /* If you add/modify any public symbols in this file, don't forget to
21    change the stubs in dummy-chart.c */
22
23 #include <config.h>
24
25 #include <stdio.h>
26 #include <plot.h>
27 #include <math.h>
28 #include <gsl/gsl_histogram.h>
29 #include <gsl/gsl_randist.h>
30 #include <assert.h>
31
32 #include "hash.h"
33
34 #include "var.h"
35 #include "chart.h"
36
37 /* Write the legend of the chart */
38 void
39 histogram_write_legend(struct chart *ch, const struct normal_curve *norm)
40 {
41   char buf[100];
42   pl_savestate_r(ch->lp);
43
44   sprintf(buf,"N = %.2f",norm->N);
45   pl_move_r(ch->lp, ch->legend_left, ch->data_bottom);
46   pl_alabel_r(ch->lp,0,'b',buf);
47
48   sprintf(buf,"Mean = %.1f",norm->mean);
49   pl_fmove_r(ch->lp,ch->legend_left,ch->data_bottom + ch->font_size * 1.5);
50   pl_alabel_r(ch->lp,0,'b',buf);
51
52   sprintf(buf,"Std. Dev = %.2f",norm->stddev);
53   pl_fmove_r(ch->lp,ch->legend_left,ch->data_bottom + ch->font_size * 1.5 * 2);
54   pl_alabel_r(ch->lp,0,'b',buf);
55
56   pl_restorestate_r(ch->lp);    
57 }
58
59 static void hist_draw_bar(struct chart *ch, const gsl_histogram *hist, int bar);
60
61
62 static void
63 hist_draw_bar(struct chart *ch, const gsl_histogram *hist, int bar)
64 {
65   double upper;
66   double lower;
67   double height;
68
69   const size_t bins = gsl_histogram_bins(hist);
70   const double x_pos = (ch->data_right - ch->data_left) * bar / (double) bins ;
71   const double width = (ch->data_right - ch->data_left) / (double) bins ;
72
73
74   assert ( 0 == gsl_histogram_get_range(hist, bar, &lower, &upper));
75
76   assert( upper >= lower);
77
78   height = gsl_histogram_get(hist, bar) * 
79     (ch->data_top - ch->data_bottom) / gsl_histogram_max_val(hist);
80
81   pl_savestate_r(ch->lp);
82   pl_move_r(ch->lp,ch->data_left, ch->data_bottom);
83   pl_fillcolorname_r(ch->lp, ch->fill_colour); 
84   pl_filltype_r(ch->lp,1);
85
86
87   pl_fboxrel_r(ch->lp,
88                x_pos, 0,
89                x_pos + width, height);
90
91   pl_restorestate_r(ch->lp);
92
93   {
94   char buf[5];
95   snprintf(buf,5,"%g",(upper + lower) / 2.0);
96   draw_tick(ch, TICK_ABSCISSA,
97             x_pos + width / 2.0, buf);
98   }
99
100 }
101
102
103
104
105 void
106 histogram_plot(const gsl_histogram *hist,
107                const char *factorname,
108                const struct normal_curve *norm, short show_normal)
109 {
110   int i;
111   int bins;
112   
113   struct chart *ch;
114
115   bins = gsl_histogram_bins(hist);
116
117   ch = chart_create();
118   chart_write_title(ch, _("HISTOGRAM"));
119
120   chart_write_ylabel(ch, _("Frequency"));
121   chart_write_xlabel(ch, factorname);
122
123   chart_write_yscale(ch, 0, gsl_histogram_max_val(hist), 5);
124
125   for ( i = 0 ; i < bins ; ++i ) 
126       hist_draw_bar(ch, hist, i);
127
128   histogram_write_legend(ch, norm);
129
130   if ( show_normal  )
131   {
132     /* Draw the normal curve */    
133
134     double d ;
135     double x_min, x_max, not_used ;
136     double abscissa_scale ;
137     double ordinate_scale ;
138     double range ;
139
140     gsl_histogram_get_range(hist, 0, &x_min, &not_used);
141     range = not_used - x_min;
142     gsl_histogram_get_range(hist, bins - 1, &not_used, &x_max);
143     assert(range == x_max - not_used);
144
145     abscissa_scale = (ch->data_right - ch->data_left) / (x_max - x_min);
146     ordinate_scale = (ch->data_top - ch->data_bottom) / 
147       gsl_histogram_max_val(hist) ;
148
149     pl_move_r(ch->lp, ch->data_left, ch->data_bottom);    
150     for( d = ch->data_left; 
151          d <= ch->data_right ; 
152          d += (ch->data_right - ch->data_left) / 100.0)
153       {    
154         const double x = (d - ch->data_left) / abscissa_scale + x_min ; 
155         const double y = norm->N * range * 
156           gsl_ran_gaussian_pdf(x - norm->mean, norm->stddev);
157
158         pl_fcont_r(ch->lp,  d,  ch->data_bottom  + y * ordinate_scale);
159
160       }
161     pl_endpath_r(ch->lp);
162
163   }
164   chart_submit(ch);
165 }
166