Commit 13d2886f authored by thomas.forbriger's avatar thomas.forbriger
Browse files

[WP][DOC] (libstfinv): add usage information for common options

parent eb3f5a31
# this is <stfinvbase_description_usage.txt>
# ----------------------------------------------------------------------------
# Describe the overall concept of the library.
Create and apply source time function correction filters
========================================================
Detailed description
--------------------
Options and parameters in common for all engines:
verbose produce verbose output (if implemented)
DEBUG=l produce debug output with level l
exp=k apply offset dependent weights to signals
If implemented in the engine in use then setting the parameter
exp=k will give a weight factor of ((r/1m)**k) to each signal
in order to compensate the decrease in signal energy.
Common control parameters
-------------------------
Options and parameters in common for all procedures:
verbose produce verbose output (if implemented)
DEBUG=l produce debug output with level l
exp=k apply offset dependent weights to signals
Due to the amplitude decay with offset to the source signals from receivers at
larger offset would contribute less to the optimization criterion for which
the source wavelet correction filter is constructed. The option exp provides
means to add a weight factor ((r/1m)**k) to each signal, where r is the
receiver to source offset. This is used to compensate the decrease in signal
energy.
# ----- END OF stfinvbase_description_usage.txt -----
# this is <stfinvbase_summary_usage.txt>
# ----------------------------------------------------------------------------
#
Create and apply source time function correction filters
========================================================
Summary
-------
NO YET IMPLEMENTED!
Common control parameters
-------------------------
Options and parameters in common for all procedures:
verbose produce verbose output (if implemented)
DEBUG=l produce debug output with level l
exp=k apply offset dependent weights to signals
# ----- END OF stfinvbase_summary_usage.txt -----
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