Changes between Version 3 and Version 4 of rayloc_ew


Ignore:
Timestamp:
05/11/12 09:47:13 (8 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • rayloc_ew

    v3 v4  
    2222 
    2323== Configuration File Commands == 
     24On startup, rayloc_ew reads the configuration file named on the command line.  In the control file, lines may begin with a valid rayloc_ew commands (listed below). 
     25 
     26# marks the line as a comment (example: # This is a comment). 
     27 
     28Command names must be typed in the control file exactly as shown in this document (upper/lower case matters!). Blank lines are also permitted in the control file. 
     29 
     30=== FUNCTIONAL COMMAND LISTING === 
     31 
     32Below are the commands recognized by liss2ew, grouped by the function they influence. Most of the commands are required; they may be specified in any order in the control file.  
     33 
     34{{{ 
     35Earthworm system setup 
     36                MyModId          required 
     37                HeartbeatInt     required 
     38                InRing           required  
     39                OutRing          required 
     40                Debug            optional 
     41 
     42Rayloc processing parameters: 
     43 
     44                StaFile        required 
     45                WorkDir        required 
     46 
     47                hold_params           optional; default if absent = 0  
     48                fix_depth             optional; default if absent = 1    
     49                use_PKP               optional; default if absent = 1     
     50                use_depth_ph          optional; default if absent = 1     
     51                use_S_ph              optional; default if absent = 1     
     52                pick_weight_interval  optional; default if absent = 0     
     53                Rmin                  optional; default if absent = 0    
     54                Rmax                  optional; default if absent = 0    
     55 
     56                D1                    optional; default if absent = 0     
     57                Dmin1                 optional; default if absent = 0     
     58                Dmax1                 optional; default if absent = 180   
     59 
     60                D2                    optional; default if absent = 0    
     61                Dmin2                 optional; default if absent = 0   
     62                Dmax2                 optional; default if absent = 180    
     63 
     64                D3                    optional; default if absent = 0    
     65                Dmin3                 optional; default if absent = 0  
     66                Dmax3                 optional; default if absent = 180    
     67 
     68                D4                    optional; default if absent = 0    
     69                Dmin4                 optional; default if absent = 0    
     70                Dmax4                 optional; default if absent = 180   
     71 
     72                D5                    optional; default if absent = 0    
     73                Dmin5                 optional; default if absent = 0   
     74                Dmax5                 optional; default if absent = 180   
     75}}} 
     76 
     77=== ALPHABETIC COMMAND LISTING & DESCRIPTION === 
     78In the following section, all configuration file commands are listed in alphabetical order. Listed along with the command (bold-type) are its arguments (in red), the name of the subroutine that processes the command, and the function within the module that the command influences. A detailed description of the command and is also given. Default values and example commands are listed after each command description. 
     79 
     80The following list is organized by: 
     81 
     82command [argument here] 
     83 
     84D1,D2,D3,D4,D5   0 or 1    rayloc_ew_GetConfig              processing parameters 
     85            
     86Pick weight distance interval flag(s) (there are five parameters 1=5) (TRUE = 1/FALSE = 0) (def = 0). These work in conjuction with the Dmin and Dmax parameters. They provide 5 optional distance intervals over which arrivals are essentially zero weighted. 
     87 
     88Default:  0 
     89Example:  D1 0 
     90          D2 1 
     91          D4 1 
     92 Debug                                           rayloc_ew_GetConfig              Earthworm setup  
     93            
     94Turns on debug logging for rayloc_ew. 
     95 
     96Default:  no debug logging 
     97Example:  Debug 
     98 Dmin1, Dmin2, Dmin3, Dmin4 Dmin5 degrees                        rayloc_ew_GetConfig              processing parameters            
     99Lower bound of distance interval(s) in which weights are zero (default 0). Note that in order to use this parameter, a corresponding Dx should be turned ON. 
     100 
     101Default:  0 
     102Example:  Dmin1 0 
     103          Dmin2 10 
     104          Dmin5 20 
     105 Dmax1, Dmax2, Dmax3, Dmax4, Dmax5    degrees                         rayloc_ew_GetConfig              processing parameters            
     106Upper bound of distance interval(s) in which weights are zero (default 180). Note that in order to use this parameter, a corresponding Dx should be turned ON. 
     107 
     108 
     109Default:  0 
     110Example:  Dmax1 180 
     111          Dmin2 170 
     112          Dmin5 160 
     113 fix_depth       0 or 1                         rayloc_ew_GetConfig              processing parameters            
     114Use fixed depth in inversion: TRUE (1) or FALSE(0). 
     115 
     116Default:  1 
     117Example:  fix_depth 1 
     118 HeartBeatInt nsec                         rayloc_ew_GetConfig             Earthworm Setup 
     119            
     120Defines the number of seconds, nsec between TYPE_HEARTBEAT messages issued by rayloc_ew. 
     121 
     122Default:  none 
     123Example:  HeartBeatInterval 30 
     124 hold_params   0 or 1                         rayloc_ew_GetConfig             processing parameters            
     125Hold latitude, longitude, depth, and origin time flag (default = FALSE (0). 
     126Default:  0 
     127Example:  hold_params 1 
     128 InRing ring                            rayloc_ew_GetConfig              Earthworm setup 
     129            
     130Tells rayloc_ew which shared memory region to use for input. ring is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique number for the key to the shared memory region. 
     131 
     132Default:  none 
     133Example:  InRing HYPO_RING 
     134 MyModId mod_id                        rayloc_ew_GetConfig              Earthworm setup 
     135            
     136Sets the module id for labeling all outgoing trigger, heartbeat, and error messages. mod_id is a character string (valid strings are listed in earthworm.d) that relates to a unique single-byte number. 
     137 
     138Default:  none 
     139Example:  MyModuleId MOD_RAYLOC_EW 
     140 OutRing ring                             rayloc_ew_GetConfig              Earthworm setup 
     141            
     142Tells rayloc_ew which shared memory region to use for output. ring is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique number for the key to the shared memory region. 
     143 
     144Default:  none 
     145Example:  OutRing PICK_RING 
     146 
     147 
     148 pick_weight_interval 0 or 1                  rayloc_ew_GetConfig              processing parameters            
     149Pick weight residual interval flag (TRUE/FALSE) (default = FALSE) 
     150 
     151Default:  0 
     152Example:  pick_weight_interval   1 
     153 Rmin seconds                  rayloc_ew_GetConfig              processing parameters         
     154         Lower bound of residual interval in which weights can be non-zero (default = 0). To activate this parameter pick_weight_interval must be 1.   
     155Default:  0 
     156Example:  Rmin 0.1 
     157 Rmax seconds                  rayloc_ew_GetConfig              processing parameters            
     158Upper bound of residual interval in which weights can be non-zero (default = 0). To activate this parameter pick_weight_interval must be 1. 
     159 
     160Default:  0 
     161Example:  Rmax 1 
     162 StaFile filename                  rayloc_ew_GetConfig              processing parameters            
     163File with stations information in GLASS format. Here is an example of few lines 
     164AAE    9.0291N  38.7655E 2442 IU Addis Ababa, Ethiopia 
     165AAK   42.6390N  74.4940E 1645 II Ala-Archa, Kyrgyzstan 
     166AAM   42.2997N  83.6561W  249 US Ann Arbor, Michigan, USA 
     167ABKT  37.9303N  58.1188E  678 II Alibek (Geyokcha), Turkmenistan 
     168ABL   34.8508N 119.2208W 1981 NC Mount Abel, California, USA 
     169The sample file is provided with the rayloc_ew distribution. This file used to match the station names from TYPE_LOC_GLOBAL  
     170with their 3D coordinates (which is not a part of the TYPE_LOC_GLOBAL message). 
     171 
     172Default:  none 
     173Example:  StaFile        "/home/ilya/rayloc_work/glass_station_list.txt" 
     174 use_PKP 0 or 1                  rayloc_ew_GetConfig              processing parameters            
     175Use or not PKP phases. 
     176 
     177Default:  1 
     178Example:  use_PKP 0 
     179 use_depth_ph 0 or 1                 rayloc_ew_GetConfig              processing parameters            
     180Use or not depth phases. 
     181 
     182 
     183 
     184Default:  1 
     185Example:  use_depth_ph 0 
     186 
     187 use_S_ph 0 or 1                  rayloc_ew_GetConfig             processing parameters            
     188Use or not S phases. 
     189 
     190 
     191 
     192Default:  1 
     193Example:  use_S_ph 0 
     194 WorkDir dirname                  rayloc_ew_GetConfig             processing parameters            
     195This is the location of the work directory for rayloc_ew. rayloc_ew stores temp files in there.  
     196Three model files should be placed in this directory before processing: 
     1971) tau.table 
     1982) ak135.hed 
     1993) ak135.tbl 
     200Those files are prebuilt and shipped with rayloc_ew distribution. 
     201 
     202Default:  none 
     203Example:  WorkDir        "/export/home/isti/model" 
     204 
     205 
     206 
     207=== Sample Configuration File === 
     208{{{ 
     209# 
     210# 
     211#                     rayloc_ew Configuration File 
     212# 
     213MyModId        MOD_RAYLOC_EW   # This instance of rayloc_ew 
     214StaFile        "/gaia/home/mwithers/Projects/EWSupport/Working/run_smeagol/model/glass_station_list.txt"   # File containing station name/pin# info 
     215WorkDir        "/gaia/home/mwithers/Projects/EWSupport/Working/run_smeagol/model"         # Directory where model and tmp files are stored 
     216InRing           RAY_RING     # Transport ring to find TYPE_LOC_GLOBAL messages, 
     217OutRing          RAY_RING     # Transport ring to write TYPE_RAYLOC messages 
     218HeartbeatInt            30     # Heartbeat interval, in seconds, 
     219Debug                    1     # If 1, print debugging message 
     220# 
     221# 
     222# Parameters/flags used to control processing of rayloc 
     223# Default values are provided in comments and used if any 
     224# of the parameters in to configuration is undefined 
     225# 
     226hold_params           0    # Hold latitude, longitude, depth, and origin time flag (def = 0) 
     227fix_depth             1    # Fix depth (def = 1) 
     228use_PKP               1    # Use PKP phases (def = 1) 
     229use_depth_ph          1    # Use depth phases (def 1) 
     230use_S_ph              1    # Use S phases (def = 1) 
     231pick_weight_interval  0    # Pick weight residual interval flag (T/F) (def = 1) 
     232Rmin                  0    # Lower bound of residual interval in which weights can be non-zero (def = 0) 
     233Rmax                  0    # Upper bound of residual interval in which weights can be non-zero (def = 0) 
     234# 
     235D1                    0    # Pick weight distance interval flag(s) (T/F) (def = 0) 
     236Dmin1                  0    # Lower bound of distance interval(s) in which weights are zero (def = 0) 
     237Dmax1                180    # Upper bound of distance interval(s) in which weights are zero (def = 180) 
     238# 
     239D2                    0   # Pick weight distance interval flag(s) (T/F) (def = 0) 
     240Dmin2                 0   # Lower bound of distance interval(s) in which weights are zero (def = 0) 
     241Dmax2               180   # Upper bound of distance interval(s) in which weights are zero (def = 180) 
     242# 
     243D3                    0   # Pick weight distance interval flag(s) (T/F) (def = 0) 
     244Dmin3                 0   # Lower bound of distance interval(s) in which weights are zero (def = 0) 
     245Dmax3               180   # Upper bound of distance interval(s) in which weights are zero (def = 180) 
     246# 
     247D4                    0   # Pick weight distance interval flag(s) (T/F) (def = 0) 
     248Dmin4                 0   # Lower bound of distance interval(s) in which weights are zero (def = 0) 
     249Dmax4               180   # Upper bound of distance interval(s) in which weights are zero (def = 180) 
     250# 
     251D5                    0   # Pick weight distance interval flag(s) (T/F) (def = 0) 
     252Dmin5                 0   # Lower bound of distance interval(s) in which weights are zero (def = 0) 
     253Dmax5               180   # Upper bound of distance interval(s) in which weights are zero (def = 180) 
     254# 
     255}}} 
     256 
     257 
    24258 
    25259== Helpful Hints ==