Changes between Initial Version and Version 1 of statrigfilter


Ignore:
Timestamp:
03/25/12 14:01:42 (10 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • statrigfilter

    v1 v1  
     1[[PageOutline]] 
     2 
     3= [wiki:Earthworm Earthworm] Module: statrigfilter = 
     4'''Contributed by: Lynn Dietz for the CISN''' 
     5 
     6== Function == 
     7A pkfilter like module for filtering out duplicate station triggers. (new in EW v7.0) 
     8 
     9== Details == 
     10The purpose of statrigfilter is to elimnate "duplicate" triggers from a given "station". For statrigfilter, all channels which have 
     11matching station code and network code are considered to be the from the same "station". The rules for what are considered "duplicate" triggers can be found in the specifications file used to design this program: 
     12 
     13[wiki:statrigfilter.designspecs.txt statrigfilter.designspecs.txt] 
     14 
     15Statrigfilter is location-code friendly and will handle both  TYPE_CARLSTATRIG_SCNL and TYPE_CARLSTATRIG messages. 
     16 
     17=== Example Configuration File === 
     18{{{ 
     19#  
     20# statrigfilter configuration file 
     21 
     22# Basic Earthworm setup: 
     23#------------------------ 
     24 MyModuleId   MOD_STATRIGFILTER # module id for this instance of statrigfilter  
     25 InRing       PICK_RING         # shared memory ring for input 
     26 OutRing      FILTERPICK_RING   # shared memory ring for output 
     27 HeartbeatInt 30                # seconds between heartbeats 
     28 LogFile      1                 # 0 log to stderr/stdout only  
     29                                # 1 log to stderr/stdout and to disk file 
     30                                # 2 log to disk file only 
     31 Debug        1 
     32 
     33# List the message logos to grab from InRing, WILDCARDs permitted. 
     34# Multiple "GetLogo" commands are allowed, with no hardcoded limit. 
     35#         Installation    Module      Message Types 
     36#----------------------------------------------------------------- 
     37 GetLogo  INST_WILDCARD  MOD_WILDCARD # TYPE_CARLSTATRIG & TYPE_CARLSTATRIG_SCNL 
     38 
     39# Trigger Filtering Parameters 
     40#----------------------------- 
     41 TriggerHistory       5      # Keep track of this many triggers which have 
     42                             # made it thru the filter for each station. 
     43 
     44 TimeTolerance        2.0    # If trigger times are within this many seconds of 
     45                             # each other, they are "duplicates." 
     46 
     47 OlderTrigAllowed     1      # 0=reject any non-duplicate trigger whose  
     48                             #   timestamp is earlier than the youngest  
     49                             #   passed trigger for this station. 
     50                             # 1=accept a non-duplicate trigger whose timestamp 
     51                             #   is earlier than the youngest passed trigger, 
     52                             #   but place a limit on how old it can be. 
     53                             #   Must also use the "OlderTrigLimit" command. 
     54                             # 2=accept any non-duplicate trigger whose  
     55                             #   timestamp is earlier than the youngest    
     56                             #   passed trigger. 
     57 
     58 OlderTrigLimit       10     # Required only if OlderTrigAllowed = 1 
     59                             # Accept an trigger whose timestamp is between 
     60                             # TimeTolerance and OlderTrigLimit sec      
     61                             # earlier than the youngest passed trigger 
     62                             # from this station. 
     63 
     64# List of Allowed Components 
     65#--------------------------- 
     66# If you want ALL component codes to be eligible to pass thru  
     67# statrigfilter, comment out all "AllowComponent" commands. 
     68# If you want to limit which component codes pass thru statrigfilter, 
     69# use one "AllowComponent" command for each allowed component code. 
     70#AllowComponent   VDZ 
     71#AllowComponent   VHZ 
     72#AllowComponent   VLZ 
     73#AllowComponent   SHZ 
     74#AllowComponent   SLZ 
     75#AllowComponent   EHZ 
     76#AllowComponent   HHZ 
     77#AllowComponent   BHZ 
     78#AllowComponent   DP1 
     79#AllowComponent   DP2 
     80#AllowComponent   DP3 
     81#AllowComponent   EP1 
     82#AllowComponent   EP2 
     83#AllowComponent   EP3 
     84 
     85# Optional commands: 
     86#------------------- 
     87 MaxMessageSize   128        # length (bytes) of largest msg to be processed 
     88                             # from InRing.  Default=MAX_BYTES_PER_EQ 
     89 
     90 UseOriginalLogo  1          # 0  apply statrigfilter's logo to any msgs that 
     91                             #    pass the filter test (normal Earthworm behavior) 
     92                             # non-zero means apply the original logo to any 
     93                             #    messages that pass the filter test.  This 
     94                             #    also requires that InRing and OutRing be  
     95                             #    different to avoid "missed message" or 
     96                             #    "sequence gap" storms in trigger-reading modules.. 
     97}}} 
     98 
     99== Helpful Hints ==