Earthworm Quick Review

User's Guide

Lucky Vidmar

April 22, 2002

 

OBJECTIVE

The objective of the Interactive Earthworm Quick Review (EQR) is to provide Earthworm with a remote, rapid event review capability. Its intended use is permit a duty seismologist to rapidly respond to a significant event. It was not designed to serve as a routine analysis facility.

Its features include:

·        Requires only browser access to the Internet.

·        Interacts with events via the Earthworm DBMS.

·        Viewing and editing of automatic event parameters

·        Graphic re-picking.

·        Event relocation and re-insertion into DBMS.

·        Supports interlocks for concurrent reviewers.

 

SYSTEM OVERVIEW

The major software components of EQR are:

* The Oracle DBMS containing event parameters and event trace data.

* Webserver programs which manipulate the data and provide a user interface.

* The SeisGram2K applet (by Anthony Lomax), which provides interactive processing.

The EQR system works by allowing the analyst to retrieve an event from the DBMS, modify its parameters, relocate the event, and subsequently decide whether to reinsert the new solution or to delete the event from the DBMS. The system works in two modes: text-based and web-based.

The web-based review system is also file-based. The system creates a temporary directory into which all available information about the event is retrieved, and which the system uses to relocate and re-insert the event.

 

 

 

SYSTEM SETUP

This section assumes a user who is familiar with Earthworm setup procedures, as well as one with moderate familiarity with Oracle, Solaris, and Windows 2000.

When configuring EQR for the first time it is best to start from the sample directory which is a part of Earthworm distribution:

Create the web directory by copying the sample directory structure:

            mkdir $EW_HOME/web

     cd $EW_HOME/$EW_VERSION/web_sample

     tar -cf - . | (cd $EW_HOME/web; tar -xf -)

This will create the following directory tree

          web

              bin

              log

              params

              html

                   review

                   alarms

                   [ . . . ]

Make sure that the directories in the web tree are writeable by the user under which ID the web server is started:

            chown websrv.netscape $EW_HOME/web/*

 

Modify the configuration files to comply with the installation specific requirements. EQR relies on the following configuration files in $EW_HOME/web/params (samples of each are given in the appendix):

            * review_event.d - set up the paths, binaries, log directories, etc.

            * LM_review.d - name is set in review_event.d. Configures localmag to recompute

             the local magnitude for an event from a hypoinverse solution and amplitude picks

             read from the SAC headers of Wood-Anderson traces.

            * LM_writeWA.d - name is set in review_event.d. Configures localmag to

             produce SAC files of Wood-Anderson traces.

 

REVIEW PROCESS

EQR requires Netscape v4.5 or higher, and Microsoft Internet Explorer v5.0 or higher.

 

Warning about browser caching

 

Both Netscape and Internet Explorer browsers perform caching which may interfere with the operation of the procedures below. Caching refers to the browser's tendency to store web pages in local memory, and to preferentially display old, cached versions rather than requesting new ones from the web server.

To prevent Netscape from caching, set the cache size to 0:

Go to Edit/Preferences.

Click on the arrow next to Advanced.

Click on Cache from the lower list.

Set Disk Cache and Memory cache sizes to 0.

Click on both Clear Disk Cache and Clear Memory Cache

Click OK.
 

Procedure for the Internet Explorer:

Click on the "Tools" button on the top row of buttons.

From there, select "Internet Options".

Select "General"

On the center panel, labeled "Temporary Internet Files", select "settings"

On the radio-button set called "Check for newer versions of stored pages", select "Every visit to the page".

Close all windows via the "OK" button.

 

 

Retrieve an event for review

The interactions with the initial web page of Interactive Earthworm which allows the user to specify search criteria are beyond the scope of this document. Once the desired list of events is displayed, there are two ways for entering EQR:

            * By clicking on the event's box on the map; or

            * By clicking on the number of picks in the yellow column of the list of events.

Either action will open up a new browser window in which the event's parameters are shown. From this page the user can:

·        Manually modify the duration or local magnitudes;

·        Select which magnitude is to be preferred;

·        Manually modify the weights of arrival picks;

·        Graphically modify the arrival and amplitude picks by invoking the SeisGram2K applet. See below for detailed instruction on using the applet

·        Graphically create new arrival and amplitude picks from previously unpicked traces.

Clicking on "CLICK HERE TO SHOW THE MAP" produces a detailed map showing the stations which were used in the automatic solution. Empty triangles are used to show stations which did not participate; solid ones for those that did. The size of the map shown is accommodated to include the most distant station which was used in the automatic solution.

Clicking on the links under the "VIEW SEISMOGRAMS" label opens up a new browser window showing a static gif image of the available trace data.

Clicking on the link under “CLICK HERE FOR OTHER SOLUTIONS” will open up a new browser window showing other, non-preferred solutions (if any) and allowing the user to enter the review system for those particular solutions.

 

At the bottom of the initial page are four buttons:

·        Refresh - will reload the current page and display the latest event parameters. This is useful if the user graphically modified any channels. Note that refreshing any pages within EQR via the browser's Refresh button is highly discouraged.

·        Cancel - gracefully exit the system by deleting the temporary review directory so that another user can later review the same event.

·        Done - process the data from the web form (potentially modified magnitudes and picks) and prepare for continuation of the review process. At this point the user must decide what to do with the modified event parameters.

·        Retrieve Unpicked – retrieve from the database those traces that were not previously picked, allowing the user to create new arrival or amplitude picks. Once unpicked traces are retrieved, this button will no longer appear.

 

What to do with the modified event?

After clicking Done, the temporary review directory contains the latest, potentially modified, state of the event. The user is presented with three buttons:

·        Relocate - invoke hypoinverse on the event and read the new solution. Pass this new solution to localmag so that a new local magnitude can be calculated. Update the review directory with the outputs of hypoinverse and localmag and display the initial review page allowing the user to continue reviewing.

·        Re-Insert Event - read the event parameters from the temporary directory and write it to the database as a new and preferred solution.

·        Delete Event - delete all information associated with this event from the database.

If the user chooses to insert or delete the event, a confirmation page is presented. Here, the user can click Cancel to return to the initial review page. Otherwise, the user must select whether to enter the Alarms System before proceeding with the action (insertion or deletion). If the user chooses to proceed without alarms, the event is either inserted or deleted and a confirmation page is displayed. Here, if the event was just re-inserted into the database the user can click on Finish Reviewing to delete the temporary review directory on the server and terminate review, or Continue Reviewing to return to the event review page. However, if the event has been deleted from the database, the only option is to click on Finish Reviewing because the event has been permanently erased.

 

Alarms System

If the user chose to enter the Alarms System, the event's information is processed against the alarm rules from the database. If the event satisfies any of the rules (e.g., location polygon, magnitude, etc.), the user is shown a list of alarms which should be issued. The user can review the text message of each alarm and modify it at will. The user can also click on the Send? checkbox to cancel a particular alarm.

By clicking Continue, the user signals that the review is completed. The system will insert or delete the event and then send the alarms that have not been cancelled by the user. Then, the user will be presented with a list of names and phone numbers of people who must be telephoned in order to satisfy any outstanding Phone alarms. The user is expected to click on the Done? checkbox after each phone recipient has been reached. This feature is intended for auditing purposes since the list of alarms for each event is stored in the database.

Once the phone alarms have been processed by the user, clicking on Continue Reviewing will return the user to the review web page, while Finish Reviewing will delete the temporary review directory and terminate the review process for this event.

 

SeisGram2K applet

This applet, written by Anthony Lomax, provides interactive graphical repicking. It is invoked by clicking on the name of the channel on the review page. If SAC files for all three components of a channel are available, then all three will be shown.

The applet comes with extensive help that can be accessed from the Help menu. This section provides a brief overview of the applet's functionality. The applet can be invoked with many command line arguments. Only the most basic ones are hard-coded in the source code to invoke the applet in Quick Review Mode. The user is invited to specify further configuration parameters through the SeisGramOption parameter in the review_event.d configuration file (see below).

There are three rows of controls across the top of the applet window. The top row of buttons control the vertical and horizontal gain and horizontal position. The "Initial" button will restore the display to the state as it was when the applet first executed. The "Previous" button will restore to the previous state.

The second row of buttons sets the 'mode' of the interactions, and determines the set of buttons displayed in the third row. Three of the modes are of special interest:

"Event" mode: It offers a 'zoom' feature wherein the user can drag the mouse to define a rectangular region in the trace display. Releasing the mouse button will that cause region to be displayed. Should one get lost while zooming, The "Initial" button will restore the display to the original setting. The "SendPicks" button, displayed in the third row, will cause the picks to be returned to the server machine.

"Pick" mode permits interactive picking: An existing pick can be dragged by its designating letter at the top of the pick line. A new pick can be created by clicking on a portion of trace. The new pick can then be moved by horizontal movement. The uncertainty of the pick can be set by vertical movements, and is graphically shown by uncertainty bars. The attributes of the pick can then be set via the buttons on the third row. The "Set" and "Clear" buttons on the third row terminate the pick creation process, either by saving the pick (on the browser machine), or deleting it.

"Filter" mode permits one to choose filter type and limits. "Initial" will not restore the pre-filtered display to do so, exit the applet, and re-start from the event parameter page.
 
To modify an existing pick:

·        Click on the "Pick" button; the pick-mode is entered, and pick sub-buttons appear.

·        With the mouse, grab the top of the pick bar by its description characters. The pick bar should turn green. It can now be moved with the mouse to the desired position.

·        Select the pick's type from the drop-down menu.

·        Click on e, i, c, d to set further characteristics.

·        When done editing the pick, Click on "Set". The process can be repeated from here.

NOTE:

·        The pick is lost if "Set" is not pressed before exiting "Pick" mode.

·        To recover from operator errors, one can terminate the applet by closing the applet window and re-invoking it by clicking on the channel name on the event parameter page.

·        No picks are returned to the server until "Event" mode is entered, and "SendPicks" is pressed.

 

To create a new pick:

·        If not already in pick mode, click the "Pick" button.

·        Click in the trace window to create a pick bar.

·        The pick uncertainty is set graphically by moving the mouse up and down (screen-wise) while dragging he pick bar. Move the mouse 'up' to create the uncertainty bars, and to increase the uncertainty. Move the mouse 'down' to decrease. This is somewhat delicate; place the mouse on the green pick bar UNDER the trace, and them move UPWARD with the left button depressed. If you move initially move the mouse DOWNWARD, nothing happens.

·        Click on P, S, Ppmax, etc. to set the pick's type.

·        Click on e, i, c, d to set further characteristics.

·        Click "Set" when done with this pick.

 

To create a new Amplitude pick from trace in counts:

·        Click on Remove Mean

·        From the Presets menu, select Wood-Anderson to transform the trace into W-A. Note that this will only work if response file is available from the server.

·        From the Pick mode, click on either O-Pmax, or P-Pmax button to have the applet automatically calculate the amplitude picks using either the standard Richter method or the Peak-to-Peak method.

·        Picks can also be created manually as described above.

 

To delete a pick:

·        Activate a pick by clicking on its designator characters (pick turns green).

·        Click "Clear".

The above steps cause pick values to be changed on the browser machine only. When the picks for a channel are finalized, they must be returned to the client machine by clicking "Event" to exit picking mode, and then clicking "SendPicks". This writes the modified and new picks back to the server. The new parameters will not automatically appear on the page from which the review applet was called. In order to see the changes effected in the applet, click on "Refresh", at the bottom of the event parameter page (not the refresh button of the browser!).

 

CONFIGURATION FILES

Configuring the Quick Review system may be a tedious task, requiring several trial-and-error iterations. What follows are tips and suggestions, rather than a mere dump of the configuration files. See the example configuration files and comments therein for much more detailed information regarding specific options.

In general, setting up Quick review involves the following steps:

 

Look-and-Feel

This step involves customizing the review_event.d configuration file. See the example file for detailed comments on each field. This is where the user sets up:

Wood-Anderson files

In the review_event.d file, the user specifies the configuration file (LM_writeWA_configfile option) which will be handed to localmag in order to produce Wood-Anderson transforms of the existing trace data in counts. The files will be written in SAC format in the review directory, and will be used to allow review of Local Magnitudes.

The user must also specify the full path to the localmag executable through the LM_progname option in review_event.d

 

 

SeisGram2K Configuration

In the review_event.d file, the user must specify the name of the javascript file to be included with the dynamically generated web pages allowing the applet to start up (JavascriptFile option). The user can also configure how many traces will be shown in the multi-channel display for arrival and amplitude picks.

The user can specify initial command-line parameters to be handed to the applet when it is invoked, using the SeisGramOption parameter in review_event.d. SeisGram2K accepts many command-line arguments - see the list in the Help menu within the applet. Note, however, that the following arguments must not be specified, as they are hard-coded in order to invoke the applet in the Quick review mode:

The user can specify any number of SeisGramOption parameters, but great care should be taken that the syntax and format is correct because they are not checked by the review system. The options will be passed directly to the applet as they appear in the configuration file.

 

Hypoinverse Location Calculation

In review_event.d, the user must specify:

 

 

 

Local Magnitude Calculation

In the review_event.d file, the user specifies the configuration file (LM_review_configfile option) which will be handed to localmag in order to recalculate the local magnitude given the amplitude readings in the SAC headers. The user must also specify the full path to the localmag executable through the LM_progname option in review_event.d.

The user must specify the method used to compute the ML magnitude (LM_method), as well as the name of the resulting output file that localmag should write in the review directory (LM_outputfile). Finally, the user must specify whether the recalculated local magnitude should be made preferred over any other magnitudes associated with the event (MakeLMPreferred).

NB - Localmag Configuration: The user will notice that there are potentially three configuration files needed to support localmag, either in its earthworm mode or as a standalone program in quick review. This may cause configuration glitches, especially if changes are made to the earthworm behavior but not to the review behavior. It is suggested that the user extract the common configuration elements (e.g., location and template of the response files) of all three files and include them into smaller, further customized parameter files:

 

 

EXAMPLE CONFIGURATION FILES

review_event.d

 

#

# Configuration file for the review system

#

#

# Database connection parameters

#

DBuser            db_user

DBpassword        db_pwd

DBservice         db_service

 

#Debug

Logfiledir ../log/

#

# NetworkCode: Two letter designation of this seismic network to

# be used in CUBE messages

#

NetworkCode XY

#

# hostname of the machine holding up web pages

#

WebHost webhost.domain

#

# ReviewSource: One or more entries (max 10) denoting the

# author (Source) of the Origins which are allowed to review.

#

#

ReviewSource 014024021 # Montana

ReviewSource 014024005 # Utah

#

# Directory where temporary review files are written. This is

# where Arc files, as well as SAC files for each arrival are

# temporarily stored

#

# NOTE: this directory must be under the web's earthworm directory

# because this is where the review applet needs to find the

# SAC files

#

ReviewDir /home/earthworm/web/html/review

#

# WebDir: Web mapping of ReviewDir

#

WebDir                        /earthworm/review

 

#

# SacBufferLen - specify the length in bytes of the largest

# SAC file you are willing to save. This should correspond

# to the snippet lengths being stored in the database by

# ora_trace_save (as computed by arc2trigII.d)

#

SacBufferLen 500000

 

####################################

# HYPOINVERSE REVIEW SECTION

####################################

#

# Full path to the hypoinverse program

#

PathToHypoBin           /home/earthworm/v6.1/bin/hyp2000

 

#

# Full path to the hypoinverse directory

#

HypoinverseDir          /home/earthworm/web/params/hyp2000

#

# Name of the hypoinverse configuration file

#

HypoConfig        example.hyp

 

####################################

# LOCALMAG REVIEW SECTION

####################################

#

# LM_progname: full path to the executable which computes

# local magnitudes (e.g., Pete's localmag)

#

LM_progname /home/earthworm/v6.1/bin/localmag

#

# LM_writeWA_configfile: full path to the configuration file

# for the LM_progname executable which causes it to produce

# SAC files with Wood-Anderson traces.

#

#

LM_writeWA_configfile /home/earthworm/web/params/localmag_writeWA.d

#

# LM_review_configfile: full path to the configuration file

# for the LM_progname executable which causes it to

# recompute the local magnitude given the potentially reviewed

# information in the WA sac headers.

#

LM_review_configfile /home/earthworm/web/params/localmag_review.d

#

# LM_outputfile: name of the output file of the LM_progname

# executable. For localmag, this option must be set to the

# value of the filename for the outputFormat option.

#

LM_outputfile LocalMag.output

#

# LM_method: method used for computing the ML magnitude.

# Valid methods are Peak2Peak and Zero2Peak. Zero2Peak method

# uses one amplitude pick from zero to peak. Peak2Peak method

# uses two picks denoting the largest plus-to-minus or

# minus-to-plus swing in the sliding window whose length

# is determined by the value of slideLength in the

# LM_progname's configuration file.

#

# The choice of method is installation-specific, but it must

# be consistent over various modules dealing with local

# magnitude calculations. If LM_configfiles use slideLength

# greater than 0 then then method should be set to Peak2Peak.

LM_method Peak2Peak

#

# MakeLMPreferred: If set, the local magnitude computed,

# if any, will be set as preferred. Otherwise, the coda

# magnitude is preferred

MakeLMPreferred

#

#

#

 

 

####################################

# SEISGRAM2K APPLET SETUP SECTION

####################################

#

# Name of the file containing Lomax javascript.

# NOTE: It must exist under ReviewDir/lomax

#

#

JavascriptFile          LomaxApplet.js

#

# OPTIONAL: ShowArrivalPicks

# How many of the closest arrival picks will be displayed

# by the Lomax applet. If this option is not specified,

# the multi-channel applet display will not be available.

#

ShowArrivalPicks 10

#

# OPTIONAL: ShowAmplitudeStas

# How many of the closest stations with amplitude picks

# will be displayed by the Lomax . If this option is not

# specified, the multi-channel applet display of amplitude

# picks will not be available.

# Note: Both horizontal components for a station will be displayed.

#

ShowAmplitudePicks 6

#

# Output format (platform): sparc or intel

#

SacFormat         sparc

 

####################################

# ALARMS SECTION

####################################

#

# EwParams -- directory where earthworm configuration lives. This is

# needed to acesss earthworm.d and its mappings between names and Ids.

#

EwParams /home/earthworm/run/params

#

# AlarmRing: name of the ring where alarm processors are waiting

#

AlarmRing HYPO_RING

#

# MyModuleID: name of the module issuing alarms

#

MyModuleID MOD_ALARM

#

# MyInstID: Installation name

#

MyInstID INST_USNSN

 

 

 

###################################################

# Command: WaveformLinks

#

# Description:

# Specifies links that are created at the bottom

# of the eqparams page, to link to record section

# displays(waveforms).

#

# Params:

# PROGRAM_NAME

# specifies the program name that the link will

# attempt to execute

#

# DESCRIPTION

# the text of the link that will show up on the

# eqparams page

#

# OPEN_IN_NEW_WINDOW

# a flag {1=TRUE | 0=FALSE} that determines whether the

# link is opened in a new window. Specifically it specifies

# whether an html TARGET field is specified for the link.

#

# WINDOW_NAME (only if OPEN_IN_NEW_WINDOW=1)

# Name of the targe window where the link will be opened.

###################################################

#WaveformLinks PROGRAM_NAME DESCRIPTION OPEN_IN_NEW_WINDOW WINDOW_NAME

WaveformLinks "ora2snip_arr_60" "60 seconds aligned on pick time" 1 "60 secs"

WaveformLinks "ora2snip_arr_200" "200 seconds aligned on pick time" 1 "200 secs"

WaveformLinks "ora2snip_all" "All Snippets" 1 "All snippets"

 

##############################################################################

#

# OPTIONAL APPEARANCE CONFIGURATION:

# Set the following to customize the appearance of the page:

# - BackgroundColor: Set to any valid HTML color string

# - HeaderLogo: Full path to the file containing the picture to be

# displayed on the top of the page.

# - FooterLogo: Full path to the file containing the picture to be

# displayed on the bottom of the page.

#

# Logo note: The logo file must be a valid HTML picture file (gif, jpeg..)

# sized to the desired size. It will be placed at the top or the

# bottom exactly as it appears in the file. The file name

# must be relative to the web-server's root directory.

#

##############################################################################

BackgroundColor lemonchiffon

HeaderLogo ../images/c_USGSid.jpg

FooterLogo ../images/c_USGSid.jpg

 

 

##############################################################################

#

# Taper parameters used in converting trace to ground motion (OPTIONAL)

#

# TaperLength: length of cosine taper in seconds to be applied at

# both ends of the input data to provide a smooth

# transition into the zero-padded area

#

# LowFreqTaper1: Low-frequency taper band low limit; expressed absolutely

# LowFreqTaper2: Low-frequency taper band high limit; expressed absolutely

#

# HighFreqTaper1: high-frequency taper band low limit; as a percentage of Nyquist

# HighFreqTaper2: high-frequency taper band high limit; as a percentage of Nyquist

#

# DEFAULTS: TaperLength = 0.0

# LowFreqTaper1 = 0.05

# LowFreqTaper2 = 0.1

# HighFreqTaper1 = 0.45/deltaT (90% of Nyquist)

# HighFreqTaper2 = 0.5/deltaT (100% of Nyquist)

#

##############################################################################

TaperLength 1.0

LowFreqTaper1 0.05

LowFreqTaper2 0.1

HighFreqTaper1 0.45

HighFreqTaper2 0.5

 

##############################################################################

#

# SeisGram2K (SG2K) Optional arguments:

#

# NB: THIS IS NOT FOR THE MEEK

#

# The applet is invoked from the review pages with the minimum

# configuration necessary to run in it the quick review mode. This

# means that most of SG2K's behavior will be in the default mode.

#

# Since SG2K comes with many useful options, this is where the

# user can customize the functioning and appearance of SG2K. Below

# the user can specify up to 30 SeisGramOption commands in the

# following format:

#

# SeisGramOption SG2K-parameter SG2K-value

#

# For the list of valid SG2K parameters and the corresponding

# value formats, click on Help in SG2K. Note that NO ERROR

# CHECKING OF THESE VALUES is performed by quick review - they will

# be passed to SG2K as they appear. So, if the applet does not work

# "right" be sure to check the format of the parameter values, as

# those can be quite complex.

#

# IMPORTANT - the following parameters are hard-coded in the review

# code, and must remain so in order for the applet to work

# correctly. DO NOT EVER SET THESE:

#

# event.id

# event.url

# event.protocol

# event.sendall

# channel.response.ext

#

##############################################################################

SeisGramOption    commands.preset   "Wood-Anderson, transfer from this to wa;-; 1Hz a-causal Highpass, hp amp n 2 co 1; 10Hz a-causal Lowpass, lp amp n 2 co 10;-; 1Hz Bwrth Highpass, hp bu n 2 co 1; 10Hz Bwrth Lowpass, lp bu n 2 co 10;-; 0.1-5Hz a-causal Bandpass, bp amp n 2 co 0.1 5; 0.1-25Hz a-causal Bandpass, bp amp n 2 co 0.1 25;-; 0.01-3Hz a-causal Bandpass, bp amp n 2 co 0.01 3; 0.001-3Hz a-causal Bandpass, bp amp n 2 co 0.001 3; "

#SeisGramOption commands.onread rmean

#SeisGramOption display.lockallignment YES

 

 

 

localmag_common.d

# Configuration file for the localmag program

#

# *****NOTE*******

# Please make same changes to ewweb2 localmag files localmag_review_common.d

# and localmag_review.d in directory /home/ewweb2/web/params

# ***************

#

# ------------History of changes----------------

# Modified for use at University of Utah - October 2001 SN

# modifed Jan 28, 2002 to include suggested changes from Jim Pechmann (SN)

#

# ----------------------------------------------

#

# Some of these parameters can be overridden on the command-line;

# some of them only make sense on the command-line.

#

# As of 20 December, 2000, there is NO SUPPORT for Earthworm Database (EWDB)

# Required Commands:

# The following five commands are always required by localmag.

# Other commands below may be required when certain options are given.

# maxSta number

# The number of stations to be used by localmag must be specified with

# the maxSta command. This is the number of unique SNs to be used.

# A total of 6 * maxSta channel structures will be allocated.

# The maxSta command must come before any "Pri" commands.

maxSta 100

# maxDist km

# The maximum epicenter - station distance in kilometers.

# Stations lying outside this radius will not be used by localmag.

#

maxDist 600

# maxTrace nsamples

# The maximum number of trace data samples to process from one SCN.

# This is the product of the trace length in seconds and the highest

# expected sample rate. For example, 10 minutes of data at 100 samples per

# second gives 60000 samples.

maxTrace 100000

# logA0 filename

# The file containing the table of -logA0 values versus distance.

# This file mist start with two commands:

# Dist <type>: which distance is to used to access this table.

# choices are: epi - station - epicenter distance

# hypo - station - hypocenter distance (use event depth

# but not station depth.)

# nDist number: the number of table entries that follow.

# Following these two commands are `nDist' lines of distance and -logA0

# values. The distance numbers must be integer values, in kilometers.

# The -logA0 values are positive decimal values.

# Entries MUST be in order of increasing distance.

# When this table is used to find the -logA0 value, the entry with distance

# nearest to the desired distance will be used. If the desired distance

# exceeds the largest distance in this table, then the -logA0 value for

# the last table entry will be returned.

logA0 /home/earthworm/run/params/Richter.tab

# staLoc: station location source

# Choices: File <loc-file> - get station locations from a hyp2000-format

# file named loc-file

# EWDB - query the EW database for station locations; access info

# given below.

# SAC - get station locations from the header of SAC files.

# Can be either station lat and lon, or station-epicenter

# distance in the SAC header.

staLoc File /home/earthworm/run/params/staFile

# Regional Velocity model: must be specified as "@vel_model_file". Typically

# this will be the same file as used for binder_ew.

@/home/earthworm/run/params/vel_model

# readAmpDirect: flag to tell localmag to read Wood-Anderson amplitudes

# directly from a `trace' source instead of from Wood-Anderson traces.

# If this flag is used, then traceSource must be one that includes

# amplitude data, such as SAC files, EW database.

#

# default: flag is not present, so localmag reads amplitudes from

# Wood-Anderson traces that it either synthesizes or reads from

 

#

# Set Vp/Vs ration to 1.74

#

psratio 1.74

 

# Add STA COMP NET

# Del STA COMP NET

# SCN selection is done by a selection list and a rejection list.

# The station selection command `Add' specifies the names of

# STA (station), COMP (component), and NET (network).

# The wildcard `*' may be used for any or all of STA, COMP, NET.

# COMP may be given as the first two letters of the component name,

# to select all direction desgnators are accepted for that component.

# If no Add commands are given, all SCNs will be selected.

# The Del command is used to put SCNs on the rejection list:

# for example: "Add * EL UW" followed by "Del LAB EL UW" to include

# all ELE and ELN components from UW except LAB.ELE.UW and LAB.ELN.UW.

# Localmag will NEVER use vertical components.

# List as many Add and Del commands as desired, one to a line

# Compute local magnitudes on data from broadbands (HH and BH),

# short-period digital-digital-telemetry station TM2, the SLC

# Wood-Anderson, USNSN strong-motion instruments (HL US), and

# all UU strong-motion stations (EN UU) located on rock.

#

Add * HH *

Del ABC HH XY

Add * BH *

Del 123 BH XY

Del * EH *

# traceTimes start end

# The start and end times for traces is set here.

# <start> is the number of seconds before estimated P arrival to start

# the trace.

# <end> is the number of seconds after estimated S arrival to end the trace.

# default: traceTimes 5.0 60.0 # starts trace 5 seconds before estimated P

# arrival and ends trace 60 seconds after estimated S arrival.

traceTimes 10.0 85.0

# searchWindow A B C D

# The time window for searching for peak amplitudes is set here.

# <A> is the multiple of the estimated interval P - S to start the

# search before estimated S arrival.

# <B> is the minimum number of seconds before estimated S arrival to

# start the peak search.

# <C> is the multiple of the estimated interval P - S to end the

# search after the estimated S arrival.

# <D> is the minimum number of seconds after estimated S arrival to

# end the peak search.

# default: searchWindow 0.0 2.0 0.0 30.0 # Search window runs from 2 seconds

# before to 30 seconds after the estimated S arrival, independent of

# the P - S interval.

searchWindow 1.05 2.0 0.0 80.0

# slideLength n

# Set the width of of the sliding search window to n seconds.

# default: slideLength 0.8 # sliding search window is 0.8 seconds wide

slideLength 0.8

# z2pThresh is the threshold by which the zero-to-peak maximum in the

# search window must exceed the zero-to-peak maximum from the

# pre-event portion of the trace. This test tries to ensure that the

# zero-to-peak and peak-to-peak values are seismic and not just noise.

# default: z2pThresh 3.0

z2pThresh 3.0

# meanCompMags: If present, this command causes localmag to compute a

# stations local magnitude by taking the mean of the local magnitudes

# for each of its horizontal components, Otherwise, localmag will take

# the average of the component amplitudes and use that to find the

# local magnitude for the station.

# WoodAndersonCoefs <period> <damp> <gain>: optional command to specify the

# coefficients used for the Wood-Anderson instrument response. The standard

# parameters for the transfer function are:

# period: 0.8 seconds; damping 0.8 critical; gain: 2800

# However, testing by Uhrhammer & Collins (BSSA 1990, V80 p702-716) and

# others indicate better values are:

# period 0.8 seconds; damping 0.7 critical; gain 2080 (twenty-eighty)

#

# default: WoodAndersonCoefs 0.8 0.8 2800

 

 

#

# EWDBaccess user password service

# How to access the Earthworm Database, if needed.

# Give the user name, password, and srvice needed for connection.

# default: none

 

# wsTimeout: wave_server timeout in milliseconds

# default: 5000 milliseconds

# wsTimeout 10000

# Debug N

# There are several different debug features, listed below.

# You can give one Debug command for each feature you want to turn on,

# or you can add together the values of desired features and give

# one Debug command.

# value feature

# 1 trace and search times and P and S arrival estimates

# 2 SCN selection tests

# 4 distance and LogA0 values

# 8 SAC file selection (only if traceSource is SAC)

# 16 ws_client debugging

# 32 poles. zeros and gain values

# 64 trial frequency response functions to STDOUT

# 128 full frequency response function to STDOUT

# 256 input and output trace date including in padded area

#Debug 1

Debug 2

#Debug 4

Debug 8

#Debug 16

#Debug 32

#Debug 64

#Debug 128

#Debug 256

# SCN Parameters: normally this command will be given as "@scn_param_file"

# to cause the separate file "scn_param_file" to be processed.

@/home/earthworm/run/params/localmag.scn_param

 

localmag_ew.d

 

# Configuration file for the localmag program

#

# ***** NOTE *******

# The trouble is that we need to keep EW localmag and review localmag

# configurations consistent. This has proven to be difficult. So, here

# goes another try. There will be one localmag_common.d file where all

# common configuration options go. Then, this file can be included

# into other localmag*.d configurations where the remaining few

# parameters can be customized.

# ***************

#

# ------------History of changes----------------

# Modified for use at University of Utah - October 2001 SN

# modifed Jan 28, 2002 to include suggested changes from Jim Pechmann (SN)

#

# ----------------------------------------------

#

@/home/earthworm/run/params/localmag_common.d

 

# traceSource: Where localmag will obtain trace data

# choices are: waveServer <server-list> - raw traces from wave_servers;

# server-list is either a space separated list

# of ip-address:port or

# "File <server-file>"

# SACFile - raw traces from SAC files

# SACWAFile - synthetic Wood-Anderson traces from SAC files

# EWDB - raw traces from EW database; access info given below

# default: waveServer with list of servers read from $EW_PARAMS/servers

traceSource waveServer xxx.xxx.xxx.xxx:yyyyy

# eventSource: Tells localmag how and where to learn about a new event

# choices are: ARCH - hyp2000 archive message, read from stdin

# SAC - SAC file header;

# EWDB <eventID> - query EW database for eventID; usually

# given as command-line option.

# default: ARCH

eventSource ARCH

# respSource: Tells localmag where to get response information;

# may be ommitted if traceSource points to Wood-Anderson

# Choices: EWDB - query the EW databse for pole-zero-gain responses.

# SAC <pz-filename-format> - find response files in the

# SAC directory given with SACsource.

# filename-format is a string similar to printf

# format: %S, %C, %N are replaced by station,

# component and network names, respectively,

# all in upper case. Similarly %s, %c, %n work

# for lower-case station, component and network.

# The digraph %% stands for %; all other

# characters are taken literally.

# The response file format is that used by SAC.

# File <dirname> <pz-filename-format> - find response files in

# directory dirname with file names given by

# pz-filename-format, as above. dirname can be

# a full directory name, or relative to $EW_PARAMS.

#

# default: none; you must specify one of the above choices.

respSource File /home/earthworm/run/params/Responses %S.%C.%N.resp

# saveTrace: whether and how to save synthetic Wood-Anderson traces

# If saveTrace command is absent, no traces will be saved.

# Choices: SAC <baseDir> <dirFormat> <filename-format> -

# save W-A traces in SAC-format files.

# baseDir specifies a fixed directory name.

# dirFormat gives a formattted subdirectory name; the

# format string is that used for the "date" command applied

# to the event origin time, with the addition of `%i'

# to indicate the event ID. Be careful with this; some

# formats produce output not compatible with file names.

# filename-format gives the formatted file name using

# % to introduce one of the format specifiers "sScCnN%"

# `s' is the station name in lower case; `S' is upper case

# Likewise for component and network names; `%' stands for

# itself. All other characters are taken literally.

#

# default: None (no Wood-Anderson traces are saved.)

saveTrace SAC /home/earthworm/run/log/SAC.W-A %Y%m%d%H%M%S %S.%C.%N

 

# outputFormat: how localmag reports its results; results are always logged

# Choices: LM - TYPE_LOCALMAG message to earthworm transport

# EWDB - send results to Earthworm database.

# default: LM if using earthworm transport; no report otherwise

 

 

#

# Earthworm Transport commands. Use these commands to make localmag

# run as an earthworm module to run continuously.

# Otherwise localmag runs as a standalone program and handles a

# single event per invocation.

#

 

# RingInName <ring>: specify the name of the earthworm transport ring from

# which to read TYPE_HYP2000ARC messages for event notification.

RingInName HYPO_RING

# RingOutName <ring>: specify the name of the earthworm transport ring to

# which Magnitude, Heartbeat and Error messages are sent. This may be

# the same as RingInName if desired.

RingOutName HYPO_RING

# MyModId <module-id>: specify the module ID for localmag

MyModId MOD_LOCALMAG

# HeartBeatInterval int: How often localmag should beat its heart.

# Currently, localmag will not issue heartbeats while it is busy doing

# calculations for an event. Thus a heartbeat could be late by as much as the

# time it takes to do a full localmag event calculation. Be sure that

# statmgr will wait that long for the heartbeat.

HeartBeatInterval 30

# getEventsFrom INST_ID MOD_ID

# Specify the installation ID and module ID names from which to get

# hypoinverse archive messages to read event data. These names may be

# selected from earthworm.d and earthworm_global.d Only required when

# localmag is running as an Earthworm module. No default values.

getEventsFrom INST_WILDCARD MOD_EQPROC

 

 

 

localmag_writeWA.d

# Configuration file for localmag_writeWA.d

#

# Most of the options are the same as localmag_review.d,

# so we include them here.

#

@/home/earthworm/run/params/localmag_common.d

 

# traceSource: Where localmag will obtain trace data

# choices are: waveServer <server-list> - raw traces from wave_servers;

# server-list is either a space separated list

# of ip-address:port or

# "File <server-file>"

# SACFile - raw traces from SAC files

# SACWAFile - synthetic Wood-Anderson traces from SAC files

# EWDB - raw traces from EW database; access info given below

# default: waveServer with list of servers read from $EW_PARAMS/servers

# traceSource waveServer File servers

traceSource SACFile

 

# eventSource: Tells localmag how and where to learn about a new event

# choices are: ARCH - hyp2000 archive message, read from stdin

# SAC - SAC file header;

# EWDB <eventID> - query EW database for eventID; usually

# given as command-line option.

# default: ARCH

eventSource SAC

# respSource: Tells localmag where to get response information;

# may be ommitted if traceSource points to Wood-Anderson

# Choices: EWDB - query the EW databse for pole-zero-gain responses.

# SAC <pz-filename-format> - find response files in the

# SAC directory given with SACsource.

# filename-format is a string similar to printf

# format: %S, %C, %N are replaced by station,

# component and network names, respectively,

# all in upper case. Similarly %s, %c, %n work

# for lower-case station, component and network.

# The digraph %% stands for %; all other

# characters are taken literally.

# The response file format is that used by SAC.

# File <dirname> <pz-filename-format> - find response files in

# directory dirname with file names given by

# pz-filename-format, as above. dirname can be

# a full directory name, or relative to $EW_PARAMS.

#

# default: none; you must specify one of the above choices.

respSource File . %S.%C.%N.pz

 

# saveTrace: whether and how to save synthetic Wood-Anderson traces

# If saveTrace command is absent, no traces will be saved.

# Choices: SAC <baseDir> <dirFormat> <filename-format> -

# save W-A traces in SAC-format files.

# baseDir specifies a fixed directory name.

# dirFormat gives a formattted subdirectory name; the

# format string is that used for the "date" command applied

# to the event origin time, with the addition of `%i'

# to indicate the event ID. Be careful with this; some

# formats produce output not compatible with file names.

# filename-format gives the formatted file name using

# % to introduce one of the format specifiers "sScCnN%"

# `s' is the station name in lower case; `S' is upper case

# Likewise for component and network names; `%' stands for

# itself. All other characters are taken literally.

#

# default: None (no Wood-Anderson traces are saved.)

saveTrace SAC . . %S.%C.%N.wa

 

# outputFormat: how localmag reports its results; results are always logged

# Choices: LM - TYPE_LOCALMAG message to earthworm transport

# EWDB - send results to Earthworm database.

# default: LM if using earthworm transport; no report otherwise

 

# SACsource <SAC-directory> <filename-format>: where to find SAC files for

# reading.

# <SAC-directory> is a fixed directory name

# <filename-format> is the format for SAC

# file names.

# This command or its equivalent on the command

# line is required if traceSource or respSource

# is SAC files.

SACsource . %S.%C.%N

 

 

 

localmag_review.d

# Configuration file for localmag_review.d

#

#

@/home/earthworm/run/params/localmag_common.d

# traceSource: Where localmag will obtain trace data

# choices are: waveServer <server-list> - raw traces from wave_servers;

# server-list is either a space separated list

# of ip-address:port or

# "File <server-file>"

# SACFile - raw traces from SAC files

# SACWAFile - synthetic Wood-Anderson traces from SAC files

# EWDB - raw traces from EW database; access info given below

# default: waveServer with list of servers read from $EW_PARAMS/servers

# traceSource waveServer File servers

traceSource SACFile

 

# eventSource: Tells localmag how and where to learn about a new event

# choices are: ARCH - hyp2000 archive message, read from stdin

# SAC - SAC file header;

# EWDB <eventID> - query EW database for eventID; usually

# given as command-line option.

# default: ARCH

eventSource ARCH

# respSource: Tells localmag where to get response information;

# may be ommitted if traceSource points to Wood-Anderson

# Choices: EWDB - query the EW databse for pole-zero-gain responses.

# SAC <pz-filename-format> - find response files in the

# SAC directory given with SACsource.

# filename-format is a string similar to printf

# format: %S, %C, %N are replaced by station,

# component and network names, respectively,

# all in upper case. Similarly %s, %c, %n work

# for lower-case station, component and network.

# The digraph %% stands for %; all other

# characters are taken literally.

# The response file format is that used by SAC.

# File <dirname> <pz-filename-format> - find response files in

# directory dirname with file names given by

# pz-filename-format, as above. dirname can be

# a full directory name, or relative to $EW_PARAMS.

#

# default: none; you must specify one of the above choices.

respSource File . %S.%C.%N.pz

 

# readAmpDirect: flag to tell localmag to read Wood-Anderson amplitudes

# directly from a `trace' source instead of from Wood-Anderson traces.

# If this flag is used, then traceSource must be one that includes

# amplitude data, such as SAC files, EW database.

#

# default: flag is not present, so localmag reads amplitudes from

# Wood-Anderson traces that it either synthesizes or reads from traceSource.

readAmpDirect

 

# outputFormat: how localmag reports its results; results are always logged

# Choices: LM - TYPE_LOCALMAG message to earthworm transport

# File <filename> - write TYPE_MAGNITUDE message to the

# file specified by filename. Standalone mode only.

# EWDB - send results to Earthworm database.

# default: LM if using earthworm transport; no report otherwise

outputFormat File LocalMag.output

 

# SACsource <SAC-directory> <filename-format>: where to find SAC files for

# reading.

# <SAC-directory> is a fixed directory name

# <filename-format> is the format for SAC

# file names.

# This command or its equivalent on the command

# line is required if traceSource or respSource

# is SAC files.

SACsource . %S.%C.%N.wa

 

 

Questions? Issues? Subscribe to the Earthworm List (earthw).