sigfit.cc 9.07 KB
Newer Older
thomas.forbriger's avatar
thomas.forbriger committed
1
2
3
4
5
/*! \file sigfit.cc
 * \brief fit signal by trial-signals
 * 
 * ----------------------------------------------------------------------------
 * 
6
 * $Id: sigfit.cc,v 1.7 2004-02-10 21:15:25 tforb Exp $
thomas.forbriger's avatar
thomas.forbriger committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 * \author Thomas Forbriger
 * \date 28/01/2004
 * 
 * fit signal by trial-signals
 * 
 * Copyright (c) 2004 by Thomas Forbriger (BFO Schiltach) 
 * 
 * REVISIONS and CHANGES 
 *  - 28/01/2004   V1.0   Thomas Forbriger
 * 
 * ============================================================================
 */
#define SIGFIT_VERSION \
  "SIGFIT   V1.0   fit signal by trial-signals"
#define SIGFIT_CVSID \
22
  "$Id: sigfit.cc,v 1.7 2004-02-10 21:15:25 tforb Exp $"
thomas.forbriger's avatar
thomas.forbriger committed
23
24
25
26
27
28

#include <fstream>
#include <iostream>
#include <list>
#include <vector>
#include <tfxx/commandline.h>
thomas.forbriger's avatar
thomas.forbriger committed
29
#include <tfxx/error.h>
thomas.forbriger's avatar
thomas.forbriger committed
30
#include <sffxx.h>
31
32
#include <sffostream.h>
#include <tsxx/tsxx.h>
thomas.forbriger's avatar
thomas.forbriger committed
33
34
35
#include <tsxx/innerproduct.h>
#include <aff/array.h>
#include <aff/dump.h>
36
#include <aff/seriesoperators.h>
37
#include <linearxx/lapackxx.h>
thomas.forbriger's avatar
thomas.forbriger committed
38
39

typedef std::list<std::string> Tnamelist;
40
typedef ts::TDsfftimeseries Tbundle;
thomas.forbriger's avatar
thomas.forbriger committed
41
42
typedef Tbundle::Tseries Tseries;
typedef std::vector<Tbundle> Tbundlevec;
thomas.forbriger's avatar
thomas.forbriger committed
43
typedef aff::Array<Tbundle::Tseries::Tvalue> Tmatrix;
thomas.forbriger's avatar
thomas.forbriger committed
44
45
46
47
48
49
50
51

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

// structure to store commandline options
struct Options {
  bool verbose;
thomas.forbriger's avatar
thomas.forbriger committed
52
  double Tdate;
thomas.forbriger's avatar
thomas.forbriger committed
53
  bool truncate;
thomas.forbriger's avatar
thomas.forbriger committed
54
55
56
57
58
59
60
61
62
}; // struct Options

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

  // define usage information
  char usage_text[]=
  {
    SIGFIT_VERSION "\n"
thomas.forbriger's avatar
thomas.forbriger committed
63
64
    "usage: sigfit [-v] [-Tdate v] [-truncate]" "\n"
    "              signal trial [trial ...]" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
65
66
67
68
69
70
71
72
73
74
75
    "   or: sigfit --help|-h" "\n"
  };

  // define full help text
  char help_text[]=
  {
    SIGFIT_CVSID "\n"
    "\n"
    "-v           be verbose" "\n"
    "-Sramp       add a ramp to the set of trial signals" "\n"
    "-Sconst      add a constant to the set of trial signals" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
76
77
    "-Tdate v     tolerance for comparison of date of first sample" "\n"
    "             v give the tolerance in units of the sampling interval" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
78
    "-truncate    truncate all series to the same number of samples" "\n"
thomas.forbriger's avatar
thomas.forbriger committed
79
80
81
82
83
84
85
86
87
88
89
90
91
92
    "\n"
    "signal       signal to by explained by a linear combination" "\n"
    "             of trial signals" "\n"
    "trial        any set of trial signals"
  };

  // define commandline options
  using namespace tfxx::cmdline;
  static Declare options[]= 
  {
    // 0: print help
    {"help",arg_no,"-"},
    // 1: verbose mode
    {"v",arg_no,"-"},
thomas.forbriger's avatar
thomas.forbriger committed
93
    // 2: date tolerance
thomas.forbriger's avatar
thomas.forbriger committed
94
    {"Tdate",arg_yes,"0."},
thomas.forbriger's avatar
thomas.forbriger committed
95
96
    // 3: truncate to a common number of samples
    {"truncate",arg_no,"-"},
thomas.forbriger's avatar
thomas.forbriger committed
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
    {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);
  }

/*
  // dummy operation: print option settings
  for (int iopt=0; iopt<2; iopt++)
  {
    cout << "option: '" << options[iopt].opt_string << "'" << endl;
    if (cmdline.optset(iopt)) {  cout << "  option was set"; }
    else { cout << "option was not set"; }
    cout << endl;
    cout << "  argument (string): '" << cmdline.string_arg(iopt) << "'" << endl;
    cout << "     argument (int): '" << cmdline.int_arg(iopt) << "'" << endl;
    cout << "    argument (long): '" << cmdline.long_arg(iopt) << "'" << endl;
    cout << "   argument (float): '" << cmdline.float_arg(iopt) << "'" << endl;
    cout << "  argument (double): '" << cmdline.double_arg(iopt) << "'" << endl;
    cout << "    argument (bool): '";
    if (cmdline.bool_arg(iopt))
    { cout << "true"; } else { cout << "false"; }
    cout << "'" << endl;
  }
  while (cmdline.extra()) { cout << cmdline.next() << endl; }

  // dummy operation: print rest of command line
  while (cmdline.extra()) { cout << cmdline.next() << endl; }
*/

  // read options
  Options opt;
  opt.verbose=cmdline.optset(1);
thomas.forbriger's avatar
thomas.forbriger committed
145
  opt.Tdate=cmdline.double_arg(2);
thomas.forbriger's avatar
thomas.forbriger committed
146
  opt.truncate=cmdline.optset(3);
thomas.forbriger's avatar
thomas.forbriger committed
147

thomas.forbriger's avatar
thomas.forbriger committed
148
149
  /*----------------------------------------------------------------------*/

thomas.forbriger's avatar
thomas.forbriger committed
150
  // read file names
thomas.forbriger's avatar
thomas.forbriger committed
151
152
153
154
  TFXX_assert(cmdline.extra(),"ERROR: missing signal file name!");
  std::string signalname=cmdline.next();

  TFXX_assert(cmdline.extra(),"ERROR: missing trial signal file name!");
thomas.forbriger's avatar
thomas.forbriger committed
155
156
157
  Tnamelist namelist;
  while (cmdline.extra()) { namelist.push_back(cmdline.next()); }

thomas.forbriger's avatar
thomas.forbriger committed
158
159
160
161
162
163
164
165
166
167
168
169
  // read signal file
  Tbundle signal;
  {
    if (opt.verbose)
    { cout << "read signal file \"" << signalname << "\"" << endl; }
    std::ifstream is(signalname.c_str());
    sff::FileHeader fileheader(is);
    if (opt.verbose)
    { cout << "  read trace" << endl; }
    sff::InputWaveform<Tseries> inputwaveform(is);
    sff::TraceHeader traceheader=inputwaveform.header();
    signal.header=traceheader.wid2();
170
    signal=inputwaveform.series();
thomas.forbriger's avatar
thomas.forbriger committed
171
172
173
174
175
176
177
178
179
180
181
182
183
184
    bool last=traceheader.last();
    std::string wid2line=signal.header.line();
    if (opt.verbose)
    { 
      cout << "  " << wid2line.substr(0,69) << endl; 
      if (!last)
      {
        cout << "there are more traces in that files" << endl 
          << "ignoring them..." << endl;
      }
    }
  }
  
  // read trial files
thomas.forbriger's avatar
thomas.forbriger committed
185
  if (opt.verbose)
thomas.forbriger's avatar
thomas.forbriger committed
186
  { cout << namelist.size() << " trial data files to read" << endl; }
thomas.forbriger's avatar
thomas.forbriger committed
187
188
189
190
  Tbundlevec bundlevec;
  for (Tnamelist::const_iterator i=namelist.begin(); i!=namelist.end(); i++)
  {
    if (opt.verbose)
thomas.forbriger's avatar
thomas.forbriger committed
191
    { cout << "read trial data file \"" << *i << "\"" << endl; }
thomas.forbriger's avatar
thomas.forbriger committed
192
193
194
195
196
197
    std::ifstream is(i->c_str());
    sff::FileHeader fileheader(is);
    bool last=false;
    while(!last)
    {
      if (opt.verbose)
thomas.forbriger's avatar
thomas.forbriger committed
198
      { cout << "  read trial signal #" << bundlevec.size()+1 << endl; }
thomas.forbriger's avatar
thomas.forbriger committed
199
200
201
202
      sff::InputWaveform<Tseries> inputwaveform(is);
      sff::TraceHeader traceheader=inputwaveform.header();
      Tbundle bundle;
      bundle.header=traceheader.wid2();
203
      bundle=inputwaveform.series();
thomas.forbriger's avatar
thomas.forbriger committed
204
205
206
207
208
209
210
      bundlevec.push_back(bundle);
      last=traceheader.last();
      std::string wid2line=bundle.header.line();
      if (opt.verbose)
      { cout << "  " << wid2line.substr(0,69) << endl; }
    }
  }
thomas.forbriger's avatar
thomas.forbriger committed
211
212
213

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

thomas.forbriger's avatar
thomas.forbriger committed
214
215
216
217
  // truncate length if requested
  if (opt.truncate)
  {
    if (opt.verbose) { cout << "truncate signals if necessary..." << endl; }
218
    long int n=signal.last();
thomas.forbriger's avatar
thomas.forbriger committed
219
220
    for (Tbundlevec::const_iterator i=bundlevec.begin(); 
         i!=bundlevec.end(); i++)
221
222
    { n=n<i->last() ? n : i->last(); }
    if (signal.last()>n)
thomas.forbriger's avatar
thomas.forbriger committed
223
    {
224
225
      signal.setlastindex(n);
      signal.header.nsamples=signal.size();
thomas.forbriger's avatar
thomas.forbriger committed
226
227
228
229
230
231
      if (opt.verbose) { cout << "truncate signal to "
        << signal.header.nsamples << " samples" << endl; }
    }
    for (Tbundlevec::iterator i=bundlevec.begin(); 
         i!=bundlevec.end(); i++)
    { 
232
      if (i->last()>n)
thomas.forbriger's avatar
thomas.forbriger committed
233
      {
234
235
        i->setlastindex(n);
        i->header.nsamples=signal.size();
thomas.forbriger's avatar
thomas.forbriger committed
236
237
238
239
240
241
242
243
244
        if (opt.verbose) { cout << "truncate trial signal" << endl
          << i->header.line() << endl; }
      }
    }
  }

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

  // check header consistency
thomas.forbriger's avatar
thomas.forbriger committed
245
246
  sff::WID2compare compare(sff::Fnsamples | sff::Fdt | sff::Fdate);
  compare.setdatetolerance(opt.Tdate);
thomas.forbriger's avatar
thomas.forbriger committed
247
248
249
250
251
252
253
254
255
256
257
258
259
  if (opt.verbose) { cout << "checking consistency..." << endl; }
  for (Tbundlevec::const_iterator i=bundlevec.begin(); i!=bundlevec.end(); i++)
  {
    if (!compare (i->header,signal.header))
    {
      cerr << "ERROR: header signature mismatch:" << endl;
      cerr << "signal:" << endl;
      cerr << signal.header.line();
      cerr << "trial signal:" << endl;
      cerr << i->header.line();
      TFXX_abort("baling out...");
    }
  }
thomas.forbriger's avatar
thomas.forbriger committed
260
261
262
263
264
265
266
267
268
269
270
271

  /*----------------------------------------------------------------------*/
  
  // set up system of linear equations
  if (opt.verbose) { cout << "set up system of linear equations..." << endl; }
  int N=bundlevec.size();
  if (opt.verbose) { cout << "system is of size " << N << "x" << N << endl; }
  Tmatrix Matrix(N,N), rhs(N), coeff(N);
  for (int i=1; i<=N; ++i)
  {
    for (int k=i; k<=N; ++k)
    {
272
      Matrix(i,k)=ts::innerproduct(bundlevec[i-1], bundlevec[k-1]);
thomas.forbriger's avatar
thomas.forbriger committed
273
274
      Matrix(k,i)=Matrix(i,k);
    }
275
    rhs(i)=ts::innerproduct(bundlevec[i-1], signal);
thomas.forbriger's avatar
thomas.forbriger committed
276
  }
277

278
  // solve
279
  coeff=linear::lapack::dposv(Matrix,rhs);
280
281
282

  // set up synthetics
  Tbundle synthetics;
283
284
  synthetics=Tseries(signal.shape());
  synthetics.series()=0.;
285
  for (int i=1; i<=N; ++i)
286
  { synthetics += coeff(i) * bundlevec[i-1]; }
287
288
289
290
291
  synthetics.header=signal.header;
  synthetics.header.channel="synt";

  // set up residual
  Tbundle residual;
292
293
  residual=Tseries(signal.shape());
  residual=signal-synthetics;
294
295
296
297
  residual.header=signal.header;
  residual.header.channel="diff";
  
  // calculate rms values
298
299
  double signalrms=ts::rms(signal);
  double residualrms=ts::rms(residual);
300
301
302
303
304
305
306
307
  
  cout << "signalrms: " << signalrms << endl;
  cout << "residualrms: " << residualrms << endl;
  cout << "coefficients: " << endl;
  for (int i=1; i<=N; ++i)
  { cout << coeff(i) << "  "; }
  cout << endl;

308
309
  std::ofstream ofs("junkname");
  sff::SFFostream<Tseries> os(ofs);
310
311
  os << signal;
  os << synthetics;
312
  os << residual;
thomas.forbriger's avatar
thomas.forbriger committed
313
314
315
}

/* ----- END OF sigfit.cc ----- */