Commit c49c7f3c authored by thomas.forbriger's avatar thomas.forbriger
Browse files

[WP][DOC] (libstfinv): add detailed description to README

parent 18b03b49
......@@ -3,39 +3,59 @@ this is <README>
STFINV -- library for determination of source wavelet correction filter
============================================================================
The purpose of this library is to provide methods for the derivation of source
wavelet correction filters in approaches to full waveform inversion. Given a
set of recorded data and a set of synthetic data (typically, but not
necessarilly the impulse response of the subsurface) a source wavelet
correction filter is obtained due to some optimization citerion. The synthetic
waveforms are convolved with this filter wavelet and the convolved synthetics
as well as the wavelet itself are returned to the user.
Purpose
-------
Create and apply a source wavelet correction filter for full-waveform
inversion of field data.
Installation
------------
See README.md and INSTALL.md in the root directory of the repository for
general installation instructions.
Description
-----------
The purpose of this library (libstfinv) is to provide methods for the
derivation of source wavelet correction filters in approaches to full waveform
inversion. Given a set of recorded data and a set of synthetic data
(typically, but not necessarilly the expected impulse response of the
subsurface) a source wavelet correction filter is obtained by application of a
user-selectable optimization citerion. The synthetic waveforms are convolved
with this filter wavelet and the convolved synthetics as well as the wavelet
itself are returned to the user.
environment variables:
LOCINCLUDEDIR Defines the path where header files will be copied for
usage in your own projects. You will pass this path to
the precompiler with the -I option.
LOCLIBDIR Defines the path where the binary library will be
placed.
TF_WWWBASEDIR Defines the path to your personal homepage. That's the
place where doxygen output will be written too (see
in the Makefile).
The effective time history of the seismic source used in field recordings is
not well known in most cases. This applies in particular to transient sources
(like explosives or hammer blows). The so-called 'source-time-function' might
even vary from shot to shot. For this reason it is not possible to use an
appropriate source-time-function in the initial simulation of synthetic data
in an approach of full-waveform inversion. However, after synthetic data have
been calculated using a generic source-time-function, a correction filter can
be constructed such that an improved source-time-function will reduce the
misfit to the recorded data.
make all installs headers, binary libraries and documentation
The software library libstfinv provides several constrained and unconstrained
approaches to finding an optimized source-wavelet correction filter. It is
flexible and capable of being extended with further approaches in the future.
The program soutifu supports application directly to seismic time series data
files.
Dependencies
------------
This library requires code from libaff and libfourierxx.
Am external dependency is fftw3
The testprogram requires libtfxx in addition.
Software library: libstfinv
---------------------------
The library libstfinv provides a C++ API (application programming interface)
as well as a C API to the user of the library. A Fortran API is not yet
implemented but could be constructed on top of the C API without effort. The
library provides several approaches (procedures) to finding an optimized
source wavelet correction filter. Each of the procedures is addressed through
the same API, such that programs using the library could immediately benefit
from a new approach after its implementation and without need to modify
consumer programs. The different procedures are encapsulated in so-called
'engines'. The procedures are fully controllable by the end-user through
configuration string sequences which are passed to the library.
A standalone binary executable soutifu which can be used to apply libstfinv to
waveform data files is provided in src/ts/wf.
Stand-alone binary executable: soutifu
--------------------------------------
A stand-alone binary executable soutifu is provided as well, which makes use
of this library. It can be applied directly to seismic time series data files
and provides access to all engines and supports a variety of data file
formats.
soutifu is provided in directory src/ts/wf within Seitosh.
Documentation
=============
......@@ -68,4 +88,27 @@ Lisa Groos. 2013. 2D full waveform inversion of shallow seismic Rayleigh waves.
Dissertation, Karlsruher Institut für Technologie.
http://nbn-resolving.org/urn:nbn:de:swb:90-373206
Installation
============
See README.md and INSTALL.md in the root directory of the repository for
general installation instructions.
environment variables:
LOCINCLUDEDIR Defines the path where header files will be copied for
usage in your own projects. You will pass this path to
the precompiler with the -I option.
LOCLIBDIR Defines the path where the binary library will be
placed.
TF_WWWBASEDIR Defines the path to your personal homepage. That's the
place where doxygen output will be written too (see
in the Makefile).
make all installs headers, binary libraries and documentation
Dependencies
------------
This library requires code from libaff and libfourierxx.
Am external dependency is fftw3
The testprogram requires libtfxx in addition.
----- END OF README -----
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment