STFINV library: seek source wavelet correction filter
stfinvidentity.h
Go to the documentation of this file.
1 
37 // include guard
38 #ifndef STFINV_STFINVIDENTITY_H_VERSION
39 
40 #define STFINV_STFINVIDENTITY_H_VERSION \
41  "STFINV_STFINVIDENTITY_H V1.1"
42 
43 #include<stfinv/stfinvbase.h>
44 
45 namespace stfinv {
46 
57  public:
61  static const char* const ID;
63  static const char* const description;
67  const stfinv::Waveform& stf,
68  const std::string& parameters)
69  : Tbase(triples, stf, parameters),
70  Mscaleenergy(false)
71  { this->initialize(); }
75  const stfinv::Waveform& stf,
76  const stfinv::Tvectorofpairs& pairs,
77  const std::string& parameters)
78  : Tbase(triples, stf, pairs, parameters),
79  Mscaleenergy(false)
80  { this->initialize(); }
82  virtual ~STFEngineIdentity() { }
84  virtual void exec();
86  virtual void help(std::ostream& os=std::cout) const;
88  static void classhelp(std::ostream& os=std::cout);
90  virtual void usage(std::ostream& os=std::cout) const;
92  static void classusage(std::ostream& os=std::cout);
94  virtual const char* name() const;
95  private:
97  void initialize();
98 
99  // member data
100  private:
103  }; // class STFEngineIdentity
104 
105 } // namespace stfinv
106 
107 #endif // STFINV_STFINVIDENTITY_H_VERSION (includeguard)
108 
109 /* ----- END OF stfinvidentity.h ----- */
bool Mscaleenergy
scale energy
static const char *const ID
ID used to select thsi engine.
std::vector< stfinv::WaveformPair > Tvectorofpairs
Vector of pairs.
Definition: stfinvbase.h:125
virtual const char * name() const
return name of engine
Root namespace of library.
Definition: doxygen.txt:43
STFEngineIdentity(const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const stfinv::Tvectorofpairs &pairs, const std::string &parameters)
Constructor.
virtual void usage(std::ostream &os=std::cout) const
print detailed description
STFEngineIdentity(const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const std::string &parameters)
Constructor.
static const char *const description
short description of this engine
static void classusage(std::ostream &os=std::cout)
print detailed description
virtual ~STFEngineIdentity()
abstract base requires virtual destructor
Engine to apply a scalar factor.
A class to store a single waveform. This will be used to pass the source correction filter...
Definition: stfinvbase.h:111
stfinv::STFBaseEngine Tbase
typedef to refer to base class
void initialize()
initialize work space
C++ interface and abstract base class (prototypes)
virtual void help(std::ostream &os=std::cout) const
print online help
Abstract base class for engines to derive source correction filter.
Definition: stfinvbase.h:208
virtual void exec()
Start engine.
std::vector< stfinv::WaveformTriple > Tvectoroftriples
Vector of triples.
Definition: stfinvbase.h:132
Tseries stf() const
return source correction filter series
Definition: stfinvbase.h:273
static void classhelp(std::ostream &os=std::cout)
print online help