/* This small function returns an associative array of pointers to
doubles keyed by station names that are the arrival times read from
the database. Because we are dealing with this db bundle pointer
this is simpler than manipulating the db directly
Author: G Pavlis
*/
Arr *get_arrivals(Dbptr dbbundle)
{
int is, ie;
Arr *a;
double time,*t;
char sta[20];
dbget_range(dbbundle,&is,&ie);
a = newarr(0);
for(dbbundle.record=is;dbbundle.record<ie;++dbbundle.record)
{
if(dbgetv(dbbundle,0,
"sta",sta,
"arrival.time", &time,0) == dbINVALID)
{
elog_complain(0,"dbgetv error reading arrival information from row %d\n",
dbbundle.record);
continue;
}
/* the idea here is to skip this step if an arrival is
already set. This often because only every third trace
or a three-component set yields a unique station name */
if(getarr(a,sta) == NULL)
{
t=malloc(sizeof(double));
if(t==NULL)elog_die(0,"get_arrivals malloc failure for simple double\n");
*t = time;
setarr(a,sta,(void *)t);
}
}
return(a);
}
int grdb_sc_getstachan(Dbptr dbscgr, int record, char *sta, char *chan,
int *nsegs, double *time, double *endtime)
{
Dbptr db;
long is, ie;
if (record >= 0) dbscgr.record = record;
if (dbgetv (dbscgr, 0, "sta", sta, "chan", chan, "bundle", &db, 0) == dbINVALID) {
register_error (0, "grdb_sc_getstachan: dbgetv() error.\n");
return (-1);
}
dbget_range (db, &is, &ie);
*nsegs = (int)(ie - is);
db.record = is;
dbgetv (db, 0, "time", time, 0);
db.record = ie-1;
dbgetv (db, 0, "endtime", endtime, 0);
/* Normal exit. */
return (0);
}
int
main (int argc, char **argv)
{
int c,
verbose = 0,
errflg = 0;
char *dbinname=malloc(1024);
char *dboutname=malloc(1024);
Point *poly;
double lat,lon;
char *auth=strdup("regions2polygon");
char *ptype= strdup("rp");
char *dir=strdup(".");
char *dfile=strdup("polygons");
int ftype=polyFLOAT;
char *name;
int nregions, nvertices;
Tbl *sortkeys, *groupkeys;
Dbptr dbin,dbout,dbi,dbo,dbg,dbb;
int i,from,to,nv;
int vertex;
elog_init ( argc, argv ) ;
while ((c = getopt (argc, argv, "vV")) != -1) {
switch (c) {
case 'v':
verbose++ ;
break;
case 'V':
usage ();
break;
case '?':
errflg++;
break ;
}
}
if ((errflg) || argc < 3)
usage ();
dbinname = argv[optind++];
dboutname= argv[optind++];
if (dbopen(dbinname,"r",&dbin)) {
elog_die(1,"cannot open database %s",dbinname);
}
dbi=dblookup(dbin,0,"regions",0,0);
sortkeys=newtbl(2);
pushtbl(sortkeys,"regname");
pushtbl(sortkeys,"vertex");
groupkeys=newtbl(1);
pushtbl(groupkeys,"regname");
dbi=dbsort(dbi,sortkeys,0,"regions.sorted");
dbg=dbgroup(dbi,groupkeys,0,0);
dbquery(dbg,dbRECORD_COUNT,&nregions);
if (nregions <1) {
elog_die(0,"table regions seems to be empty (or not present)");
}
if (verbose) elog_notify(0,"creating database descriptor %s",dboutname);
if (dbcreate(dboutname,"polygon1.2",0,0,0)) {
elog_die(1,"cannot create database %s",dboutname);
}
dbopen(dboutname,"r+",&dbout);
dbo=dblookup(dbout,0,"polygon",0,0);
for (i=0; i< nregions; i++) {
dbg.record=i;
dbgetv(dbg,0,"regname",name,"bundle",&dbb,0);
dbget_range(dbb,&from,&to);
nvertices= to - from;
if (verbose) elog_notify(0,"%s (%i nvertices)",name,nvertices);
poly=malloc(2 * nvertices * sizeof(double));
nv=0;
for (dbi.record=from; dbi.record<to; dbi.record++) {
dbgetv(dbi,0,
"regname",name,
"vertex",&vertex,
"lat",&lat,"lon",&lon,
0);
poly[nv].lat=lat;
poly[nv].lon=lon;
nv++;
}
writePolygonData(dbo,poly,nv,name,1,0,ptype,auth,dir,dfile,ftype);
free(poly);
}
/*
*/
return 0;
}
int main(int argc, char **argv)
{
char *dbin; /* Input db name */
char *dbout; /* output db name */
Dbptr db; /* input db pointer */
Dbptr dbo; /* base output db pointer */
Dbptr dbv; /* set to view formed by join */
char *pfin=NULL; /* input parameter file */
char *sift_exp; /* sift expression for subset */
int sift = 0; /* default is no sift. */
Tbl *sortkeys;
Tbl *joinkey1, *joinkey2;
/*Pointers to views returned by dbgroup (keyed to origin and event
respectively */
Dbptr dborigin_group;
Tbl *origin_group; /* relation keys used in grouping*/
long nevents;
/* db row variables */
long evid;
long nrows, nrows_raw;
int useold=0;
Pf *pf;
Tbl *ta,*tu;
Tbl *reason_converged, *residual;
Location_options o;
Arr *arr_phase;
int i;
Tbl *converge_history;
Hypocenter h0;
Hypocenter *hypos;
long niterations;
char *vmodel;
int ret_code; /* ggnloc return code */
double **C; /* covariance matrix*/
float emodel[4];
/* entries for S-P feature */
long nbcs;
Arr *badclocks;
/* need global setting of this to handle fixed depth solutions*/
int global_fix_depth;
C=dmatrix(0,3,0,3);
if(argc < 3) usage();
dbin = argv[1];
dbout = argv[2];
for(i=3;i<argc;++i)
{
if(!strcmp(argv[i],"-pf"))
{
++i;
if(i>=argc) usage();
pfin = argv[i];
}
else if(!strcmp(argv[i],"-sift"))
{
++i;
if(i>=argc) usage();
sift_exp = argv[i];
sift = 1;
}
else if(!strcmp(argv[i],"-useold"))
useold = 1;
else
usage();
}
/* set default this way*/
if(pfin == NULL) pfin = strdup("relocate");
/* Initialize the error log and write a version notice */
elog_init (argc, argv) ;
cbanner("Version $Revision$ $Date$\n",
"relocate inputdb outputdb [-pf pf -sift expression -useold]\n",
"Gary Pavlis",
"Indiana University",
"*****@*****.**");
/* Alway join assoc, arrival, and site. We join site
to make sure station table is properly dynamic to account for
time changes. With this setup, the stations can even move
around and this should still work.*/
if(dbopen(dbin,"r",&db) == dbINVALID)
elog_die(1,"Unable to open input database %s\n",dbin);
if(dbopen(dbout,"r+",&dbo) == dbINVALID)
elog_die(1,"Unable to open output database %s\n",dbout);
dbv = dbjoin ( dblookup(db,0,"event",0,0),
dblookup(db,0,"origin",0,0),
0,0,0,0,0);
if(dbv.table == dbINVALID)
elog_die(1,"event->origin join failed\n");
dbv = dbjoin ( dbv, dblookup(db,0,"assoc",0,0),
0,0,0,0,0);
if(dbv.table == dbINVALID)
elog_die(1,"event->origin->assoc join failed\n");
dbv = dbjoin ( dbv, dblookup(db,0,"arrival",0,0),
0,0,0,0,0);
if(dbv.table == dbINVALID)
elog_die(1,"event->origin->assoc->arrival join failed\n");
/* We will explicitly set the keys for this join because it
was found to fail sometimes */
joinkey1 = newtbl(0);
joinkey2 = newtbl(0);
pushtbl(joinkey1,"arrival.sta");
pushtbl(joinkey1,"arrival.time");
pushtbl(joinkey2,"sta");
pushtbl(joinkey2,"ondate::offdate");
dbv = dbjoin ( dbv, dblookup(db,0,"site",0,0),
&joinkey1,&joinkey2,0,0,0);
if(dbv.table == dbINVALID)
elog_die(1,"event->origin->assoc->arrival->site join failed\n");
/* Subset using sift_key if requested */
if(sift)
{
dbv = dbsubset(dbv,sift_exp,0);
if(dbv.record == dbINVALID)
elog_die(1,"dbsubset of %s with expression %s failed\n",
dbin, sift_exp);
}
/* This keeps only the prefered origin records intact */
dbv = dbsubset(dbv,"orid == prefor", 0);
if(dbv.record == dbINVALID)
elog_die(1,"Subset to preferred origin records failed\n");
/* First we have to run a unique key sort in the following order
to remove redundant picks made on multiple channels. We will
issue a warning if the record count changes. */
dbquery(dbv, dbRECORD_COUNT, &nrows_raw);
sortkeys = newtbl(0);
pushtbl(sortkeys,"evid");
pushtbl(sortkeys,"sta");
pushtbl(sortkeys,"phase");
dbv = dbsort(dbv,sortkeys,UNIQUE,0);
dbquery(dbv, dbRECORD_COUNT, &nrows);
if(nrows != nrows_raw)
elog_complain(0,"Input database has duplicate picks of one or more phases on multiple channels\n\
Which picks will be used here is unpredictable\n\
%ld total picks, %ld unique\nContinuing\n", nrows_raw, nrows);
/* This sort is the required one for the grouping that follows*/
sortkeys = newtbl(3);
pushtbl(sortkeys,"evid");
pushtbl(sortkeys,"orid");
pushtbl(sortkeys,"arrival.time");
dbv = dbsort(dbv,sortkeys,0,0);
if(dbv.record == dbINVALID)
elog_die(1,"dbsort on evid,orid,arrival.time failed\n");
/* Set up grouping by events */
origin_group = newtbl(0);
pushtbl(origin_group, "evid");
dborigin_group = dbgroup(dbv, origin_group, "origin_group",1);
if(dborigin_group.record == dbINVALID)
elog_die(1,"dbgroup by origin failed\n");
dbquery(dborigin_group,dbRECORD_COUNT,&nevents);
elog_notify(0,"Attempting to relocate %ld events in subsetted database\n",
nevents);
/* DB is now set up correctly, now we turn to the parameter files */
i = pfread(pfin,&pf);
if(i != 0) elog_die(1,"Pfread error\n");
o = parse_options_pf (pf);
global_fix_depth=o.fix[2];
arr_phase = parse_phase_parameter_file(pf);
vmodel = pfget_string(pf,"velocity_model_name");
/* set up minus phase for bad clock problems */
badclocks = newarr(0);
if(db_badclock_definition(db,pf,badclocks))
elog_complain(0,"Warning: problems in database definitions of bad clock time periods\n");
pfget_badclocks(pf,badclocks);
nbcs = cntarr(badclocks);
if(nbcs>0) fprintf(stdout,"relocate: bad clock feature enabled\n\n");
/* Change by JN to output evid and orid. */
/* fprintf(stdout,"lat lon depth time rms wrms interquartile ndata ndgf iterations\n"); */
fprintf(stdout,"evid orid lat lon depth time rms wrms interquartile ndata ndgf iterations\n");
/* Main loop. We utilize the group views and loop through by
events */
for(dborigin_group.record=0;
dborigin_group.record< nevents;++dborigin_group.record)
{
Dbptr db_bundle; /* db pointer returned from bundle field
of dborigin_group for current event */
Arr *station_table;
Arr *array_table;
long is, ie;
long orid; /* orid assigned relocated event in output db */
if(dbgetv(dborigin_group,0,"evid", &evid,
"bundle", &db_bundle,NULL ) == dbINVALID)
elog_complain(1,"dbgetv error for row %ld of event group\n",
dborigin_group.record);
dbget_range(db_bundle,&is,&ie);
station_table = dbload_station_table(dbv,
is,ie,pf);
array_table = dbload_array_table(dbv,
is,ie,pf);
ta = dbload_arrival_table(dbv,
is,ie,station_table, arr_phase);
tu = dbload_slowness_table(dbv,
is,ie,array_table, arr_phase);
/* this actually sets up the minus phase feature for bad clocks*/
if(nbcs)
{
if(minus_phases_arrival_edit(ta,arr_phase,badclocks))
elog_complain(0,"Warning(relocate): problems in minus_phase_arrival_edit function\n");
}
if(useold)
{
char dtype[2];
h0 = db_load_initial(dbv,is);
/* keep fixed depth if done before.
setting dbv.record here is a bit of
a potential maintenance problem */
dbv.record=is;
dbgetv(dbv,0,"dtype",dtype,NULL );
if( (!strcmp(dtype,"g")) || (!strcmp(dtype,"r")) )
o.fix[2]=1;
}
else
h0 = initial_locate(ta, tu, o, pf);
ret_code = ggnloc(h0,ta,tu,o,
&converge_history,&reason_converged,&residual);
if(ret_code < 0)
{
elog_complain(1,"ggnloc failed to produce a solution\n");
}
else
{
if(ret_code > 0)
elog_complain(1,"%d travel time calculator failures in ggnloc\nSolution ok\n",
ret_code);
niterations = maxtbl(converge_history);
hypos = (Hypocenter *)gettbl(converge_history,
niterations-1);
predicted_errors(*hypos,ta,tu,o,C,emodel);
/* Next 3 calls changed by JN to output evid, orid and number_data */
orid = save_origin(dbv,is,ie,o.fix[3],*hypos,dbo);
evid = save_event(dbv,is,ie,orid,dbo);
fprintf(stdout,"%ld %ld %lf %lf %lf %lf %g %g %g %d %d %ld\n",
evid,
orid,
hypos->lat,hypos->lon,hypos->z,hypos->time,
hypos->rms_raw, hypos->rms_weighted,
hypos->interquartile,
hypos->number_data,
hypos->degrees_of_freedom,
niterations);
save_origerr(orid,*hypos,C,dbo);
save_assoc(dbv,is,ie,orid,vmodel,residual,*hypos,dbo);
/* These save genloc add on tables */
save_emodel(orid,emodel,dbo);
save_predarr(dbo,ta,tu,*hypos,orid,vmodel);
}
o.fix[2]=global_fix_depth;
if(maxtbl(converge_history)>0)freetbl(converge_history,free);
if(maxtbl(reason_converged)>0)freetbl(reason_converged,free);
if(maxtbl(residual)>0)freetbl(residual,free);
destroy_data_tables(tu, ta);
destroy_network_geometry_tables(station_table,array_table);
}
return(0);
}
void main(int argc, char **argv)
{
Dbptr db, dbv, dbge, dbgg;
/*ensemble_mode is primary grouping, grouping_on set if secondary on*/
int ensemble_mode,grouping_on;
Tbl *ensemble_keys;
Tbl *group_keys;
int i;
char *pfi=NULL;
Pf *pf,*pfo_head,*pfo_total;
Tbl *process_list;
int dryrun=0;
char *sift_exp=NULL;
int sift;
/*Attributes listed in require will abort program if missing
passthrough parameters will generate an error message but not
cause the program to abort. Both contain pointers to Attribute_map*/
Tbl *require,*passthrough;
Attribute_map *amap;
FILE *fp;
Tbl *error_list;
char *tag;
int sleep_time;
DB2PFS_verbose=0;
/*crack the command line*/
if(argc<3) usage();
elog_init(argc,argv);
if(dbopen(argv[1],"r",&db)==dbINVALID)
{
elog_complain(0,"dbopen failed on database %s\n",argv[1]);
usage();
}
for(i=3;i<argc;++i)
{
if(!strcmp(argv[i],"-pf"))
{
++i;
if(i>argc) usage();
pfi=argv[i];
}
else if(!strcmp(argv[i],"-V"))
usage();
else if(!strcmp(argv[i],"-v"))
DB2PFS_verbose=1;
else if(!strcmp(argv[i],"-n"))
dryrun=1;
else if(!strcmp(argv[i],"-sift"))
{
++i;
if(i>argc) usage();
sift=1;
sift_exp=argv[i];
}
else
usage();
}
if(!dryrun)
{
fp=fopen(argv[2],"r+");
if(fp==NULL) usage();
}
if(pfi==NULL) pfi=strdup("db2pfstream");
if(pfread(pfi,&pf))
elog_die(0,"Error reading parameter file %s.pf\n",pfi);
sleep_time=pfget_int(pf,"sleep_time");
/* The output view gets a virtual table name that tags the
overall collection of stuff. This comes from the parameter file
to make this program general, BUT it must be coordinated with
the reader code. */
tag = pfget_string(pf,"virtual_table_name");
if(tag==NULL)elog_die(0,"Required parameter (virtual_table_name) missing from parameter file\n");
ensemble_mode = pfget_boolean(pf,"ensemble_mode");
if(ensemble_mode)
{
ensemble_keys=pfget_tbl(pf,"ensemble_keys");
if(ensemble_keys==NULL)
elog_die(0,
"ensemble_mode is on, but no grouping keys defined\nCheck parameter file\n");
group_keys=pfget_tbl(pf,"group_keys");
if(group_keys==NULL)
grouping_on = 0;
else
{
if(maxtbl(group_keys)>0)
grouping_on = 1;
else
grouping_on = 0;
}
}
if(DB2PFS_verbose && ensemble_mode)
{
char sm[128];
char *key;
strcpy(sm,"Defining ensemble with keys: ");
for(i=0;i<maxtbl(ensemble_keys);++i)
{
key=gettbl(ensemble_keys,i);
strcat(sm,key);
}
elog_log(0,"%s\n",sm);
if(grouping_on)
{
strcpy(sm,"Grouping ensemble with keys: ");
for(i=0;i<maxtbl(group_keys);++i)
{
key = gettbl(group_keys,i);
strcat(sm,key);
}
elog_log(0,"%s\n",sm);
}
}
/*This function calls dbprocess using a tbl from pf*/
dbv=dbform_working_view(db,pf,"dbprocess_list");
if(dbv.record==dbINVALID)
elog_die(0,"dbprocess failed: check database and parameter file parameter dbprocess_list\n");
if(sift_exp!=NULL)dbv=dbsubset(dbv,sift_exp,0);
/*Now we form the groupings if needed */
if(ensemble_mode)
{
dbge = dbgroup(dbv,ensemble_keys,"ensemble",1);
if(dbge.record == dbINVALID)
elog_die(0,"dbgroup with ensemble keys failed\n");
if(grouping_on)
{
dbgg = dbgroup(dbv,group_keys,"groups",2);
if(dbgg.record == dbINVALID)
elog_die(0,"dbgroup on secondary grouping keys failed\n");
}
}
/*This builds the maps of which attributes will be saved */
require = pfget_Attribute_map(pf,"require");
if(require==NULL)
elog_die(0,"Error in parameter file for parameter require\n");
passthrough = pfget_Attribute_map(pf,"passthrough");
if(passthrough==NULL)
elog_die(0,"Error in parameter file for parameter passthrough\n");
/* Unfortunately, we have two different loops for ensemble mode
and single object mode */
if(ensemble_mode)
{
int number_ensembles;
Dbptr db_bundle_1;
Dbptr db_bundle_2;
int is_ensemble, ie_ensemble;
int isg, ieg;
int number_groups;
pfo_head=pfnew(0);
pfput_tbl(pfo_head,"ensemble_keys",ensemble_keys);
if(grouping_on) pfput_tbl(pfo_head,"group_keys",group_keys);
dbquery(dbge,dbRECORD_COUNT,&number_ensembles);
if(DB2PFS_verbose) elog_log(0,"database has %d ensembles\n",
number_ensembles);
if(grouping_on)
{
dbgg.record=0;
dbquery(dbgg,dbRECORD_COUNT,&number_groups);
if(DB2PFS_verbose)
elog_log(0,"database has %d subgroups\n",
number_groups);
}
for(dbge.record=0;dbge.record<number_ensembles;
++dbge.record)
{
Pf_ensemble *pfe;
int nmembers;
char *grp_records;
Tbl *grplist;
dbgetv(dbge,0,"bundle",&db_bundle_1,0);
dbget_range(db_bundle_1,&is_ensemble,&ie_ensemble);
nmembers = ie_ensemble-is_ensemble;
/* pfe does not need to hold the group records
for this application so the ngroups variable is
passed as 0*/
pfe=create_Pf_ensemble(nmembers,0);
/*Now loop through and load the array of pf's
with parameters defined by the attribute maps*/
for(i=0,dbv.record=is_ensemble;i<nmembers;
++i,++dbv.record)
{
pfe->pf[i]=pfnew(PFARR);
error_list=db2pf(dbv,require,pfe->pf[i]);
if(maxtbl(error_list)>0)
{
if(dryrun)
{
elog_log(0,"Ensemble %d at input database view record %d lacks required attributes\n",
dbge.record,dbv.record);
log_error_list(error_list);
}
else
{
fprintf(fp,"%s\n",END_OF_DATA_SENTINEL);
fflush(fp);
elog_log(0,"FATAL ERROR: ensemble %d at input database view record %d lacks required attributes\nOUTPUT DATA STREAM TRUNCATED\n",
i,dbv.record);
log_error_list(error_list);
exit(-1);
}
}
freetbl(error_list,free);
error_list=db2pf(dbv,passthrough,pfe->pf[i]);
if(DB2PFS_verbose)
{
elog_log(0,"Warning: null passthrough attributes for ensemble %d at row %d\n",
dbge.record,dbv.record);
log_error_list(error_list);
}
freetbl(error_list,free);
pfput_boolean(pfe->pf[i],"data_valid",1);
}
if(grouping_on)
{
grplist=newtbl(0);
do {
dbgetv(dbgg,0,"bundle",&db_bundle_2,0);
dbget_range(db_bundle_2,&isg,&ieg);
grp_records=malloc(30);
sprintf(grp_records,"%d %d",
isg-is_ensemble,ieg-is_ensemble-1);
pushtbl(grplist,grp_records);
++dbgg.record;
}
while (ieg<ie_ensemble);
pfput_tbl(pfo_head,"group_records",grplist);
}
pfo_total=build_ensemble(1,tag,pfo_head,pfe);
free_Pf_ensemble(pfe);
if(!dryrun)
{
pfout(fp,pfo_total);
fprintf(fp,"%s\n",ENDPF_SENTINEL);
fflush(fp);
}
pffree(pfo_total);
if(grouping_on)freetbl(grplist,free);
}
}
else
{
/*This is the simpler, single block mode */
int nrecords;
Pf *pfo;
dbquery(dbv,dbRECORD_COUNT,&nrecords);
pfo=pfnew(PFARR);
for(dbv.record=0;dbv.record<nrecords;++dbv.record)
{
error_list=db2pf(dbv,require,pfo);
if(maxtbl(error_list)>0)
{
if(dryrun)
{
elog_log(0,"Input database view at row %d lacks required parameters\n",
dbv.record);
log_error_list(error_list);
}
else
{
fprintf(fp,"%s\n",END_OF_DATA_SENTINEL);
fflush(fp);
elog_log(0,"FATAL: input database view at row %d lacks required parameters\n",
dbv.record);
log_error_list(error_list);
exit(-1);
}
}
freetbl(error_list,free);
error_list=db2pf(dbv,passthrough,pfo);
pfput_boolean(pfo,"data_valid",1);
if(DB2PFS_verbose)
{
elog_log(0,"Warning: null passthrough attributes for row %d of input database view\n",
dbv.record);
}
if(!dryrun)
{
pfout(fp,pfo);
fprintf(fp,"%s\n",ENDPF_SENTINEL);
}
}
}
if(!dryrun)
{
fprintf(fp,"%s\n",END_OF_DATA_SENTINEL);
fflush(fp);
sleep(sleep_time);
fclose(fp);
}
exit(0);
}
/* This is the main processing function for this program.
Arguments:
dbv - db pointer to a complex view of the database to be
processed. That is, it has these properties:
1. It is a join of:
event->origin->assoc->arrival
2. subset to single arrival name AND orid==prefor
3. sorted by evid/sta
pf - input parameter space
The main processing loop here keys on the grouping defined in the view
passed as dbgrp. That is, seismograms for each event group are processed
as a complete gather. After that, are nested loops to do the multiwavelet
processing as described in Bear and Pavlis (1999a,b).
Author: Gary Pavlis
Date: March 1999+
*/
#define LAG_ERROR -100000 /* Computed lags smaller than this returned
by compute_optimal_lag are treated as an error
condition. Should probably be in an include file*/
void mwap_process(Dbptr dbv,char *phase, Pf *pf)
{
int nevents; /* number of events=number of groups in dbgrp */
MWbasis *mw; /* Multiwavelet basis functions */
Tbl **decimators; /* List of loaded decimators used to construct
multiwavelet transforms in lower bands */
Tbl **dec_objects; /*Actual decimation filter objects */
/* Note: mw and dec_objects define the multiwavelet transform */
int nwavelets,nbands;
/* sets coherence mode used to determine optimal lag */
int coherence_type;
Arr *stations; /* This associative array holds MWstation objects
that contain header like data that is station
dependent */
Arr *badclocks; /* associative array keyed by sta name holding
list of time intervals with bad timing */
char *refsta; /* Name of reference station */
double refelev; /* reference elevation from parameter file */
int nsta; /* number of stations */
int ntest;
Dbptr db; /* generic db lookup parameter */
Dbptr dbgrp; /* evid group db pointer */
Dbptr tr; /* trace database */
Dbptr dbmps; /* mwpredslow table */
Tbl *sortkeys,*sortkeys2; /* used because different tr routines require
different sort orders */
int *pad; /* vector of length nbands holding computed time padding
lengths for each band in samples */
int tpad; /*time pad actually used (max of *pad) */
Time_Window *swin, *nwin; /* arrays defining time windows
for signal and noise respectively (relative to arrival)*/
Time_Window swinall, nwinall; /*define read time intervals (extracted
from swin and nwin arrays */
int *decfac; /* array of decimation factors needed at times */
Arr *mwarr; /* Holds indexed multiwavelet transformed trace objects*/
/* We keep three copies of arrival time information.
arrival0 = original times read from db (never altered)
arrivals = current working copy
arrival_new = new estimate obtained from "arrivals"
*/
Arr *arrival0,*arrivals,*arrival_new;
Arr *static_result; /* Holds error statistics for static estimates */
MWSlowness_vector u0,u;
int i,j;
double avgamp, amperr;
int ampndgf;
int iterations;
double ucovariance[9];
char *array_name;
int accumulate;
/* These are channel code names used in trace library rotation
functions rotate_to_standard and trrotate. */
char *stdchans[3]={ EW, NS , VERTICAL };
char *pcchans[3]={"R","T","ZL"};
Arr *mwsig_arr,*mwnoise_arr; /* these index pointers to mw transformed
signal and noise series */
Arr **sn_ratios; /* vector of Arr pointers of length nbands indexing
signal to noise ratio estimates (stored in a structure) for
every station */
Spherical_Coordinate polarization0,polarization;
Spherical_Coordinate polarz={1.0,0.0,0.0};
Arr *model_times=NULL;
MWSlowness_vector model_slow;
double rctm[9]; /*ray coordinate transformation matrix*/
double timeref; /* time reference at reference station */
double time;
double t0,twin;
double si;
double fc,fwin;
int evid;
int lag; /* optimal lab computed by coherence measure */
double peakcm; /*Peak value of coherence measure */
/* For a given gather we set moveout computed moveout time in
seconds relative to the reference station. This time includes
the combined current static estimates. This is a vector workspace
that is recycled for every gather. It is alloced soon as we
know the number of stations in the site table. */
double *moveout;
MWgather **gathers;
Particle_Motion_Ellipse *avgpm;
Particle_Motion_Error *avgerr;
char *pmtype_to_use; /* type of particle motion estimate to use
for polarization */
Arr *pm_arr,*pmerr_arr;
Arr *pmarray,*errarray;
/* This vector defines the "up" direction. For P waves this
initialization is correct. For S it may not be appropriate, but
this is something to repair later */
double up[3]={0.0,0.0,1.0};
int bankid; /* mutliwavelet group id */
int band_exit = 0;
/* name of parameter file produced by GUI to control this program */
char *guipf;
int stack_alignment;
Pf *pfcontrol;
int loopback;
int numberpasses=0;
/* These define the relative time window used for stack and
particle motion. s denotes stack, ts0 etc are pm */
double sts0,ste0; /* we don't need the equivalent of ts1 and te1 */
double ts0,ts1,te1,te0;
/* This is essential or copy_arrival_array can produce garbage */
arrival0=NULL;
arrivals = NULL;
arrival_new=NULL;
pm_arr = NULL;
pmerr_arr = NULL;
pmarray = NULL;
errarray = NULL;
si = pfget_double(pf,"sample_interval");
/* First we need to load the multiwavelet functions and the
associated decimators for the transform. Each of these
routines will die if serious problems occur and have no
error returns. Wavelet functions can be loaded from a parameter
file or a db. */
if(pfget_boolean(pf,"get_wavelets_from_database"))
{
mw = load_multiwavelets_db(dbv,pf,&nwavelets,&bankid);
}
else
{
mw = load_multiwavelets_pf(pf,&nwavelets);
bankid = pfget_int(pf,"bankid");
}
decimators = define_decimation(pf,&nbands);
allot(int *,decfac,nbands);
dec_objects = build_decimation_objects(decimators,nbands,decfac);
print_band_info(mw,decfac,pf);
/* This creates the station objects. The time extracted here
is needed to sort out the ontime:endtime key in the site table.
This is done is a less than bombproof fashion by randomly
grabbing the time in the first record view.
Because of the way the site table works this will always work
in some fashion. It will only matter if a station ever moves
and then we have a bad problem anyway. */
dbv.record = 0;
dbgetv(dbv,0,"time",&time,0);
stations = build_station_objects(dbv,pf,time);
refsta = get_refsta(stations);
array_name = pfget_string(pf,"array_name");
if(array_name == NULL)
{
elog_complain(0,"WARNING: array_name not defined in parameter file. Set to default of ARRAY\n");
array_name = strdup("ARRAY");
}
refelev = pfget_double(pf,"reference_elevation");
/* This loads a definition of bad clocks from an extension
table called timing. This comes from libgenloc where it
is used to handle automatic switching to S-P times. */
badclocks=newarr(0);
if(db_badclock_definition(dbv,pf,badclocks))
{
elog_notify(0,"Problems in setting up table of stations with timing problems\n");
}
/* This function can define stations as always having bad timing
based on a parameter Tbl list of station names keyed by bad_clock.*/
pfget_badclocks(pf,badclocks);
pmtype_to_use = pfget_string(pf,"array_particle_motion_to_use");
if(pmtype_to_use==NULL) pmtype_to_use=strdup(PMOTION_BEAM);
/* this used to be a variable, but we no longer have a choice.*/
coherence_type=USE_COHERENCE;
/* This variable sets if we should reset the arrival estimates
to starting values for each band. When true the results accumulate
from band to band. That is we keep adding corrections from previous
band to progressively higher frequency.*/
accumulate = pfget_boolean(pf,"accumulate_statics");
/* compute time pad lengths for each band of the mw transforms */
pad = compute_tpad(dec_objects, mw, stations,pf);
/* These routine parses the parameter file for noise and
analysis time window information respectively returning
arrays of Time_Window structures of length nbands*/
decfac = get_decimation_factors(dec_objects, pf);
swin = get_signal_windows(decfac,pad,pf);
nwin = get_noise_windows(decfac,pad,pf);
print_window_data(decfac,nbands,swin,nwin,pf);
/* This gets time windows for signal and noise needed for
reading data (i.e. largest time ranges needed) */
swinall = compute_time_window(swin,decfac,nbands);
nwinall = compute_time_window(nwin,decfac,nbands);
guipf = pfget_string(pf,"mwapcontrol");
/* better safe than sorry */
if(guipf==NULL)
{
elog_die(0,"Missing required parameter mwapcontrol");
}
/* We can create these works spaces now for efficiency so
we don't have to constantly recreate them dynamically below */
allot(double *,moveout,cntarr(stations));
allot(MWgather **,gathers,nwavelets);
/* This associative array holds indexed pointers to multiwavelet
transformed traces. We create it here, but it is repeatedly
freed and cleared below */
mwarr = newarr(0);
/* This one has to be initialized*/
static_result=newarr(0);
/* We need this table repeatedly below so we avoid constant
lookups */
dbmps = dblookup(dbv,0,"mwpredslow",0,0);
if(dbmps.record == dbINVALID)
elog_die(0,"db lookup failed for mwpredslow table\nMWavelet schema extensions are required\n");
/* Now we loop through the outer loop event by event.
This is structured here by using a dbgroup defined db pointer
that is passed through the argument list. The db pointer
is incremented and then the bundle is taken apart to crack
apart each group of traces (the gather). Note we use
a defined name to look up the evid grouped table. */
dbgrp = dblookup(dbv,0,EVIDBDLNAME,0,0);
if (dbgrp.record == dbINVALID)
elog_die(0,"Error in dblookup for named evid group table = %s\n",
EVIDBDLNAME);
dbquery(dbgrp,dbRECORD_COUNT,&nevents);
fprintf(stdout,"Processing begins for %d events\n",nevents);
sortkeys = newtbl(0);
pushtbl(sortkeys,"sta");
pushtbl(sortkeys,"chan");
pushtbl(sortkeys,"time");
sortkeys2 = newtbl(0);
pushtbl(sortkeys2,"time");
pushtbl(sortkeys2,"sta");
pushtbl(sortkeys2,"chan");
for(dbgrp.record=0;dbgrp.record<nevents;++dbgrp.record)
{
Dbptr db_bundle;
int evid;
int is, ie;
int ierr;
double modaz;
if(dbgetv(dbgrp,0,"evid", &evid,
"bundle", &db_bundle,0) == dbINVALID)
{
elog_complain(1,"dbgetv error for row %d of event group\nAttempting to continue by skipping to next event\n",
dbgrp.record);
continue;
}
dbget_range(db_bundle,&is,&ie);
if(ie-is<3)
{
elog_complain(0,"Insufficient data to process for evid %d\nNeed at least three station -- found only %d\n",
evid,ie-is);
continue;
}
/* We utilize what we call plane wave statics here
to approximately correct for wavefront curvature.
We set the record number to is so we can access
the correct origin information from the db. Because
we used a join allrows of this group should have the
same origin data. */
ierr = set_pwstatics(stations,refsta,phase,db_bundle,pf);
if(ierr)elog_complain(0,"%d errors computing %d plane wave statics for evid %d\n",
ierr,ie-is,evid);
/* This routine loads an Arr of arrival times from
the input db to be used to compute initial slowness
vector and initial statics. */
arrival0 = get_arrivals(db_bundle);
/* We edit the MWstation array to flag stations
with bad timing in this function */
MWcheck_timing(arrival0,stations,badclocks);
/* Save these times */
copy_arrival_array(arrival0,&arrivals);
/* Initialize slowness vector to 0 and then estimate
it from data using current arrival times */
u0.ux = 0.0; u0.uy = 0.0; u0.refsta = refsta;
timeref = compute_time_reference(stations,arrivals,refsta,u0);
/* for the first pass we use weights defined for the
lowest frequency band. This is done because it asssumed
that if frequency dependent weighting is actually used
the lowest band would have the widest effective aperture. */
ierr = estimate_slowness_vector(u0,arrivals,stations,
refsta, refelev, timeref, phase, nbands-1,&u);
/* It is necessary to reset the time reference to handle
the case correctly when the reference station does not
actually record this event. This function uses a moveout
correction that depends upon the slowness vector, so it can
float about a bit in that situation */
if(ierr>0)
elog_notify(0,"%d nonfatal errors in estimate_slowness_vetor for evid %d\n",ierr,evid);
else if(ierr < 0)
{
elog_complain(0,"estimate_slowness_vector failed for initial slowness estimate for evid %d\nData for this event will be skipped\n",
evid);
continue;
}
/* This routine returns the slowness vector and an arr of
estimated arrival times. The slowness vector is saved
in the mwpredslow table immediately below. Arrival times
are used to compute residuals later. */
ierr = MWget_model_tt_slow(stations, refsta, phase,
db_bundle, pf, &model_times, &model_slow);
timeref = compute_time_reference(stations,arrivals,refsta,u);
polarization0=estimate_initial_polarization(model_slow,stations,
refsta,phase);
modaz = atan2(model_slow.ux,model_slow.uy);
if(dbaddv(dbmps,0,"sta",array_name,
"evid",evid,
"phase",phase,
"time",timeref,
"slo",hypot(model_slow.ux,model_slow.uy),
"azimuth",deg(modaz),
"majoraz",deg(polarization0.phi),
"majorema",deg(polarization0.theta),
"vmodel",pfget_string(pf,"TTmodel"),0) == dbINVALID)
{
elog_complain(0,"dbaddv error for evid %d on mwpredslow table\n",
evid);
}
/* This function reads in the trace data for this event
using time windows defined above */
tr = mwap_readdata(dbgrp,arrivals,swinall, nwinall);
if(tr.record == dbINVALID)
{
elog_complain(0,"Serious problems reading data for evid %d -- no data processed for this event\n",evid);
continue;
}
tr = dblookup(tr,0,"trace",0,0);
/* We first glue together any possible recording break
generated entries -- common with continuous data.
This also seems to require a resort because of the
way data was read in. */
/*
tr = dbsort(tr,sortkeys,0,0);
*/
trsplice(tr,0.1,0,0);
/* We run trsplit to break up waveform segments at real gaps.
I'm not sure later code will work correctly if it isn't an
all or nothing situations (e.g. gap in Z component, but
not in N or E). In any case, we have to deal with
potential multiple segments later. */
trsplit(tr,0,0);
trapply_calib(tr);
trdemean_seg(tr);
/* Now we have reorder the traces or this will not work
correctly*/
tr = dbsort(tr,sortkeys2,0,0);
ierr = rotate_to_standard(tr,stdchans);
if(ierr<0)
{
elog_complain(0,"rotate_to_standard failed processing evid %d -- no data processed for this event\n",
evid);
continue;
}
if(ierr>0)elog_complain(0,"rotate_to_standard failed for %d stations\n",
ierr);
/* This releases the space held by the raw data traces
keeping only the rotate_to_standard outputs */
free_noncardinal_traces(tr);
elog_log(0,"Computing multiwavelet transform: be\
patient as this can take a while with many channels\n");
/* This function computes the multiwavelet transform
of all traces currently in tr for signals around arrival*/
mwsig_arr = tr_mwtransform(tr,arrivals,swin,decfac,dec_objects,
nbands,mw,nwavelets);
/* We repeat the same thing for noise windows */
mwnoise_arr = tr_mwtransform(tr,arrivals,nwin,decfac,
dec_objects,nbands,mw,nwavelets);
/* Now compute signal to noise ratio figures for all
nbands storing the structures that define the results
in an Arr keyed by station. Note this is actually
a vector of Arr pointers of length nbands. Further
note the following function creates this complicated
object, and it must be freed after each event is
processed. */
sn_ratios=compute_signal_to_noise(mwsig_arr,mwnoise_arr,
stations,arrivals,swin,nwin,
nbands,nwavelets);
/* Now we get to the heart of this program. This is
the outer loop over frequency. Note the loop goes
backward because the lowest frequencies are the final
row of the mw transform matrices of pointers */
copy_MWslowness_vector(&u,&u0);
if(numberpasses>0)
{
fprintf(MWpout,"NEWEVENT %d\n",evid);
}
for(i=nbands-1;i>=0;--i)
{
if(!accumulate)
copy_arrival_array(arrival0,&arrivals);
copy_arrival_array(arrivals,&arrival_new);
fc = (mw[i].f0)/(2.0*si*decfac[i]);
fwin = (mw[i].fw)/(2.0*si*decfac[i]);
fprintf(stdout,"Processing begins on band %d with center frequency %lf\nWait for -Hit Accept button when ready- prompt\n",
i,fc);
/* This builds the basic working gathers for
each wavelet and builds a shortcut of pointers
to MWtraces that are related */
for(j=0;j<nwavelets;++j)
{
gathers[j] = build_MWgather(i,j,
mwsig_arr,stations,
sn_ratios[i],pf);
}
fprintf(stdout,"Working gather for this band has %d stations\n",
gathers[0]->nsta);
/* Testing band 0 should be sufficient. The
signal-to-noise is averaged overall wavelets so
the same stations should be deleted in all
wavelet of the group */
if(gathers[0]->nsta < 3)
{
elog_notify(0,"Insufficient data in band %d to passed signal-to-noise cutoff defined for this band for evid %d\nSkipping to next frequency band\n",
i,evid);
continue;
}
/* This may not be necessary, but it is certainly
important for debugging. We check that all
the gathers in the group have the same length.
If they aren't, we are in trouble because we use
a single vector to hold moveout information */
check_gather_consistency(gathers,nwavelets);
/* Now we compute the moveout information assuming
stations are in the same order in the gather for
each wavelet */
if(compute_total_moveout(*gathers,stations,refsta,
u,refelev,phase,moveout))
{
elog_die(0,"Cannot find reference station to compute moveout: Should not happen unless program overwrites itself\n");
}
if(numberpasses>0)
{
fprintf(MWpout,"NEWBAND %d\n",i);
fflush(MWpout);
}
else
{
char ctmp[40];
fprintf(stdout,"Starting processing of first event\nSelect and options and press the Start button when ready\n");
fprintf(MWpout,"STARTUP %d %d\n",
evid,i);
fflush(MWpout);
fgets(ctmp,40,MWpin);
}
++numberpasses;
/* This is placed here to allow changing the
alignment options on the fly. Choice may
depend on data. */
pfread(guipf,&pfcontrol);
stack_alignment=get_stack_align_mode(pfcontrol);
pffree(pfcontrol);
/* kind of a odd loop construct here made
necessary by differences in stackalignment
options. If we align with theoretical value
or use the vertical we do not need to repeat
this loop and we fall out the bottom. If we
use the pm estimate, however, we have to
realign the stack rotated to the new major
ellipse estimate. In that case we have to
repeat the whole procedure.*/
loopback=2;
do {
MWstack *stack;
switch(stack_alignment)
{
case PMTHEORY:
copy_polarization(&polarization0,&polarization);
loopback=0;
break;
case PMZ:
copy_polarization(&polarz,&polarization);
loopback=0;
break;
case PMESTIMATE:
default:
/* This uses theoretical version for the
first pass then the estimate on the
second */
if(loopback==2)
copy_polarization(&polarization0,
&polarization);
}
stack=MWcompute_arrival_times(gathers,
nwavelets,timeref,moveout,
polarization,swin[i],
sn_ratios[i],guipf,
&arrival_new,&static_result,
&avgamp, &err, &ndgf);
if(stack==NULL)
{
/* I use a flag to avoid an
evil goto here */
band_exit = 1;
/* This is strange but necessary
to stop string of bogus errors from
copy_arrival_array function when
this loops back */
if(arrival_new!=NULL)
freearr(arrival_new,free);
arrival_new = NULL;
break;
}
/* Note this routine updates residual
static values to new values relative to
the new slowness vector estimate */
ierr = estimate_slowness_vector(u0,
arrival_new,stations,
refsta, refelev, timeref,
phase, i, &u);
/* We need to recompute the moveout to
now be relative to the new slowness vector
estimate. We then use this for particle
motion analysis which can change the
polarization vector */
compute_total_moveout(*gathers,stations,refsta,
u,refelev,phase,moveout);
/* This segment converts particle motions
for 3-c arrays. */
if(gathers[0]->ncomponents==3)
{
MWstack *spm;
Time_Window pmtwindow;
double *timeweight;
/* We extract the time window
from a control parameter file which
is assumed to be created by a GUI
with tcl/tk */
pfread(guipf,&pfcontrol);
ts0=pfget_double(pfcontrol,"pm_ts0");
ts1=pfget_double(pfcontrol,"pm_ts1");
te1=pfget_double(pfcontrol,"pm_te1");
te0=pfget_double(pfcontrol,"pm_te0");
/* we need these below, not here */
sts0=pfget_double(pfcontrol,"stack_ts0");
ste0=pfget_double(pfcontrol,"stack_te0");
twin = ste0-sts0;
pffree(pfcontrol);
pmtwindow.tstart = nint(ts0/(stack->dt));
pmtwindow.tend = nint(te0/(stack->dt));
spm = MWextract_stack_window(stack,
&pmtwindow);
if(spm==NULL)
elog_die(0,
"Fatal error in MWextract_stack_window\n");
/* Sets time weight function for
a trapezoidal window */
timeweight=MWstack_set_trapezoidal_window(spm->tstart,
spm->dt,spm->nt,
ts0,ts1,te1,te0);
dcopy(spm->nt,timeweight,1,spm->timeweight,1);
free(timeweight);
MWstack_apply_timeweight(spm);
if(MWcompute_array_particle_motion(gathers,
nwavelets,spm,timeref,moveout,
up,&pmarray,&errarray, &pm_arr,&pmerr_arr) )
{
elog_complain(0,"Errors in MWcompute_array_particle_motion\n");
}
avgpm = (Particle_Motion_Ellipse *)getarr(pmarray,pmtype_to_use);
avgerr = (Particle_Motion_Error *)getarr(pmarray,pmtype_to_use);
polarization
=unit_vector_to_spherical(avgpm->major);
destroy_MWstack(spm);
}
peakcm=stack->coherence[idamax(
stack->nt,
stack->coherence,1)];
copy_arrival_array(arrival_new,&arrivals);
freearr(arrival_new,free);
arrival_new = NULL;
destroy_MWstack(stack);
if(stack_alignment==PMESTIMATE)
--loopback;
}while(loopback>0);
if(band_exit)
{
band_exit = 0;
continue;
}
/* This routine computes the covariance of
the estimated slowness vector */
if(compute_slowness_covariance(stations,static_result,
ucovariance) )
elog_complain(0,"Problems computing slowness vector covariance estimate for evid %d and band %d\n",
evid, i);
/* routines below save a time window. We compute
the lag corrected start time at the reference station
here as t0 to simplify this in functions that
need this.*/
t0 = timeref + sts0;
/* This series of functions save results in a set
of css3.0 extension tables. */
/* ampndgf+1 here is a cheap solution to the
number of stations used in a solution. This
confusion is necessary because autoediting reduces
the data set. Poor planning caused me to not
force this to be saved explicitly, but ampndgf is
an exact surrogate. The +1 is needed because the
calculation uses number_used - 1 since the average
amplitude is extracted as a free parameter.
*/
if(MWdb_save_slowness_vector(phase,&u,t0,twin,
array_name,evid,bankid,fc,fwin,
ucovariance,ampndgf+1,3,
coherence_type,peakcm,dbv))
dbsave_error("mwslow",evid,i);
if(MWdb_save_avgamp(array_name, evid, bankid, phase,
fc, t0, twin, avgamp,amperr,ampndgf,
dbv) )
dbsave_error("mwavgamp",evid,i);
if(MWdb_save_statics(evid, bankid, phase, fc, t0,
twin,refelev,*gathers,moveout,static_result,
stations,sn_ratios[i],
arrivals, model_times,dbv))
dbsave_error("mwtstatic:mwastatic:mwsnr",evid,i);
t0=timeref+ts0;
twin = te0-ts0;
if(MWdb_save_pm(array_name,evid,bankid,phase,fc,t0,
twin,*gathers,moveout,pm_arr,pmerr_arr,
avgpm,avgerr,dbv) )
dbsave_error("mwpm",evid,i);
/* We have to release the memory held in these
associative arrays. In the earlier loop the
function that creates them always clears them
before continuing when they are not null.
The explicit NULL set after the free is done
to make sure in looping back the particle
motion routine clears these correctly. */
freearr(pm_arr,free);
pm_arr = NULL;
freearr(pmerr_arr,free);
pmerr_arr = NULL;
/* same for static arr */
freearr(static_result,free);
static_result = NULL;
}
/*release main work spaces with this series of complicated free routines.
Here is where you really wish C had garbage collection */
free_sn_ratios_arr(sn_ratios,nbands);
free_MWtransform_arr(mwsig_arr,nbands,nwavelets);
free_MWtransform_arr(mwnoise_arr,nbands,nwavelets);
trdestroy(&tr);
freearr(arrival0,free);
freearr(arrivals,free);
/* This may not be necessary, but better safe than sorry */
arrivals = NULL; arrival0 = NULL; arrival_new = NULL;
}
free(moveout);
free(swin);
free(nwin);
free(refsta);
}
