Changes between Initial Version and Version 1 of eqfilterII


Ignore:
Timestamp:
05/29/12 10:33:38 (9 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • eqfilterII

    v1 v1  
     1[[PageOutline]] 
     2 
     3= [wiki:Earthworm Earthworm] Module: eqfilterII = 
     4'''Contributed by: ''' 
     5 
     6== Function == 
     7Clone of eqfilterII to work with any of TYPE_HYP2000ARC, TYPE_LOC_GLOBAL, and TYPE_RAYLOC (new in EW v7.0) 
     8 
     9== Details == 
     10This is verion II the Earthworm hypocenter garbage rejector. EqfilterII was cloned from eqfilter. It accepts any of three message types: TYPE_HYP2000ARC, TYPE_LOC_GLOBAL, and TYPE_RAYLOC (eqfilter only accepts TYPE_HYP2000ARC). Whatever message type is read, is also the type written to eqfilterII's message ring. EqfilterII gets its messages from the !InRing does some sanity checks then puts any that pass all configured tests onto the !OutRing. !InRing and !OutRing can not be the same. All tests are optional. If a test is not configured then it is not performed. If a test is configured then it must pass. Tests are tied to inst_id. More or less all parameters in the hypo summary card may be tested for. Additionally, authoritative regions may be configured. Minimum number of coda picks greater than zero for multiple magnitudes may also be configured. 
     11 
     12INST_WILDCARD is allowed. If wildcard is the only installation configured for a given test then arc messages from all installations will be tested with those parameters. If only a specific installation is configured for a given test, then only messages from that installation will be tested and all others will fail. If a specific installation is configured for a given test and wildcard is also configured for that test, then messages from the specific will use those parameters, and all other non-specified installations will use the wildcard params. 
     13 
     14== Configuration File Commands == 
     15eqfilterII is the so called garbage rejector . That is it performs sanity and authoritative region tests to any of three message types found on the !InRing and passes to the !OutRing (TYPE_HYP2000ARC, TYPE_LOC_GLOBAL, and TYPE_RAYLOC). !InRing and !OutRing can not be the same. 
     16 
     17All tests are optional. If a test is not configured then it is not performed. If a test is configured then it must pass. Tests are tied to inst_id. More or less all parameters in the hypo summary card may be tested for. Additionally, authoritative regions may be configured. Minimum number of coda picks greater than zero for multiple magnitudes may also be configured. 
     18 
     19INST_WILDCARD is allowed. If wildcard is the only institute configured for a given test then arc messages from any installation will be tested with those parameters. If only specific installation is configured for a given test, then only messages from that installation will be tested for and all others will fail. If a specific installation is configured for a given test and wildcard is also configured for that test, then messages from the specific will use those parameters, and all other non-specified installations will use the wildcard params. 
     20 
     21On startup, eqfilterII reads the configuration file named on the command-line. Commands in this file set up all parameters used in testing events for passing to the clean ring. In the control file, lines may begin with a valid eqfilterII command (listed below) or with one of 2 special characters: 
     22{{{ 
     23#  marks the line as a comment (example: # This is a comment). 
     24 
     25@  allows control files to be nested; one control file can be 
     26   accessed from another with the command "@" followed by 
     27   a string representing the path name of the next control file 
     28   (example: @model.d). 
     29}}} 
     30 
     31Command names must be typed in the control file exactly as shown in this document (upper/lower case matters!). 
     32 
     33=== EXAMPLE CONFIGURATION FILE === 
     34{{{ 
     35 # This is eqfilterII's parameter file! 
     36# 
     37MyModuleId   MOD_EQFILTERII  # module id for this instance of eqfilterII 
     38InRing       HYPO_RING       # ring to pick up hyp2000arc messages 
     39OutRing      HYPO_RING_CLEAN # ring to write output 
     40HeartBeatInt 30              # seconds between heartbeats 
     41LogFile      1               # 0 means don't create a disc log file. 1=> do. 
     42                             # all hyp2000arc messages get logged.  If a message 
     43                             # passes this is logged, if it fails the test(s) which 
     44                             # failed are logged. 
     45#Debug                       # uncomment to log lots of trash 
     46 
     47# List the message logos to grab from transport ring 
     48#              Installation       Module       Message Type 
     49GetEventsFrom INST_WILDCARD MOD_WILDCARD TYPE_LOC_GLOBAL 
     50GetEventsFrom INST_WILDCARD MOD_WILDCARD TYPE_HYP2000ARC 
     51GetEventsFrom INST_WILDCARD MOD_WILDCARD TYPE_RAYLOC 
     52 
     53# 
     54# AllowUndefInst - OPTIONAL 
     55#  Applies only to authreg test. 
     56#  If this is uncommented, the messages with installation 
     57#  ID not listed in any InclRegion command below will be written to the 
     58#  OutRing.  To prevent writing of messages with "unknown" installation 
     59#  IDs, make sure that this options is NOT commented out. 
     60# 
     61AllowUndefInst 
     62 
     63# 
     64# List authoritative regions: at least one InclRegion keyword is required. 
     65#  It associates an earthworm installation ID with a polygon (max 20 sides) 
     66#  inside of which that installation is authoritative. 
     67#    o An installation can have more than one authoritative region. 
     68#    o A region can belong to more than one installation. 
     69# 
     70# The points of a polygon should be listed as if lines of the polygon 
     71# were being drawn without lifting up the pencil, until the polygon 
     72# is closed. Therefore, the first and the last point should be 
     73# the same, and each two the points in between should be the ends 
     74# of one side of the polygon. 
     75# 
     76# ExclRegion is optional. It allows for "holes" to be cut inside of the 
     77# authoritative regions defined by InclRegion option. 
     78# 
     79# 
     80# Region polygons below are from CNSS: 
     81#  http://quake.geo.berkeley.edu/cnss/cnss-detail.html#polygons 
     82# 
     83 
     84# 
     85#Keyword      InstID     NumSides    Lat, Lon  Lat, Lon  ... 
     86# 
     87 
     88# 
     89# Alaska Regional Network - AK 
     90# 
     91 
     92# 
     93# AVO Volcanos 
     94# 
     95InclRegion   INST_AVO       5    62.50 -148.00   60.00 -150.00   57.50 -157.00   58.75 -157.00   62.50 -152.50   62.50 -148.00 
     96InclRegion   INST_AVO       4    51.25 -175.50   52.50 -175.50   52.50 -178.00   51.25 -178.00   51.25 -175.50 
     97 
     98 
     99# 
     100# Southern California Seismic Network - CI 
     101# 
     102# 
     103# HVO Network - HV 
     104# 
     105InclRegion   INST_HVO       8    18.83 -155.00   19.50 -154.75   20.00 -154.92   20.25 -155.25   20.33 -155.92   20.00 -156.50   19.17 -156.17   18.75 -155.67   18.83 -155.00 
     106 
     107# 
     108# Montana Seismic Network - MB 
     109# 
     110InclRegion   INST_BUTTE     8    45.17 -110.00   45.17 -111.33   44.50 -111.33   44.50 -113.00   47.95 -116.00   48.50 -115.00   48.50 -113.00   47.00 -110.00   45.17 -110.00 
     111 
     112# 
     113# Northern California Seismic Networks - NC 
     114# 
     115InclRegion    INST_MENLO     9   36.68 -117.79   37.75 -118.25   37.75 -119.50   39.50 -120.75   42.00 -121.41   42.00 -122.70   43.02 -125.00   40.00 -125.50   34.69 -121.37   36.68 -117.79 
     116 
     117# 
     118# New Madrid Seismic Network - NM 
     119# 
     120InclRegion    INST_MEMPHIS   8   37.63  -86.68   36.63  -88.62   34.03  -88.42   34.00  -93.50   38.00  -93.50   40.00  -91.50   40.00  -85.00   38.80  -85.00   37.63  -86.68 
     121 
     122# 
     123# Nevada Seismic Network - NN 
     124# 
     125InclRegion    INST_UNR      11   35.30 -114.60   35.80 -116.40   36.68 -117.79   37.75 -118.25   37.75 -119.50   39.50 -120.75   40.50 -120.50   41.50 -119.20   41.30 -118.30   40.00 -116.00   37.50 -114.30   35.30 -114.60 
     126 
     127# 
     128# SouthEast US Seismic Network - SE 
     129# 
     130 
     131# 
     132# Puerto Rico Seismic Network - PR 
     133# 
     134 
     135# 
     136# Utah Seismograph Network - UU 
     137# 
     138InclRegion    INST_UTAH      4   36.75 -108.75   36.75 -114.25   42.50 -114.25   42.50 -108.75   36.75 -108.75 
     139 
     140# 
     141# Pacific Northwest Seismic Network - UW 
     142# 
     143InclRegion    INST_UW       11   43.02 -125.00   42.00 -122.70   42.00 -121.00   45.90 -117.80   48.20 -117.80   48.95 -122.00   48.95 -122.80   48.20 -123.00   48.50 -125.00   44.50 -124.60   43.00 -125.00   43.02 -125.00 
     144 
     145# 
     146# Yellowstone WY Seismic Network - WY 
     147# 
     148InclRegion    INST_UTAH      4   44.00 -109.75   44.00 -111.33   45.17 -111.33   45.17 -109.75   44.00 -109.75 
     149 
     150# for all subsequent tests INST_WILDCARD is legal but will be superceded 
     151# by additional Keyword entries with non-wildcard InstID. 
     152 
     153#Depth test 
     154# is hypo between MinDepth and MaxDepth km 
     155#Keyword    InstID         MinDepth  MaxDepth 
     156#DepthTest   INST_WILDCARD   0.0       25.0 
     157 
     158#number phase (high weight) test 
     159# are there at least NPhase phases with phase weight greater than 0.1 
     160#Keyword    InstID         NPhase 
     161#nphTest  INST_WILDCARD   5 
     162 
     163#total number phase (any weight) test 
     164# are there at least NPhase phases with phase weight greater than 0.0 
     165#Keyword    InstID         NPhaseTotal 
     166nphtotalTest  INST_WILDCARD   5 
     167 
     168#gap test 
     169# is the gap < MaxGap  degrees 
     170#Keyword    InstID         MaxGap 
     171#GapTest     INST_MEMPHIS   270.0 
     172 
     173#dmin test 
     174# is distance to nearest station at no greater than MaxDmin km 
     175#Keyword    InstID         MaxDmin 
     176#DminTest    INST_MEMPHIS   50.0 
     177 
     178#rms test 
     179# is the rms less than MaxRMS seconds 
     180#Keyword    InstID         MaxRMS 
     181#RMSTest     INST_MEMPHIS   2.5 
     182 
     183#e0 test 
     184# is the largest principal error less than MaxE0 km 
     185#Keyword    InstID         MaxE0 
     186#MaxE0Test      INST_MEMPHIS   50.0 
     187 
     188#erh test 
     189# is the horizontal error less than MaxERH km 
     190#Keyword    InstID         MaxERH 
     191#MaxERHTest     INST_MEMPHIS   50.0 
     192 
     193#erz test 
     194# is the vertical error less than MaxERZ km 
     195#Keyword    InstID         MaxERZ 
     196#MaxERZTest     INST_MEMPHIS   25.0 
     197 
     198#Mag test 
     199# is the magnitude greater than MinMag 
     200#Keyword    InstID         MinMag 
     201MinMagTest     INST_MEMPHIS   -9.9 
     202MinMagTest     INST_AVO        3.0 
     203MinMagTest     INST_HVO        3.0 
     204MinMagTest     INST_BUTTE      0.0 
     205MinMagTest     INST_MENLO      2.5 
     206MinMagTest     INST_UNR        2.5 
     207MinMagTest     INST_UTAH       2.5 
     208MinMagTest     INST_UW         2.5 
     209MinMagTest     INST_WILDCARD   4.0 
     210 
     211#Ncoda test 
     212# given an event with Magnitude Mag, are there at least MinC coda picks 
     213# 
     214# note here that since a test is defined for INST_MEMPHIS, unless there 
     215#   is a wildcard test also defined, only INST_MEMPHIS events have a 
     216#   chance of passing.  This is so because once a test is configured, 
     217#   only configured instid's will pass the test. 
     218#Keyword    InstID         MinC  Mag 
     219NcodaTest   INST_MEMPHIS   4     2.0 
     220NcodaTest   INST_MEMPHIS   9     3.0 
     221NcodaTest   INST_WILDCARD  6     2.0 
     222 
     223# end of parameter file 
     224}}} 
     225 
     226=== ALPHABETIC COMMAND LISTING & DESCRIPTION === 
     227 
     228In the following section, all configuration file commands are listed in alphabetical order.  Listed along with the command (bold-type) are its arguments (in red) and a description of the command.  There are no default values so if you configure the command without arguments, all messages fail. 
     229 
     230 
     231The following list is organized by: 
     232 
     233command [argument here] 
     234 
     235 
     236'''!AllowUndefInst''' 
     237 
     238Command with no arguments and applies only to Authoritative Regions. Any messages with installation ID not listed in any InclRegion will will pass the Authoritative Region test.  
     239 
     240'''Debug''' 
     241 
     242Command with no arguments. If present, many debug messages are logged. 
     243 
     244'''!DepthTest [Inst_ID !MinDepth !MaxDepth]''' 
     245 
     246If defined, only messages from Inst_ID that have hypocentral depth between !MinDepth and !MaxDepth kilometers, exclusive, will be passed. All others fail. 
     247 
     248'''!DminTest [Inst_ID !MaxDmin]''' 
     249 
     250If defined, only messages from InstID with a distance to the nearest station of less than !MaxDmin kilometers will be passed. All others fail. 
     251 
     252'''!ExclRegion  [Inst_ID !NumSides Lat1 Lon1 Lat2 Lon2 ... Lat1 Lon1]''' 
     253 
     254List of exclude regions to cut "holes" in a given Inst_ID's authoritave polygon. The points of a polygon should be listed as if lines of the polygon were being drawn without lifting up the pencil, until the polygon is closed. Therefore, the first and the last point should be the same, and each two the points in between should be the ends of one side of the polygon.  INST_WILDCARD is NOT ALLOWED with this test. 
     255 
     256'''!GapTest [Inst_ID !MaxGap]''' 
     257 
     258If defined, only messages from InstID with azimuthal gap of less than !MaxGap degrees will be passed. All others fail. 
     259 
     260'''!GetEventsFrom>  [INST_ID MOD_ID]''' 
     261 
     262What message logos to listen to. Can be more than one, but no more than five. The message type can be any of TYPE_LOC_GLOBAL, TYPE_HYP2000ARC, TYPE_RAYLOC. Multiple message types of the three allowed can be used (up to the max number of logos). 
     263 
     264'''!HeartBeatInt  [Seconds]''' 
     265 
     266Required command to define number of seconds between heartbeats placed on !OutRing. 
     267 
     268'''!InclRegion  [Inst_ID !NumSides Lat1 Lon1 Lat2 Lon2 ... Lat1 Lon1]''' 
     269 
     270List authoritative regions. It associates an earthworm installation ID with a polygon (max 20 sides) inside of which that installation is authoritative. An installation can have more than one authoritative region. A region can belong to more than one installation. The points of a polygon should be listed as if lines of the polygon were being drawn without lifting up the pencil, until the polygon is closed. Therefore, the first and the last point should be the same, and each two the points in between should be the ends of one side of the polygon.  INST_WILDCARD is NOT ALLOWED with this test.  
     271 
     272'''!InRing  [!RingName]''' 
     273 
     274Read messages from this ring. 
     275 
     276'''!LogFile  [int]''' 
     277 
     278If set to 1, turn on logging. If set to 0, turn it off. 
     279 
     280'''!MinMagTest  [Inst_ID !MinMag]''' 
     281 
     282If defined, messages from installation Inst_ID with magnitude greater than !MinMag will pass. All others fail. 
     283 
     284'''MaxE0Test  [Inst_ID MaxE0]''' 
     285 
     286If defined, messages from installation Inst_ID with E0 less than MaxE0 will pass. All others fail. E0 is the value of the largest principal error in kilometers. 
     287 
     288'''MaxERHTest  [Inst_ID MaxERH]''' 
     289 
     290If defined, messages from installation Inst_ID with ERH less than MaxERH will pass. All others fail. ERH is the value of the largest horizontal error in kilometers. 
     291 
     292'''MaxERZTest  [Inst_ID MaxERZ]''' 
     293 
     294If defined, messages from installation Inst_ID with ERZ less than MaxERZ will pass. All others fail. ERZ is the value of the veritical error in kilometers. 
     295 
     296'''!MyModuleId  [name]''' 
     297 
     298name is the instance of this module and must be defined in earthworm.d 
     299 
     300'''!NcodaTest  [Inst_ID MinC Mag]''' 
     301 
     302If defined, messages from installation Inst_ID with magnitude greater than Mag, must have at least MinC coda duration picks greater than 0. All others fail. 
     303 
     304'''nphTest  [Inst_ID NPhase]''' 
     305 
     306If defined, messages from installation Inst_ID with more than NPhase arrivals having phase weight greater than 0.1 will pass.  All others fail. 
     307 
     308'''!OutRing  [name]''' 
     309 
     310Required. Outgoing messages get written to name ring. Can not be the same is !InRing. 
     311 
     312'''RMSTest  [Inst_ID MaxRMS]''' 
     313 
     314If defined, messages from installation Inst_ID with rms error less than MaxRMS will pass. All others fail. 
     315 
     316== Helpful Hints ==