Changes between Initial Version and Version 1 of pkfilter


Ignore:
Timestamp:
03/25/12 13:56:36 (9 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • pkfilter

    v1 v1  
     1[[PageOutline]] 
     2 
     3= [wiki:Earthworm Earthworm] Module: pkfilter = 
     4'''Contributed by: ''' 
     5 
     6== Function == 
     7A duplicate pick removal filter. (new in EW v7.0) 
     8 
     9== Details == 
     10The purpose of pkfilter is to reduce the number of "duplicate" picks from a given "station". For pkfilter, all components which have matching station code and network code are considered to be the from the same "station". The rules for what are considered "duplicate" picks can be found in the specifications file used to design this program: 
     11 
     12[wiki:pkfilter.designspecs.txt pkfilter.designspecs.txt] 
     13 
     14Pkfilter is location-code friendly and will handle both the TYPE*2K and TYPE*SCNL versions picks and codas. 
     15 
     16This module was written by Lynn Dietz for the CISN. 
     17 
     18=== Example Configuration File === 
     19{{{ 
     20pkfilter is a pick filtering module designed to prevent duplicate picks. Below is a copy of the .d file with detailed notes on each parameter 
     21 
     22# pkfilter configuration file 
     23 
     24# Basic Earthworm setup: 
     25#------------------------ 
     26 MyModuleId   MOD_PKFILTER    # module id for this instance of pkfilter  
     27 InRing       PICK_RING       # shared memory ring for input 
     28 OutRing      FILTERPICK_RING # shared memory ring for output 
     29 HeartbeatInt 30              # seconds between heartbeats 
     30 LogFile      1               # 0 log to stderr/stdout only  
     31                              # 1 log to stderr/stdout and to disk file 
     32                              # 2 log to disk file only 
     33 Debug        1 
     34 
     35# List the message logos to grab from InRing, WILDCARDs permitted. 
     36# Multiple "GetLogo" commands are allowed, with no hardcoded limit. 
     37#         Installation    Module      Message Types 
     38#----------------------------------------------------------------- 
     39 GetLogo  INST_WILDCARD  MOD_WILDCARD # TYPE_PICK_SCNL & TYPE_CODA_SCNL 
     40                                      # TYPE_PICK2K & TYPE_CODA2K 
     41 
     42# Pick Filtering Parameters 
     43#-------------------------- 
     44 PickHistory          5      # Keep track of this many picks which have 
     45                             # made it thru the filter for each station. 
     46 
     47 PickTolerance        3.0    # If pick times are within this many seconds of 
     48                             # each other, they are "duplicates." 
     49 
     50 OlderPickAllowed     1      # 0=reject any non-duplicate pick whose  
     51                             #   timestamp is earlier than the youngest  
     52                             #   passed pick for this station. 
     53                             # 1=accept a non-duplicate pick whose timestamp 
     54                             #   is earlier than the youngest passed pick, 
     55                             #   but place a limit on how old it can be. 
     56                             #   Must also use the "OlderPickLimit" command. 
     57                             # 2=accept any non-duplicate pick whose  
     58                             #   timestamp is earlier than the youngest    
     59                             #   passed pick. 
     60 
     61 OlderPickLimit       30     # Required only if OlderPickAllowed = 1 
     62                             # Accept an pick whose timestamp is between 
     63                             # PickTolerance and OlderPickLimit sec      
     64                             # earlier than the youngest passed pick 
     65                             # from this station. 
     66 
     67 DuplicateOnQuality   1      # If non-zero, transfer a duplicate when its 
     68                             #  quality is better than the original. 
     69 
     70 QualDiffAllowed      1      # Required quality difference for later pick to 
     71                             # be allowed to pass as a duplicate. 
     72                             #  0 means any pick greater than current pick 
     73                             #  1 means a pick of 1 replaces a pick of 3  
     74                             #  2 means a pick of 0 replaces a pick of 3  
     75                             #  3 is invalid because it is equivalent to  
     76                             #    turning off the duplicate on quality test  
     77 
     78# List of Allowed Components 
     79#--------------------------- 
     80# If you want ALL component codes to be eligible to pass thru  
     81# pkfilter, comment out all "AllowComponent" commands. 
     82# If you want to limit which component codes pass thru pkfilter, 
     83# use one "AllowComponent" command for each allowed component code. 
     84# A component refers to the CHANNEL name in the SCNL tuple. 
     85 AllowComponent   VDZ 
     86 AllowComponent   VHZ 
     87 AllowComponent   VLZ 
     88 AllowComponent   SHZ 
     89 AllowComponent   SLZ 
     90 AllowComponent   EHZ 
     91 AllowComponent   HHZ 
     92 AllowComponent   BHZ 
     93 AllowComponent   DP1 
     94 AllowComponent   DP2 
     95 AllowComponent   DP3 
     96 AllowComponent   EP1 
     97 AllowComponent   EP2 
     98 AllowComponent   EP3 
     99 
     100# Coda Filtering Parameters 
     101#-------------------------- 
     102 CodaFilter       1          # Possible coda filtering values: 
     103                             #  0 = allow no codas thru filter 
     104                             #  1 = allow only codas which match passed 
     105                             #      picks to pass thru filter  
     106                             #  2 = allow all codas thru 
     107 
     108# Optional commands: 
     109#------------------- 
     110 MaxMessageSize   128        # length (bytes) of largest msg to be processed 
     111                             # from InRing.  Default=MAX_BYTES_PER_EQ 
     112 
     113 UseOriginalLogo  1          # 0  apply pkfilter's logo to any messages that 
     114                             #    pass the filter test (normal Earthworm behavior) 
     115                             # non-zero means apply the original logo to any 
     116                             #    messages that pass the filter test.  This 
     117                             #    also requires that InRing and OutRing be  
     118                             #    different to avoid "missed message" or 
     119                             #    "sequence gap" storms in pick-reading modules. 
     120}}} 
     121 
     122 
     123== Helpful Hints ==