Changes between Version 8 and Version 9 of carlsubtrig


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

--

Legend:

Unmodified
Added
Removed
Modified
  • carlsubtrig

    v8 v9  
    108108In the following section, all configuration file commands are listed in alphabetical order. Listed along with the command (bold-type) are its arguments (in red), the name of the subroutine that processes the command, and the function within the module that the command influences. A detailed description of the command and is also given. Default values and the values used by PNSN are listed after each command description. 
    109109 
    110  
    111 command arg1                    processed by            function 
    112  AllSubnets nsubnets            ReadConfig              Earthworm setup 
     110The following list is organized by: 
     111 
     112command [argument here] 
     113 
     114'''!AllSubnets [nsubnets]'''[[BR]] 
     115Processed by: !ReadConfig[[BR]] 
     116Function: Earthworm setup 
    113117 
    114118If nsubnets trigger for an event, then the trigger message will include the SCNL wildcard. A process reading the trigger message could understand this wildcard to mean "retrieve data for All stations". 
    115  
     119{{{ 
    116120Default:  0 
    117121Example:  AllSubnets  10 
    118  Channel SCNL                   ReadConfig              Earthworm setup 
     122}}} 
     123 
     124'''Channel [SCNL]'''[[BR]] 
     125Processed by: !ReadConfig[[BR]] 
     126Function: Earthworm setup 
    119127 
    120128Specify a single SCNL that should be listed in all trigger messages. For example, this can be used to list time channels that never trigger but should always be present in waveform data filesets. This command can be used as many times as necessary. 
    121  
     129{{{ 
    122130Default:  0 
    123131Example:  Channel WWVB.TIM.UW 
    124  CoincidentStaTriggers                  ReadConfig              Earthworm setup 
     132}}} 
     133 
     134'''!CoincidentStaTriggers'''[[BR]] 
     135Processed by: !ReadConfig[[BR]] 
     136Function: Earthworm setup 
    125137 
    126138The number of station triggers that match exactly to the second that must be met for a trigger message to be rejected. The idea here is to eliminate telemetry glitches by mapping exactly coincident in time trigger on times. The carlstatrigger messages only have on time to the whole second. 
    127  
     139{{{ 
    128140Default:  0  (not set) 
    129141Example:  CoincidentStaTriggers 9 
    130  CompAsWild                     ReadConfig              Earthworm setup 
     142}}} 
     143 
     144'''!CompAsWild'''[[BR]] 
     145Processed by: !ReadConfig[[BR]] 
     146Function: Earthworm setup 
    131147 
    132148Flag with no value. If present, carlsubtrig will put the wildcard `*' in the trigger message in place of component names. This can be used if you have multi-component stations but only want to listen for station triggers from the vertical component. 
    133  
     149{{{ 
    134150Default:  0  (flag not set) 
    135151Example:  CompAsWild 
    136  Debug level                    ReadConfig              Earthworm setup 
     152}}} 
     153 
     154'''Debug [level]'''[[BR]] 
     155Processed by: !ReadConfig[[BR]] 
     156Function: Earthworm setup 
    137157 
    138158Sets the debug logging level for CarlSubTrig. With level set to zero minimal logging is done. Very verbose logging is obtained with level set to 4. 
    139  
     159{{{ 
    140160Default:  0 
    141161Example:  Debug  3 
    142  DefStationDur nsecs            ReadConfig              Station parameters 
    143   
     162}}} 
     163 
     164'''!DefStationDur [nsecs]'''[[BR]] 
     165Processed by: !ReadConfig[[BR]] 
     166Function: Station parameters 
     167 
    144168Sets the default station trigger duration to nsecs seconds. This value is used to terminate a station trigger only if no trigger-off message matching a trigger-on message is received from CarlStaTrig. 
    145  
     169{{{ 
    146170Default:  none 
    147171Example:  DefStationDur  120 
    148  GetEventsFrom inst mod_id      ReadConfig              Earthworm setup 
    149   
    150 Contrls the TYPE_CARLSTATRIG messages input to carlsubtrig. CarlSubTrig will only process TYPE_CARLSTATRIG messages that come from module mod_id at installation inst. inst and mod_id are character strings (valid strings are listed in earthworm.h/earthworm.d) which are related to single-byte numbers that uniquely identify each installation and module. Only one "GetSumFrom" command may be issued; wildcards (INST_WILDCARD and MOD_WILDCARD) will force carlsubtrig to process all station trigger messages, regardless of their place of origin. 
    151  
     172}}} 
     173 
     174'''!GetEventsFrom [inst mod_id]'''[[BR]] 
     175Processed by: !ReadConfig[[BR]] 
     176Function: Earthworm setup 
     177 
     178Contrls the TYPE_CARLSTATRIG messages input to carlsubtrig. !CarlSubTrig will only process TYPE_CARLSTATRIG messages that come from module mod_id at installation inst. inst and mod_id are character strings (valid strings are listed in earthworm.h/earthworm.d) which are related to single-byte numbers that uniquely identify each installation and module. Only one "!GetSumFrom" command may be issued; wildcards (INST_WILDCARD and MOD_WILDCARD) will force carlsubtrig to process all station trigger messages, regardless of their place of origin. 
     179{{{ 
    152180Default:  none 
    153181Example   GetEventsFrom  INST_WILDCARD  MOD_WILDCARD 
    154  HeartBeatInterval nsec         ReadConfig              Earthworm setup 
     182}}} 
     183 
     184'''!HeartBeatInterval [nsec]'''[[BR]] 
     185Processed by: !ReadConfig[[BR]] 
     186Function: Earthworm setup 
    155187 
    156188Defines the number of seconds, nsec between TYPE_HEARTBEAT messages issued by carlsubtrig. 
    157  
     189{{{ 
    158190Default:  none 
    159191Example:  HeartBeatInterval 30 
    160  IgnoreCoincident                       ReadConfig              Earthworm setup 
    161 IgnoreCoincident nsubs 
    162 If more than the specified number of subnets nsubs are coincidentally triggered, then the coincident check for 
    163 triggers is not performed. The reason for this option is because the coincident check should only be 
    164 performed for a small number of subnets triggering since telemetry glitches would not cross more than 
     192}}} 
     193 
     194'''!IgnoreCoincident [nsubs]'''[[BR]] 
     195Processed by: !ReadConfig[[BR]] 
     196Function: Earthworm setup 
     197 
     198If more than the specified number of subnets nsubs are coincidentally triggered, then the coincident check for triggers is not performed. The reason for this option is because the coincident check should only be performed for a small number of subnets triggering since telemetry glitches would not cross more than 
    165199a few subnetworks. 
    166  
     200{{{ 
    167201Default:  3 
    168202Example:  IgnoreCoincident 4 
    169  Latency        nsec                    ReadConfig              Station parameters 
     203}}} 
    170204  
     205'''Latency [nsec]'''[[BR]] 
     206Processed by: !ReadConfig[[BR]] 
     207Function: Station parameters 
     208 
    171209Specifies the number of seconds that carlsubtrig will wait for delivery of station trigger messages. This allows for slow telemetry paths and other delays. 
    172  
     210{{{ 
    173211Default:  none 
    174212Example:  Latency   15 
    175  ListSubnets ls         ReadConfig              Earthworm setup 
    176  
    177 Flag for determining how which SCNLs will be listed in the trigger message. When ListSubnets is absent or ls is 0, the trigger message will include all triggered SCNLs. If ls is 1, the trigger list will include the untriggered SCNLs as well as the triggered SCNLs from the triggered subnets (but will omit triggered SCNLs that are NOT in the triggered subnets). When ListSubnets is 2, the trigger message will list all SCNLs from the triggered subnets, as well as all other triggered SCNLs (union of options 0 and 1). When ListSubnets is 3, the trigger message will list all SCNLs in any subnets that have at least one triggered SCNL. However, if more than AllSubnets have triggered, then the SCN wildcard will be listed instead of a long list of non-triggered stations. If this flag is absent, then carlsubtrig lists only stations that actually triggered during the event. 
    178 The idea here is to adjust the number of SCNLs in the trigger message for a small event. With ListSubnets at 1, we include untriggered SCNLs from triggered subnets. If the subnets are layed out in small geographic areas, then we might expect to have some seismic signal from all SCNLs in triggered subnets. By including those SCNLs in the trigger message, we allow downstream analysis to have the opportunity to look at the data from those SCNLs. If we increase ls to 3, then we are being more conservative in that we save data for anything in subnets that had any SCNLs trigger. In practice, we find that this high value results in almost every SCNL being listed. This is particularly true when there is a lot of weather or telemetry noise present on the network. 
    179  
    180  
     213}}} 
     214 
     215'''!ListSubnets [ls]'''[[BR]] 
     216Processed by: !ReadConfig[[BR]] 
     217Function: Earthworm setup 
     218 
     219Flag for determining how which SCNLs will be listed in the trigger message. When !ListSubnets is absent or ls is 0, the trigger message will include all triggered SCNLs. If ls is 1, the trigger list will include the untriggered SCNLs as well as the triggered SCNLs from the triggered subnets (but will omit triggered SCNLs that are NOT in the triggered subnets). When !ListSubnets is 2, the trigger message will list all SCNLs from the triggered subnets, as well as all other triggered SCNLs (union of options 0 and 1). When !ListSubnets is 3, the trigger message will list all SCNLs in any subnets that have at least one triggered SCNL. However, if more than !AllSubnets have triggered, then the SCN wildcard will be listed instead of a long list of non-triggered stations. If this flag is absent, then carlsubtrig lists only stations that actually triggered during the event. 
     220 
     221The idea here is to adjust the number of SCNLs in the trigger message for a small event. With !ListSubnets at 1, we include untriggered SCNLs from triggered subnets. If the subnets are layed out in small geographic areas, then we might expect to have some seismic signal from all SCNLs in triggered subnets. By including those SCNLs in the trigger message, we allow downstream analysis to have the opportunity to look at the data from those SCNLs. If we increase ls to 3, then we are being more conservative in that we save data for anything in subnets that had any SCNLs trigger. In practice, we find that this high value results in almost every SCNL being listed. This is particularly true when there is a lot of weather or telemetry noise present on the network. 
     222{{{ 
    181223Default:  0  (flag not set) 
    182224Example:  ListSubnets  1 
    183  MaxDuration nsec               ReadConfig              Subnet parameters 
    184   
     225}}} 
     226 
     227'''!MaxDuration [nsec]'''[[BR]] 
     228Processed by: !ReadConfig[[BR]] 
     229Function: Subnet parameters 
     230 
    185231Specifies the maximum duration of a network trigger as nsec seconds. This could be used to limit the size of datafiles retrieved from a wave server. 
    186  
     232{{{ 
    187233Default:  none 
    188234Example:  MaxDuration  1800 
    189  MaxTrigMsgLen nsec             ReadConfig              Subnet parameters 
    190   
     235}}} 
     236 
     237'''!MaxTrigMsgLen [nsec]'''[[BR]] 
     238Processed by: !ReadConfig[[BR]] 
     239Function: Subnet parameters 
     240 
    191241Specifies the maximum length (bytes) of a triglist message; up to MAX_BYTES_PER_EQ (earthworm.h). 
    192  
     242{{{ 
    193243Default:  MAX_BYTES_PER_EQ 
    194244Example:  MaxTrigMsgLen  30000 
    195  MyModuleId mod_id              ReadConfig              Earthworm setup 
     245}}} 
     246 
     247!MyModuleId [mod_id] 
     248Processed by: !ReadConfig 
     249Function: Earthworm setup 
    196250 
    197251Sets 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. 
    198  
     252{{{ 
    199253Default:  none 
    200254Example:  MyModuleId MOD_CARLSUBTRIG 
     255}}} 
     256 
    201257 NetTriggerDur nsecs            ReadConfig              Subnet parameters 
    202258  
     
    367423 
    368424== Helpful Hints == 
    369  
    370