proj/util/apps/hmi_fixCROTA2.c

#include "jsoc.h"
#include "jsoc_main.h"

char *module_name = "hmi_fixCROTA2";

/*
 * This program updates CROTA2 based on results of the 2012 transit of Venus.
 * CROTA2 is corrected by adding either CAM1_DELTA or CAM2_DELTA
 * hmi.lev1 products must have CALVER32 and other procusts must have CALVER64 keywords.
 * CALVER64 or CALVER32 will have the second nibble set to 1.
 * If INST_ROT is present it will be updated.
 * DATE is updated.
 * A HISTORY line is added.
 *
 * call with hmi_fixCROTA2 ds=<seriesname> first=<first_time> last=<last_time>
 *
 * The program will operate on blocks of about 100d, 10d, 1d, or 6h as appropriate for
 * less than 25000 records in a chunk.
 *
 * The program requires (for now) that the first primekey be a slotted TIME.
 *
 * No query arguments other than the time range for each chunk are used.
 *
 * If CALVER32 == -2^31 it will be set to 0xFFFFFFFF prior to other processing.
 * CALVER64 and CALVER32 bit assignments:
 * At present CALVER64 is a string of 16 Hex digits.  It can be divided finer or coarser later as needed.
 * bits 00:03 == HFCORRVR from old lev1, limb height of formation code version number
 * bits 04:07 == CROTA2 version.  Was version 0 since launch, now becomes version 1.
 *
 */

#define DIE(msg) {fflush(stdout);fprintf(stderr,"%s, status=%d\n",msg,status); return(status);}

#define NOTSPECIFIED "Not Specified"

ModuleArgs_t module_args[] =
{
     {ARG_STRING, "ds", NOTSPECIFIED,  "data series to process."},
     {ARG_TIME, "first", NOTSPECIFIED, "first time to process."},
     {ARG_TIME, "last", NOTSPECIFIED, "last time to process."},
     {ARG_END}
};

#define     CAM1_DELTA  (0.0135 - 0.082596) // i.e. change 180.082596 to 180.0135 by adding CAM1_DELTA to INST_ROT and  CROTAT2
#define     CAM2_DELTA  (-0.0702)           // i.e. change 180.0 to 179.9298 by adding CAM1_DELTA to INST_ROT and  CROTAT2
#define     BLOCKSIZE   (4000)             // approx number of records to process in one call, will be rounded down to nice time.
#define     HOUR        (3600)
#define     DAY         (86400)

int DoIt(void)
  {
  int status = DRMS_SUCCESS;
  DRMS_Record_t *inTemplate;
  DRMS_RecordSet_t *inRS, *outRS;
  DRMS_Keyword_t *pkey;
  int irec, nrecs, npkeys;
  const char *dsSeries = params_get_str(&cmdparams, "ds");
  char dsQuery[DRMS_MAXQUERYLEN];
  char *timekeyname;
  TIME t_first = params_get_time(&cmdparams, "first");
  TIME t_last = params_get_time(&cmdparams, "last");
  TIME t_step, t_epoch, t_block, t_start, t_stop;
  int hasCALVER64;
  int hasCALVER32;

  char history[4096];

  // Now find the prime time keyword name
  inTemplate = drms_template_record(drms_env, dsSeries, &status);
  if (status || !inTemplate) DIE("series not found");
  npkeys = inTemplate->seriesinfo->pidx_num;
  timekeyname = NULL;
  if (npkeys > 0)
    {
    int i;
    for (i=0; i<npkeys; i++)
        {
        pkey = inTemplate->seriesinfo->pidx_keywords[i];
        if (pkey->info->recscope > 1)
           pkey = drms_keyword_slotfromindex(pkey);
        if (pkey->info->type != DRMS_TYPE_TIME)
          continue;
        if(i > 0) DIE("Input series must have TIME keyword first, for now...");
        timekeyname = pkey->info->name;
        t_step = drms_keyword_getdouble(drms_keyword_stepfromslot(pkey), &status);
        if (status) DIE("problem getting t_step");
        t_epoch = drms_keyword_getdouble(drms_keyword_epochfromslot(pkey), &status);
        if (status) DIE("problem getting t_epoch");
        break;
        }
    }
  else
    DIE("Must have time prime key");

  hasCALVER64 = drms_keyword_lookup(inTemplate, "CALVER64", 0) != NULL;
  hasCALVER32 = drms_keyword_lookup(inTemplate, "CALVER32", 0) != NULL;

fprintf(stdout,"Series %s hasCALVER32=%d hasCALVER64=%d\n",dsSeries, hasCALVER32, hasCALVER64);
fflush(stdout);

  if (strncmp(dsSeries, "hmi.lev1", 8) && !hasCALVER64)
    DIE("Must have non-linked CALVER64 keyword for products above lev1");

  if (strncmp(dsSeries, "hmi.lev1", 8) == 0 && !hasCALVER32)
    DIE("Must have non-linked CALVER32 keyword for lev1 products");

  t_block = t_step * BLOCKSIZE;
  if (t_block > 100*DAY)
    t_block = 100*DAY;
  else if (t_block > 10*DAY)
    t_block = 10*DAY;
  else if (t_block > DAY)
    t_block = DAY;
  else if (t_block > 6*HOUR)
    t_block = 6*3600;

  for (t_start = t_first; t_start <= t_last; t_start += t_block)
    {
    char first[100], last[100];
    t_stop = t_start + t_block - t_step;
    if (t_stop > t_last)
      t_stop = t_last;
    sprint_time(first, t_start, pkey->info->unit, 0);
    sprint_time(last, t_stop, pkey->info->unit, 0);

    sprintf(dsQuery, "%s[%s-%s]", dsSeries, first, last);
fprintf(stdout,"Query %s ",dsQuery);
fflush(stdout);
    
    inRS = drms_open_records(drms_env, dsQuery, &status);
    nrecs = inRS->n;
    if (status || nrecs == 0)
      {
      fprintf(stdout, " status=%d, no records found, skip this block\n",status);
      fflush(stdout);
      continue;
      }
  
    outRS = drms_clone_records_nosums(inRS, DRMS_PERMANENT, DRMS_SHARE_SEGMENTS, &status);
    nrecs = outRS->n;
    if (status || nrecs == 0)
      DIE("No records cloned");
    drms_close_records(inRS, DRMS_FREE_RECORD);
  
    for (irec=0; irec<nrecs; irec++)
      {
      DRMS_Record_t *rec = outRS->records[irec]; 
      double inst_rot, crota2; 
      unsigned long long calver64 = 0;
      unsigned int calver32 = 0;
      int quality, camera, instrot_status;

      quality = drms_getkey_int(rec, "QUALITY", &status);
      // if (!status && quality < 0)
        // continue;

      if (hasCALVER64)
        {
        calver64 = (unsigned long long)drms_getkey_longlong(rec, "CALVER64", NULL);
        if ((calver64 & 0xF0) != 0)
          {
          fprintf(stdout, "Record previously processed, skip, first=%s, irec=%d\n", first, irec);
          fflush(stdout);
          continue;
          }
        }
      else if (hasCALVER32)
        {
        calver32 = (unsigned int)drms_getkey_int(rec, "CALVER32", NULL);
        if ((calver32 & 0xF0) != 0)
          {
          fprintf(stdout, "Record previously processed, skip, first=%s, irec=%d\n", first, irec);
          fflush(stdout);
          continue;
          }
        }

      inst_rot = drms_getkey_double(rec, "INST_ROT", &instrot_status);
      camera = drms_getkey_int(rec, "CAMERA", NULL);
      crota2 = drms_getkey_double(rec, "CROTA2", NULL);

      // The action is all between here and the end of the irec loop
      if (camera == 1)
        {
        crota2 += CAM1_DELTA;
        inst_rot += CAM1_DELTA;
        sprintf(history, "CROTA2 corrected by adding %6.4f degrees", CAM1_DELTA);
        }
      else
        {
        crota2 += CAM2_DELTA;
        inst_rot += CAM2_DELTA;
        sprintf(history, "CROTA2 corrected by adding %6.4f degrees", CAM2_DELTA);
        }
      
      if (hasCALVER64)
        {
        calver64 &= 0xFFFFFFFFFFFFFF0F;
        calver64 |= 0x0000000000000010;
        drms_setkey_longlong(rec, "CALVER64", calver64);
        }
      if (hasCALVER32)
        {
        if (calver32 == 0x80000000)
          calver32 = 0xFFFFFFFF;
        calver32 &= 0xFFFFFF0F;
        calver32 |= 0x00000010;
        drms_setkey_int(rec, "CALVER32", calver32);
        }

      if (!instrot_status)
        drms_setkey_double(rec, "INST_ROT", inst_rot);
      drms_setkey_double(rec, "CROTA2", crota2);
      drms_appendhistory(rec, history, 1);
      drms_setkey_time(rec, "DATE", CURRENT_SYSTEM_TIME);
      } //end of "irec" loop
  
    if (drms_close_records(outRS, DRMS_INSERT_RECORD))
      fprintf(stderr, "drms_close_records failure for first=%s\n", first);

    fprintf(stdout, "%s CROTA2 fixed for %s through %s\n", dsSeries, first, last);
    fflush(stdout);
    } // end of time chunk loop

  return (DRMS_SUCCESS);
  } // end of DoIt

---