STFINV library: seek source wavelet correction filter
stfinv.h File Reference

C API to library (prototypes) More...

Include dependency graph for stfinv.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  CPairs
 Array of waveform pairs.This is used to pass data for a set of synthetic time series, which should be convolved with the new source correction filter on the fly. A collection of time series consists of CPairs::n waveform pairs. For each waveform pair this struct holds a reference to a struct CWaveformPair which itself provides a reference to the users workspace for time series. More...
 
struct  CTriples
 Array of waveform triples.This is used to pass data for a complete profile. A profile consists of CTriples::n receivers. For each receiver this struct holds a reference to a struct CWaveformTriple which itself provides a reference to the users workspace for time series. More...
 
struct  CWaveform
 A struct to store a single waveform. More...
 
struct  CWaveformPair
 A struct to store the time series for a pair of waveforms.This struct provides references to the users workspace, where the time series for on receiver are stored. More...
 
struct  CWaveformTriple
 A struct to store the time series for a waveform triple.This struct provides references to the users workspace, where the time series for on receiver are stored. More...
 

Macros

#define STFINV_STFINV__H_VERSION   "STFINV_STFINV__H V1.3"
 

Functions

void freestfinvengine ()
 Free the engine. More...
 
void initstfinvengine (struct CTriples triples, struct CWaveform stf, char *parameters)
 Initialize the engine. More...
 
void initstfinvenginewithpairs (struct CTriples triples, struct CWaveform stf, struct CPairs pairs, char *parameters)
 Initialize the engine and pass additional time series to be convolved on the fly. More...
 
void printengines ()
 List procedures (engines) on stdout. More...
 
void printhelp ()
 Print usage summary to stdout. More...
 
void printusage (char *id)
 Print detailed description for engine "id" to stdout. More...
 
void runstfinvengine ()
 Run the engine. More...
 

Detailed Description

C API to library (prototypes)


Author
Thomas Forbriger
Date
06/05/2011

C API to library (prototypes)

Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach)


This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software

Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

REVISIONS and CHANGES

  • 06/05/2011 V1.0 Thomas Forbriger
  • 28/06/2011 V1.1 requires extern declaration for C++ since binary code is compiled by C++ compiler, not C compiler
  • 30/09/2011 V1.2 implemented handling of additional time series pairs
  • 14/10/2015 V1.3 new end-user usage functions

Definition in file stfinv.h.