STFINV library: seek source wavelet correction filter
stfinvany.h
Go to the documentation of this file.
1 
38 // include guard
39 #ifndef STFINV_STFINVANY_H_VERSION
40 
41 #define STFINV_STFINVANY_H_VERSION \
42  "STFINV_STFINVANY_H V1.2"
43 
44 #include<stfinv/stfinvbase.h>
45 
46 namespace stfinv {
47 
60  class STFEngine {
61  public:
80  STFEngine(const stfinv::Tvectoroftriples& triples,
81  const stfinv::Waveform& stf,
82  const std::string& parameters);
113  STFEngine(const stfinv::Tvectoroftriples& triples,
114  const stfinv::Waveform& stf,
115  const stfinv::Tvectorofpairs& pairs,
116  const std::string& parameters);
118  ~STFEngine();
122  stfinv::Waveform run() { return(Mengine->run()); }
124  static void engines(std::ostream& os=std::cout);
126  static void help(std::ostream& os=std::cout);
132  static void usage(const std::string& id, std::ostream& os=std::cout);
133  private:
135  void initialize(const stfinv::Tvectoroftriples& triples,
136  const stfinv::Waveform& stf,
137  const stfinv::Tvectorofpairs& pairs,
138  const std::string& parameters);
141  }; // class STFEngine
142 
143  /*----------------------------------------------------------------------*/
144 
150  void engines(std::ostream& os=std::cout);
151 
157  void help(std::ostream& os=std::cout);
158 
164  void usage(const std::string& id, std::ostream& os=std::cout);
165 
166 } // namespace stfinv
167 
168 #endif // STFINV_STFINVANY_H_VERSION (includeguard)
169 
170 /* ----- END OF stfinvany.h ----- */
std::vector< stfinv::WaveformPair > Tvectorofpairs
Vector of pairs.
Definition: stfinvbase.h:125
void initialize(const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const stfinv::Tvectorofpairs &pairs, const std::string &parameters)
initialize engine.
Definition: stfinvany.cc:77
stfinv::Waveform run()
Start engine and return source correction filter.
Definition: stfinvany.h:122
Root namespace of library.
Definition: doxygen.txt:43
static void engines(std::ostream &os=std::cout)
List procedures (engines) currently recognized.
Definition: stfinvany.cc:134
stfinv::STFBaseEngine & STFBaseEngine()
Return actual engine.
Definition: stfinvany.h:120
STFEngine(const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const std::string &parameters)
Constructor.
Definition: stfinvany.cc:56
stfinv::Waveform run()
Start engine and return reference to source correction filter.
Definition: stfinvbase.h:235
A class to store a single waveform. This will be used to pass the source correction filter...
Definition: stfinvbase.h:111
static void usage(const std::string &id, std::ostream &os=std::cout)
Print detailed usage description.
Definition: stfinvany.cc:164
void engines(std::ostream &os)
Definition: stfinvany.cc:187
C++ interface and abstract base class (prototypes)
static void help(std::ostream &os=std::cout)
List engines currently recognized and print summary.
Definition: stfinvany.cc:145
void help(std::ostream &os)
Definition: stfinvany.cc:192
~STFEngine()
Destructor must remove engine.
Definition: stfinvany.cc:127
Abstract base class for engines to derive source correction filter.
Definition: stfinvbase.h:208
std::vector< stfinv::WaveformTriple > Tvectoroftriples
Vector of triples.
Definition: stfinvbase.h:132
Class to access any engine in the library.
Definition: stfinvany.h:60
stfinv::STFBaseEngine * Mengine
Pointer to actual engine.
Definition: stfinvany.h:140
void usage(const std::string &id, std::ostream &os)
Definition: stfinvany.cc:197