compass-calibration.c

   1 /*
   2  * Copyright (C) 2014 Intel Corporation.
   3  */
   4
   5 #include <errno.h>
   6 #include <fcntl.h>
   7 #include <math.h>
   8 #include <hardware/sensors.h>
   9 #include <sys/stat.h>
  10 #include <string.h>
  11 #include <utils/Log.h>
  12 #include "calibration.h"
  13 #include "matrix-ops.h"
  14 #include "description.h"
  15
  16 #ifdef DBG_RAW_DATA
  17 #define MAX_RAW_DATA_COUNT 2000
  18 static FILE *raw_data = NULL;
  19 static FILE *raw_data_selected = NULL;
  20 static int raw_data_count = 0;
  21 int file_no = 0;
  22 #endif
  23
  24 /* We'll have multiple calibration levels
  25 *  so that we can provide an estimation as fast as possible
  26 */
  27 static const float min_diffs[CAL_STEPS] =  { 0.2, 0.4, 0.6, 1.0 };
  28 static const float max_sqr_errs[CAL_STEPS] = { 10.0, 8.0, 5.0, 3.5 };
  29 static const unsigned int lookback_counts[CAL_STEPS] = { 3, 4, 5, 6 };
  30
  31 /* reset calibration algorithm */
  32 static void reset_sample (struct compass_cal* data)
  33 {
  34     int i,j;
  35     data->sample_count = 0;
  36     for (i = 0; i < DS_SIZE; i++)
  37         for (j=0; j < 3; j++)
  38             data->sample[i][j] = 0;
  39 }
  40
  41 static double calc_square_err (struct compass_cal* data)
  42 {
  43     double err = 0;
  44     double raw[3][1], result[3][1], mat_diff[3][1];
  45     int i;
  46
  47     for (i = 0; i < DS_SIZE; i++) {
  48         raw[0][0] = data->sample[i][0];
  49         raw[1][0] = data->sample[i][1];
  50         raw[2][0] = data->sample[i][2];
  51
  52         substract (3, 1, raw, data->offset, mat_diff);
  53         multiply(3, 3, 1, data->w_invert, mat_diff, result);
  54
  55         double diff = sqrt(result[0][0] * result[0][0] + result[1][0] * result[1][0]
  56              + result[2][0] * result[2][0]) - data->bfield;
  57
  58         err += diff * diff;
  59     }
  60     err /= DS_SIZE;
  61     return err;
  62 }
  63
  64 // Given an real symmetric 3x3 matrix A, compute the eigenvalues
  65 static void compute_eigenvalues(double mat[3][3], double* eig1, double* eig2, double* eig3)
  66 {
  67     double p = mat[0][1] * mat[0][1] + mat[0][2] * mat[0][2] + mat[1][2] * mat[1][2];
  68
  69     if (p < EPSILON) {
  70         *eig1 = mat[0][0];
  71         *eig2 = mat[1][1];
  72         *eig3 = mat[2][2];
  73         return;
  74     }
  75
  76     double q = (mat[0][0] + mat[1][1] + mat[2][2]) / 3;
  77     double temp1 = mat[0][0] - q;
  78     double temp2 = mat[1][1] - q;
  79     double temp3 = mat[2][2] - q;
  80
  81     p = temp1 * temp1 + temp2 * temp2 + temp3 * temp3 + 2 * p;
  82     p = sqrt(p / 6);
  83
  84     double mat2[3][3];
  85     assign(3, 3, mat, mat2);
  86     mat2[0][0] -= q;
  87     mat2[1][1] -= q;
  88     mat2[2][2] -= q;
  89     multiply_scalar_inplace(3, 3, mat2, 1/p);
  90
  91     double r = (mat2[0][0] * mat2[1][1] * mat2[2][2] + mat2[0][1] * mat2[1][2] * mat2[2][0]
  92         + mat2[0][2] * mat2[1][0] * mat2[2][1] - mat2[0][2] * mat2[1][1] * mat2[2][0]
  93         - mat2[0][0] * mat2[1][2] * mat2[2][1] - mat2[0][1] * mat2[1][0] * mat2[2][2]) / 2;
  94
  95     double phi;
  96     if (r <= -1.0)
  97         phi = M_PI/3;
  98     else if (r >= 1.0)
  99         phi = 0;
 100     else
 101         phi = acos(r) / 3;
 102
 103     *eig3 = q + 2 * p * cos(phi);
 104     *eig1 = q + 2 * p * cos(phi + 2 * M_PI / 3);
 105     *eig2 = 3 * q - *eig1 - *eig3;
 106 }
 107
 108 static void calc_evector(double mat[3][3], double eig, double vec[3][1])
 109 {
 110     double h[3][3];
 111     double x_tmp[2][2];
 112     assign(3, 3, mat, h);
 113     h[0][0] -= eig;
 114     h[1][1] -= eig;
 115     h[2][2] -= eig;
 116
 117     double x[2][2];
 118     x[0][0] = h[1][1];
 119     x[0][1] = h[1][2];
 120     x[1][0] = h[2][1];
 121     x[1][1] = h[2][2];
 122     invert(2, x, x_tmp);
 123     assign(2, 2, x_tmp, x);
 124
 125     double temp1 = x[0][0] * (-h[1][0]) + x[0][1] * (-h[2][0]);
 126     double temp2 = x[1][0] * (-h[1][0]) + x[1][1] * (-h[2][0]);
 127     double norm = sqrt(1 + temp1 * temp1 + temp2 * temp2);
 128
 129     vec[0][0] = 1.0 / norm;
 130     vec[1][0] = temp1 / norm;
 131     vec[2][0] = temp2 / norm;
 132 }
 133
 134 static int ellipsoid_fit (mat_input_t m, double offset[3][1], double w_invert[3][3], double* bfield)
 135 {
 136     int i;
 137     double h[DS_SIZE][9];
 138     double w[DS_SIZE][1];
 139     double h_trans[9][DS_SIZE];
 140     double p_temp1[9][9];
 141     double p_temp2[9][DS_SIZE];
 142     double temp1[3][3], temp[3][3];
 143     double temp1_inv[3][3];
 144     double temp2[3][1];
 145     double result[9][9];
 146     double p[9][1];
 147     double a[3][3], sqrt_evals[3][3], evecs[3][3], evecs_trans[3][3];
 148     double evec1[3][1], evec2[3][1], evec3[3][1];
 149
 150     for (i = 0; i < DS_SIZE; i++) {
 151         w[i][0] = m[i][0] * m[i][0];
 152         h[i][0] = m[i][0];
 153         h[i][1] = m[i][1];
 154         h[i][2] = m[i][2];
 155         h[i][3] = -1 * m[i][0] * m[i][1];
 156         h[i][4] = -1 * m[i][0] * m[i][2];
 157         h[i][5] = -1 * m[i][1] * m[i][2];
 158         h[i][6] = -1 * m[i][1] * m[i][1];
 159         h[i][7] = -1 * m[i][2] * m[i][2];
 160         h[i][8] = 1;
 161     }
 162     transpose (DS_SIZE, 9, h, h_trans);
 163     multiply (9, DS_SIZE, 9, h_trans, h, result);
 164     invert (9, result, p_temp1);
 165     multiply (9, 9, DS_SIZE, p_temp1, h_trans, p_temp2);
 166     multiply (9, DS_SIZE, 1, p_temp2, w, p);
 167
 168     temp1[0][0] = 2;
 169     temp1[0][1] = p[3][0];
 170     temp1[0][2] = p[4][0];
 171     temp1[1][0] = p[3][0];
 172     temp1[1][1] = 2 * p[6][0];
 173     temp1[1][2] = p[5][0];
 174     temp1[2][0] = p[4][0];
 175     temp1[2][1] = p[5][0];
 176     temp1[2][2] = 2 * p[7][0];
 177
 178     temp2[0][0] = p[0][0];
 179     temp2[1][0] = p[1][0];
 180     temp2[2][0] = p[2][0];
 181
 182     invert(3, temp1, temp1_inv);
 183     multiply(3, 3, 1, temp1_inv, temp2, offset);
 184     double off_x = offset[0][0];
 185     double off_y = offset[1][0];
 186     double off_z = offset[2][0];
 187
 188
 189     a[0][0] = 1.0 / (p[8][0] + off_x * off_x + p[6][0] * off_y * off_y
 190             + p[7][0] * off_z * off_z + p[3][0] * off_x * off_y
 191             + p[4][0] * off_x * off_z + p[5][0] * off_y * off_z);
 192
 193     a[0][1] = p[3][0] * a[0][0] / 2;
 194     a[0][2] = p[4][0] * a[0][0] / 2;
 195     a[1][2] = p[5][0] * a[0][0] / 2;
 196     a[1][1] = p[6][0] * a[0][0];
 197     a[2][2] = p[7][0] * a[0][0];
 198     a[2][1] = a[1][2];
 199     a[1][0] = a[0][1];
 200     a[2][0] = a[0][2];
 201
 202     double eig1 = 0, eig2 = 0, eig3 = 0;
 203     compute_eigenvalues(a, &eig1, &eig2, &eig3);
 204
 205     sqrt_evals[0][0] = sqrt(eig1);
 206     sqrt_evals[1][0] = 0;
 207     sqrt_evals[2][0] = 0;
 208     sqrt_evals[0][1] = 0;
 209     sqrt_evals[1][1] = sqrt(eig2);
 210     sqrt_evals[2][1] = 0;
 211     sqrt_evals[0][2] = 0;
 212     sqrt_evals[1][2] = 0;
 213     sqrt_evals[2][2] = sqrt(eig3);
 214
 215     calc_evector(a, eig1, evec1);
 216     calc_evector(a, eig2, evec2);
 217     calc_evector(a, eig3, evec3);
 218
 219     evecs[0][0] = evec1[0][0];
 220     evecs[1][0] = evec1[1][0];
 221     evecs[2][0] = evec1[2][0];
 222     evecs[0][1] = evec2[0][0];
 223     evecs[1][1] = evec2[1][0];
 224     evecs[2][1] = evec2[2][0];
 225     evecs[0][2] = evec3[0][0];
 226     evecs[1][2] = evec3[1][0];
 227     evecs[2][2] = evec3[2][0];
 228
 229     multiply (3, 3, 3, evecs, sqrt_evals, temp1);
 230     transpose(3, 3, evecs, evecs_trans);
 231     multiply (3, 3, 3, temp1, evecs_trans, temp);
 232     transpose (3, 3, temp, w_invert);
 233     *bfield = pow(sqrt(1/eig1) * sqrt(1/eig2) * sqrt(1/eig3), 1.0/3.0);
 234     multiply_scalar_inplace(3, 3, w_invert, *bfield);
 235
 236     return 1;
 237 }
 238
 239 static void compass_cal_init (FILE* data_file, struct sensor_info_t* info)
 240 {
 241
 242 #ifdef DBG_RAW_DATA
 243     if (raw_data) {
 244         fclose(raw_data);
 245         raw_data = NULL;
 246     }
 247
 248     if (raw_data_selected) {
 249         fclose(raw_data_selected);
 250         raw_data_selected = NULL;
 251     }
 252
 253     char path[64];
 254     snprintf(path, 64, RAW_DATA_FULL_PATH, file_no);
 255     raw_data = fopen(path,"w+");
 256     snprintf(path, 64, RAW_DATA_SELECTED_PATH, file_no);
 257     raw_data_selected = fopen(path,"w+");
 258     file_no++;
 259     raw_data_count = 0;
 260 #endif
 261
 262     struct compass_cal* cal_data = (struct compass_cal*) info->cal_data;
 263
 264     if (cal_data == NULL)
 265         return;
 266
 267     int data_count = 14;
 268     reset_sample(cal_data);
 269
 270     if (!info->cal_level && data_file != NULL) {
 271        int ret = fscanf(data_file, "%d %lf %lf %lf %lf %lf %lf %lf %lf %lf %lf %lf %lf %lf",
 272             &info->cal_level, &cal_data->offset[0][0], &cal_data->offset[1][0], &cal_data->offset[2][0],
 273             &cal_data->w_invert[0][0], &cal_data->w_invert[0][1], &cal_data->w_invert[0][2],
 274             &cal_data->w_invert[1][0], &cal_data->w_invert[1][1], &cal_data->w_invert[1][2],
 275             &cal_data->w_invert[2][0], &cal_data->w_invert[2][1], &cal_data->w_invert[2][2],
 276             &cal_data->bfield);
 277
 278         if (ret != data_count) {
 279             info->cal_level = 0;
 280         }
 281     }
 282
 283     if (info->cal_level) {
 284         ALOGV("CompassCalibration: load old data, caldata: %f %f %f %f %f %f %f %f %f %f %f %f %f",
 285             cal_data->offset[0][0], cal_data->offset[1][0], cal_data->offset[2][0],
 286             cal_data->w_invert[0][0], cal_data->w_invert[0][1], cal_data->w_invert[0][2], cal_data->w_invert[1][0],
 287             cal_data->w_invert[1][1], cal_data->w_invert[1][2], cal_data->w_invert[2][0], cal_data->w_invert[2][1],
 288             cal_data->w_invert[2][2], cal_data->bfield);
 289
 290     } else {
 291         cal_data->offset[0][0] = 0;
 292         cal_data->offset[1][0] = 0;
 293         cal_data->offset[2][0] = 0;
 294
 295         cal_data->w_invert[0][0] = 1;
 296         cal_data->w_invert[1][0] = 0;
 297         cal_data->w_invert[2][0] = 0;
 298         cal_data->w_invert[0][1] = 0;
 299         cal_data->w_invert[1][1] = 1;
 300         cal_data->w_invert[2][1] = 0;
 301         cal_data->w_invert[0][2] = 0;
 302         cal_data->w_invert[1][2] = 0;
 303         cal_data->w_invert[2][2] = 1;
 304
 305         cal_data->bfield = 0;
 306     }
 307
 308 }
 309
 310 static void compass_store_result(FILE* data_file, struct sensor_info_t* info)
 311 {
 312     struct compass_cal* cal_data = (struct compass_cal*) info->cal_data;
 313
 314     if (data_file == NULL || cal_data == NULL)
 315         return;
 316
 317     int ret = fprintf(data_file, "%d %f %f %f %f %f %f %f %f %f %f %f %f %f\n",
 318         info->cal_level, cal_data->offset[0][0], cal_data->offset[1][0], cal_data->offset[2][0],
 319         cal_data->w_invert[0][0], cal_data->w_invert[0][1], cal_data->w_invert[0][2],
 320         cal_data->w_invert[1][0], cal_data->w_invert[1][1], cal_data->w_invert[1][2],
 321         cal_data->w_invert[2][0], cal_data->w_invert[2][1], cal_data->w_invert[2][2],
 322         cal_data->bfield);
 323
 324     if (ret < 0)
 325         ALOGE ("compass calibration - store data failed!");
 326 }
 327
 328 static int compass_collect (struct sensors_event_t* event, struct sensor_info_t* info, int64_t current_time)
 329 {
 330     float data[3] = {event->magnetic.x, event->magnetic.y, event->magnetic.z};
 331     unsigned int index,j;
 332     unsigned int lookback_count;
 333     float min_diff;
 334
 335     struct compass_cal* cal_data = (struct compass_cal*) info->cal_data;
 336
 337     if (cal_data == NULL)
 338         return -1;
 339
 340     /* Discard the point if not valid */
 341     if (data[0] == 0 && data[1] == 0 && data[2] == 0)
 342         return -1;
 343
 344 #ifdef DBG_RAW_DATA
 345     if (raw_data && raw_data_count < MAX_RAW_DATA_COUNT) {
 346         fprintf(raw_data, "%f %f %f\n", (double)data[0], (double)data[1],
 347                  (double)data[2]);
 348         raw_data_count++;
 349     }
 350
 351     if (raw_data && raw_data_count >= MAX_RAW_DATA_COUNT) {
 352         fclose(raw_data);
 353         raw_data = NULL;
 354     }
 355 #endif
 356
 357     lookback_count = lookback_counts[info->cal_level];
 358     min_diff = min_diffs[info->cal_level];
 359
 360     // For the current point to be accepted, each x/y/z value must be different enough
 361     // to the last several collected points
 362     if (cal_data->sample_count > 0 && cal_data->sample_count < DS_SIZE) {
 363         unsigned int lookback = lookback_count < cal_data->sample_count ? lookback_count :
 364                         cal_data->sample_count;
 365         for (index = 0; index < lookback; index++){
 366             for (j = 0; j < 3; j++) {
 367                 if (fabsf(data[j] - cal_data->sample[cal_data->sample_count-1-index][j]) < min_diff) {
 368                     ALOGV("CompassCalibration:point reject: [%f,%f,%f], selected_count=%d",
 369                        data[0], data[1], data[2], cal_data->sample_count);
 370                        return 0;
 371                 }
 372             }
 373         }
 374     }
 375
 376     if (cal_data->sample_count < DS_SIZE) {
 377         memcpy(cal_data->sample[cal_data->sample_count], data, sizeof(float) * 3);
 378         cal_data->sample_count++;
 379         ALOGV("CompassCalibration:point collected [%f,%f,%f], selected_count=%d",
 380             (double)data[0], (double)data[1], (double)data[2], cal_data->sample_count);
 381 #ifdef DBG_RAW_DATA
 382         if (raw_data_selected) {
 383             fprintf(raw_data_selected, "%f %f %f\n", (double)data[0], (double)data[1], (double)data[2]);
 384         }
 385 #endif
 386     }
 387     return 1;
 388 }
 389
 390 static void compass_compute_cal (struct sensors_event_t* event, struct sensor_info_t* info)
 391 {
 392     struct compass_cal* cal_data = (struct compass_cal*) info->cal_data;
 393     float sqr_norm = 0;
 394     float sanity_norm = 0;
 395     float scale = 1;
 396
 397     if (!info->cal_level || cal_data == NULL)
 398         return;
 399
 400     double result[3][1], raw[3][1], diff[3][1];
 401
 402     raw[0][0] = event->magnetic.x;
 403     raw[1][0] = event->magnetic.y;
 404     raw[2][0] = event->magnetic.z;
 405
 406     substract(3, 1, raw, cal_data->offset, diff);
 407     multiply (3, 3, 1, cal_data->w_invert, diff, result);
 408
 409     sqr_norm = (result[0][0] * result[0][0] +
 410                 result[1][0] * result[1][0] +
 411                 result[2][0] * result[2][0]);
 412
 413     sanity_norm = (sqr_norm < MAGNETIC_LOW) ?  MAGNETIC_LOW : sanity_norm;
 414     sanity_norm = (sqr_norm > MAGNETIC_HIGH) ? MAGNETIC_HIGH : sanity_norm;
 415
 416     if (sanity_norm) {
 417         scale = sanity_norm / sqr_norm;
 418         scale = sqrt(scale);
 419         result[0][0] = result[0][0] * scale;
 420         result[1][0] = result[1][0] * scale;
 421         result[2][0] = result[2][0] * scale;
 422     }
 423
 424     event->magnetic.x = event->data[0] = result[0][0];
 425     event->magnetic.y = event->data[1] = result[1][0];
 426     event->magnetic.z = event->data[2] = result[2][0];
 427 }
 428
 429
 430 static int compass_ready (struct sensor_info_t* info)
 431 {
 432     mat_input_t mat;
 433     int i;
 434     float max_sqr_err;
 435
 436     struct compass_cal* cal_data = (struct compass_cal*) info->cal_data;
 437
 438     if (cal_data->sample_count < DS_SIZE)
 439         return info->cal_level;
 440
 441     max_sqr_err = max_sqr_errs[info->cal_level];
 442
 443     /* enough points have been collected, do the ellipsoid calibration */
 444     for (i = 0; i < DS_SIZE; i++) {
 445        mat[i][0] = cal_data->sample[i][0];
 446        mat[i][1] = cal_data->sample[i][1];
 447        mat[i][2] = cal_data->sample[i][2];
 448     }
 449
 450     /* check if result is good */
 451     struct compass_cal new_cal_data;
 452     /* the sample data must remain the same */
 453     new_cal_data = *cal_data;
 454     if (ellipsoid_fit(mat, new_cal_data.offset, new_cal_data.w_invert, &new_cal_data.bfield)) {
 455         double new_err = calc_square_err (&new_cal_data);
 456         ALOGI("new err is %f, max sqr err id %f", new_err,max_sqr_err);
 457         if (new_err < max_sqr_err) {
 458             double err = calc_square_err(cal_data);
 459             if (new_err < err) {
 460                 /* new cal data is better, so we switch to the new */
 461                 memcpy(cal_data->offset, new_cal_data.offset, sizeof(cal_data->offset));
 462                 memcpy(cal_data->w_invert, new_cal_data.w_invert, sizeof(cal_data->w_invert));
 463                 cal_data->bfield = new_cal_data.bfield;
 464                 if (info->cal_level < (CAL_STEPS - 1))
 465                     info->cal_level++;
 466                 ALOGV("CompassCalibration: ready check success, caldata: %f %f %f %f %f %f %f %f %f %f %f %f %f, err %f",
 467                     cal_data->offset[0][0], cal_data->offset[1][0], cal_data->offset[2][0], cal_data->w_invert[0][0],
 468                     cal_data->w_invert[0][1], cal_data->w_invert[0][2], cal_data->w_invert[1][0], cal_data->w_invert[1][1],
 469                     cal_data->w_invert[1][2], cal_data->w_invert[2][0], cal_data->w_invert[2][1], cal_data->w_invert[2][2],
 470                     cal_data->bfield, new_err);
 471             }
 472         }
 473     }
 474     reset_sample(cal_data);
 475     return info->cal_level;
 476 }
 477
 478 void calibrate_compass (struct sensors_event_t* event, struct sensor_info_t* info, int64_t current_time)
 479 {
 480     long current_time_ms = current_time / 1000000;
 481     int cal_level;
 482
 483     /* Calibration is continuous */
 484     compass_collect (event, info, current_time_ms);
 485
 486     cal_level = compass_ready(info);
 487
 488     switch (cal_level) {
 489
 490         case 0:
 491             event->magnetic.status = SENSOR_STATUS_UNRELIABLE;
 492             break;
 493
 494         case 1:
 495             compass_compute_cal (event, info);
 496             event->magnetic.status = SENSOR_STATUS_ACCURACY_LOW;
 497             break;
 498
 499         case 2:
 500             compass_compute_cal (event, info);
 501             event->magnetic.status = SENSOR_STATUS_ACCURACY_MEDIUM;
 502             break;
 503
 504         default:
 505             compass_compute_cal (event, info);
 506             event->magnetic.status = SENSOR_STATUS_ACCURACY_HIGH;
 507             break;
 508     }
 509 }
 510
 511 void compass_read_data (struct sensor_info_t* info)
 512 {
 513     FILE* data_file = fopen (COMPASS_CALIBRATION_PATH, "r");
 514
 515     compass_cal_init(data_file, info);
 516     if (data_file)
 517         fclose(data_file);
 518 }
 519
 520 void compass_store_data (struct sensor_info_t* info)
 521 {
 522     FILE* data_file = fopen (COMPASS_CALIBRATION_PATH, "w");
 523
 524     compass_store_result(data_file, info);
 525     if (data_file)
 526         fclose(data_file);
 527
 528 }