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

[WP][DOC] (libstfinv): provide use text for Fourier domain procedures

parent 7eb0f3d8
# this is <stfinvfourier_description_usage.txt>
# ----------------------------------------------------------------------------
#
Procedures in the Fourier domain
--------------------------------
Options and parameters in common for procedures in the Fourier domain:
fpow2 use power of two for number of coefficients
fdiv=d use integer multiple of d for number of coefficients
fpad=f padding factor
tshift=d delay source correction filter wavelet by d (in seconds)
in order to expose acausal components
================================
Detailed description
--------------------
Options and parameters in common for Fourier engines:
fpad=f padding factor (default: 1.5)
fpow2 use power of two
fdiv=d use integer multiple of d
tshift=d delay source correction filter wavelet by "d"
seconds in order to expose acausal parts
These options define the number of samples N used for the FFT.
This should be larger than the number of samples M in the
original series to avoid wrap-around. N=M*f at least. If fpow2
is set, N will be the next power of 2 larger than M*f. Else if
fdiv is set, N will be the next integer multiple of d larger
than M*f.
These options define the number of samples N used for the FFT (Fast Fourier
Transform). This number N should be larger than the number of samples M in the
original input time series to avoid wrap-around. If fpow2 is set, N will be
the next power of 2 larger than M*f. Else if fdiv is set, N will be the next
integer multiple of d larger than M*f.
The derived correction filter in some cases can contain acausal components.
This means that the impulse response is non-zero for negative time values.
Since by definition, the impulse response is output for the time interval of
the input data, these acausal components can remain unnoticed. The option
tshift can be used to shift the impulse response as obtained by inverse FFT in
order to expose acausal components.
# ----- END OF stfinvfourier_description_usage.txt -----
......@@ -2,8 +2,10 @@
# ----------------------------------------------------------------------------
#
Procedures in the Fourier domain
================================
Summary
-------
NO YET IMPLEMENTED!
--------------------------------
Options and parameters in common for procedures in the Fourier domain:
fpow2 use power of two for number of coefficients
fdiv=d use integer multiple of d for number of coefficients
fpad=f padding factor
tshift=d delay source correction filter wavelet by d (in seconds)
# ----- END OF stfinvfourier_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