statistics.c

   1 /* statistics.c */
   2 /* creates the UI for the Info & Stats page -
   3  * controlled through the following interfaces:
   4  *
   5  * void show_dive_stats(struct dive *dive)
   6  * void flush_dive_stats_changes(struct dive *dive)
   7  *
   8  * called from gtk-ui:
   9  * GtkWidget *stats_widget(void)
  10  */
  11 #include <stdio.h>
  12 #include <string.h>
  13 #include <stdlib.h>
  14 #include <stdarg.h>
  15 #include <time.h>
  16
  17 #include "dive.h"
  18 #include "display.h"
  19 #include "display-gtk.h"
  20 #include "divelist.h"
  21
  22 typedef struct {
  23         GtkWidget *date,
  24                 *dive_time,
  25                 *surf_intv,
  26                 *max_depth,
  27                 *avg_depth,
  28                 *water_temp,
  29                 *sac,
  30                 *otu,
  31                 *o2he,
  32                 *gas_used;
  33 } single_stat_widget_t;
  34
  35 static single_stat_widget_t single_w;
  36
  37 typedef struct {
  38         GtkWidget *total_time,
  39                 *avg_time,
  40                 *shortest_time,
  41                 *longest_time,
  42                 *max_overall_depth,
  43                 *min_overall_depth,
  44                 *avg_overall_depth,
  45                 *min_sac,
  46                 *avg_sac,
  47                 *max_sac,
  48                 *selection_size,
  49                 *max_temp,
  50                 *avg_temp,
  51                 *min_temp;
  52 } total_stats_widget_t;
  53
  54 static total_stats_widget_t stats_w;
  55
  56 typedef struct {
  57         duration_t total_time;
  58         /* avg_time is simply total_time / nr -- let's not keep this */
  59         duration_t shortest_time;
  60         duration_t longest_time;
  61         depth_t max_depth;
  62         depth_t min_depth;
  63         depth_t avg_depth;
  64         volume_t max_sac;
  65         volume_t min_sac;
  66         volume_t avg_sac;
  67         int max_temp;
  68         int min_temp;
  69         unsigned int combined_temp;
  70         unsigned int combined_count;
  71         unsigned int selection_size;
  72 } stats_t;
  73
  74 static stats_t stats;
  75 static stats_t stats_selection;
  76
  77
  78 static void process_dive(struct dive *dp, stats_t *stats)
  79 {
  80         int old_tt, sac_time = 0;
  81         const char *unit;
  82
  83         old_tt = stats->total_time.seconds;
  84         stats->total_time.seconds += dp->duration.seconds;
  85         if (dp->duration.seconds > stats->longest_time.seconds)
  86                 stats->longest_time.seconds = dp->duration.seconds;
  87         if (stats->shortest_time.seconds == 0 || dp->duration.seconds < stats->shortest_time.seconds)
  88                 stats->shortest_time.seconds = dp->duration.seconds;
  89         if (dp->maxdepth.mm > stats->max_depth.mm)
  90                 stats->max_depth.mm = dp->maxdepth.mm;
  91         if (stats->min_depth.mm == 0 || dp->maxdepth.mm < stats->min_depth.mm)
  92                 stats->min_depth.mm = dp->maxdepth.mm;
  93         stats->avg_depth.mm = (1.0 * old_tt * stats->avg_depth.mm +
  94                         dp->duration.seconds * dp->meandepth.mm) / stats->total_time.seconds;
  95         if (dp->sac > 2800) { /* less than .1 cuft/min (2800ml/min) is bogus */
  96                 int old_sac_time = sac_time;
  97                 sac_time += dp->duration.seconds;
  98                 stats->avg_sac.mliter = (1.0 * old_sac_time * stats->avg_sac.mliter +
  99                                 dp->duration.seconds * dp->sac) / sac_time ;
 100                 if (dp->sac > stats->max_sac.mliter)
 101                         stats->max_sac.mliter = dp->sac;
 102                 if (stats->min_sac.mliter == 0 || dp->sac < stats->min_sac.mliter)
 103                         stats->min_sac.mliter = dp->sac;
 104         }
 105         if (dp->watertemp.mkelvin) {
 106                 if (stats->min_temp == 0 || dp->watertemp.mkelvin < stats->min_temp)
 107                         stats->min_temp = dp->watertemp.mkelvin;
 108                 if (dp->watertemp.mkelvin > stats->max_temp)
 109                         stats->max_temp = dp->watertemp.mkelvin;
 110                 stats->combined_temp += get_temp_units(dp->watertemp.mkelvin, &unit);
 111                 stats->combined_count++;
 112         }
 113 }
 114
 115 static void process_all_dives(struct dive *dive, struct dive **prev_dive)
 116 {
 117         int idx;
 118         struct dive *dp;
 119
 120         *prev_dive = NULL;
 121         memset(&stats, 0, sizeof(stats));
 122         if (dive_table.nr > 0) {
 123                 stats.shortest_time.seconds = dive_table.dives[0]->duration.seconds;
 124                 stats.min_depth.mm = dive_table.dives[0]->maxdepth.mm;
 125                 stats.selection_size = dive_table.nr;
 126         }
 127         /* this relies on the fact that the dives in the dive_table
 128          * are in chronological order */
 129         for (idx = 0; idx < dive_table.nr; idx++) {
 130                 dp = dive_table.dives[idx];
 131                 if (dp->when == dive->when) {
 132                         /* that's the one we are showing */
 133                         if (idx > 0)
 134                                 *prev_dive = dive_table.dives[idx-1];
 135                 }
 136                 process_dive(dp, &stats);
 137         }
 138 }
 139
 140 void process_selected_dives(GList *selected_dives, GtkTreeModel *model)
 141 {
 142         struct dive *dp;
 143         unsigned int i;
 144         GtkTreeIter iter;
 145         GtkTreePath *path;
 146
 147         memset(&stats_selection, 0, sizeof(stats_selection));
 148         stats_selection.selection_size = amount_selected;
 149
 150         for (i = 0; i < amount_selected; ++i) {
 151                 GValue value = {0, };
 152                 path = g_list_nth_data(selected_dives, i);
 153                 if (gtk_tree_model_get_iter(model, &iter, path)) {
 154                         gtk_tree_model_get_value(model, &iter, 0, &value);
 155                         dp = get_dive(g_value_get_int(&value));
 156                 }
 157                 process_dive(dp, &stats_selection);
 158         }
 159 }
 160
 161 static void set_label(GtkWidget *w, const char *fmt, ...)
 162 {
 163         char buf[80];
 164         va_list args;
 165
 166         va_start(args, fmt);
 167         vsnprintf(buf, sizeof(buf), fmt, args);
 168         va_end(args);
 169         gtk_label_set_text(GTK_LABEL(w), buf);
 170 }
 171
 172 static char * get_time_string(int seconds, int maxdays)
 173 {
 174         static char buf[80];
 175         if (maxdays && seconds > 3600 * 24 * maxdays)
 176                 snprintf(buf, sizeof(buf), "more than %d days", maxdays);
 177         else {
 178                 int days = seconds / 3600 / 24;
 179                 int hours = (seconds - days * 3600 * 24) / 3600;
 180                 int minutes = (seconds - days * 3600 * 24 - hours * 3600) / 60;
 181                 if (days > 0)
 182                         snprintf(buf, sizeof(buf), "%dd %dh %dmin", days, hours, minutes);
 183                 else
 184                         snprintf(buf, sizeof(buf), "%dh %dmin", hours, minutes);
 185         }
 186         return buf;
 187 }
 188
 189 static void show_single_dive_stats(struct dive *dive)
 190 {
 191         char buf[80];
 192         double value;
 193         int decimals;
 194         const char *unit;
 195         int idx, offset, gas_used;
 196         struct dive *prev_dive;
 197         struct tm *tm;
 198
 199         process_all_dives(dive, &prev_dive);
 200
 201         tm = gmtime(&dive->when);
 202         snprintf(buf, sizeof(buf),
 203                 "%s, %s %d, %d %2d:%02d",
 204                 weekday(tm->tm_wday),
 205                 monthname(tm->tm_mon),
 206                 tm->tm_mday, tm->tm_year + 1900,
 207                 tm->tm_hour, tm->tm_min);
 208
 209         set_label(single_w.date, buf);
 210         set_label(single_w.dive_time, "%d min", (dive->duration.seconds + 30) / 60);
 211         if (prev_dive)
 212                 set_label(single_w.surf_intv,
 213                         get_time_string(dive->when - (prev_dive->when + prev_dive->duration.seconds), 4));
 214         else
 215                 set_label(single_w.surf_intv, "unknown");
 216         value = get_depth_units(dive->maxdepth.mm, &decimals, &unit);
 217         set_label(single_w.max_depth, "%.*f %s", decimals, value, unit);
 218         value = get_depth_units(dive->meandepth.mm, &decimals, &unit);
 219         set_label(single_w.avg_depth, "%.*f %s", decimals, value, unit);
 220         if (dive->watertemp.mkelvin) {
 221                 value = get_temp_units(dive->watertemp.mkelvin, &unit);
 222                 set_label(single_w.water_temp, "%.1f %s", value, unit);
 223         } else
 224                 set_label(single_w.water_temp, "");
 225         value = get_volume_units(dive->sac, &decimals, &unit);
 226         if (value > 0) {
 227                 set_label(single_w.sac, "%.*f %s/min", decimals, value, unit);
 228         } else
 229                 set_label(single_w.sac, "");
 230         set_label(single_w.otu, "%d", dive->otu);
 231         offset = 0;
 232         gas_used = 0;
 233         buf[0] = '\0';
 234         /* for the O2/He readings just create a list of them */
 235         for (idx = 0; idx < MAX_CYLINDERS; idx++) {
 236                 cylinder_t *cyl = &dive->cylinder[idx];
 237                 unsigned int start, end;
 238
 239                 start = cyl->start.mbar ? : cyl->sample_start.mbar;
 240                 end = cyl->end.mbar ? : cyl->sample_end.mbar;
 241                 if (!cylinder_none(cyl)) {
 242                         /* 0% O2 strangely means air, so 21% - I don't like that at all */
 243                         int o2 = cyl->gasmix.o2.permille ? : AIR_PERMILLE;
 244                         if (offset > 0) {
 245                                 snprintf(buf+offset, 80-offset, ", ");
 246                                 offset += 2;
 247                         }
 248                         snprintf(buf+offset, 80-offset, "%d/%d", (o2 + 5) / 10,
 249                                 (cyl->gasmix.he.permille + 5) / 10);
 250                         offset = strlen(buf);
 251                 }
 252                 /* and if we have size, start and end pressure, we can
 253                  * calculate the total gas used */
 254                 if (cyl->type.size.mliter && start && end)
 255                         gas_used += cyl->type.size.mliter / 1000.0 * (start - end);
 256         }
 257         set_label(single_w.o2he, buf);
 258         if (gas_used) {
 259                 value = get_volume_units(gas_used, &decimals, &unit);
 260                 set_label(single_w.gas_used, "%.*f %s", decimals, value, unit);
 261         } else
 262                 set_label(single_w.gas_used, "");
 263 }
 264
 265 static void show_total_dive_stats(struct dive *dive)
 266 {
 267         double value;
 268         int decimals;
 269         const char *unit;
 270         stats_t *stats_ptr;
 271
 272         if (amount_selected < 2)
 273                 stats_ptr = &stats;
 274         else
 275                 stats_ptr = &stats_selection;
 276
 277         set_label(stats_w.selection_size, "%d", stats_ptr->selection_size);
 278         if (stats_ptr->min_temp) {
 279                 value = get_temp_units(stats_ptr->min_temp, &unit);
 280                 set_label(stats_w.min_temp, "%.1f %s", value, unit);
 281         }
 282         if (stats_ptr->combined_temp && stats_ptr->combined_count)
 283                 set_label(stats_w.avg_temp, "%.1f %s", stats_ptr->combined_temp / (stats_ptr->combined_count * 1.0), unit);
 284         if (stats_ptr->max_temp) {
 285                 value = get_temp_units(stats_ptr->max_temp, &unit);
 286                 set_label(stats_w.max_temp, "%.1f %s", value, unit);
 287         }
 288         set_label(stats_w.total_time, get_time_string(stats_ptr->total_time.seconds, 0));
 289         set_label(stats_w.avg_time, get_time_string(stats_ptr->total_time.seconds / stats_ptr->selection_size, 0));
 290         set_label(stats_w.longest_time, get_time_string(stats_ptr->longest_time.seconds, 0));
 291         set_label(stats_w.shortest_time, get_time_string(stats_ptr->shortest_time.seconds, 0));
 292         value = get_depth_units(stats_ptr->max_depth.mm, &decimals, &unit);
 293         set_label(stats_w.max_overall_depth, "%.*f %s", decimals, value, unit);
 294         value = get_depth_units(stats_ptr->min_depth.mm, &decimals, &unit);
 295         set_label(stats_w.min_overall_depth, "%.*f %s", decimals, value, unit);
 296         value = get_depth_units(stats_ptr->avg_depth.mm, &decimals, &unit);
 297         set_label(stats_w.avg_overall_depth, "%.*f %s", decimals, value, unit);
 298         value = get_volume_units(stats_ptr->max_sac.mliter, &decimals, &unit);
 299         set_label(stats_w.max_sac, "%.*f %s/min", decimals, value, unit);
 300         value = get_volume_units(stats_ptr->min_sac.mliter, &decimals, &unit);
 301         set_label(stats_w.min_sac, "%.*f %s/min", decimals, value, unit);
 302         value = get_volume_units(stats_ptr->avg_sac.mliter, &decimals, &unit);
 303         set_label(stats_w.avg_sac, "%.*f %s/min", decimals, value, unit);
 304 }
 305
 306 void show_dive_stats(struct dive *dive)
 307 {
 308         /* they have to be called in this order, as 'total' depends on
 309          * calculations done in 'single' */
 310         show_single_dive_stats(dive);
 311         show_total_dive_stats(dive);
 312 }
 313
 314 void flush_dive_stats_changes(struct dive *dive)
 315 {
 316         /* We do nothing: we require the "Ok" button press */
 317 }
 318
 319 static GtkWidget *new_info_label_in_frame(GtkWidget *box, const char *label)
 320 {
 321         GtkWidget *label_widget;
 322         GtkWidget *frame;
 323
 324         frame = gtk_frame_new(label);
 325         label_widget = gtk_label_new(NULL);
 326         gtk_box_pack_start(GTK_BOX(box), frame, TRUE, TRUE, 3);
 327         gtk_container_add(GTK_CONTAINER(frame), label_widget);
 328
 329         return label_widget;
 330 }
 331
 332 GtkWidget *total_stats_widget(void)
 333 {
 334         GtkWidget *vbox, *hbox, *statsframe, *framebox;
 335
 336         vbox = gtk_vbox_new(FALSE, 3);
 337
 338         statsframe = gtk_frame_new("Statistics");
 339         gtk_box_pack_start(GTK_BOX(vbox), statsframe, TRUE, FALSE, 3);
 340         framebox = gtk_vbox_new(FALSE, 3);
 341         gtk_container_add(GTK_CONTAINER(statsframe), framebox);
 342
 343         /* first row */
 344         hbox = gtk_hbox_new(FALSE, 3);
 345         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 346         stats_w.selection_size = new_info_label_in_frame(hbox, "Dives");
 347         stats_w.max_temp = new_info_label_in_frame(hbox, "Max Temp");
 348         stats_w.min_temp = new_info_label_in_frame(hbox, "Min Temp");
 349         stats_w.avg_temp = new_info_label_in_frame(hbox, "Avg Temp");
 350
 351         /* second row */
 352         hbox = gtk_hbox_new(FALSE, 3);
 353         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 354
 355         stats_w.total_time = new_info_label_in_frame(hbox, "Total Time");
 356         stats_w.avg_time = new_info_label_in_frame(hbox, "Avg Time");
 357         stats_w.longest_time = new_info_label_in_frame(hbox, "Longest Dive");
 358         stats_w.shortest_time = new_info_label_in_frame(hbox, "Shortest Dive");
 359
 360         /* third row */
 361         hbox = gtk_hbox_new(FALSE, 3);
 362         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 363
 364         stats_w.max_overall_depth = new_info_label_in_frame(hbox, "Max Depth");
 365         stats_w.min_overall_depth = new_info_label_in_frame(hbox, "Min Depth");
 366         stats_w.avg_overall_depth = new_info_label_in_frame(hbox, "Avg Depth");
 367
 368         /* fourth row */
 369         hbox = gtk_hbox_new(FALSE, 3);
 370         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 371
 372         stats_w.max_sac = new_info_label_in_frame(hbox, "Max SAC");
 373         stats_w.min_sac = new_info_label_in_frame(hbox, "Min SAC");
 374         stats_w.avg_sac = new_info_label_in_frame(hbox, "Avg SAC");
 375
 376         return vbox;
 377 }
 378
 379 GtkWidget *single_stats_widget(void)
 380 {
 381         GtkWidget *vbox, *hbox, *infoframe, *framebox;
 382
 383         vbox = gtk_vbox_new(FALSE, 3);
 384
 385         infoframe = gtk_frame_new("Dive Info");
 386         gtk_box_pack_start(GTK_BOX(vbox), infoframe, TRUE, FALSE, 3);
 387         framebox = gtk_vbox_new(FALSE, 3);
 388         gtk_container_add(GTK_CONTAINER(infoframe), framebox);
 389
 390         /* first row */
 391         hbox = gtk_hbox_new(FALSE, 3);
 392         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 393
 394         single_w.date = new_info_label_in_frame(hbox, "Date");
 395         single_w.dive_time = new_info_label_in_frame(hbox, "Dive Time");
 396         single_w.surf_intv = new_info_label_in_frame(hbox, "Surf Intv");
 397
 398         /* second row */
 399         hbox = gtk_hbox_new(FALSE, 3);
 400         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 401
 402         single_w.max_depth = new_info_label_in_frame(hbox, "Max Depth");
 403         single_w.avg_depth = new_info_label_in_frame(hbox, "Avg Depth");
 404         single_w.water_temp = new_info_label_in_frame(hbox, "Water Temp");
 405
 406         /* third row */
 407         hbox = gtk_hbox_new(FALSE, 3);
 408         gtk_box_pack_start(GTK_BOX(framebox), hbox, TRUE, FALSE, 3);
 409
 410         single_w.sac = new_info_label_in_frame(hbox, "SAC");
 411         single_w.otu = new_info_label_in_frame(hbox, "OTU");
 412         single_w.o2he = new_info_label_in_frame(hbox, "O" UTF8_SUBSCRIPT_2 " / He");
 413         single_w.gas_used = new_info_label_in_frame(hbox, "Gas Used");
 414
 415         return vbox;
 416 }