Changes between Initial Version and Version 1 of ShmDocFileConfig


Ignore:
Timestamp:
01/22/2009 02:44:28 PM (14 years ago)
Author:
MarcusWalther
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ShmDocFileConfig

    v1 v1  
     1= Configuration file of SHM = 
     2 
     3The configuration file controls all global parameters of the SHM program. Its default location is ''$SH_INPUTS/shm-config.txt''. It is recommended create a private copy and define an environment variable ''$SH_USER_PARAM'' pointing to it (e.g.: `setenv SH_USER_PARAM $HOME/shm-myconfig.txt`). 
     4 
     5== Syntax description == 
     6 
     7Each line consists of two parts: <keyword> and <value>, separated by one or more blanks (or tabs). Neither <keyword> nor <value> may contain blanks. All lines starting with '!', '#' or blank lines are ignored. Empty string values must be entered as <NULL> or NULL. 
     8 
     9Variables beginning with v$ are freely definable, all other names are fixed and hardwired in the program code. v$-variables appear in the definition of the MiniSEED read dialog boxes to be able to compose your own station subsets. Names of v$ variables are not case sensitive, their values are case sensitive. 
     10 
     11'''include''' statements read prepared parameter subsets from files of the same syntax as this file. Default path of this parameter subset is $SH_INPUTS, prepended if the first character is not '/'. The parameters may be overwritten in later statements, e.g. in the main configuration file. 
     12 
     13Since version 2.4g all text string and string glist parameters may contain environment variables or internal variables (v$-variables) which are translated accordingly. 
     14 
     15valid parameters: 
     16 
     17 file_version:: 
     18  Version of parameter file, e.g. 1.0. This is the version number of the parameter file, not related to version numbers of SH or SHM.  
     19 
     20 texteditor:: 
     21  Type: text string. Editor used for displaying text files. Value example: xedit  
     22 
     23 station_info_file:: 
     24    type: text string (up to 2.4e), string list (since 2.4g). Station info file, default takes the value as defined in the SH startup file, usually ''$SH_INPUTS/STATINF.DAT''. As a string list (separated by blanks, commas or semicolons) it takes an arbitrary number of files wich are searched for station information in the specified order. 
     25 
     26 filter_lookup_file:: 
     27    Type: text string (up to 2.4e), string list (since 2.4g). Filter lookup table, default takes the value ''$SH_INPUTS/filter_lookup.txt''. As a string list (separated by blanks, commas or semicolons) it takes an arbitrary number of files which are searched for filter entries in the specified order. 
     28 
     29 sensitivity_file:: 
     30    Type: text string (up to 2.4e), string list (since 2.4g). Sensitivity file for data streams. default takes the value ''$SH_INPUTS/sensitivities.txt''. A value of old-style uses separate seedcalib_... files in ''$SEED_INPUTS'' which have been used before SHM version 2.4. For a syntax description of the file read the [ShmDocFileSensitivity sensitivity file manual]. As a string list (separated by blanks, commas or semicolons) it takes an arbitrary number of files which are searched for sensitivity/gain information in the specified order. 
     31 
     32 defpath_filter (since version 2.4g):: 
     33    Type: string list. List of search paths for filters. Default is a value of ". $SH_FILTER" (current path and $SH_FILTER directory).  
     34 
     35 defpath_command (since version 2.4g):: 
     36    Type: string list. List of search paths for command procedures. Default is a value of ". $SH_COMMAND" (current path and $SH_COMMAND directory).  
     37 
     38 v$read_dialog_stations_??:: 
     39    Type: text string. Stations in read dialog box for MiniSEED data. Separate elements by commas, no blanks please. Elements 1 to 30 give names to the 30 station buttons of the dialog box. Elements 31 and 32 ! give names to the two subgroup buttons. Empty names are specified by 3 hyphens '---'. Subgroups (optional) are indicated by brackets around the station list group (like [xyz,abc],[bbb,ccc]). Maximum is two subgroups. Up to 99 (not useful!) different dialog boxes may be defined. Switch them using the Next button of the dialog box. List elements with a value starting with $ refer to a v$-variable defining a station subset. Example: 
     40{{{ 
     41v$read_dialog_stations_01 [GRA1,GRA2,GRA3,GRA4,GRC1,GRC2],[RGN,RUE,FUR,MOX,CLL,BRG,WET],GRF,GRSN 
     42v$read_dialog_stations_02 $NW,---,$SW,---,---,$N,$C,$S,---,---,---,$E 
     43 
     44! station subsets for above button 
     45v$nw bug,ibbn,tns,bseg,clz,wlf,nrdl,hlg 
     46v$sw bfo,stu,tns,gra1,grfo,fur,wlf 
     47v$n rgn,hlg,bseg,ibbn,rue,clz,nrdl,ubba 
     48v$c mox,gra1,grfo,tns,bug,clz,brg,cll,wlf,nrdl,ubba 
     49v$s bfo,brg,cll,clz,fur,gec2,gra1,mox,stu,tns,tann,wet,wlf 
     50v$e gec2,wet,werd,wern,tann,gunz,neub,manz,rotz,gra1,grfo,mox,cll,brg,fbe 
     51}}} 
     52 
     53 v$read_dialog_channels_??:: 
     54  Type: text string. Channel names for the Mini-SEED dialog boxes defined above. If not specified it defaults to LH,BH,HH. Example: 
     55{{{ 
     56v$read_dialog_channels_01 LH,BH,HH 
     57v$read_dialog_channels_02 LH,BH,SH 
     58}}} 
     59 
     60 prompt_analyst:: 
     61    Type: boolean (Values: True/False). Prompt for analysts's initials at startup of SHM. Default is False. 
     62 
     63 analyst:: 
     64    Type: text string. Analysts initals if not prompted (prompt_analyst set to False). Default is <NULL>. 
     65 
     66 list_of_analysts:: 
     67    Type: text string. List of valid analyst initials. Enter no blanks in this comma-separated list! Default is <NULL>. Example: 
     68{{{ 
     69list_of_analysts sta,wh,ki,xx 
     70}}} 
     71 
     72 minmax_format:: 
     73    Type: text string. Output of minimum/maximum amplitudes in the single trace window as numbers. Specify as C format string (e.g. %5.2f) or enter <NULL> for no output. Default is <NULL>. 
     74 
     75 filter_type:: 
     76    Type: character. Default filter type for all filter operations. Possible values: F = FFT filters, R = recursive filters. 
     77 
     78 default_quality:: 
     79    Type: integer. Default quality of phase picks. Possible values between 1='bad' and 9='very good'. Default is 2. 
     80 
     81 default_event_type:: 
     82    Type: integer. Default type of event. Possible values are:  
     83 * 0 = unknown (default),  
     84 * 1 = teleseismic earthquake,  
     85 * 2 = nuclear explosion,  
     86 * 3 = regional earthquake,  
     87 * 4 = local earthqake,  
     88 * 5 = quarry blast,  
     89 * 6 = mining induced  
     90 
     91 default_phase_flags:: 
     92    Type: integer. Default flag values set on phases. Possible flags: 0x01 = calibration event, 0x02 = ignore event, 0x04 = telex phase. Recommended: 0 Default is 0. 
     93 
     94 default_depth_type:: 
     95    Type: integer. Default depth type. Possible values: 0 = undefined, 1 = preset, 2 = estimated, 3 = free depth, 4 = poor quality, 5 = less well constrained, 6 = reliable, 7 = external depth source. Default is 0. 
     96 
     97 default_loc_quality:: 
     98    Type: integer. Default location quality. Possible values: 0 = undefined, 1 = signal too weak, 2 = incoherent, 3 = no bearing possible, 4 = region only, 5 = reliable. Default is 0. 
     99 
     100 default_depth:: 
     101    Type: floating point. Default source depth in km. Default is 33.0. 
     102 
     103 max_cursor_form:: 
     104    Type: integer. Cursorform changes when clicking the middle mouse button. The number of waveform shapes is given here. Possible values: 2 = crosshair, 3 = waveform cursor, 4 = negative waveform, 5 = hilbert transformed waveform, 6 = negative hilbert transformed waveform. Default is 5. 
     105 
     106 depth_phase_list:: 
     107    Type: text string. List of depth phases used for depth determination. Default is pP,sP,pS,sS. 
     108 
     109 theo_phase_list:: 
     110    Type: text string. List of preselected phases in the theoretical phase arrival dialog box. Default is P,S,pP,pS,sP,sS,ScS,PcP,PP,SS. 
     111 
     112 diff_phase_list:: 
     113    Type: text string. Phase differences used for distance determination in option Phase Diff. Default is S-P,PP-P,Pg-Pn 
     114 
     115 defpath_filter:: 
     116    Type: text string. Path to filter files, default takes the value of $SH_FILTER. 
     117 
     118 defpath_events:: 
     119    Type: text string. Path to detection lists, default takes the value of $HOME. 
     120 
     121 defpath_gse:: 
     122    Type: text string. Path to GSE files, default takes the value of $SH_ROOT/sh/data-examples/gse. 
     123 
     124 defpath_ah:: 
     125    Type: text string. Path to AH files. default takes the value of $HOME. 
     126 
     127 defpath_q:: 
     128    Type: text string. Path to q-files. default takes the value of $HOME. 
     129 
     130 defpath_evid:: 
     131    Type: text string. Path to evid directory (for event number generation). default takes the value of $SH_PRIVATE/evid. 
     132 
     133 defpath_evtout:: 
     134    Type: text string. Path to evtout directory where evt-files are created. default takes the value of $SH_PRIVATE/evtout. 
     135 
     136 defpath_data:: 
     137    Type: text string. Path to sfdfile for MiniSEED input. 
     138 
     139 default_filter:: 
     140    Type: text string. Default filter, applied after Read New. Default is <NULL>. 
     141 
     142 default_source:: 
     143    Type: text string. Default source (reporting agency) in your evt-files. Default is UNDEF. 
     144 
     145 phase_ampl_diff:: 
     146    Type: floating point. How far (in s) an amplitude measurement can be away from the phase pick. 
     147 
     148 refstation:: 
     149    Type: text string. Reference station used in array operations. Default is CENTRE. 
     150 
     151 list_of_refstations:: 
     152    Type: text string. List of reference stations offered in the dialog box (option Ref. Station ...), maximum 6 stations. 
     153 
     154 double_click_time:: 
     155    Type: integer. Maximum time difference between two mouse clicks (in ms) to accept it as double click. Default is 200. 
     156 
     157 min_drag_box_width:: 
     158    Type: integer. Minimum size of trace magnification drag box (right mouse button) in pixels. Default is 7. 
     159 
     160 x_max_drawlth:: 
     161    Type: integer. Seismograms are drawn in portions of this size (in samples). Default is 4096. 
     162 
     163 drag_box_rubber_val:: 
     164    Type: integer. For changing the size of an existing drag box the right mouse click must be that close to the right border of the box (in pixels). Default is 10. 
     165 
     166 top_margin:: 
     167    Type: integer. Top margin of trace display in pixels. Default is 20. 
     168 
     169 window_border:: 
     170    Type: integer. Window border in pixels. Default is 3. 
     171 
     172 close_phase_resol:: 
     173    Type: floating point. How close to an existing phase a left mouse click must be to grab it instead of creating a new phase. Unit is pixels. Default is 8.0. 
     174 
     175 trace_zoom_base:: 
     176    Type: floating point. The trace amplitude zoom ruler has exponential magnification steps. The formula is <zoom> = <trace_zoom_base> * exp( <ruler> / <trace_zoom_exp> ) where <ruler> is the value read from the ruler. Default is 10.0. 
     177 
     178 trace_zoom_exp:: 
     179    Type: floating point. Description see trace_zoom_base. Default is 3.3333333. 
     180 
     181 area_zoom_base:: 
     182    Type: floating point. Exponential magnification of the drawing area (ruler in the Setup dialog box). Parameter description similar to trace_zoom_base above. Default is 10.0. 
     183 
     184 area_zoom_exp:: 
     185    Type: floating point. Description see area_zoom_base. Default is 25.0. 
     186 
     187 move_wdw_step:: 
     188    Type: floating point. When moving time windows in the main display window (options Window - Move Right/Move Left) the following value is multiplied to the default step of 50% of the width of the window. Default is 1.0. 
     189 
     190 calib_wdw_width:: 
     191    Type: floating point. Width of calibration window in s/deg (window opening in Calibration option). Default is 2.5. 
     192 
     193 calib_wdw_height:: 
     194    Type: floating point. Height of calibration window in s/deg. Default is 2.5. 
     195 
     196 calib_azimuth_grid:: 
     197    Type: floating point. Grid size for azimuth in the calibration window. Default is 10.0. 
     198 
     199 calib_slowness_grid:: 
     200    Type: floating point. Grid size for slowness in the calibration window. Default is 0.5. 
     201 
     202 auto_phase:: 
     203    Type: text string. Name of dummy phases. Default is beam. 
     204 
     205 event_check_proc:: 
     206    Type: text string. Event check procedure applied to evt-files created with Final Parameters. Default is <NULL>. 
     207 
     208 screendump_proc:: 
     209    Type: text string. Screendump procedure. Default is screendump.csh. 
     210 
     211 evtview_proc:: 
     212    Type: text string. Reformatting of evt-files for quick viewing. Default is ev2view.  
     213 
     214 reformat_proc:: 
     215    Type: text string. Reformatting program to GSE used in Read Other. Default is undefined. 
     216 
     217 final_proc:: 
     218    Type: text string. Final processing of evt-files (after Final Parameters). Default is undefined. (To be changed to <NULL>). 
     219 
     220 motif_log:: 
     221    Type: text string. Log file of motif actions for debugging purposes. Default is <NULL>. 
     222 
     223 top_down_order:: 
     224    Type: boolean. Ordering of traces on display: first on top (True) or on bottom (False). Default is False. 
     225 
     226 trace_normalisation:: 
     227    Type: integer. Since SHM version 2.4c. This value controls the normalisation of the traces on the display. It replaces the parameter auto_scaling. Possible values are: 0 = use old style auto_scaling value (not recommended), 1 = use constant normalisation for all traces (norm c in SH), 2 = scale traces with the same magnification depending on the maximum value on screen (norm aw in SH), 3 = scale traces separately so that all traces show the same maximum amplitude on display (norm sw in SH). Default is 0. 
     228 
     229 auto_scaling:: 
     230    Type: boolean. Obsolete since SHM version 2.4c. Scale traces separately (True) or with the same magnification (False). Default is True. 
     231 
     232 reverse_xors:: 
     233    Type: boolean. Reverse XOR pixels, on some machines necessary for correct colour display. Default is False. 
     234 
     235 full_phase_names:: 
     236    Type: boolean. Use full phase names (with 'i'/'e' before phase name and 'c'/'d' after it). Default is False. 
     237 
     238 own_accelerators:: 
     239    Type: boolean. Use own accelerators for hotkeys, the motif hotkeys have a problem on recent Linux versions. Default is True. 
     240 
     241 recover_evid:: 
     242    Type: boolean. Since SHM version 2.4c. Controls whether or not the option Recover from EVT-File reads the event ID from the file. If set to True then changes to the anaylsis made after recovering will be saved under the same event ID. If set to False a new event ID is created. Default is False. 
     243 
     244 sn_noise_start, sn_noise_end, sn_signal_start, sn_signal_end:: 
     245    Type: floating point. Time windows for determination of signal/noise ratio for the phase in the phase dialog box. The four values give the time in s for the start and end of the noise and signal window relative to the phase onset time. Default values are -13.0, -3.0, -1.0 and 9.0, respectively. 
     246 
     247 idphases_tol_slow:: 
     248    Type: floating point. Available since SHM version 2.4c. Used in Identify Phase. Maximum slowness tolerance in s/deg in a phase match using epicentres determined by external sources (from Internet). Default is 1.5. 
     249 
     250 idphases_tol_azim:: 
     251    Type: floating point. Available since SHM version 2.4c. Used in Identify Phase. Maximum azimuth tolerance in deg in a phase match using epicentres determined by external sources (from Internet). Default is 20.0. 
     252 
     253 spectrogram_width:: 
     254    Type: integer. Available since SHM version 2.4d. Must be a power of 2. Used in Spectrogram. Number of samples in a time window for FFT. See Spectrogram page for details. Default is 1024. 
     255 
     256 spectrogram_step:: 
     257    Type: integer. Available since SHM version 2.4d. Used in Spectrogram. Number of samples by which the specrogram time window is shifted in each step. See Spectrogram page for details. Default is 4. 
     258 
     259 exclusive_agency:: 
     260    Type: text string. Available since SHM version 2.4c. Used in Identify Phase. Restrict search for given epicentres to a specific agency given here. If set to NULL or not specified, all agencies are accepted. Default is NULL. 
     261 
     262 debug_level:: 
     263    Type: integer. Debug level; 0 = no debug output, 1 = little debug output, 2 = more debug output, ... Default is 0. 
     264 
     265The following parameters are usually set in one of the include files. Their value may be overwritten by specifying a new definition after the include statement. 
     266 
     267 parameter_box_x, parameter_box_y, parameter_box_w, parameter_box_h:: 
     268    Type: integer. Position and size (width & height) of the parameter box in pixel units. Usually set in shm-conf-*-geometry.txt. 
     269 
     270 phase_box_x, phase_box_y, phase_box_w, phase_box_h:: 
     271    Type: integer, Position and size of phase dialog box. Usually set in shm-conf-*-geometry.txt. 
     272 
     273 window_main_x, window_main_y, window_main_w, window_main_h:: 
     274    Type: integer. Position and size of main trace display window. Usually set in shm-conf-*-geometry.txt. 
     275 
     276 single_trace_box_x, single_trace_box_y, single_trace_box_w, single_trace_box_h:: 
     277    Type: integer. Position and size of the single trace window. Usually set in shm-conf-*-geometry.txt. 
     278 
     279 draw_area_width, draw_area_height:: 
     280    Type: integer. Size (width & height) of the drawing area in the main trace display window. If its size is bigger than the frame of the window (set in the window_main_? parameters) then scrollbars are added to navigate on the drawing area. Usually set in shm-conf-*-geometry.txt. 
     281 
     282 small_menu_font:: 
     283    Type: boolean. Use a small font for the menu line to fit on smaller displays with screen widths of 1024 pixels. Usually set in shm-conf-*-geometry.txt. 
     284 
     285 colour_bg_red, colour_bg_green, colour_bg_blue:: 
     286    Type: floating point. RGB colour of the main trace display background. Possible values for each of these three variables range from 0.0 (dark) to 1.0 (full colour). Usually set in shm-conf-*-colours.txt. 
     287 
     288 colour_fg_red, colour_fg_green, colour_fg_blue:: 
     289    Type: floating point. RGB colour of the seismogram traces. Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt. 
     290 
     291 colour_mark_red, colour_mark_green, colour_mark_blue:: 
     292    Type: floating point. RGB colour of manually picked phases. Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt. 
     293 
     294 colour_theo_red, colour_theo_green, colour_theo_blue:: 
     295    Type: floating point. RGB colour of theoretical phases. Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt. 
     296 
     297 colour_auto_red, colour_auto_green, colour_auto_blue:: 
     298    Type: floating point. RGB colour of automatically created phases. Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt. 
     299 
     300 colour_crsr_red, colour_crsr_green, colour_crsr_blue:: 
     301    Type: floating point. RGB colour of cursor and rubber window (right mouse button). Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt. 
     302 
     303 colour_dialog_fg_red, colour_dialog_fg_green, colour_dialog_fg_blue:: 
     304    Type: floating point. RGB colour of dialog box foreground (text). Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt. 
     305 
     306 colour_dialog_bg0_red, colour_dialog_bg0_green, colour_dialog_bg0_blue:: 
     307    Type: floating point. RGB colour of dialog box text background. Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt. 
     308 
     309 colour_dialog_bg1_red, colour_dialog_bg1_green, colour_dialog_bg1_blue:: 
     310    Type: floating point. RGB colour of dialog box background 1. Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt. 
     311 
     312 colour_dialog_bg2_red, colour_dialog_bg2_green, colour_dialog_bg2_blue:: 
     313    Type: floating point. RGB colour of dialog box text background 2. Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt. 
     314 
     315 colour_alert_red, colour_alert_green, colour_alert_blue:: 
     316    Type: floating point. Since version 2.4e. RGB colour of alert traces. Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt. 
     317 
     318 colour_addfil_red, colour_addfil_green, colour_addfil_blue:: 
     319    Type: floating point. Since version 2.4e. RGB colour of traces with additional Butterworth filter. Values between 0.0 and 1.0. Usually set in shm-conf-*-colours.txt.  
     320 
     321back to [ShmDocIndex documentation index]