Changes between Version 4 and Version 5 of carlstatrig


Ignore:
Timestamp:
05/22/12 13:18:34 (8 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • carlstatrig

    v4 v5  
    106106Function: Trigger parameter 
    107107 
    108 Sets the decimation count for CarlStaTrig. Normally, every sample is used for computing averages; this is the default decimation of 1. To reduce CPU load, the decimation may be set to 2 or 3 without significantly affecting the trigger results. Then CarlStaTrig will use every second or third sample for averaging. 
    109  
     108Sets the decimation count for !CarlStaTrig. Normally, every sample is used for computing averages; this is the default decimation of 1. To reduce CPU load, the decimation may be set to 2 or 3 without significantly affecting the trigger results. Then !CarlStaTrig will use every second or third sample for averaging. 
     109{{{ 
    110110Default:  1 
    111111Example:  Decimation  3 
    112  
    113 GetWavesFrom Inst Mod           ReadConfig              Earthworm Setup 
    114  
    115                  
     112}}} 
     113 
     114'''!GetWavesFrom [Inst Mod]'''[[BR]] 
     115Processed by: !ReadConfig[[BR]] 
     116Function: Earthworm Setup 
     117 
    116118Defines the waveform logos to retrieve, Inst and Mod module for processing.  
    117  
     119{{{ 
    118120Example: GetWavesFrom INST_WILDCARD MOD_WILDCARD 
    119  HeartBeatInterval nsec ReadConfig              Earthworm Setup 
    120  
    121                  
    122 Defines the number of seconds, nsec between TYPE_HEARTBEAT messages issued by carlstatrig. Example: HeartBeatInterval 30 
    123  MaxGap nlevel          ReadConfig              Trigger parameter 
    124  
    125                  
     121}}} 
     122 
     123'''!HeartBeatInterval [nsec]'''[[BR]] 
     124Processed by: !ReadConfig[[BR]] 
     125Function: Earthworm Setup 
     126 
     127Defines the number of seconds, nsec between TYPE_HEARTBEAT messages issued by carlstatrig.  
     128{{{ 
     129Example: HeartBeatInterval 30 
     130}}} 
     131 
     132'''!MaxGap [nlevel]'''[[BR]] 
     133Processed by: !ReadConfig[[BR]] 
     134Function: Trigger parameter 
     135 
    126136Sets the gap size, in sample periods, above which the station averages are restarted. For smaller gaps, data is interpolated to the sample period for that station. The sample period is specified in TRACE_BUF messages from the source module for that station. The default is 1; that is, reset the station averages for any gap larger than the sample period. 
    127  
     137{{{ 
    128138Default:  1 
    129139Example:  MaxGap  15 
    130  MyModuleId mod_id      ReadConfig              Earthworm setup 
    131  
    132                  
     140}}} 
     141 
     142'''!MyModuleId [mod_id]'''[[BR]] 
     143Processed by: !ReadConfig[[BR]] 
     144Function: Earthworm setup 
     145 
    133146Sets 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. 
    134  
     147{{{ 
    135148Default:  none 
    136149Example:  MyModuleId MOD_CARLSTATRIG 
    137  Quiet equiet           ReadConfig              Trigger parameter 
    138  
    139                  
     150}}} 
     151 
     152'''Quiet [equiet]'''[[BR]] 
     153Processed by: !ReadConfig[[BR]] 
     154Function: Trigger parameter 
     155 
    140156Sets the value of Carl Johnson's equiet parameter for the station trigger calculation. This parameter is a trigger level adjustment. 
    141  
     157{{{ 
    142158Default:  none 
    143159Example:  Quiet 4.0 
    144  Ratio ratio            ReadConfig              Trigger parameter 
    145  
    146                  
     160}}} 
     161 
     162'''Ratio [ratio]'''[[BR]] 
     163Processed by: !ReadConfig[[BR]] 
     164Function: Trigger parameter 
     165 
    147166Sets the value of the trigger ratio. In Carl Johnson's original formulation, this was enumer / edenom. 
    148  
     167{{{ 
    149168Default:  none 
    150169Example:  Ratio 2.3 
    151  RingNameIn ring                ReadConfig              Earthworm setup 
    152  
    153                  
     170}}} 
     171 
     172'''!RingNameIn [ring]'''[[BR]] 
     173Processed by: !ReadConfig[[BR]] 
     174Function: Earthworm setup 
     175 
    154176Tells carlstatrig 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. 
    155  
     177{{{ 
    156178Default:  none 
    157179Example:  RingNameIn  WAVE_RING 
    158  RingNameOut ring               ReadConfig              Earthworm setup 
    159  
    160                  
     180}}} 
     181 
     182'''!RingNameOut [ring]'''[[BR]] 
     183Processed by: !ReadConfig[[BR]] 
     184Function: Earthworm setup 
     185 
    161186Tells carlstatrig 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. 
    162  
     187{{{ 
    163188Default:  none 
    164189Example:  RingNameOut PICK_RING 
    165  StartUp nsec           ReadConfig              Trigger parameter 
    166  
    167                  
     190}}} 
     191 
     192'''!StartUp [nsec]'''[[BR]] 
     193Processed by: !ReadConfig[[BR]] 
     194Function: Trigger parameter 
     195 
    168196Sets the startup time for stations averages to nsec seconds. Carlstatrig waits this number of seconds after startup and reset before it calculates station triggers. This allows long-term averages to stabilize; otherwise false triggers would be sent on startup. 
    169  
     197{{{ 
    170198Default:  none 
    171199Example:  StartUp  7 
    172  STAtime nsec           ReadConfig              Trigger parameter 
    173                  
     200}}} 
     201 
     202'''STAtime [nsec]'''[[BR]] 
     203Processed by: !ReadConfig[[BR]] 
     204Function: Trigger parameter 
     205 
    174206Sets the time for the short-term average (STA) to nsec seconds. 
    175  
     207{{{ 
    176208Default:  1 
    177209Example:  STAtime  3 
    178  LTAtime nsta           ReadConfig              Trigger parameter 
    179                  
     210}}} 
     211 
     212'''LTAtime [nsta]'''[[BR]] 
     213Processed by: !ReadConfig[[BR]] 
     214Function: Trigger parameter 
     215 
    180216Sets the nominal time for the long-term average (LTA) time to nsta STAtimes. This is the time over which the time-dependent weighting factor used in the averaging decreases by a factor of approximately 1/e. 
    181  
     217{{{ 
    182218Default:  8 
    183219Example:  LTAtime  20 
    184  StationFile sta_file   ReadConfig              Station File 
    185                  
    186 Specifes sta_file as the file of stations to be monitored by carlstatrig. This file can be the same station file as the one for CarlSubTrig. CarlStaTrig uses all TRACEBUF messages it gets from its input ring which are listed in the station file. Any other TRACEBUF messages, and stations in the file for which there are no TRACEBUF messages, are ignored. In the following sample station file, the Trigger Time To Live value is not used by carlstaTrig. 
    187  
     220}}} 
     221 
     222'''!StationFile [sta_file]'''[[BR]] 
     223Processed by: !ReadConfig[[BR]] 
     224Function: Station File 
     225 
     226Specifes sta_file as the file of stations to be monitored by carlstatrig. This file can be the same station file as the one for !CarlSubTrig. !CarlStaTrig uses all TRACEBUF messages it gets from its input ring which are listed in the station file. Any other TRACEBUF messages, and stations in the file for which there are no TRACEBUF messages, are ignored. In the following sample station file, the Trigger Time To Live value is not used by carlstaTrig. 
     227{{{ 
    188228Default:  none 
    189229Example:  StationFile  pnsn_trig.sta 
     230}}} 
    190231 
    191232=== Sample Configuration File ===