trdefaults.pf - default initialization values for the trace library
The trace library specializes in the manipulation of trace data,
especially reading and writing data between databases on disk
and an internal database specially designed for trace manipulation.
A few of the default values may occasionally need to be overridden
for some special purpose. The trdefaults parameter file provides a
central location to perform such modifications. It also figures in the
procedure for adding a new waveform type.
-
waveform_types
This table lists waveform types which are recognized by the library.
As delivered, all of the types have routines for reading the waveform
type, and most have corresponding routines for writing. However, it's
possible to add new types, or perhaps add the capability of writing some
type which is not currently supported. Refer to addwf(5) for more information.
-
tick_tolerance
When splicing together waveform segments, several tests are performed to ensure
that the segments are truly contiguous. The common tolerance in these tests is
the fraction of a sample period by which adjacent samples can vary from the computed
value and still be considered contiguous. The default is 1/2 sample.
-
samprate_tolerance
A second test is sample rate, which is much more strict: the default tolerance
is "ABS(1-s1/s2) < .0001".
-
verbose_splicing
If splicing fails mysteriously, one can optionally print some potentially
interesting numbers by repeating the operation with the verbose_splicing
parameter set to yes.
-
max_open_files
Some of the routines underlying trsave_wf might potentially open very many files,
causing the process to run out of file descriptors. Setting a limit prevents
this. Typically the limit is calculated dynamically using getrlimit(2), but an
explicit number may be put in here instead.
-
default_datatype
trsave_wf(3) (and most Antelope programs) save data in this
default format (sd) if no other format is specified.
-
default_waveform_pattern
default naming pattern for waveforms (see trwfname(3))
-
multiply_calib_in_sac_output
SAC format does not include a calib value (at least one that is normally used.)
This leaves open the question of how to deal with calib when creating sac output format.
One approach is to always save the raw data into the sac output, ignoring calib.
Another approach is to multiply the waveforms by calib, presumably converting
the output to velocity units (or acceleration or displacement, depending on segtype).
This behavior may be specified using the flag multiply_calib_in_sac_output from
trdefaults.pf.
When importing and exporting data, some data may use keys other
than station and channel codes
to uniquely identify a datastream. SEED uses net and loc codes to
disambiguate these situations; autodrm uses net and aux codes.
The css 3.0 schema uses only sta and chan to uniquely identify a data stream,
and does not include net and loc codes.
This might lead potentially
to multiple data streams with the same sta and chan codes.
Antelope addresses this problem by providing a mechanism for
folding the network code into the station key, and the loc/aux code
into the channel key, when required. This is handled by the routines
map_autodrm_netsta(3), map_seed_chanloc(3), map_autodrm_chanaux(3),
map_seed_netsta(3), autodrm_net(3), seed_net(3), autodrm_aux(3),
and seed_loc(3).
These routines first consult the foreignkeys database, the location of
which is specified here. This database provides
explicit mappings between foreign and local keys. If no
mapping exists in the database, the routines consult defaults from
trdefaults.
When mapping from foreign keys into local keys, the
lists seed_net_sta, seed_sta_chan_loc, autodrm_net_sta, and autodrm_sta_chan_aux
provide default mappings using regular expressions. Each entry in the list consists of
a regular expression followed by the appropriate remapping. (See morphtbl(3)
for more examples).
For each list, a
name is formed by joining the appropriate keys (ie, net and foreign station code fsta) with underscores
(ie, net_fsta). Then
the list is inspected for a matching regular expression.
If a match is found, the corresponding remapping is
used to obtain the local key (either sta or chan).
If a match is found, and the foreignkeys database is writable, the routines
add an appropriate entry to that database.
When mapping from
local keys into foreign keys, the foreignkeys database is first consulted.
If no match is found, then the values of
default_autodrm_network, default_aux_code, default_seed_network, and default_loc_code
are used.
Unlike the the foreign to local mapping,
entries are not automatically added to foreignkeys tables by
the inverse (local to foreign) mapping.
trmapnames(1) can also be used to show this inverse mapping.
You can interactively query the foreignkeys database (or add to it)
with the program trmapnames(1).
-
foreignkeys_database
specifies a default database to use for transformations between external
(SEED and autoDRM) net/sta, chan/loc and local sta, chan. The database
is relative to ANTELOPE; the default is in $ANTELOPE/data/site/foreignkeys.
-
seed_net_sta
-
seed_sta_chan_loc
-
autodrm_net_sta
-
autodrm_sta_chan_aux
When mapping from foreign keys into local keys, the
lists seed_net_sta, seed_sta_chan_loc, autodrm_net_sta, and autodrm_sta_chan_aux
provide default mappings using regular expressions. Each entry in the list consists of
a regular expression followed by the appropriate remapping. (See morphtbl(3)
for more examples).
-
default_autodrm_network
-
default_aux_code
-
default_seed_network
-
default_loc_code
When mapping from local keys into foreign keys,
the default parameters above are used only when
lookup in the foreignkeys database fails.
-
reference_coordinates
autodrm(1) requires filling in a "reference_coordinates" field in
various parts of its output. This parameter is not present in any CSS
table, nor is it commonly maintained anywhere else. A default value
is kept here, where it is used to fill in the waveform headers used by
autodrm. The default is WGS-84.
-
miniseed_record_size
The default record size of 4096 for steim compressed data may be
overridden with this parameter. The value must be a power of 2,
and at least 128.
-
miniseed_dataformat
The default dataformat is 11, corresponding to steim compression level 2.
Steim compression level 1 may be forced by setting this parameter to 10.
-
miniseed_has_b100
By default, the software inserts a blockette 100, providing sample rate
at a higher resolution (and in a more convenient format) than the
standard miniseed header. However, this blockette uses one more 64 byte
frame of a miniseed record. Set this value to no to suppress
the generation of blockette 100's.
-
miniseed_has_b1001
The 1001 blockette allows specifying microsecond precision in the time
tags for a miniseed block, as well as a "timing quality" and a frame count.
If miniseed_has_b1001 is set to yes, then Antelope provides a 1001 blockette
with time specified to the microsecond (typically exceeding the accuracy
of the timing measurement). The "timing quality" is filled in with a
default number specified in trdefaults.pf: miniseed_timing_quality.
-
miniseed_timing_quality
This is the default value filled in for the "timing quality". The default value
49 is not one that the Quanterra baler will ever produce.
-
ignore_miniseed_errors
Antelope is insistent that miniseed be properly written. However, some
miniseed incorporates errors, but may nonetheless be readable. This
will turn off the error detection. This should only be done with caution
and for a particular dataset, not as a routine practice. Instead, the
source of the bad miniseed should be determined and corrected.
-
miniseed_segment_seconds
When generating wfdisc records for large miniseed volumes, one can cause the
wfdisc records to occur at approximate day or hour boundaries by
setting this parameter appropriately. The default value of 86400 selects
day boundaries; zero would eliminate boundaries. The boundaries always
fall on miniseed record boundaries, so the boundaries will seldom be exactly
as requested, but only as close as possible. The first miniseed record following
a boundary should get a wfdisc record.
$(TRLIBS)
trsave_wf(3)
trsplice(3)
orb2db(1)
autodrm_net(3)
PFPATH can be used to override the default location of this file.
Daniel Quinlan
Table of Contents
Antelope Release 4.8 Darwin 8.7.0 2006-09-26
Boulder Real Time Technologies, Inc
For more information, contact support@brtt.com