noisymize.cc 12.5 KB
Newer Older
1 2 3 4 5
/*! \file noisymize.cc
 * \brief program reads a set of SFF traces, convolves them with white noise and stacks
 * 
 * ----------------------------------------------------------------------------
 * 
thomas.forbriger's avatar
thomas.forbriger committed
6
 * $Id: noisymize.cc,v 1.10 2007-03-09 09:52:20 tforb Exp $
7 8 9 10 11 12 13 14 15
 * \author Thomas Forbriger
 * \date 27/06/2006
 * 
 * program reads a set of SFF traces, convolves them with white noise and stacks
 * 
 * Copyright (c) 2006 by Thomas Forbriger (BFO Schiltach) 
 * 
 * REVISIONS and CHANGES 
 *  - 27/06/2006   V1.0   Thomas Forbriger
thomas.forbriger's avatar
thomas.forbriger committed
16
 *  - 11/07/2006   V1.1   keep result of full convolution length
thomas.forbriger's avatar
thomas.forbriger committed
17
 *  - 26/02/2007   V1.2   report factors
thomas.forbriger's avatar
thomas.forbriger committed
18
 *  - 02/03/2007   V1.3   scale with offset
thomas.forbriger's avatar
thomas.forbriger committed
19
 *                 V1.4   special scaling for horizontal component
thomas.forbriger's avatar
thomas.forbriger committed
20 21 22 23
 *  - 08/03/2007   V1.5   
 *                        - allow switching of offset specific scaling
 *                        - added description in help section
 *                        - improved out format of list of factors
24 25 26 27
 * 
 * ============================================================================
 */
#define NOISYMIZE_VERSION \
thomas.forbriger's avatar
thomas.forbriger committed
28 29
  "NOISYMIZE   V1.5   program reads a set of SFF traces,\n" \
  "                   convolves them with white noise and stacks"
30
#define NOISYMIZE_CVSID \
thomas.forbriger's avatar
thomas.forbriger committed
31
  "$Id: noisymize.cc,v 1.10 2007-03-09 09:52:20 tforb Exp $"
32 33 34 35

#include <fstream>
#include <iostream>
#include <string>
thomas.forbriger's avatar
thomas.forbriger committed
36
#include <cmath>
37 38 39
#include <tfxx/commandline.h>
#include <tfxx/error.h>
#include <aff/series.h>
thomas.forbriger's avatar
thomas.forbriger committed
40
#include <aff/seriesoperators.h>
41 42 43
#include <tsxx/tsxx.h>
#include <tsxx/convolve.h>
#include <tsxx/sffheaders.h>
thomas.forbriger's avatar
thomas.forbriger committed
44
#include <tsxx/random.h>
45 46 47 48 49 50 51 52
#include <datreadxx/readany.h>

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

// put all commandline settings into a struct
struct Options {
thomas.forbriger's avatar
thomas.forbriger committed
53
  bool verbose, setnoiselength, overwrite, reportfactors;
thomas.forbriger's avatar
thomas.forbriger committed
54
  bool noscaling;
thomas.forbriger's avatar
thomas.forbriger committed
55
  int noiselength;
thomas.forbriger's avatar
thomas.forbriger committed
56
  double offexp;
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
  std::string inputformat;
}; // struct Options

// put all filenames in one struct
struct Filenames {
  std::string Zin;
  std::string Rin;
  std::string Zout;
  std::string Rout;
}; // struct Filenames

// values type to be used for samples
typedef double Tvalue;

// time series
typedef aff::Series<Tvalue> Tseries;

// full featured time series file
typedef ts::sff::File<Tseries> Tfile;

int main(int iargc, char* argv[])
{

  // define usage information
  char usage_text[]=
  {
    NOISYMIZE_VERSION "\n"
    "usage: noisymize Zin Rin Zout Rout" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
85
    "                 [-v] [-type t] [-n n] [-o] [-rf] [-s e]" "\n"
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
    "   or: noisymize --help|-h" "\n"
  };

  // define full help text
  char help_text[]=
  {
    NOISYMIZE_CVSID "\n"
    "\n"
    "Zin          vertical component input data" "\n"
    "Rin          radial component input data" "\n"
    "Zout         vertical component output data" "\n"
    "Rout         radial component output data" "\n"
    "\n"
    "-v           be verbose" "\n"
    "-type t      input file type" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
101
    "-n n         number of noise samples to use" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
102
    "-o           overwrite output" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
103
    "-rf          report factors" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
104 105
    "-s e         scale seismograms with offset" "\n"
    "             the scaling factor is r**e, where r is the offset" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
    "-fixed       do not scale each offset with a randomly" "\n"
    "             chosen amplitude" "\n"
    "\n"
    "Description of the procedure:" "\n"
    "- the program reads pairs of seismograms from Zin and Rin" "\n"
    "- each of the input files may contain multiple traces" "\n"
    "- for each trace in Zin there must be a corresponding trace" "\n"
    "  in Rin at the same offset" "\n"
    "- for each offset the program does the following:" "\n"
    "  1. the Z-trace and the R-trace are convolved with the same" "\n"
    "     stochastic time series (random normaly distributed white noise)" "\n"
    "     a new stochastic time series is calculated for each offset" "\n"
    "     through the libgsl random number generator" "\n"
    "  2. the Z-trace and the R-trace are scaled by a random value" "\n"
    "     (this function can be switched off through option -fixed)" "\n"
    "  3. the Z-trace and the R-trace are scaled by an offset" "\n"
    "     dependend value (selected through option -s e)" "\n"
    "  4. the R-trace is scaled by 2/pi to simulate a uniform" "\n"
    "     distribution of sources of all azimuths; as a consequence" "\n"
    "     the R result my be used as N- and E-component as well" "\n"
    "- the results for all offsets are stacked; the resulting Z-" "\n"
    "  and R-series are written to files Zout and Rout," "\n"
    "  respectively"
129 130 131 132 133 134 135 136 137 138 139 140
  };

  // define commandline options
  using namespace tfxx::cmdline;
  static Declare options[]= 
  {
    // 0: print help
    {"help",arg_no,"-"},
    // 1: verbose mode
    {"v",arg_no,"-"},
    // 2: input format
    {"type",arg_yes,"sff"},
thomas.forbriger's avatar
thomas.forbriger committed
141 142
    // 3: number of noise samples
    {"n",arg_yes,"1"},
thomas.forbriger's avatar
thomas.forbriger committed
143
    // 4: overwrite output file
thomas.forbriger's avatar
thomas.forbriger committed
144
    {"o",arg_no,"-"},
thomas.forbriger's avatar
thomas.forbriger committed
145 146
    // 5: report factors
    {"rf",arg_no,"-"},
thomas.forbriger's avatar
thomas.forbriger committed
147 148
    // 6: report factors
    {"s",arg_yes,"0."},
thomas.forbriger's avatar
thomas.forbriger committed
149 150
    // 7: report factors
    {"fixed",arg_no,"-"},
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    {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...
  if (cmdline.optset(0))
  {
    cerr << usage_text << endl;
    cerr << help_text << endl;
    exit(0);
  }

 
  /*----------------------------------------------------------------------*/
  // read command line settings

  Options opt;
  opt.verbose=cmdline.optset(1);
  opt.inputformat=cmdline.string_arg(2);
thomas.forbriger's avatar
thomas.forbriger committed
179 180
  opt.setnoiselength=cmdline.optset(3);
  opt.noiselength=cmdline.int_arg(3);
thomas.forbriger's avatar
thomas.forbriger committed
181
  opt.overwrite=cmdline.optset(4);
thomas.forbriger's avatar
thomas.forbriger committed
182
  opt.reportfactors=cmdline.optset(5);
thomas.forbriger's avatar
thomas.forbriger committed
183
  opt.offexp=cmdline.double_arg(6);
thomas.forbriger's avatar
thomas.forbriger committed
184
  opt.noscaling=cmdline.optset(7);
185 186 187 188 189 190 191 192 193 194 195 196 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

  Filenames filename;
  TFXX_assert(cmdline.extra(), "ERROR: missing filename Zin!");
  filename.Zin=cmdline.next();
  TFXX_assert(cmdline.extra(), "ERROR: missing filename Rin!");
  filename.Rin=cmdline.next();
  TFXX_assert(cmdline.extra(), "ERROR: missing filename Zout!");
  filename.Zout=cmdline.next();
  TFXX_assert(cmdline.extra(), "ERROR: missing filename Rout!");
  filename.Rout=cmdline.next();

  /*----------------------------------------------------------------------*/
  // read vertical component input data
  if (opt.verbose)
  { cout << "read input file " << filename.Zin << endl; }
  Tfile Zindata;
  {
    std::ifstream ifs(filename.Zin.c_str());
    datread::ianystream is(ifs, datread::anyID(opt.inputformat));
    Zindata.read(is.idatstream(), opt.verbose); 
  }
  // read radial component input data
  if (opt.verbose)
  { cout << "read input file " << filename.Rin << endl; }
  Tfile Rindata;
  {
    std::ifstream ifs(filename.Rin.c_str());
    datread::ianystream is(ifs, datread::anyID(opt.inputformat));
    Rindata.read(is.idatstream(), opt.verbose); 
  }

  /*----------------------------------------------------------------------*/
  // consistency checks
  // ------------------
  //
  if (opt.verbose) { cout << "consistency checks:" << endl; }

  // check number of traces
  TFXX_assert(Zindata.size()==Rindata.size(),
              "ERROR: inconsitent number of traces");
  if (opt.verbose) 
  { cout << "input files both have " << Zindata.size() << " traces." << endl; }

  // check trace headers
  Tfile::Tbase::const_iterator Zit=Zindata.begin();
  Tfile::Tbase::const_iterator Rit=Rindata.begin();
  sff::WID2compare compare(sff::Fnsamples | sff::Fdt);
  while((Zit!=Zindata.end()) && (Rit!=Rindata.end()))
  {
    TFXX_assert(compare(Zit->header.wid2(), Rit->header.wid2()),
                "ERROR: inconsitent trace headers");
    if (Zit->header.hasinfo())
    {
      sff::INFO Zinfo=Zit->header.info();
      sff::INFO Rinfo=Rit->header.info();
      TFXX_assert(Zinfo==Rinfo,
                  "ERROR: inconsitent coordinates");
    }
    ++Zit;
    ++Rit;
  }
  if (opt.verbose) 
  { cout << "trace headers and coordinates are consistent" << endl; }

  /*----------------------------------------------------------------------*/
  // go and noisymize data
  // ---------------------
thomas.forbriger's avatar
thomas.forbriger committed
252
  //
thomas.forbriger's avatar
thomas.forbriger committed
253 254
  Zit=Zindata.begin();
  Rit=Rindata.begin();
thomas.forbriger's avatar
thomas.forbriger committed
255 256 257
  // source coordinates
  sff::SRCE Zsrce=Zindata.fileheader.srce();
  sff::SRCE Rsrce=Rindata.fileheader.srce();
thomas.forbriger's avatar
thomas.forbriger committed
258 259
  // results
  Tseries Zseries, Rseries;
thomas.forbriger's avatar
thomas.forbriger committed
260 261
  // scaling factors
  Tseries fac=ts::rnd::dugauss(Zindata.size());
thomas.forbriger's avatar
thomas.forbriger committed
262
  if (opt.noscaling) { fac=1.; }
thomas.forbriger's avatar
thomas.forbriger committed
263 264
  Tseries offfac(Zindata.size());
  Tseries traceoffset(Zindata.size());
thomas.forbriger's avatar
thomas.forbriger committed
265
  //
thomas.forbriger's avatar
thomas.forbriger committed
266 267 268 269 270 271
  if (!opt.setnoiselength)
  {
    opt.noiselength=Zit->size();
  }
  if (opt.verbose) 
  { 
thomas.forbriger's avatar
thomas.forbriger committed
272 273
    cout << "convolve " << Zit->size() 
      << " data samples (each trace) with" << endl
thomas.forbriger's avatar
thomas.forbriger committed
274 275 276
      << opt.noiselength << " samples of uniform gaussian noise" 
      << " and stack." << endl; 
  }
thomas.forbriger's avatar
thomas.forbriger committed
277
  bool initialize_result=true;
thomas.forbriger's avatar
thomas.forbriger committed
278
  unsigned int itrace=0;
thomas.forbriger's avatar
thomas.forbriger committed
279 280
  while((Zit!=Zindata.end()) && (Rit!=Rindata.end()))
  {
thomas.forbriger's avatar
thomas.forbriger committed
281 282 283 284 285 286 287 288 289
    // calculate offset and offset dependend scaling
    sff::INFO Zinfo=Zit->header.info();
    sff::INFO Rinfo=Rit->header.info();
    double Zoffset=sff::offset(Zsrce, Zinfo);
    double Roffset=sff::offset(Rsrce, Rinfo);
    double offerr=(Zoffset/Roffset)-1.;
    if (offerr < 0.) { offerr=-offerr; }
    TFXX_assert((offerr < 1.e-4), 
                "ERROR: offset of R- and Z-component are inconsistent!");
thomas.forbriger's avatar
thomas.forbriger committed
290 291
    traceoffset(itrace)=Zoffset;
    offfac(itrace)=std::pow(Zoffset, opt.offexp);
thomas.forbriger's avatar
thomas.forbriger committed
292 293 294 295 296
    // scaling factor for radial component, since we see only the projection
    // of the radial component of all sources on the respective horizonzal
    // component
    // Hfactor = (int_0^{2*pi} abs(cos(phi)) d phi) / (2 pi)
    const double Hfactor=2./M_PI;
thomas.forbriger's avatar
thomas.forbriger committed
297
    // go
thomas.forbriger's avatar
thomas.forbriger committed
298
    double scalefac=fac(itrace)*offfac(itrace);
thomas.forbriger's avatar
thomas.forbriger committed
299
    if (opt.verbose) { cout << "*"; cout.flush(); }
thomas.forbriger's avatar
thomas.forbriger committed
300
    Tseries noise=ts::rnd::dugauss(opt.noiselength);
thomas.forbriger's avatar
thomas.forbriger committed
301
    if (opt.verbose) { cout << "+"; cout.flush(); }
thomas.forbriger's avatar
thomas.forbriger committed
302
    if (initialize_result)
thomas.forbriger's avatar
thomas.forbriger committed
303
    { Zseries = scalefac*ts::convolve(*Zit, noise); }
thomas.forbriger's avatar
thomas.forbriger committed
304
    else
thomas.forbriger's avatar
thomas.forbriger committed
305
    { Zseries += scalefac*ts::convolve(*Zit, noise); }
thomas.forbriger's avatar
thomas.forbriger committed
306
    if (opt.verbose) { cout << "+"; cout.flush(); }
thomas.forbriger's avatar
thomas.forbriger committed
307
    if (initialize_result)
thomas.forbriger's avatar
thomas.forbriger committed
308
    { Rseries = Hfactor*scalefac*ts::convolve(*Rit, noise); }
thomas.forbriger's avatar
thomas.forbriger committed
309
    else
thomas.forbriger's avatar
thomas.forbriger committed
310
    { Rseries += Hfactor*scalefac*ts::convolve(*Rit, noise); }
thomas.forbriger's avatar
thomas.forbriger committed
311
    initialize_result=false;
thomas.forbriger's avatar
thomas.forbriger committed
312 313
    ++Zit;
    ++Rit;
thomas.forbriger's avatar
thomas.forbriger committed
314
    ++itrace;
thomas.forbriger's avatar
thomas.forbriger committed
315
  }
thomas.forbriger's avatar
thomas.forbriger committed
316
  if (opt.verbose) { cout << endl; }
thomas.forbriger's avatar
thomas.forbriger committed
317 318 319
  if (opt.reportfactors)
  {
    cout << "factors used for scaling:" << endl;
thomas.forbriger's avatar
thomas.forbriger committed
320 321 322 323 324 325 326 327
    cout.width(5);
    cout << "#";
    cout.width(12);
    cout << "f1";
    cout.width(12);
    cout << "f2";
    cout.width(14);
    cout << "offset" << endl;
thomas.forbriger's avatar
thomas.forbriger committed
328 329
    for (itrace=0; itrace<Zindata.size(); itrace++)
    {
thomas.forbriger's avatar
thomas.forbriger committed
330 331 332 333 334 335 336 337 338
      cout.width(5); cout.precision(3);
      cout << itrace;
      cout.width(12); cout.precision(4);
      cout << fac(itrace);
      cout.width(12); cout.precision(4);
      cout << offfac(itrace);
      cout.width(12); cout.precision(4);
      cout << traceoffset(itrace)*1.e-3 << "km";
      cout << endl;
thomas.forbriger's avatar
thomas.forbriger committed
339
    }
thomas.forbriger's avatar
thomas.forbriger committed
340
    cout << "traces are scale by f1*f2" << endl;
thomas.forbriger's avatar
thomas.forbriger committed
341
  }
thomas.forbriger's avatar
thomas.forbriger committed
342 343 344

  /*----------------------------------------------------------------------*/
  // write result
thomas.forbriger's avatar
thomas.forbriger committed
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
  if (opt.verbose) 
  { cout << "prepare output data" << endl; }
  typedef ts::sff::SFFTimeSeries<Tseries> Tsffseries;
  Tsffseries Zoutdata(Zseries), Routdata(Rseries);
  Tsffseries::Theader Zheader(Zindata[0].header);
  Tsffseries::Theader Rheader(Rindata[0].header);

  sff::WID2 wid2line=Zheader.wid2();
  wid2line.nsamples=Zoutdata.size();
  wid2line.channel="Z";
  Zheader.wid2(wid2line);
  Zoutdata.header=Zheader;

  wid2line=Rheader.wid2();
  wid2line.nsamples=Routdata.size();
  wid2line.channel="R";
  Rheader.wid2(wid2line);
  Routdata.header=Rheader;

  {
    if (opt.verbose) { cout << "open output file " << filename.Zout << endl; }
    // check if output file exists and open
    if (!opt.overwrite)
    {
      std::ifstream file(filename.Zout.c_str(),std::ios_base::in);
      TFXX_assert((!file.good()),"ERROR: output file exists!");
    }
    std::ofstream ofs(filename.Zout.c_str());
    sff::SFFostream<Tseries> os(ofs);
374

thomas.forbriger's avatar
thomas.forbriger committed
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
    // prepare file FREE block
    sff::FREE filefree;
    filefree.append(NOISYMIZE_VERSION);

    os << Zoutdata;
  }

  {
    if (opt.verbose) { cout << "open output file " << filename.Rout << endl; }
    // check if output file exists and open
    if (!opt.overwrite)
    {
      std::ifstream file(filename.Rout.c_str(),std::ios_base::in);
      TFXX_assert((!file.good()),"ERROR: output file exists!");
    }
    std::ofstream ofs(filename.Rout.c_str());
    sff::SFFostream<Tseries> os(ofs);

    // prepare file FREE block
    sff::FREE filefree;
    filefree.append(NOISYMIZE_VERSION);

    os << Routdata;
  }
399 400 401
}

/* ----- END OF noisymize.cc ----- */