Changes between Version 12 and Version 13 of localmag


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

--

Legend:

Unmodified
Added
Removed
Modified
  • localmag

    v12 v13  
    567567}}} 
    568568 
    569 saveXMLdir directory    Event and Trace Commands 
     569'''saveXMLdir [directory]'''[[BR]] 
     570Function: Event and Trace Commands 
     571 
    570572Optional setting to force writing of the SHAKEMAP EVENT XML format file to the specified output directory. Using this option ignores the eventXML option which is for backward compatibility at INGV where this feature was added. The format file is: 
     573 
    571574        <Event-Id>_<Origin-Version>_event.xml  
    572575 
    573  
    574 SCNLpar STA COMP NET LOC special-parameters     Auxilliary Data Sources 
     576'''SCNLpar [STA COMP NET LOC special-parameters]'''[[BR]] 
     577Function: Auxilliary Data Sources 
     578 
    575579Set certain parameters (described below) for specific traces identified by their SCN: STA, COMP, NET, and LOC (station/component/network name.) No wildcards are permitted here; each SCNL must be given explicitly, but only if special values are needed for that SCNL. Often, the default values will be adequate for most SCNLs. If there are only a few of these commands, they may be listed in the configuration file. But if a large number of them are needed, it may be more convenient to place them in a separate file. Then that file will get included with the configuration file by the syntax: 
     580 
    576581@scnl_param_file 
     582 
    577583Note that the format of this files is identical to the one used by the gmew module. Each SCNLpar command must include the STA, COMP, NET, LOC names followed by the following seven decimal values. Use spaces between all eleven items in each SCNLpar line. All values must be present; no default values are used for an SCNL if it has an SCNLpar line. The seven decimal values are: 
    578 magnitude correction 
    579 The value to be added to the component local magnitude to account for site effects. Normally this value should be the same for each component at a given site. 
    580 taper low-freq off 
    581 The frequency at the low end of the passband below which the cosine taper has zero value. This taper is applied to the frequency response function before it is convolved with the trace. Frequency units are Hz. 
    582 taper low-freq on 
    583 The frequency at the low end of the passband above which the cosine taper has a value of 1. The low-end taper can be eliminated by setting the off and on values to the same value. The default low-end taper is turned off, passing all low frequencies. 
    584 taper high-freq on 
    585 The frequency at the high end of the passband below which the cosine taper has a value of 1. 
    586 taper high-freq off 
    587 The frequency at the high end of the passband above which the cosine taper has a value of 0. The high-end taper can be eliminated by setting the off and on values to the same value. The default high-end taper has an off value equal to the trace Nyquist frequency (one half the sample rate.) The default on frequency is 90% of the Nyquist frequency. 
    588 clipping limit 
    589 The value, in digital counts, beyond which in absolute value the unprocessed trace should be considered clipped. If the trace is declared clipped by locamag, it will synthesized into a Wood-Anderson trace, but it will not have amplitude picks or magnitude calculations performed. The default clipping limit is 7.55e+06 counts, 90% of 2^23, the limit of a 24-bit digitizer. 
    590 taper time interval 
    591 This value is not used by localmag; it is only used by the gmew module. 
     584 
     585magnitude correction: The value to be added to the component local magnitude to account for site effects. Normally this value should be the same for each component at a given site. 
     586 
     587taper low-freq off: The frequency at the low end of the passband below which the cosine taper has zero value. This taper is applied to the frequency response function before it is convolved with the trace. Frequency units are Hz. 
     588 
     589taper low-freq on: The frequency at the low end of the passband above which the cosine taper has a value of 1. The low-end taper can be eliminated by setting the off and on values to the same value. The default low-end taper is turned off, passing all low frequencies. 
     590 
     591taper high-freq on: The frequency at the high end of the passband below which the cosine taper has a value of 1. 
     592 
     593taper high-freq off: The frequency at the high end of the passband above which the cosine taper has a value of 0. The high-end taper can be eliminated by setting the off and on values to the same value. The default high-end taper has an off value equal to the trace Nyquist frequency (one half the sample rate.) The default on frequency is 90% of the Nyquist frequency. 
     594 
     595clipping limit: The value, in digital counts, beyond which in absolute value the unprocessed trace should be considered clipped. If the trace is declared clipped by localmag, it will synthesized into a Wood-Anderson trace, but it will not have amplitude picks or magnitude calculations performed. The default clipping limit is 7.55e+06 counts, 90% of 2^23, the limit of a 24-bit digitizer. 
     596 
     597taper time interval: This value is not used by localmag; it is only used by the gmew module. 
     598{{{ 
    592599Default: as described above 
    593600Example: SCNLpar SEA EHE UW -- 0.2   0.1 0.1 20 25   2.9e4 1.0 
    594  
    595  
    596  
    597 searchStartPhase phase  Amplitude Controls 
     601}}} 
     602 
     603'''searchStartPhase [phase]'''[[BR]] 
     604Function: Amplitude Controls 
     605 
    598606Specify which phase arrival time to use in computing the search start time (see searchTimes). Choices are P for the first arriving P phase from the layered velocity model, or S for the first arriving S phase from the layered model. 
     607{{{ 
    599608Default: searchStartPhase S 
    600609Example: searchStartPhase P 
    601  
    602  
    603  
    604 searchTimes A B Amplitude Controls 
     610}}} 
     611 
     612'''searchTimes [A B]'''[[BR]] 
     613Function: Amplitude Controls 
     614 
    605615Specify the start and end times of the interval in which localmag will search for peak amplitudes in the Wood-Anderson traces. Together with the P- or S-phase arrival times estimated from the velocity model, and the Sg arrival time these two parameters set the start and end times of this search window. The search times are computed as follows: 
     616 
    606617start time: 
     618 
    607619= T - A 
     620 
    608621end time: 
     622 
    609623= (distance/SgSpeed) + B 
     624 
    610625where T is arrival time of the searchStartPhase and distance is the distance from hypocenter to station. 
     626{{{ 
    611627Default: searchTimes 1.0 45.0 # Search window runs from 1 second 
    612628        before searchStartPhase to 45 seconds after the estimated Sg arrival 
    613629Example: searchTimes 1.0 45.0 
    614  
    615  
    616  
    617 SgSpeed Amplitude Controls 
     630}}} 
     631 
     632'''!SgSpeed'''[[BR]] 
     633Function: Amplitude Controls 
     634 
    618635Specify the speed of the Sg phase. Research by Jim Peschmann at UUSS has shown that the majority of peak amplitudes in the Wood-Anderson traces occur near to or after the Sg phase arrival. This fixed phase speed is a better predictor of the peak time than the phases computed from the layered velocity model. 
     636{{{ 
    619637Default: none, required command 
    620638Example: SgSpeed 3.39 
    621  
    622  
    623  
    624 slideLength N   Amplitude Controls 
     639}}} 
     640 
     641'''slideLength [N]'''[[BR]] 
     642Function: Amplitude Controls 
     643 
    625644Localmag can perform two different searches for the "peak" magnitude of a given Wood-Anderson trace. First, (provided the trace has no gaps and is not clipped), a search is made for the largest absolute value within the search window. This will be the largest zero-to-peak value, since the Wood-Anderson trace always has zero mean in the program. 
     645 
    626646The second search is a "sliding window" search, in which the largest swing, positive-to-negative or negative-to-positive, is measured within a sliding window of N seconds duration. The window slides along the full length of the search window. The result is the largest peak-to-peak value for the trace. Since the local magnitude formula is based on a zero-to-peak value, one half of the peak-to-peak value is used for the magnitude calculation. The intent of this sliding window search is to reduce the chances of picking a one-sided glitch that could happen with the zero-to-peak search. 
    627647 
    628648To turn off the sliding-window search, set N to any negative value. If peak-to-peak values are not available to localmag (becuase the sliding-window search is disabled or because the values can't be read from the data source) localmag will use the zero-to-peak value if it is available. Turning off this feature will improve localmag's performance, since the sliding window search is quite CPU-intensive. 
    629  
     649{{{ 
    630650Default:  0.8 seconds, the free period of the Wood-Anderson instrument 
    631651Example: slideLength 1.0 
    632  
    633  
    634  
    635 staLoc LOC [params]     Auxilliary Data Sources 
     652}}} 
     653 
     654'''staLoc [LOC [params]]'''[[BR]] 
     655Function: Auxilliary Data Sources 
     656 
    636657Tells localmag where to find station location information. Station locations are used to find the station-epicenter distance, which is then used in the local magnitude calculation, as well as in the estimate of P and S phase arrivals. The choices for LOC are: 
    637 File loc-file: 
    638 Get station locations from a hyp2000-format station location file named loc-file. This file must be in text format, not the binary-format file sometimes used by hyp2000. If the file is not located in the current directory, partial or full path information must be included in loc-file. 
    639 EWDB 
    640 Query the Earthworm database for station locations. Not currently implemented. 
    641 SAC 
    642 Get station locations from the header of SAC files. This can be either station lat and lon, or station-epicenter distance in the SAC header. This option can only be used if the trace source is SAC. 
     658 
     659File loc-file: Get station locations from a hyp2000-format station location file named loc-file. This file must be in text format, not the binary-format file sometimes used by hyp2000. If the file is not located in the current directory, partial or full path information must be included in loc-file. 
     660 
     661EWDB: Query the Earthworm database for station locations. Not currently implemented. 
     662 
     663SAC: Get station locations from the header of SAC files. This can be either station lat and lon, or station-epicenter distance in the SAC header. This option can only be used if the trace source is SAC. 
     664{{{ 
    643665Default: none; this command is required 
    644666Example: staLoc File /earthworm/run/params/hypoinverse/stas/uw_sta.hinv 
    645  
    646  
    647  
    648 tracesource SOURCE [params]     Event and Trace Commands 
     667}}} 
     668 
     669'''tracesource SOURCE [params]'''[[BR]] 
     670Function: Event and Trace Commands 
     671 
    649672Directs localmag to obtain trace data from SOURCE. In the event that localmag is reading amplitudes directly (see readAmpDirect), this command directs localmag to the appropriate SOURCE. Choices are: 
    650 waveServer server-list 
    651 Obtain trace data from the wave servers in server-list, a space delimited list of one or more server:port pairs. The server can be an IP address or a hostname for the wave server. The port is the port number used by that wave server. 
    652 waveServer File server-file 
    653 Command line: -tvObtain trace data from the wave servers listed in the file named server-file. This file consists of lines listing server and port, one server to each line. The two entries on a line may be separated by space or colon. 
     673 
     674waveServer server-list: Obtain trace data from the wave servers in server-list, a space delimited list of one or more server:port pairs. The server can be an IP address or a hostname for the wave server. The port is the port number used by that wave server. 
     675 
     676waveServer File server-file: Command line: -tvObtain trace data from the wave servers listed in the file named server-file. This file consists of lines listing server and port, one server to each line. The two entries on a line may be separated by space or colon. 
     677 
    654678Localmag will connect to one server at a time. For each connection, it will obtain the server's current menu, match SCNLs on the menu against the selection list from Add and Del commands, obtain and process the trace data segment for each of the selected SCNLs. The time interval for each trace is established by the traceTimes command. After all the selected SCNLs for one wave server have been processed, the connection to that server will be closed and the next server will be accessed. 
    655679 
    656 SACFile 
    657 Command line: -ts SACdir filename-formatObtain raw trace data (as opposed to Wood-Anderson traces) from SAC files. The files are found in directory SACdir, will filenames matching filename-format. See SACsource for details on filename matching.. 
    658 SACWAFile 
    659 Command line: -tsW SACdir filename-formatObtain Wood-Anderson traces from SAC files. The files are found in directory SACdir, will filenames matching filename-format. 
    660 EWDB 
    661 Obtain raw trace data from an Earthworm Database. Not Currently implemented. 
     680SACFile: Command line: -ts SACdir filename-formatObtain raw trace data (as opposed to Wood-Anderson traces) from SAC files. The files are found in directory SACdir, will filenames matching filename-format. See SACsource for details on filename matching.. 
     681 
     682SACWAFile: Command line: -tsW SACdir filename-formatObtain Wood-Anderson traces from SAC files. The files are found in directory SACdir, will filenames matching filename-format. 
     683 
     684EWDB: Obtain raw trace data from an Earthworm Database. Not Currently implemented. 
     685{{{ 
    662686Default:  waveServer with list of servers read from the file $EW_PARAMS/servers 
    663687Example: traceSource SACFile 
    664  
    665  
    666  
    667 traceTimes START END    Event and Trace Commands 
     688}}} 
     689 
     690'''traceTimes [START END]'''[[BR]] 
     691Function: Event and Trace Commands 
     692 
    668693Specify the start and end times of trace data to be used from any trace source. 
    669 START: 
    670 is the number of seconds before the first P arrival from the layered velocity model to start the trace. 
    671 END: 
    672 is the number of seconds after the Sg arrival computed from hypocenter to station distance and SgSpeed to end the trace. 
     694 
     695START: is the number of seconds before the first P arrival from the layered velocity model to start the trace. 
     696 
     697END: is the number of seconds after the Sg arrival computed from hypocenter to station distance and SgSpeed to end the trace. 
     698 
    673699Once localmag computes the start and end times for the trace using the traceTimes values, it adds on additional time to the trace window. This extra time is used to apply a cosine taper to the data in the time domain. The length of each of these tapers will be 5 percent of the total trace length. The tapered portion of the trace is never including in the peak search window nor in the pre-event noise check window. This taper is applied to prevent 'wrap-around' spikes from appearing in the pre-event noise check window. 
     700{{{ 
    674701Default: traceTimes 5.0 60.0 
    675702Example: traceTimes 10.0 40.0 
    676  
    677  
    678  
    679 useMedian 
    680 Event and Trace Commands 
     703}}} 
     704 
     705'''useMedian'''[[BR]] 
     706Function: Event and Trace Commands 
     707 
    681708By default the localmag program puts the average Ml into the TYPE_MAGNITUDE message. If this command is issued, then the median value of the median is inserted into the magnitude and the algorithm member of the MAG_INFO struct is set to "MED" 
    682  
     709{{{ 
    683710Default: useMedian (off by default) 
    684711Example: useMedian 
    685  
    686 velocity model  Auxilliary Data Sources 
     712}}} 
     713 
     714'''velocity [model]'''[[BR]] 
     715Function: Auxilliary Data Sources 
     716 
    687717Read in the one-dimensional velocity model to be used to estimate P and S phase arrival times. This is done using the syntax: 
     718 
    688719@velocity_file 
     720 
    689721Typically this will be the same file as used for binder_ew. Localmag will always look for this file in the current directory, so appropriate path information must be included if the file is located elsewhere. The commands that are most useful in this file are lay and psratio. Also see the Velocity Model section at [wiki:binder_ew binder_ew]. 
     722{{{ 
    690723Default:  none 
    691724Example: @/earthworm/run/params/uw_velovity.d 
    692  
    693  
    694 WoodAndersonCoefs period damp gain      Miscellaneous Commands 
     725}}} 
     726 
     727'''WoodAndersonCoefs [period damp gain]'''[[BR]] 
     728Function: Miscellaneous Commands 
     729 
    695730Optional command to specify the coefficients used for the Wood-Anderson instrument response. The standard parameters for the transfer function are: period: 0.8 seconds; damping 0.8 critical; gain: 2800. However, testing by Uhrhammer & Collins indicate better values are: period 0.8 seconds; damping 0.7 critical; gain 2080 (twenty-eighty). Be sure you know what you are doing before you change these values! 
     731{{{ 
    696732Default: as described above 
    697733Example: WoodAndersonCoefs 0.8 0.7 2080 
    698  
    699  
    700  
    701 wsTimeout M     Miscellaneous Commands 
     734}}} 
     735 
     736'''wsTimeout [M]'''[[BR]] 
     737Function: Miscellaneous Commands 
     738 
    702739Set the timeout for wave server connections to M milliseconds. If no response is heard from the wave server after this time, localmag will assume this wave server is dead and proceed to the next one. 
     740{{{ 
    703741Default: 5000 milliseconds 
    704742Example: wsTimeout 10000 
    705  
    706  
    707  
    708 z2pThresh T     Miscellaneous Commands 
     743}}} 
     744 
     745'''z2pThresh [T]'''[[BR]] 
     746Function: Miscellaneous Commands 
     747 
    709748In addition to searching the search window for peak amplitudes (the  'event' zero-to-peak), localmag checks the part of trace prior to estimated P arrival for peak amplitude (the  'pre-event' peak.) If the  'event' peak is not greater than T times the  'pre-event' peak, there is not sufficient event signal above the pre-event noise, and localmag does not use the event peak amplitude for that trace. Localmag will also skip the expensive sliding window search for peak-to-peak amplitude for small event peak amplitudes. 
     749 
    710750The traceTimes command in the config file specifies how many seconds before P and after S is to be analyzed by localmag. Starting from that time duration, additional time is allotted at each end to allow for a 5% time domain taper and still have the above specified ttime duration untouched by the taper. The pre-event noise level is determined from the synthetic Wood-Anderson data from the end of the starting taper to the time that is 10 percent of the start traceTimes value before the estimated P arrival. 
     751{{{ 
    711752Default: 3.0 
    712753Example: z2pThresh 1.5 
     754}}} 
    713755 
    714756=== Sample Configuration File ===