STFINV library: seek source wavelet correction filter
stfinvfdleastsquares.h
Go to the documentation of this file.
1 
39 // include guard
40 #ifndef STFINV_STFINVFDLEASTSQUARES_H_VERSION
41 
42 #define STFINV_STFINVFDLEASTSQUARES_H_VERSION \
43  "STFINV_STFINVFDLEASTSQUARES_H V1.3"
44 
45 #include<stfinv/stfinvfourier.h>
46 
47 namespace stfinv {
48 
220  public:
224  static const char* const ID;
226  static const char* const description;
230  const stfinv::Waveform& stf,
231  const std::string& parameters)
232  : Tbase(triples, stf, parameters), Mwaterlevel(1.e-3)
233  { this->initialize(); }
237  const stfinv::Waveform& stf,
238  const stfinv::Tvectorofpairs& pairs,
239  const std::string& parameters)
240  : Tbase(triples, stf, pairs, parameters), Mwaterlevel(1.e-3)
241  { this->initialize(); }
245  virtual void exec();
247  virtual void help(std::ostream& os=std::cout) const;
249  static void classhelp(std::ostream& os=std::cout);
251  virtual void usage(std::ostream& os=std::cout) const;
253  static void classusage(std::ostream& os=std::cout);
255  virtual const char* name() const;
256  private:
258  void initialize();
259 
260  // member data
261  private:
263  double Mwaterlevel;
264  }; // class STFEngineFDLeastSquares
265 
266 } // namespace stfinv
267 
268 #endif // STFINV_STFINVFDLEASTSQUARES_H_VERSION (includeguard)
269 
270 /* ----- END OF stfinvfdleastsquares.h ----- */
stfinv::STFFourierDomainEngine Tbase
typedef to refer to base class
STFEngineFDLeastSquares(const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const std::string &parameters)
Constructor.
std::vector< stfinv::WaveformPair > Tvectorofpairs
Vector of pairs.
Definition: stfinvbase.h:125
Root namespace of library.
Definition: doxygen.txt:43
Base class for all engines which operate in the Fourier domain.
Fourier domain least squares engine.
virtual void exec()
Start engine.
A class to store a single waveform. This will be used to pass the source correction filter...
Definition: stfinvbase.h:111
virtual void usage(std::ostream &os=std::cout) const
print detailed description
static const char *const ID
ID used to select this engine.
virtual ~STFEngineFDLeastSquares()
abstract base requires virtual destructor
virtual void help(std::ostream &os=std::cout) const
print online help
static void classusage(std::ostream &os=std::cout)
print detailed description
a base class for all engines which operate in the Fourier domain (prototypes)
std::vector< stfinv::WaveformTriple > Tvectoroftriples
Vector of triples.
Definition: stfinvbase.h:132
virtual const char * name() const
return name of engine
Tseries stf() const
return source correction filter series
Definition: stfinvbase.h:273
static void classhelp(std::ostream &os=std::cout)
print online help
void initialize()
initialize work space
static const char *const description
short description of this engine
STFEngineFDLeastSquares(const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const stfinv::Tvectorofpairs &pairs, const std::string &parameters)
Constructor.