source: trunk/params/localmag.d @ 7968

Revision 7968, 18.1 KB checked in by paulf, 4 months ago (diff)

updated common params dir with latest .d .desc from source

  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
Line 
1# Configuration file for the localmag program
2# Some of these parameters can be overridden on the command-line;
3# some of them only make sense on the command-line.
4#
5# As of 20 December, 2000, there is NO SUPPORT for Earthworm Database (EWDB)
6#
7# Required Commands:
8# The following five commands are always required by localmag.
9# Other commands below may be required when certain options are given.
10#
11# maxSta number
12# The number of stations to be used by localmag must be specified with
13# the maxSta command. This is the number of unique SNs to be used.
14# A total of 6 * maxSta channel structures will be allocated.
15# The maxSta command must come before any "Pri" commands.
16
17maxSta 100
18
19# maxDist km
20# The maximum epicenter - station distance in kilometers.
21# Stations lying outside this radius will not be used by localmag.
22#
23maxDist 600
24
25# If ML_min < ML < ML_Max: Apply linear correction to ML: ML_final = m * ML + b
26#                  m        b   ML_min ML_max
27#LinearCorrection 0.8548 0.8324  0.     4.8
28
29# maxTrace nsamples
30# The maximum number of trace data samples to process from one SCN.
31# This is the product of the trace length in seconds and the highest
32# expected sample rate. For example, 10 minutes of data at 100 samples per
33# second gives 60000 samples.
34
35maxTrace 60000
36
37
38# logA0 filename
39# The file containing the table of -logA0 values versus distance.
40# This file mist start with two commands:
41#   Dist <type>: which distance is to used to access this table.
42#        choices are: epi - station - epicenter distance
43#                     hypo - station - hypocenter distance (use event depth
44#                          but not station depth.)
45#   nDist number: the number of table entries that follow.
46#  Following these two commands are 'nDist' lines of distance and -logA0
47#  values. The distance numbers must be integer values, in kilometers.
48#  The -logA0 values are positive decimal values.
49#  Entries MUST be in order of increasing distance.
50#  When this table is used to find the -logA0 value, the entry with distance
51#  nearest to the desired distance will be used. If the desired distance
52#  exceeds the largest distance in this table, then the -logA0 value for
53#  the last table entry will be returned.
54
55logA0 Richter.tab
56
57
58# staLoc: station location source
59#    Choices: File <loc-file> - get station locations from a hyp2000-format
60#                               file named loc-file
61#             EWDB - query the EW database for station locations; access info
62#                    given below.
63#             SAC - get station locations from the header of SAC files.
64#                   Can be either station lat and lon, or station-epicenter
65#                   distance in the SAC header.
66
67staLoc File /data0/earthworm/run/params/hypoinverse/stas/uw_sta.hinv
68
69
70# Regional Velocity model: must be specified as "@vel_model_file". Typically
71#    this will be the same file as used for binder_ew.
72
73@uw_velocity.d
74
75# Speed of Sg wave; provides a good estimate of the Wood-Anderson peak arrival
76
77SgSpeed 3.39
78
79
80# Optional Commands
81#
82# eventSource: Tells localmag how and where to learn about a new event
83#    choices are: ARCH - hyp2000 archive message
84#                 SAC - SAC file header;
85#                 EWDB <eventID> - query EW database for eventID; usually
86#                            given as command-line option.
87#    default: ARCH
88# eventSource ARCH
89
90
91# traceSource: Where localmag will obtain trace data
92#    choices are: waveServer <server-list> - raw traces from wave_servers;
93#                              server-list is either a space separated list
94#                              of ip-address:port or
95#                           "File <server-file>"
96#                 SACFile - raw traces from SAC files
97#                 SACWAFile - synthetic Wood-Anderson traces from SAC files
98#                 EWDB - raw traces from EW database; access info given below
99#    default: waveServer with list of servers read from $EW_PARAMS/servers
100
101# traceSource waveServer File servers
102
103
104# Add STA COMP NET LOC
105# Del STA COMP NET LOC
106# SCNL selection is done by a selection list and a rejection list.
107# The station selection command 'Add' specifies the names of
108# STA (station), COMP (component), and NET (network).
109# The wildcard '*' may be used for any or all of STA, COMP, NET, LOC
110# COMP may be given as the first two letters of the component name,
111# to select all direction desgnators are accepted for that component.
112# If no Add commands are given, all SCNs will be selected.
113# The Del command is used to put SCNs on the rejection list:
114# for example: "Add * EL UW *" followed by "Del LAB EL UW *" to include
115# all ELE and ELN components from UW except LAB.ELE.UW.-- and LAB.ELN.UW.--.
116# Localmag will NEVER use vertical components.
117# List as many Add and Del commands as desired, one to a line
118
119Add * BH * *
120Add * HH * *
121Add * SL * *
122Add * EL * *
123Del LAB * UW *
124
125
126# respSource: Tells localmag where to get response information;
127#   may be ommitted if traceSource points to Wood-Anderson
128#    Choices: EWDB - query the EW databse for pole-zero-gain responses.
129#             SAC <pz-filename-format> - find response files in the
130#                            SAC directory given with SACsource.
131#                            filename-format is a string similar to printf
132#                            format: %S, %C, %N are replaced by station,
133#                            component and network names, respectively,
134#                            all in upper case. Similarly %s, %c, %n work
135#                            for lower-case station, component and network.
136#                            The digraph %% stands for %; all other
137#                            characters are taken literally.
138#                            The response file format is that used by SAC.
139#             File <dirname> <pz-filename-format> - find response files in
140#                            directory dirname with file names given by
141#                            pz-filename-format, as above. dirname can be
142#                            a full directory name, or relative to $EW_PARAMS.
143#
144#    default: none; you must specify one of the above choices.
145
146respSource File responses %S_%C_%N.pz
147
148
149# readAmpDirect: flag to tell localmag to read Wood-Anderson amplitudes
150#   directly from a 'trace' source instead of from Wood-Anderson traces.
151#   If this flag is used, then traceSource must be one that includes
152#   amplitude data, such as SAC files, EW database.
153#
154# default: flag is not present, so localmag reads amplitudes from
155#   Wood-Anderson traces that it either synthesizes or reads from traceSource.
156
157
158# extraDelay seconds
159# number of seconds to wait after the total trace length has arrived at
160# most distant station before processing event; used only when localmag is
161# running as an Earthworm module.
162# default: extraDelay 0.0  # no extra delay added to estimated propagation time
163
164extraDelay 0.0
165
166
167# waitNow is an OPTIONAL flag (no args required) which tells localmag to wait
168# "extraDelay" seconds from when the TYPE_HYP2000ARC message is received
169#
170#waitNow 
171
172
173# traceTimes start end
174# The start and end times for traces is set here.
175#   <start> is the number of seconds before estimated P arrival to start
176#           the trace.
177#   <end> is the number of seconds after estimated Sg arrival to end the trace.
178#   default: traceTimes 5.0 60.0 # starts trace 5 seconds before estimated P
179#           arrival and ends trace 60 seconds after estimated S arrival.
180# WARNING: if searchTimesTauSFunc is set, traceTimes is ignored
181
182traceTimes 5.0 60.0
183
184
185# searchStartPhase phase
186# The phase to use for computing the start of the peak serach window
187#    Choices: P - the first-arriving P phase from the layered velocity model
188#             S - the first-arriving S phase from the layered velocity model
189#    default: searchStartPhase S
190
191searchStartPhase S
192
193
194# searchTimes A B
195# The time window for searching for peak amplitudes is set here.
196#    <A> number of seconds before the searchStartPhase to start the
197#        search window.
198#    <B> is the  number of seconds of seconds after the constant-speed Sg
199#        arrival to end the search window
200# default: searchWindow 1.0 45.0 # Search window runs from 1 second
201#        before searchStartPhase arrival to 45 seconds after Sg arrival
202
203searchTimes 1.0 45.0
204
205# searchTimesTauSFunc  K1 K2  A B  deltaA deltaB
206# The time window for searching for peak amplitudes is:
207#    <searchStartTime> A seconds before the Estimated_P_Times
208#    <searchEndTime>   B seconds after
209#                      Estimated_S_Times + ( K1 * ( 1 - exp( - TauS / K2 ) ) )
210#                      where TauS = Estimated_S_Times - Origin_Time
211# The time window for cutting traces is:
212#    <traceStartTime> deltaA seconds before <searchStartTime>
213#    <traceEndTime>   deltaB seconds after  <searchEndTime>
214# example: searchTimesTauSFunc 40.0 30.0  1.0 1.0  19.0 9.0
215# WARNING: searchTimesTauSFunc conflicts with searchTimes
216# WARNING: traceTimes is ignored if searchTimesTauSFunc is used
217
218# searchTimesTauSFunc 40.0 30.0  1.0 1.0  19.0 9.0
219
220
221# slideLength n
222# Set the width of of the sliding search window to n seconds.
223# default: slideLength 0.8 # sliding search window is 0.8 seconds wide
224
225slideLength 0.8
226
227
228# z2pThresh is the threshold by which the zero-to-peak maximum in the
229# search window must exceed twice the zero-to-peak maximum from the
230# pre-event portion of the trace. This test tries to ensure that the
231# zero-to-peak and peak-to-peak values are seismic and not just noise.
232# default: z2pThresh 3.0
233
234z2pThresh 3.0
235
236# meanCompMags: If present, this command causes localmag to compute a
237#    stations local magnitude by taking the mean of the local magnitudes
238#    for each of its horizontal components, Otherwise, localmag will take
239#    the average of the component amplitudes and use that to find the
240#    local magnitude for the station.
241
242# require2Horizontals: If present, this new command requires that both horizontal components
243#    be valid in order for a station's channel mags to be used in the magnitude computation
244
245# allowVerticals: If present, this allows the Richter.tab to have a 3rd column for vertical
246#    logA0 attenuation and Z components will be included. WonYoung Kim of LCSN wrote a paper
247#    in BSSA that computed vertical attenuation relationships for the NE USA
248
249# if this next line is used, then the orientation char can be mapped
250# to an actual orientation letter for use in localmag (which only knows N and E for horizontal
251# components (not names like EH1 or EH2).
252#
253ChannelNumberMap   ENZ   # map 1 2 3 to ENZ to allow oddly oriented sensors to be used
254
255
256# useMedian - an optional flag to turn compute magnitude using L1 norm instead of averaging
257
258# ResponseInMeters - an optional flag to convert SAC P&Z from meters into what is required
259#                       units of nanometers. Allows use of rdseed -pf  files directly.
260
261# WoodAndersonCoefs <period> <damp> <gain>: optional command to specify the
262#   coefficients used for the Wood-Anderson instrument response. The standard
263#   parameters for the transfer function are:
264#   period: 0.8 seconds; damping 0.8 critical; gain: 2800
265#   However, testing by Uhrhammer & Collins (BSSA 1990, V80 p702-716) and
266#   others indicate better values are:
267#   period 0.8 seconds; damping 0.7 critical; gain 2080 (twenty-eighty)
268#
269# default: WoodAndersonCoefs 0.8 0.8 2800
270
271
272# saveTrace: whether and how to save synthetic Wood-Anderson traces
273#            If saveTrace command is absent, no traces will be saved.
274#   Choices: SAC <baseDir> <dirFormat> <filename-format> -
275#                  save W-A traces in SAC-format files.
276#                baseDir specifies a fixed directory name.
277#                dirFormat gives a formattted subdirectory name; the
278#                  format string is that used for the "date" command applied
279#                  to the event origin time, with the addition of '%i'
280#                  to indicate the event ID and optionally '%v' for the
281#                  origin version. Be careful with this; some
282#                  formats produce output not compatible with file names.
283#                filename-format gives the formatted file name using
284#                  % to introduce one of the format specifiers "sScCnN%"
285#                  's' is the station name in lower case; 'S' is upper case
286#                  Likewise for component and network names; '%' stands for
287#                  itself. All other characters are taken literally.
288#
289#   default: None (no Wood-Anderson traces are saved.)
290
291
292# outputFormat: how localmag reports its results; results are always logged
293#    Choices: LM - TYPE_MAGNITUDE message to earthworm transport
294#             File <filename> - write TYPE_MAGNITUDE message to the
295#                  file specified by filename. Standalone mode only.
296#             EWDB - send results to Earthworm database.
297#  default: LM if using earthworm transport; no report otherwise
298
299
300#
301# EWDBaccess user password service 
302#            How to access the Earthworm Database, if needed.
303#            Give the user name, password, and srvice needed for connection.
304# default: none
305
306
307# SACsource <SAC-directory> <filename-format>: where to find SAC files for
308#                            reading.
309#                            <SAC-directory> is a fixed directory name
310#                            <filename-format> is the format for SAC
311#                            file names.
312#                            This command or its equivalent on the command
313#                            line is required if traceSource or respSource
314#                            is SAC files.
315
316SACsource /data0/earthworm/working/src/localmag/Test/98042703361 %S.%C
317
318
319# wsTimeout: wave_server timeout in milliseconds
320#    default: 5000 milliseconds
321
322# wsTimeout 10000
323
324
325# Earthworm Transport commands. Use these commands to make localmag
326#   run as an earthworm module to run continuously.
327#   Otherwise localmag runs as a standalone program and handles a
328#   single event per invocation.
329#
330# RingInName <ring>: specify the name of the earthworm transport ring from
331#  which to read TYPE_HYP2000ARC messages for event notification.
332
333# RingInName HYPO_RING
334
335# RingOutName <ring>: specify the name of the earthworm transport ring to
336#  which Magnitude, Heartbeat and Error messages are sent. This may be
337#  the same as RingInName if desired.
338
339# RingOutName HYPO_RING
340
341# MyModId <module-id>: specify the module ID for localmag
342# MyModId MOD_LOCALMAG
343
344# HeartBeatInterval int: How often localmag should beat its heart.
345#  Currently, localmag will not issue heartbeats while it is busy doing
346#  calculations for an event. Thus a heartbeat could be late by as much as the
347#  time it takes to do a full localmag event calculation. Be sure that
348#  statmgr will wait that long for the heartbeat.
349
350# HeartBeatInterval 30
351
352# getEventsFrom  INST_ID MOD_ID
353# Specify the installation ID and module ID names from which to get
354# hypoinverse archive messages to read event data. These names may be
355# selected from earthworm.d and earthworm_global.d Only required when
356# localmag is running as an Earthworm module. No default values.
357# Use as many of these commands as necessary.
358#
359# To support the new TYPE_LOC_GLOBAL message, without impacting previous
360# installations, if the message type is missing, it will be taken
361# to be HYP2000ARC.  To process the global messages, the type
362# must be included on the line.
363#
364
365getEventsFrom INST_WILDCARD MOD_WILDCARD
366getEventsFrom INST_WILDCARD MOD_WILDCARD TYPE_LOC_GLOBAL
367
368saveSCNL 1        # Output TYPE_MAGNITUDE channel mag lines with SCNL (old style was SCN)
369
370eventXML 1        # Output shakemap style event information to XML file in sac dir
371                  # which can be specified in the saveTrace optional command.
372                  # Note this can only work if you choose SAC file output at this time.
373                  # This feature contributed by INGV.
374
375# saveXMLdir /mydir/eventXMLdir  # If set, will be used in lieu of the sac output dir
376                                 # for the shakemap event XML output file. If set, also
377                                 # turns on the saving of these files (i.e. eventXML
378                                 # flag is ignored)....
379                                 #         <Event-Id>_<Origin-Version>_event.xml
380
381# MlmsgOutDir /mydir/Mlmsgdir    # If set, all LM messages will be saved in distinct files
382                                 #         MlmsgOutDir/<Event-Id>_<Origin-Version>.lm
383
384LogFile 1         # 1 -> Keep log, 0 -> no log file
385                  # 2 -> log to module log but not to stderr/stdout
386                  # default: LogFile 1
387
388
389# Debug N
390# There are several different debug features, listed below.
391# You can give one Debug command for each feature you want to turn on,
392# or you can add together the values of desired features and give
393# one Debug command.
394# value   feature
395#     1   trace and search times and P and S arrival estimates
396#     2   SCN selection tests
397#     4   distance and LogA0 values
398#     8   SAC file selection (only if traceSource is SAC)
399#    16   ws_client debugging
400#    32   poles. zeros and gain values
401#    64   trial frequency response functions to STDOUT
402#   128   full frequency response function to STDOUT
403#   256   input and output trace date including in padded area
404
405
406# SCN Parameters: normally this command will be given as "@scn_param_file"
407# to cause the separate file "scn_param_file" to be processed.
408
409
410# Optional parameter to use with eqassemble which declares the version
411# of an event such as Prelim, Rapid and Final. Possible values for the
412# parameter LookAtVersion are: All, Prelim, Rapid and Final.
413# Default is All.
414# LookAtVersion All
415
416# Not compute magnitude for stations which have not a phase P or S in the ARC message.
417# SkipStationsNotInArc
418
419# Take in account only stations for which the weight of a phase is
420# greater than MAX(weights in ARC) * (MinWeightPercent / 100.0)
421# Used only with parameter SkipStationsNotInArc
422# Range: 0 .. 99
423# Default: 0 (all phases will be taken)
424# MinWeightPercent 10.0
425
426# MLQpar1 is the first parameter used for estimating the quality of magnitude.
427# MLQpar1 is a real number and it has to be greater than zero.  If you do not
428# declare MLQpar1 then the quality will be always equal to -1.
429# Otherwise:
430#          quality = Number of channels / ( Magnitude * MLQpar1)
431#          If quality is greater than 1, it will be set to 1.
432# MLQpar1 10.0
433
434
435#Magnitude corrections per SCNL, tapers, and clip levels can be specified by this lookaside file example
436@localmag.scnl_par.d
Note: See TracBrowser for help on using the repository browser.