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

Class to access any engine in the library. More...

#include <stfinvany.h>

Collaboration diagram for stfinv::STFEngine:

Public Member Functions

 STFEngine (const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const std::string &parameters)
 Constructor. More...
 
 STFEngine (const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const stfinv::Tvectorofpairs &pairs, const std::string &parameters)
 Constructor. More...
 
 ~STFEngine ()
 Destructor must remove engine. More...
 
stfinv::Waveform run ()
 Start engine and return source correction filter. More...
 
stfinv::STFBaseEngineSTFBaseEngine ()
 Return actual engine. More...
 

Static Public Member Functions

static void engines (std::ostream &os=std::cout)
 List procedures (engines) currently recognized. More...
 
static void help (std::ostream &os=std::cout)
 List engines currently recognized and print summary. More...
 
static void usage (const std::string &id, std::ostream &os=std::cout)
 Print detailed usage description. More...
 

Private Member Functions

void initialize (const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const stfinv::Tvectorofpairs &pairs, const std::string &parameters)
 initialize engine. More...
 

Private Attributes

stfinv::STFBaseEngineMengine
 Pointer to actual engine. More...
 

Detailed Description

Class to access any engine in the library.

The interface of this class is identical to the interface defined by the abstract base class stfinv::STFBaseEngine except that the first prefix (up to the first colon) in the parameter string is understood to identify the selected engine.

It serves as a kind of handle to provide user selectable engines to application programs.

Definition at line 60 of file stfinvany.h.


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