soutifu.cc 12.7 KB
Newer Older
thomas.forbriger's avatar
thomas.forbriger committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/*! \file soutifu.cc
 * \brief inversion for source time function
 * 
 * ----------------------------------------------------------------------------
 * 
 * $Id$
 * \author Thomas Forbriger
 * \date 06/05/2011
 * 
 * inversion for source time function
 * 
 * Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 * 
 * REVISIONS and CHANGES 
 *  - 06/05/2011   V1.0   Thomas Forbriger
 * 
 * ============================================================================
 */
#define SOUTIFU_VERSION \
  "SOUTIFU   V1.0   inversion for source time function"
#define SOUTIFU_CVSID \
  "$Id$"

#include <iostream>
25
26
#include <fstream>
#include <tfxx/error.h>
thomas.forbriger's avatar
thomas.forbriger committed
27
#include <tfxx/commandline.h>
28
29
#include <tsxx/sffheaders.h>
#include <datrwxx/readany.h>
30
#include <datrwxx/writeany.h>
31
32
33
#include <stfinv/stfinvany.h>

/*----------------------------------------------------------------------*/
thomas.forbriger's avatar
thomas.forbriger committed
34
35
36
37
38

using std::cout;
using std::cerr;
using std::endl;

thomas.forbriger's avatar
thomas.forbriger committed
39
40
41
42
/*----------------------------------------------------------------------*/
// debug helper
#define PAROUT( par ) cout << #par << "=" << par << " ";

43
44
45
46
47
48
/*----------------------------------------------------------------------*/
// function to compare double
// is true if relative residual between a and b is smaller than eps
bool sameineps(const double &a, const double& b, const double& eps=1.e-8)
{
  double reldif=std::abs(a-b);
thomas.forbriger's avatar
thomas.forbriger committed
49
  return(reldif<=(std::abs(b*eps)));
50
51
}

52
53
54
55
56
/*----------------------------------------------------------------------*/

struct Options {
  bool verbose, debug, overwrite;
  bool writestf, writeconvolved;
thomas.forbriger's avatar
thomas.forbriger committed
57
  std::string stffilename, convolvedfilename, debuglevel;
58
59
60
61
62
  datrw::Eformat datafileformat;
}; // struct Options

/*----------------------------------------------------------------------*/

thomas.forbriger's avatar
thomas.forbriger committed
63
64
65
66
67
68
69
int main(int iargc, char* argv[])
{

  // define usage information
  char usage_text[]=
  {
    SOUTIFU_VERSION "\n"
thomas.forbriger's avatar
thomas.forbriger committed
70
71
    "usage: soutifu [-v] [-o] [-wc f] [-ws f] [--type f]\n"
    "               [-DEBUG=level]\n"
72
    "               parameters data synthetics" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
73
    "   or: soutifu --help|-h" "\n"
74
    "   or: soutifu --xhelp" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
75
76
77
78
79
  };

  // define full help text
  char help_text[]=
  {
80
81
82
83
84
85
86
87
88
89
90
91
92
    SOUTIFU_CVSID "\n"
    "\n"
    "Calculate optimized source time function to minimize misfit\n"
    "between recorded data and synthetic waveforms.\n"
    "\n"
    "data         name of file containing recorded data\n"
    "synthetics   name of file containing synthetic data\n"
    "parameters   parameterstring to select STF engine\n"
    "             The string consists of an ID selecting one of the\n"
    "             available engines and a set of options an parameters\n"
    "             to be passed to this engine.\n"
    "\n"
    "-v           be verbose\n"
thomas.forbriger's avatar
thomas.forbriger committed
93
    "-DEBUG=level produce debug output at level \"level\"\n"
94
95
96
97
    "-o           overwrite existing output files\n"
    "--type f     use file format type \"f\" for file I/O\n"
    "-wc f        write convolved synthetics to file \"f\"\n"
    "-ws f        write source time function to file \"f\"\n"
98
99
100
101
    "\n"
    "Upon input the consistency of recorded and synthetic data are\n"
    "checked. For coordinates only receiver positions relative to\n"
    "source coordinates are checked, not absolute locations.\n"
thomas.forbriger's avatar
thomas.forbriger committed
102
103
104
105
106
107
108
109
110
111
  };

  // define commandline options
  using namespace tfxx::cmdline;
  static Declare options[]= 
  {
    // 0: print help
    {"help",arg_no,"-"},
    // 1: verbose mode
    {"v",arg_no,"-"},
112
113
114
115
116
117
118
119
120
121
    // 2: overwrite mode
    {"o",arg_no,"-"},
    // 3: file format
    {"type",arg_yes,"sff"},
    // 4: name of convolved synthetics
    {"wc",arg_yes,"-"},
    // 5: name of source time function
    {"ws",arg_yes,"-"},
    // 6: present full details
    {"xhelp",arg_no,"-"},
thomas.forbriger's avatar
thomas.forbriger committed
122
123
    // 7: present full details
    {"DEBUG",arg_yes,"0"},
thomas.forbriger's avatar
thomas.forbriger committed
124
125
126
127
128
129
130
131
132
133
134
135
136
137
    {NULL}
  };

  // no arguments? print usage...
  if (iargc<2) 
  {
    cerr << usage_text << endl;
    exit(0);
  }

  // collect options from commandline
  Commandline cmdline(iargc, argv, options);

  // help requested? print full help text...
138
  if (cmdline.optset(0) || cmdline.optset(6))
thomas.forbriger's avatar
thomas.forbriger committed
139
140
141
  {
    cerr << usage_text << endl;
    cerr << help_text << endl;
142
143
144
145
146
147
    datrw::supported_input_data_types(cerr);
    if (cmdline.optset(6)) { datrw::online_help(cerr); }
    cerr << endl;
    stfinv::STFEngine::help(cerr);
    cerr << endl;
    if (cmdline.optset(6)) { stfinv::help(cerr); }
thomas.forbriger's avatar
thomas.forbriger committed
148
149
150
    exit(0);
  }

151
152
153
154
155
156
157
158
159
160
  /*----------------------------------------------------------------------*/
  // read options and parameters
  Options opt;
  opt.verbose=cmdline.optset(1);
  opt.overwrite=cmdline.optset(2);
  opt.datafileformat=datrw::anyID(cmdline.string_arg(3));
  opt.writeconvolved=cmdline.optset(4);
  opt.convolvedfilename=cmdline.string_arg(4);
  opt.writestf=cmdline.optset(5);
  opt.stffilename=cmdline.string_arg(5);
thomas.forbriger's avatar
thomas.forbriger committed
161
162
  opt.debug=cmdline.optset(7);
  opt.debuglevel=cmdline.string_arg(7);
163
164
165
166
167
168
169
170
171
172
173
174
175
176

  TFXX_assert(cmdline.extra(), "missing parameter string");
  std::string parameters=cmdline.next();
  TFXX_assert(cmdline.extra(), "missing recorded data file name");
  std::string datafilename=cmdline.next();
  TFXX_assert(cmdline.extra(), "missing synthetics data file name");
  std::string syntheticsfilename=cmdline.next();

  /*----------------------------------------------------------------------*/
  // go
  // --
 
  // read input data
  // ---------------
177
  typedef aff::Series<float> Tseries;
178
179
180
181
182
183
184
  typedef ts::sff::File<Tseries> Tfile;
  Tfile recordeddata;
  Tfile syntheticdata;

  std::ios_base::openmode iopenmode
    =datrw::ianystream::openmode(opt.datafileformat);
  if (opt.verbose) { cout << "open input file " << datafilename << endl; }
thomas.forbriger's avatar
thomas.forbriger committed
185
  {
186
187
188
    std::ifstream ifs(datafilename.c_str(), iopenmode);
    datrw::ianystream is(ifs, opt.datafileformat);
    recordeddata.read(is.idatstream(), opt.verbose);
thomas.forbriger's avatar
thomas.forbriger committed
189
190
  }

191
192
193
194
195
196
  if (opt.verbose) { cout << "open input file " << syntheticsfilename << endl; }
  {
    std::ifstream ifs(syntheticsfilename.c_str(), iopenmode);
    datrw::ianystream is(ifs, opt.datafileformat);
    syntheticdata.read(is.idatstream(), opt.verbose);
  }
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271

  // check input data consistency and prepare output files
  // -----------------------------------------------------
  if (opt.verbose) 
  { 
    cout << "check input data consistency,\n"
      << "prepare output data containers, and\n"
      << "prepare waveform data workspace" << endl; 
  }

  // number of traces per file
  TFXX_assert(recordeddata.size() == syntheticdata.size(),
              "ERROR: inconsitent number of traces");
  const unsigned int ntraces=recordeddata.size();

  // output data
  Tfile convolvedsynthetics;
  Tfile stffile;

  // waveform data workspace
  stfinv::Tvectoroftriples vectoroftriples;
  stfinv::Waveform stfwaveform;

  convolvedsynthetics.fileheader=syntheticdata.fileheader;

  // cycle through all traces
  for (unsigned int itrace=0; itrace<ntraces; ++itrace)
  {
    if (opt.verbose)
    {
      cout << "  check trace #" << itrace+1 << endl;
    }
    // create a reference to the time series with trace header for thsi
    // specific trace as read from file
    const Tfile::Ttracevector::Ttimeseries& rdtseries=recordeddata[itrace];
    const Tfile::Ttracevector::Ttimeseries& sdtseries=syntheticdata[itrace];

    // create a time series to be used in the output of convolved synthetics
    // based on the input synthetics; copy trace header
    Tfile::Ttracevector::Ttimeseries cstseries(rdtseries.shape());
    cstseries.Mtraceindex=sdtseries.Mtraceindex;
    cstseries.header=sdtseries.header;

    // place reference in a waveform triple
    stfinv::WaveformTriple tracetriple;
    tracetriple.data=rdtseries;
    tracetriple.synthetics=sdtseries;
    tracetriple.convolvedsynthetics=cstseries;
    tracetriple.header.sampling.dt=rdtseries.header.wid2().dt;
    tracetriple.header.sampling.n=rdtseries.header.wid2().nsamples;

    TFXX_assert((rdtseries.header.wid2().nsamples 
                  == sdtseries.header.wid2().nsamples),
                "ERROR: inconsistent trace size");
    TFXX_assert(sameineps(rdtseries.header.wid2().dt,
                            sdtseries.header.wid2().dt),
                "ERROR: inconsistent sampling interval");

    // read out source coordinates
    tracetriple.header.sx=recordeddata.fileheader.srce().cx;
    tracetriple.header.sy=recordeddata.fileheader.srce().cy;
    tracetriple.header.sz=recordeddata.fileheader.srce().cz;

    // read out receiver coordinates
    tracetriple.header.rx=rdtseries.header.info().cx;
    tracetriple.header.ry=rdtseries.header.info().cy;
    tracetriple.header.rz=rdtseries.header.info().cz;

    // check coordinate consistency
    double ddx=rdtseries.header.info().cx-recordeddata.fileheader.srce().cx;
    double ddy=rdtseries.header.info().cy-recordeddata.fileheader.srce().cy;
    double ddz=rdtseries.header.info().cz-recordeddata.fileheader.srce().cz;
    double sdx=sdtseries.header.info().cx-syntheticdata.fileheader.srce().cx;
    double sdy=sdtseries.header.info().cy-syntheticdata.fileheader.srce().cy;
    double sdz=sdtseries.header.info().cz-syntheticdata.fileheader.srce().cz;
thomas.forbriger's avatar
thomas.forbriger committed
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
    if (opt.debug)
    if (!(sameineps(ddx,sdx) && sameineps(ddy,sdy) &&
                 sameineps(ddz,sdz)))
    {
      cout << "NOTICE: ";
      PAROUT(ddx);
      PAROUT(sdx);
      PAROUT(ddy);
      PAROUT(sdy);
      PAROUT(ddz);
      PAROUT(sdz);
      PAROUT(sameineps(ddx,sdx));
      PAROUT(sameineps(ddy,sdy));
      PAROUT(sameineps(ddz,sdz));
      cout << endl;
    }
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
    TFXX_assert((sameineps(ddx,sdx) && sameineps(ddy,sdy) &&
                 sameineps(ddz,sdz)),
                "ERROR: inconsistent receiver positions");

    // check time consistency
    TFXX_assert((rdtseries.header.wid2().date 
                == recordeddata.fileheader.srce().date),
                "ERROR: trigger delay not supported");
    TFXX_assert((sdtseries.header.wid2().date 
                == syntheticdata.fileheader.srce().date),
                "ERROR: trigger delay not supported");

    // add this triple to collection
    vectoroftriples.push_back(tracetriple);

    // add this trace to convolved synthetics
    convolvedsynthetics.push_back(cstseries);

    // catch values for stf waveform
    if (itrace==0)
    {
      Tfile::Ttracevector::Ttimeseries stftseries(tracetriple.data.shape()); 

      stfwaveform.sampling.dt=tracetriple.header.sampling.dt;
      stfwaveform.sampling.n=tracetriple.header.sampling.n;
      stfwaveform.series=stftseries;

thomas.forbriger's avatar
thomas.forbriger committed
315
316
317
318
319
320
321
322
      ::sff::WID2 wid2=stftseries.header.wid2();
      wid2.nsamples=stfwaveform.sampling.n;
      wid2.dt=stfwaveform.sampling.dt;
      wid2.date=libtime::now();
      stftseries.header.wid2(wid2);
      ::sff::SRCE srce=stffile.fileheader.srce();
      srce.date=stftseries.header.wid2().date;
      stffile.fileheader.srce(srce);
323
324
325
326
327
328
329
330
331
332
333
334
335

      stffile.push_back(stftseries);
    } // if (itrace==0)

  } // for (unsigned int itrace=0; itrace<ntraces; ++itrace)
  
  // create STF engine
  // -----------------
  if (opt.verbose) 
  {
    parameters += ":verbose";
    cout << "create STF engine" << endl; 
  }
thomas.forbriger's avatar
thomas.forbriger committed
336
  if (opt.debug) { parameters += ":DEBUG="+opt.debuglevel; }
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
  stfinv::STFEngine engine(vectoroftriples, stfwaveform, parameters);

  // run STF engine
  // --------------
  if (opt.verbose) { cout << "run engine" << endl; }
  engine.run();

  // write results
  // -------------
  
  if (opt.writestf)
  {
    if (opt.verbose) 
    {
      cout << "write STF to file " << opt.stffilename << endl;
    }
    if (!opt.overwrite)
    {
      std::ifstream file(opt.stffilename.c_str(),std::ios_base::in);
      TFXX_assert((!file.good()),"ERROR: output file exists!");
    }
    std::ios_base::openmode oopenmode
      =datrw::oanystream::openmode(opt.datafileformat);
    std::ofstream ofs(opt.stffilename.c_str(), oopenmode);
    datrw::oanystream os(ofs, opt.datafileformat, opt.debug);
    
    os << stffile.fileheader.srce();
    for (unsigned int itrace=0; itrace<stffile.size(); ++itrace)
    {
      os << stffile[itrace].header.wid2();
      os << stffile[itrace].header.info();
      os << stffile[itrace].series();
    }
  } // if (opt.writestf)

  if (opt.writeconvolved)
  {
    if (opt.verbose) 
    {
      cout << "write convolved synthetics to file " 
        << opt.convolvedfilename << endl;
    }
    if (!opt.overwrite)
    {
      std::ifstream file(opt.convolvedfilename.c_str(),std::ios_base::in);
      TFXX_assert((!file.good()),"ERROR: output file exists!");
    }
    std::ios_base::openmode oopenmode
      =datrw::oanystream::openmode(opt.datafileformat);
    std::ofstream ofs(opt.convolvedfilename.c_str(), oopenmode);
    datrw::oanystream os(ofs, opt.datafileformat, opt.debug);
    
    os << convolvedsynthetics.fileheader.srce();
    for (unsigned int itrace=0; itrace<convolvedsynthetics.size(); ++itrace)
    {
      os << convolvedsynthetics[itrace].header.wid2();
      os << convolvedsynthetics[itrace].header.info();
      os << convolvedsynthetics[itrace].series();
    }
  } // if (opt.writeconvolved)
} // main
thomas.forbriger's avatar
thomas.forbriger committed
398
399

/* ----- END OF soutifu.cc ----- */