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