Changes between Version 3 and Version 4 of carlsubtrig


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

--

Legend:

Unmodified
Added
Removed
Modified
  • carlsubtrig

    v3 v4  
    9292command [argument here] 
    9393 
    94  Debug level            ReadConfig              Earthworm setup  
    95                  
     94'''Debug [level]'''[[BR]] 
     95Processed by: !ReadConfig[[BR]] 
     96Function: Earthworm setup 
     97 
    9698Sets the debug logging level for CarlStaTrig. With level set to zero minimal logging is done. Very verbose logging is obtained with level set to 4. 
    97  
     99{{{ 
    98100Default:  0 
    99101Example:  Debug  3 
    100  Decimation count               ReadConfig              Trigger parameter 
    101                  
    102  
    103 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. 
    104  
     102}}} 
     103 
     104'''Decimation [count]'''[[BR]] 
     105Processed by: !ReadConfig[[BR]] 
     106Function: Trigger parameter 
     107 
     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{{{ 
    105110Default:  1 
    106111Example:  Decimation  3 
    107  
    108 GetWavesFrom Inst Mod           ReadConfig              Earthworm Setup 
    109  
    110                  
     112}}} 
     113 
     114'''!GetWavesFrom [Inst Mod]'''[[BR]] 
     115Processed by: !ReadConfig[[BR]] 
     116Function: Earthworm Setup 
     117 
    111118Defines the waveform logos to retrieve, Inst and Mod module for processing.  
    112  
     119{{{ 
    113120Example: GetWavesFrom INST_WILDCARD MOD_WILDCARD 
    114  HeartBeatInterval nsec ReadConfig              Earthworm Setup 
    115  
    116                  
    117 Defines the number of seconds, nsec between TYPE_HEARTBEAT messages issued by carlstatrig. Example: HeartBeatInterval 30 
    118  MaxGap nlevel          ReadConfig              Trigger parameter 
    119  
    120                  
     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 
    121136Sets 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. 
    122  
     137{{{ 
    123138Default:  1 
    124139Example:  MaxGap  15 
    125  MyModuleId mod_id      ReadConfig              Earthworm setup 
    126  
    127                  
     140}}} 
     141 
     142'''!MyModuleId [mod_id]'''[[BR]] 
     143Processed by: !ReadConfig[[BR]] 
     144Function: Earthworm setup 
     145 
    128146Sets 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. 
    129  
     147{{{ 
    130148Default:  none 
    131149Example:  MyModuleId MOD_CARLSTATRIG 
    132  Quiet equiet           ReadConfig              Trigger parameter 
    133  
    134                  
     150}}} 
     151 
     152'''Quiet [equiet]'''[[BR]] 
     153Processed by: !ReadConfig[[BR]] 
     154Function: Trigger parameter 
     155 
    135156Sets the value of Carl Johnson's equiet parameter for the station trigger calculation. This parameter is a trigger level adjustment. 
    136  
     157{{{ 
    137158Default:  none 
    138159Example:  Quiet 4.0 
    139  Ratio ratio            ReadConfig              Trigger parameter 
    140  
    141                  
     160}}} 
     161 
     162'''Ratio [ratio]'''[[BR]] 
     163Processed by: !ReadConfig[[BR]] 
     164Function: Trigger parameter 
     165 
    142166Sets the value of the trigger ratio. In Carl Johnson's original formulation, this was enumer / edenom. 
    143  
     167{{{ 
    144168Default:  none 
    145169Example:  Ratio 2.3 
    146  RingNameIn ring                ReadConfig              Earthworm setup 
    147  
    148                  
     170}}} 
     171 
     172'''!RingNameIn [ring]'''[[BR]] 
     173Processed by: !ReadConfig[[BR]] 
     174Function: Earthworm setup 
     175 
    149176Tells 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. 
    150  
     177{{{ 
    151178Default:  none 
    152179Example:  RingNameIn  WAVE_RING 
    153  RingNameOut ring               ReadConfig              Earthworm setup 
    154  
    155                  
     180}}} 
     181 
     182'''!RingNameOut [ring]'''[[BR]] 
     183Processed by: !ReadConfig[[BR]] 
     184Function: Earthworm setup 
     185 
    156186Tells 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. 
    157  
     187{{{ 
    158188Default:  none 
    159189Example:  RingNameOut PICK_RING 
    160  StartUp nsec           ReadConfig              Trigger parameter 
    161  
    162                  
     190}}} 
     191 
     192'''!StartUp [nsec]'''[[BR]] 
     193Processed by: !ReadConfig[[BR]] 
     194Function: Trigger parameter 
     195 
    163196Sets 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. 
    164  
     197{{{ 
    165198Default:  none 
    166199Example:  StartUp  7 
    167  STAtime nsec           ReadConfig              Trigger parameter 
    168                  
     200}}} 
     201 
     202'''STAtime [nsec]'''[[BR]] 
     203Processed by: !ReadConfig[[BR]] 
     204Function: Trigger parameter 
     205 
    169206Sets the time for the short-term average (STA) to nsec seconds. 
    170  
     207{{{ 
    171208Default:  1 
    172209Example:  STAtime  3 
    173  LTAtime nsta           ReadConfig              Trigger parameter 
    174                  
     210}}} 
     211 
     212'''LTAtime [nsta]'''[[BR]] 
     213Processed by: !ReadConfig[[BR]] 
     214Function: Trigger parameter 
     215 
    175216Sets 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. 
    176  
     217{{{ 
    177218Default:  8 
    178219Example:  LTAtime  20 
    179  StationFile sta_file   ReadConfig              Station File 
    180                  
    181 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. 
    182  
     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{{{ 
    183228Default:  none 
    184229Example:  StationFile  pnsn_trig.sta 
     230}}} 
    185231 
    186232=== Sample Configuration File ===