README 5.63 KB
Newer Older
1
2
3
this is <README>
============================================================================
ts/wf: time series waveform filters
4
-----------------------------------
5
6
$Id$
============================================================================
7
8

This is a collection of various filter programs which can be used to
9
10
11
12
13
14
15
16
manipulate time series data. The area of application ranges from long period
seismology to shallow seismics.

Some of the programs support only SFF data files. See usage information (by
calling the program with option '-help') for details. Some Fortran programs
support linking against libfapidxx. They commonly are provided in form of two
binary executables (e.g. susei: SFF support only; suseix: supports all
libdatrwxx formats). See variable PROGRAMS in Makefile.
17
18
19

Currently maintained programs:

20
21
Waveform filters
----------------
22
23
24
25
Programs provide frequency filters (high-pass, low-pass, etc), average and
trend removal, time domain tapers, etc. 
  stufi     filter SFF data files (uses seife filters by E. Wielandt)
  tidofi    filter data files in various formats
26
  tsfilt    filter two-column ASCII files (uses seife filters by E. Wielandt)
27
28
29
30

Vector signal component rotation
--------------------------------
  coro      select a spatial vector component from three component data
31
  rotate    rotate horizontal components
32
  xyz2uvw   rotate to internal STS-2 components and vice versa
33
34
35

Multi-signal
------------
36
37
38
  dise      calculate waveform residuals of selected traces from two input files
  gatherdiff calculate waveform residuals of full shot gathers
  sigfit    find linear regression coefficients for a set of trial signals
39
40
41
  susei     stack seismograms from two or more files
  suspect   stack seismograms after shifting to source origin time
  teseco    apply signal corrections (like barometric pressure correction)
42
43
44

Transformation
--------------
45
  evelo     calculate Hilbert transform, signal envelope, etc.
46
47
48
  foutra    apply Fourier transformation (optionally calculates PSD)

  fregra    spectrogram for unevenly sampled frequencies (not finished)
49

50
51
52
53
54
Correlation and Convolution
---------------------------
  autocorr  calculate autocorrelation of signals
  cross     cross-correlate signals
  deconv    deconvolve one signal with another
55
  noisymize convolve signals with random noise
56
57
58

Resampling
----------
59
  resaseda  apply signal interpolation in the time domain
60
  smoos     apply signal interpolation by spectral extension
61

62
63
Miscellaneous
-------------
64
  fidasexx  scale shot gathers to compile homogeneous data set
65
66
  geophone  derive geophone response and create filter control file
  sigscale  scale SG056 auxilliary data to physical units
67
  sigval    extract waveform properties like rms and write to table
68
  soutifu   find optimal source wavelet correction filter 
69
  tisli     extract time slices from multi-receiver data
70

71
72
73
74
75
Test signals
------------
Test signal generators formerly present in this directory have been moved to
src/synt/misc. They may as well still be necessary for the filter test
procedures defined in subdirectory testcases
76

77
78
79
80
81
82
83
84
85
86
87
88
89
============================================================================
Test cases
----------

In subdirectory 'testcases' test cases for several filter programs are
provided. These are not yet documented in detail. Please check Makefile in
testcases, which serves as an entry point to the other Makefiles. Several of
the test cases can be controlled by make variables to be passed on the command
line. Test cases may require other external programs in order to create test
waveforms. These programs can include programs for synthesis of full
seismograms. At least the program suite from src/synt/misc is required in most
cases.

90
============================================================================
91

92
93
Installation
------------
94

95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
For compilation instructions see README.1st in the root directory of the
tar-ball or
http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/docs/installation 


The Makefile supports program compilation and linking. Some binary libraries
are required. 

The command
  make all
will compile and install the binary executables as well as the doxygen
documentation.

Environment variables control where the results are stored and where
libraries and library header files are expected:
  LOCLIBDIR           defines location of binary libraries
  LOCINCLUDEDIR       defines location of C/C++ header files (prototypes)
  LOCBINDIR           defines location of binary executables
  TF_WWWBASEDIR       defines location of doxygen output

Dependencies:
  Compilers required to build the programs:
thomas.forbriger's avatar
thomas.forbriger committed
117
    Fortran compiler
118
119
120
121
122
    C++ compiler
    C/C++ preprocessor
    doxygen (required to process source code documentation)

  extern libraries/packages needed to compile the code
thomas.forbriger's avatar
thomas.forbriger committed
123
    PGPLOT (libpgplot, libcpgplot)
124
125
    liblapack:      linear algebra package
    libblas:        basic linear algebra functions
thomas.forbriger's avatar
thomas.forbriger committed
126
127
128
    libgsl:         GNU scientific library (libgsl, libgslcblas)
    The header files for these libraries are required as well. Under OpenSuSE
    you have to install the respective devel packages.
129
130
131
132
  
  TFSoftware libraries required to compile the code:
    libaff
    libdatrwxx
thomas.forbriger's avatar
thomas.forbriger committed
133
134
135
136
137
138
139
140
    libfapidxx
    libfourier (libfourier, libfourierxx)
    libgsexx
    liblinearxx
    libpgplot++ (libpgplotCpp)
    libseife (libcseife, libseife)
    libsff
    libsffu
141
    libsffxx
thomas.forbriger's avatar
thomas.forbriger committed
142
143
    libstfinv
    libtf
144
    libtfxx
thomas.forbriger's avatar
thomas.forbriger committed
145
146
    libtime (libtime, libtime++)
    libtsxx
147
148
149
150
151
152
153
154
155
156

============================================================================

The home of this software suite is
http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/trunk/src/ts/wf

Please send bug reports and suggestions to
Thomas.Forbriger@kit.edu

----- END OF README -----