Engine to provide a fixed wavelet. More...

#include <stfinvfixedstf.h>

Inheritance diagram for stfinv::STFEngineFixedWavelet:

Collaboration diagram for stfinv::STFEngineFixedWavelet:

[legend]

Public Types
typedef Tfftengine::TAseries	TAseries
	type of array for time series values More...

typedef Tfftengine::TAspectrum	TAspectrum
	type of array for Fourier transforms More...

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

typedef fourier::fft::DRFFTWAFFArrayEngine	Tfftengine
	type of underlying Fourier engine More...

Public Member Functions
	STFEngineFixedWavelet (const stfinv::Tvectoroftriples &triples, const stfinv::Waveform &stf, const std::string &parameters)
	Constructor. More...

virtual	~STFEngineFixedWavelet ()
	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
See also Information for users of libstfinv (programmers)
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 ="use fixed wavelet as read from file"
	short description of this engine More...

static const char *const	ID ="fix"
	ID used to select thsi engine. More...

Protected Member Functions
void	initialize ()
	initialize work space More...

Access and control functions to be used by derived classes.
These functions are part of the interface implemented in STFFourierDomainEngine.
void	fftinput ()
	copy input signals to workspace and transform input workspace to Fourier domain More...

void	fftoutput ()
	convolve synthetics with Fourier transform of stf and transform convolved synthetics and stf to time domain and pass signals to user memory space More...

TAspectrum	recordingspec () const
	return reference to Fourier transform of recorded data More...

TAspectrum	syntheticspec () const
	return reference to Fourier transform of synthetics More...

TAspectrum	stfspec () const
	return reference to Fourier transform of stf More...

TAspectrum	recordingcoeff (const unsigned int &i) const
	return reference to Fourier coeffients of recorded data for frequency i More...

TAspectrum	syntheticcoeff (const unsigned int &i) const
	return reference to Fourier coefficients of synthetics for frequency i More...

TAspectrum::Tvalue &	stfcoeff (const unsigned int &i) const
	return reference to Fourier coefficients of stf for frequency i More...

double	frequency (const unsigned int &i) const
	return value of frequency i in Hz More...

unsigned int	nfreq () const
	return number of frequencies in use More...

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...

Detailed Description

Engine to provide a fixed wavelet.

Attention: This engine is not yet implemented. As long a stfinv::STFEngineFixedWavelet is not made available through stfinv::STFEngine::initialize it must be regarded as a stub.

Definition at line 55 of file stfinvfixedstf.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description