STFINV library: seek source wavelet correction filter
stfinv::STFEngineIdentity Class Reference

Engine to apply a scalar factor. More...

#include <stfinvidentity.h>

Inheritance diagram for stfinv::STFEngineIdentity:
Collaboration diagram for stfinv::STFEngineIdentity:

Public Types

typedef stfinv::STFBaseEngine Tbase
 typedef to refer to base class More...
 

Public Member Functions

 STFEngineIdentity (const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const std::string &parameters)
 Constructor. More...
 
 STFEngineIdentity (const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const stfinv::Tvectorofpairs &pairs, const std::string &parameters)
 Constructor. More...
 
virtual ~STFEngineIdentity ()
 abstract base requires virtual destructor More...
 
virtual void exec ()
 Start engine. More...
 
virtual void help (std::ostream &os=std::cout) const
 print online help More...
 
virtual const char * name () const
 return name of engine More...
 
virtual void usage (std::ostream &os=std::cout) const
 print detailed description More...
 
Basic interface for users
stfinv::Waveform run ()
 Start engine and return reference to source correction filter. More...
 
Shape query functions
unsigned int nsamples () const
 return number of samples used in time series More...
 
unsigned int nreceivers () const
 return number of receiver signals in use More...
 
unsigned int npairs () const
 return number of additional signals to be convolved More...
 
double dt () const
 return sampling interval More...
 
Data query functions
Tseries stf () const
 return source correction filter series More...
 
Tseries::Tcoc recording (const unsigned int &i) const
 return recorded data at receiver i More...
 
Tseries::Tcoc synthetic (const unsigned int &i) const
 return synthetic data at receiver i More...
 
Tseries convolvedsynthetic (const unsigned int &i) const
 return synthetic data convolved with stf at receiver i More...
 
Tseries::Tcoc series (const unsigned int &i) const
 return synthetic data of pair i More...
 
Tseries convolvedseries (const unsigned int &i) const
 return synthetic data convolved with stf for pair i More...
 

Static Public Member Functions

static void classhelp (std::ostream &os=std::cout)
 print online help More...
 
static void classusage (std::ostream &os=std::cout)
 print detailed description More...
 

Static Public Attributes

static const char *const description ="scale with amplitude factor"
 short description of this engine More...
 
static const char *const ID ="ident"
 ID used to select thsi engine. More...
 

Protected Member Functions

Functions presented to derived classes
std::string parameter (const std::string &key, const std::string &defvalue="false") const
 return the value of a parameters More...
 
bool parameterisset (const std::string &key) const
 check is parameter was set by user More...
 
void checkreceiverindex (const unsigned int &i) const
 check for vaid receiver index More...
 
void checkseriesindex (const unsigned int &i) const
 check for vaid index off additional time series pair More...
 
double weight (const unsigned int &i) const
 return weight for signal at receiver i More...
 
aff::Series< double > weights () const
 return weights array More...
 

Protected Attributes

int Mdebug
 debug level More...
 
stfinv::Tvectorofpairs Mpairs
 Waveform pairs. More...
 
stfinv::Waveform Mstf
 source correction filter. More...
 
stfinv::Tvectoroftriples Mtriples
 Waveform triples. More...
 
int Mverbose
 verbose level More...
 

Private Member Functions

void initialize ()
 initialize work space More...
 

Private Attributes

bool Mscaleenergy
 scale energy More...
 

Detailed Description

Engine to apply a scalar factor.

Concept behin this engine
This engine convolves the synthetic data with a discrete delta pulse so to speak. Optionally the delta-peak ist scale such that the convolved synthetics will be of equal scaled energy as the recordings.

Definition at line 56 of file stfinvidentity.h.


The documentation for this class was generated from the following files: