README 2.13 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
this is <README>
============================================================================
TSXX --- basic code to handle time series analysis 
-------------------------------
$Id$
============================================================================

This library provides modules for time series analysis.
In particular this are functions that also need seismic trace header data
(like the sampling interval) additional to the time series samples
themselves.
Provided are recursive filters (i.e. an interface to seife), FIR decimating
filters, interpolation filters, tapers, containers for time series data
together with header data, and more.

16
17
18
19
20
21
22
23
24
25
26
Installation
------------
 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
27
                  inthe Makefile).
28
29
30
31
32
33

make all             installs headers, binary libraries and documentation

Other libraries that are required to compile libtsxx:
libaff, libtfxx, libgsexx, libtime, libdatrwxx, libsffxx, libcseife

34
35
36
37
38
39
40
41
42
43
44
45
46
47
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.

Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at 
  http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.

48

49
50
51
52
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.

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