Changeset 1172 for SHX


Ignore:
Timestamp:
10.02.2016 22:48:12 (4 years ago)
Author:
klaus
Message:

completed to copy wiki texts into source code; help command with short descriptions

Location:
SHX/trunk/SeismicHandler
Files:
92 edited

Legend:

Unmodified
Added
Removed
  • SHX/trunk/SeismicHandler/commands/al.py

    r1171 r1172  
    1919    [Wiki Doc Text] 
    2020 
    21     == align traces == 
     21    == Align traces == 
    2222 
    2323    '''command''': AL [<trc-list> <time-info>] [<time-pos>] 
    2424 
    25     Aligns traces along points selected by values of the specified time info entries.  Only traces given in <trc-list> are affected. If parameters one and two are omitted you have to select the traces and time points by graphic cursor.  Cursor selection is finished by the "E"-key. After the (automatic) redraw each trace has its selected point at time position <time-pos> (if <time-pos> is omitted it is set to zero). 
     25    Aligns traces along points selected by values of the specified time info 
     26    entries.  Only traces given in <trc-list> are affected. If parameters one 
     27    and two are omitted you have to select the traces and time points by 
     28    graphic cursor.  Cursor selection is finished by the "E"-key. After the 
     29    (automatic) redraw each trace has its selected point at time position 
     30    <time-pos> (if <time-pos> is omitted it is set to zero). 
    2631 
    2732    === parameters === 
    2833 
    2934     * <trc-list> ''parameter type: trace list''[[br]] 
    30       List of traces to be aligned.  If omitted, traces must be selected by graphic cursor. 
     35      List of traces to be aligned.  If omitted, traces must be selected by 
     36      graphic cursor. 
    3137 
    3238     * <time-info>  ''parameter type: info entry''[[br]] 
     
    3440 
    3541     * <time-pos>  ''parameter type: real''[[br]] 
    36       Picked points of traces are positioned at this time.  If the parameter is omitted, it is set to zero. 
     42      Picked points of traces are positioned at this time.  If the parameter 
     43      is omitted, it is set to zero. 
    3744 
    3845    === qualifiers === 
    3946 
    4047     * /nomark[[br]] 
    41        Only valid if <trc-list> & <time-info> are omitted.  The selected time points are not marked. 
     48       Only valid if <trc-list> & <time-info> are omitted.  The selected time 
     49       points are not marked. 
    4250 
    4351 
     
    4553 
    4654     `al`:: 
    47      align all selected points (selected interactivly by graphic cursor) at zero time 
     55     align all selected points (selected interactivly by graphic cursor) at 
     56     zero time 
    4857 
    4958     `al all p-onset`:: 
  • SHX/trunk/SeismicHandler/commands/am.py

    r1171 r1172  
    1919    [Wiki Doc Text] 
    2020 
    21     == determine amplitude == 
     21    == Determine amplitude == 
    2222 
    2323    '''command''': AM [<trc> <lo-time> <hi-time>] [<min>] [<max>] [<minpos>] [<maxpos>] 
    2424 
    25     Determines maximum amplitude of trace <trc> within time window from <lo-time> to <hi-time>.  If no parameter is specified the trace and the time window is selected simultaneously by graphic cursor. If no output parameter is specified the result is displayed on the dialog channel(s). 
     25    Determines maximum amplitude of trace <trc> within time window from 
     26    <lo-time> to <hi-time>.  If no parameter is specified the trace and the 
     27    time window is selected simultaneously by graphic cursor. If no output 
     28    parameter is specified the result is displayed on the dialog channel(s). 
    2629 
    2730    === parameters === 
     
    3134 
    3235     * <lo-time>, <hi-time>  ''parameter type: real''[[br]] 
    33        Time window to search for maximum amplitude.  If no parameter is specified the trace and time window is selected simultaneously by graphic cursor. 
     36       Time window to search for maximum amplitude.  If no parameter is 
     37       specified the trace and time window is selected simultaneously by 
     38       graphic cursor. 
    3439 
    3540     * <min>  ''parameter type: symbol address''[[br]] 
     
    5661 
    5762     `am 1 0. 10.`:: 
    58      determine maximum and minimum of first trace between 0 and 10 sec and display it on screen 
     63     determine maximum and minimum of first trace between 0 and 10 sec and 
     64     display it on screen 
    5965 
    6066     `am 1 0. 10. &min &max`:: 
    61      determine maximum and minimum of first trace between 0 and 10 sec and store results in symbols "min" and "max" 
     67     determine maximum and minimum of first trace between 0 and 10 sec and 
     68     store results in symbols "min" and "max" 
    6269 
    6370     `am 1 0. 10. ;;;;&MAXPOS`:: 
    64      determine position of maximum between 0 and 10 sec of first trace and store it in symbol "maxpos" 
     71     determine position of maximum between 0 and 10 sec of first trace and 
     72     store it in symbol "maxpos" 
    6573    """ 
    6674    numberOfParameters = [3, 5, 7] 
  • SHX/trunk/SeismicHandler/commands/append.py

    r1171 r1172  
    1919    [Wiki Doc Text] 
    2020 
    21     == append one trace to another == 
     21    == Append one trace to another == 
    2222 
    2323    '''command''': APPEND <src> <dst> 
    2424 
    25     Appends trace <src> to trace <dst>. Both traces must have the same sample rate. It is not accounted for any time gaps between the traces. Trace <dst> is changed by this command (greater length). 
     25    Appends trace <src> to trace <dst>. Both traces must have the same sample 
     26    rate. It is not accounted for any time gaps between the traces. Trace 
     27    <dst> is changed by this command (greater length). 
    2628 
    2729    === parameters === 
  • SHX/trunk/SeismicHandler/commands/arp.py

    r1171 r1172  
    2020    [Wiki Doc Text] 
    2121 
    22     == autoregressive process == 
     22    == Autoregressive process == 
    2323 
    2424    '''command''': ARP <trc-list> <N> <c1> <c2> ... <cN> [<s1> <s2> ... <sN>] 
    2525 
    26     Generates autoregressive process of order <N> on all traces specified in <trc-list>: 
     26    Generates autoregressive process of order <N> on all traces specified in 
     27    <trc-list>: 
    2728 
    2829       smp[k] = smp[k] + sum{i=1..N} c[i]*smp[k-i]  (k=0,1,..,K-1), 
    2930 
    30     where N=<N> and c[i] (i=1,2,..,N) are given by <c1>,<c2>,..,<cN>. The N start values c[-1],c[-2],..,c[-N] are given by <s1>,<s2>,..,<sN> respectively. 
     31    where N=<N> and c[i] (i=1,2,..,N) are given by <c1>,<c2>,..,<cN>. The N 
     32    start values c[-1],c[-2],..,c[-N] are given by <s1>,<s2>,..,<sN> 
     33    respectively. 
    3134 
    32     Improper values of <c1>..<cN> may result in a floating overflow error and crash the program.  So be careful in selecting parameters. 
     35    Improper values of <c1>..<cN> may result in a floating overflow error and 
     36    crash the program.  So be careful in selecting parameters. 
    3337 
    34     The process operates on the samples of a trace and does not care for the sample rate. Traces are processed in total, a global window (see [ShStw STW]) is neglected. 
     38    The process operates on the samples of a trace and does not care for the 
     39    sample rate. Traces are processed in total, a global window 
     40    (see [ShStw STW]) is neglected. 
    3541 
    3642    === parameters === 
     
    4349 
    4450     * <c1>,<c2>,..,<cN>  ''parameter type: real''[[br]] 
    45        Coefficents of autoregressive process.  The program does not check for improper values, they may result in a floating overflow error. 
     51       Coefficents of autoregressive process.  The program does not check for 
     52       improper values, they may result in a floating overflow error. 
    4653 
    4754     * <s1>,<s2>,..,<sN>  ''parameter type: real''[[br]] 
    48        Start values of autoregressive process.  If not specified they are assumed to be zero. 
     55       Start values of autoregressive process.  If not specified they are 
     56       assumed to be zero. 
    4957 
    5058    === examples === 
  • SHX/trunk/SeismicHandler/commands/beam.py

    r1171 r1172  
    2828    [Wiki Doc Text] 
    2929 
    30     == beam traces == 
     30    == Beam traces == 
    3131 
    3232    '''command''': BEAM <trc-list> <azimuth> <slowness> 
    3333 
    34     Delays traces specified in <trc-list> to align seismic phases with the same azimuth and slowness. The computed delays are added to already existing delays of the traces unless the "/abs" qualifier is specified. 
    35  
    36     SH needs to know the station names where the traces in <trc-list> were recorded. If not all station names are given, an error occurs. SH uses a location file to look for the location of a station. If a station name is not listed in this file, an error occurs. In this case the unknown station must be inserted to the location file using the "[ShFct FCT] station" command. For each station latitude and longitude (in degrees) must be entered. SH uses this information to compute the relative distances between the stations. Therefore the location information must be accurate enough. For station arrays there can be specified an array-relative location (in km) and an array ID number. If all stations of <trc-list> belong to the same array (same array ID number), SH uses the array relative location to shift the traces rather than the latitude,longitude information. The "/noarray" qualifier forces seismic handler to use latitude,longitude information instead of using the relative positions (if specified). 
     34    Delays traces specified in <trc-list> to align seismic phases with the 
     35    same azimuth and slowness. The computed delays are added to already 
     36    existing delays of the traces unless the "/abs" qualifier is specified. 
     37 
     38    SH needs to know the station names where the traces in <trc-list> were 
     39    recorded. If not all station names are given, an error occurs. SH uses a 
     40    location file to look for the location of a station. If a station name is 
     41    not listed in this file, an error occurs. In this case the unknown station 
     42    must be inserted to the location file using the "[ShFct FCT] station" 
     43    command. For each station latitude and longitude (in degrees) must be 
     44    entered. SH uses this information to compute the relative distances 
     45    between the stations. Therefore the location information must be accurate  
     46    enough. For station arrays there can be specified an array-relative 
     47    location (in km) and an array ID number. If all stations of <trc-list> 
     48    belong to the same array (same array ID number), SH uses the array relative 
     49    location to shift the traces rather than the latitude,longitude information. 
     50    The "/noarray" qualifier forces seismic handler to use latitude,longitude 
     51    information instead of using the relative positions (if specified). 
    3752 
    3853    === parameters === 
     
    5065 
    5166     * /noarray[[br]] 
    52        The stations are assumed to be no array even if array coordinates are given for all stations in the location file. If no array coordinates are given the qualifier has no effect. 
     67       The stations are assumed to be no array even if array coordinates are 
     68       given for all stations in the location file. If no array coordinates 
     69       are given the qualifier has no effect. 
    5370 
    5471     * /abs[[BR]] 
    55        The delays computed are used as new delay values for each trace and are not added to already existing delays. 
     72       The delays computed are used as new delay values for each trace and are 
     73       not added to already existing delays. 
    5674 
    5775    === example === 
    5876 
    5977     `beam all 30.0 5.0`:: 
    60      shift all traces to beam a phase of azimuth 30 degrees and slowness 5.0 sec/deg 
     78     shift all traces to beam a phase of azimuth 30 degrees and slowness 
     79     5.0 sec/deg 
    6180    """ 
    6281    numberOfParameters = [3] 
  • SHX/trunk/SeismicHandler/commands/calc.py

    r1171 r1172  
    3333    [Wiki Doc Text] 
    3434 
    35     == simple calculations == 
     35    == Simple calculations == 
    3636 
    3737    '''command''': CALC <type> <&var> <=> <operand1> [<operation> [<operand2>]] [<p>] 
     
    4040 
    4141     * <type> ''parameter type: char''[[BR]] 
    42        Determines type of operators <operand1>, <operand2> and result type. Possible values are "i" (integer), "r" (real), "s" (string) and "t" (time). 
     42       Determines type of operators <operand1>, <operand2> and result type. 
     43       Possible values are "i" (integer), "r" (real), "s" (string) and "t" 
     44       (time). 
    4345 
    4446     * <&var> ''parameter type: symbol address''[[BR]] 
    45        Variable where to store the result of the calculation. This may be a local or global variable. 
     47       Variable where to store the result of the calculation. This may be a 
     48       local or global variable. 
    4649 
    4750     * <=> ''parameter type: constant''[[BR]] 
     
    6063    {{{ 
    6164    #!rst 
    62     .. note: some of the operation signs are escaped by back slash to disable their special meaning inside ReST markup 
     65    .. note: some of the operation signs are escaped by back slash to disable 
     66    their special meaning inside ReST markup 
    6367 
    6468    ====== ========== ========== ========== =========== ==== 
     
    125129 
    126130     * /fmt[[BR]] 
    127        Produces output in a special format. Format string must be entered as in C printf commands. The format string should be enclosed in "< >" brackets. Note the automatic lowercase to uppercase conversion of the command line interpreter. To prevent this conversion for a single character within a format string precede this character by a "@"-sign (Example: /fmt=<%5.2@f> creates real number in floating point format "%5.2f" with two decimal digits). 
     131       Produces output in a special format. Format string must be entered as 
     132       in C printf commands. The format string should be enclosed in "< >" 
     133       brackets. Note the automatic lowercase to uppercase conversion of the 
     134       command line interpreter. To prevent this conversion for a single 
     135       character within a format string precede this character by a "@"-sign 
     136       (Example: /fmt=<%5.2@f> creates real number in floating point format 
     137       "%5.f" with two decimal digits). 
    128138 
    129139    === examples === 
    130140 
    131141     `calc r &res = 2.0 * ^delta(1)`:: 
    132      computes real multiplication of sample distance of second trace by two and stores the result in variable "res" 
     142     computes real multiplication of sample distance of second trace by two 
     143     and stores the result in variable "res" 
    133144 
    134145     `calc s &str = teststring`:: 
     
    136147 
    137148     `calc r &res = ^maxval(2) sqrt`:: 
    138      computes square root of maximum value of trace 2 and stores result in variable "res" 
     149     computes square root of maximum value of trace 2 and stores result in 
     150     variable "res" 
    139151    """ 
    140152    numberOfParameters = [3, 4, 5, 6, 7] 
  • SHX/trunk/SeismicHandler/commands/call.py

    r1171 r1172  
    2828    [Wiki Doc Text] 
    2929 
    30     == special utilities == 
     30    == Special utilities == 
    3131 
    3232    '''command''': CALL <subfunction> <p1> <p2> ... <pN> 
    3333 
    34     Special utilities for the user. The action depends on the <subfunction> keyword. 
     34    Special utilities for the user. The action depends on the <subfunction> 
     35    keyword. 
    3536 
    3637    === parameters === 
    3738 
    3839     * <subfunction> ''parameter type: string''[[br]] 
    39        Subfunction of utility. For possible values see table [#subfunctiontable subfunction table] below 
     40       Subfunction of utility. For possible values see table 
     41       [#subfunctiontable subfunction table] below 
    4042 
    4143    === subfunction table === 
     
    126128 
    127129     `call slowness p ^distance(2) ^depth(2) &slo`:: 
    128      computes P-slowness of second trace on display and stores result in variable "slo". 
     130     computes P-slowness of second trace on display and stores result in 
     131     variable "slo". 
    129132    """ 
    130133    numberOfParameters = [1,2,3,4,5,6,7] 
  • SHX/trunk/SeismicHandler/commands/cmd.py

    r1171 r1172  
    2121    [Wiki Doc Text] 
    2222 
    23     == create command file == 
     23    == Create command file == 
    2424 
    2525    '''command''': CMD <cmd-file> 
    2626 
    27     Creates command file containing all previously entered commands since beginning of SH session or since last "cmd" command. This file is an editable file which can be arbitrarily changed. Command files have an extension ".SHC". 
     27    Creates command file containing all previously entered commands since 
     28    beginning of SH session or since last "cmd" command. This file is an 
     29    editable file which can be arbitrarily changed. Command files have an 
     30    extension ".SHC". 
    2831 
    2932    === parameters === 
  • SHX/trunk/SeismicHandler/commands/connect.py

    r1171 r1172  
    2121    [Wiki Doc Text] 
    2222 
    23     == connect traces == 
     23    == Connect traces == 
    2424 
    2525    '''command''': CONNECT <subfct> <trc1> <trc2> [<lo-wdw> <hi-wdw>] 
    2626 
    27     Connects (multiplication or division) two traces and stores the result in a new created output trace. If no time window specified, the result trace is computed within the current display window. 
     27    Connects (multiplication or division) two traces and stores the result in 
     28    a new created output trace. If no time window specified, the result trace 
     29    is computed within the current display window. 
    2830 
    2931    === parameters === 
     
    3335 
    3436     * <subfct> ''parameter type: string''[[BR]] 
    35        Specifies subfunction. Valid is either "mul" (multiplication of traces) or "div" (division of traces). 
     37       Specifies subfunction. Valid is either "mul" (multiplication of traces) 
     38       or "div" (division of traces). 
    3639 
    3740     * <trc1>, <trc2> ''parameter type: trace''[[BR]] 
     
    3942 
    4043     * <lo-wdw>, <hi-wdw> ''parameter type: real''[[BR]] 
    41        The result trace is computed within this time window. If omitted the current display window is used. 
     44       The result trace is computed within this time window. If omitted the 
     45       current display window is used. 
    4246 
    4347    === examples === 
    4448 
    4549     `connect mul 1 2`:: 
    46      multiplies the first two traces on display within the current display window 
     50     multiplies the first two traces on display within the current display 
     51     window 
    4752 
    4853     `connect mul 1 2 0 100`:: 
  • SHX/trunk/SeismicHandler/commands/copy_.py

    r1171 r1172  
    1818    [Wiki Doc Text] 
    1919 
    20     == copy traces == 
     20    == Copy traces == 
    2121 
    2222    '''command''': COPY <trc-list> [<wdw-lo> <wdw-hi>] 
    2323 
    24     Makes copies of all traces specified in <trc-list>. The copies are added to the trace display. If a time window (<wdw-lo>,<wdw-hi>) is set, only the samples within this window are copied. 
     24    Makes copies of all traces specified in <trc-list>. The copies are added 
     25    to the trace display. If a time window (<wdw-lo>,<wdw-hi>) is set, only 
     26    the samples within this window are copied. 
    2527 
    2628    === parameters === 
     
    3032 
    3133     * <wdw-lo>, <wdw-hi> ''parameter type: real''[[BR]] 
    32        Time window in sec. If specified only samples within this window are copied. 
     34       Time window in sec. If specified only samples within this window are 
     35       copied. 
    3336 
    3437    === example === 
  • SHX/trunk/SeismicHandler/commands/corr.py

    r1171 r1172  
    2323    [Wiki Doc Text] 
    2424 
    25     == compute crosscorrelation == 
     25    == Compute crosscorrelation == 
    2626 
    2727    '''command''': CORR <wavelet> <wl-start> <wl-end> <corr-trc> 
  • SHX/trunk/SeismicHandler/commands/corrl.py

    r1171 r1172  
    1818    [Wiki Doc Text] 
    1919 
    20     == select correlation length == 
     20    == Select correlation length == 
    2121 
    2222    '''command''': CORRL <cl-start> <cl-end> 
  • SHX/trunk/SeismicHandler/commands/create.py

    r1171 r1172  
    3232    [Wiki Doc Text] 
    3333 
    34     == create synthetics == 
     34    == Create synthetics == 
    3535 
    3636    '''command''': CREATE <type> <dt> <length> <amplitude>[<p1>[...<pN>]] 
  • SHX/trunk/SeismicHandler/commands/cut.py

    r1171 r1172  
    1919    [Wiki Doc Text] 
    2020 
    21     == cut traces == 
     21    == Cut traces == 
    2222 
    2323    '''command''': CUT <trc-list> <lo-bound> <hi-bound> 
  • SHX/trunk/SeismicHandler/commands/decimate.py

    r1171 r1172  
    1919    [Wiki Doc Text] 
    2020 
    21     == decimate traces == 
     21    == Decimate traces == 
    2222 
    2323    '''command''': DECIMATE <trc-list> <factor> 
  • SHX/trunk/SeismicHandler/commands/del.py

    r1171 r1172  
    1818    [Wiki Doc Text] 
    1919 
    20     == delete traces == 
     20    == Delete traces == 
    2121 
    2222    '''command''': DEL <trc-list> 
  • SHX/trunk/SeismicHandler/commands/demean.py

    r1171 r1172  
    2121    [Wiki Doc Text] 
    2222 
    23     == remove mean value == 
     23    == Remove mean value == 
    2424 
    2525    '''command''': DEMEAN <trc-list> [<lo-bound> <hi-bound>] 
  • SHX/trunk/SeismicHandler/commands/derive.py

    r1171 r1172  
    2020    [Wiki Doc Text] 
    2121 
    22     == compute derivative == 
     22    == Compute derivative == 
    2323 
    2424    '''command''': DERIVE <trc-list> <algorithm> 
  • SHX/trunk/SeismicHandler/commands/despike.py

    r1171 r1172  
    2222    [Wiki Doc Text] 
    2323 
    24     == despikes traces == 
     24    == Despikes traces == 
    2525 
    2626    '''command''': DESPIKE <trc-list> <detec> [<lo-t> <hi-t>] [<nsp>] [<ndc>] 
  • SHX/trunk/SeismicHandler/commands/display.py

    r1171 r1172  
    1919    [Wiki Doc Text] 
    2020 
    21     == redisplay traces == 
     21    == Redisplay traces == 
    2222 
    2323    '''command''': DISPLAY <trc-list> <pos> 
  • SHX/trunk/SeismicHandler/commands/dtw.py

    r1171 r1172  
    1717    [Wiki Doc Text] 
    1818 
    19     == delete time window == 
     19    == Delete time window == 
    2020 
    2121    '''command''': DTW 
  • SHX/trunk/SeismicHandler/commands/dyw.py

    r1171 r1172  
    1717    [Wiki Doc Text] 
    1818 
    19     == delete y-window == 
     19    == Delete y-window == 
    2020 
    2121    '''command''': DYW 
  • SHX/trunk/SeismicHandler/commands/echo.py

    r1171 r1172  
    8888    [Wiki Doc Text] 
    8989 
    90     == text output == 
     90    == Text output == 
    9191 
    9292    '''command''': ECHO <text1>[ <text2>[ ...<textN>]] 
  • SHX/trunk/SeismicHandler/commands/echo_ch.py

    r1171 r1172  
    6767    [Wiki Doc Text] 
    6868 
    69     == select echo channel == 
     69    == Select echo channel == 
    7070 
    7171    '''command''': ECHO_CH [<filename>] 
  • SHX/trunk/SeismicHandler/commands/exec.py

    r1171 r1172  
    1717    [Wiki Doc Text] 
    1818 
    19     == execute command line == 
     19    == Execute command line == 
    2020 
    2121    '''command''': EXEC <cmd-line> 
  • SHX/trunk/SeismicHandler/commands/extract.py

    r1171 r1172  
    1818    [Wiki Doc Text] 
    1919 
    20     == extract info from q-file == 
     20    == Extract info from q-file == 
    2121 
    2222    '''command''': EXTRACT <q-file> <trcno> <info> <symbol> 
  • SHX/trunk/SeismicHandler/commands/fct.py

    r1171 r1172  
    1818    [Wiki Doc Text] 
    1919 
    20     == multi-functional command == 
     20    == Multi-functional command == 
    2121 
    2222    '''command''': FCT <subfunction> <p1> ...<pN> 
  • SHX/trunk/SeismicHandler/commands/fili.py

    r1171 r1172  
    2121    [Wiki Doc Text] 
    2222 
    23     == read filter(s) == 
     23    == Read filter(s) == 
    2424 
    2525    '''command''': FILI <kind> <filter1>[ <filter2>[ ...<filterN>]] 
  • SHX/trunk/SeismicHandler/commands/filter_.py

    r1171 r1172  
    2323    [Wiki Doc Text] 
    2424 
    25     == filter traces == 
     25    == Filter traces == 
    2626 
    2727    '''command''': FILTER <kind> <trc-list> [<lo-wdw> <hi-wdw>] [<att>] 
  • SHX/trunk/SeismicHandler/commands/findgap.py

    r1171 r1172  
    2121    [Wiki Doc Text] 
    2222 
    23     == find samples of constant value == 
     23    == Find samples of constant value == 
    2424 
    2525    '''command''': FINDGAP <trc-list> <outfile> <minzeroes> [<from>  <to>] 
  • SHX/trunk/SeismicHandler/commands/fixgap.py

    r1171 r1172  
    2020    [Wiki Doc Text] 
    2121 
    22     == fix gap == 
     22    == Fix gap == 
    2323 
    2424    '''command''': FIXGAP <trc-list> <value> [<lo-wdw> <hi-wdw>] 
  • SHX/trunk/SeismicHandler/commands/fold.py

    r1171 r1172  
    2020    [Wiki Doc Text] 
    2121 
    22     == fold traces with filter == 
     22    == Fold traces with filter == 
    2323 
    2424    '''command''': FOLD <trc-list> [<lo-bound> <hi-bound>] <filter> 
  • SHX/trunk/SeismicHandler/commands/hc.py

    r1171 r1172  
    2020    [Wiki Doc Text] 
    2121 
    22     == hardcopy == 
     22    == Hardcopy == 
    2323 
    2424    '''command''': HC [<wdw>] [<out>] 
  • SHX/trunk/SeismicHandler/commands/help.py

    r1171 r1172  
    1212from SeismicHandler.config import Settings 
    1313import os 
     14import StringIO 
    1415 
    1516firststeps = """ 
     
    2627    # magnify window and parameter window) for menu-driven interactive analysis. 
    2728    # Experimental! 
     29 
     30help * 
     31    # Show a list of all available commands with a short description. 
     32    # 'help f*' shows all commands starting with f. 
     33help filter 
     34    # Show detailed help on command filter. 
    2835     
    2936    # The following text gives examples of commands to be entered to the 
     
    146153    [Wiki Doc Text] 
    147154 
    148     == help utility == 
     155    == Help utility == 
    149156 
    150157    '''command''': HELP [<cmds>] 
    151158 
    152     Displays help information about seismic handler commands. It is possible to get a directory of all commands available ([ShHelp HELP]/DIR), a command menu with short catchwords ([ShHelp HELP]/KEY), a list of lines containing command verb and its parameters ([ShHelp HELP]/CALL) or detailed information about one or more commands specified by <cmds> (without qualifier). 
     159    Displays help information about seismic handler commands. It is possible 
     160    to get a directory of all commands available ([ShHelp HELP]/DIR), a command 
     161    menu with short catchwords ([ShHelp HELP]/KEY), a list of lines containing 
     162    command verb and its parameters ([ShHelp HELP]/CALL) or detailed information 
     163    about one or more commands specified by <cmds> (without qualifier). 
    153164 
    154165    === parameters === 
    155166 
    156167     * <cmds> ''parameter type: string''[[BR]] 
    157        Name of command or wild card expression ("*" is wild card for arbitrary text). The HELP command without parameter is equivalent to the command "[ShHelp HELP]/DIR *", it displays the directory of all help items available. 
     168       Name of command or wild card expression ("*" is wild card for arbitrary 
     169       text). The HELP command without parameter is equivalent to the command 
     170       "[ShHelp HELP]/DIR *", it displays the directory of all help items 
     171       available. 
    158172 
    159173    === qualifiers === 
    160174 
    161      * /dir (SH only) [[BR]] 
    162        Displays all command verbs matching the wild card expression <cmds>. The HELP command without any parameter is equivalent to "[ShHelp HELP]/DIR *". 
     175     * /dir [[BR]] 
     176       Displays all command verbs matching the wild card expression <cmds>. 
     177       SH: The HELP command without any parameter is equivalent to 
     178       "[ShHelp HELP]/DIR *". 
     179       SHX: no function 
    163180 
    164181     * /call (SH only) [[BR]] 
    165        Displays all commands matching the wild card expression <cmds> with their parameter lists (without description of parameters). 
    166  
    167      * /key (SH only) [[BR]] 
    168        Displays a menu of commands matching the wild card expression <cmds> with a very short description of the command. 
     182       Displays all commands matching the wild card expression <cmds> with 
     183       their parameter lists (without description of parameters). 
     184 
     185     * /key [[BR]] 
     186       SH: Displays a menu of commands matching the wild card expression <cmds> 
     187       with a very short description of the command. 
     188       SHX: no function as this is default anyway. 
    169189 
    170190    === examples === 
    171191 
    172192     `help`:: 
    173      displays a list of all available command verbs 
     193     displays a list of all available command verbs and a short decription. 
    174194 
    175195     `help FILTER`:: 
     
    180200 
    181201     `help/key`:: 
    182      displays a list of all available command verbs with catch words 
     202     (SH) displays a list of all available command verbs with catch words 
    183203 
    184204     `help/key FIL*`:: 
    185      same as above restricted to commands beginning with "FIL" 
     205     (SH) same as above restricted to commands beginning with "FIL" 
    186206 
    187207     `help/dir FIL*`:: 
    188      list of all command verbs beginning with "FIL" 
     208     (SH) list of all command verbs beginning with "FIL" 
    189209 
    190210     `help/dir *`:: 
    191      equivalent to plain "HELP" 
     211     (SH) equivalent to plain "HELP" 
    192212 
    193213     `help/call`:: 
     
    195215 
    196216     `help/call FIL*`:: 
    197      displays commands beginning with "FIL" with parameter list 
     217     (SH) displays commands beginning with "FIL" with parameter list 
    198218    """ 
    199219    numberOfParameters = [1] 
    200220    parameterQueries = [ 
    201221        { 
    202             "text": "command (empty input ok, shows first steps)", 
     222            "text": "command or '*' (empty input ok, shows first steps)", 
    203223            "type": "str", 
    204224            "question": False, 
    205225        }, 
    206226    ] 
     227    known_qualifiers = [ 
     228        "KEY", 
     229        "DIR", 
     230    ] 
     231    redraw = False 
    207232 
    208233    def __init__(self, *args, **kwargs): 
     
    214239        "Show help info." 
    215240        cmd = self.parameters[0] 
     241        #showkey = self.qualifiers["KEY"] or self.qualifiers["DIR"] 
    216242 
    217243        if cmd == 'GUI': 
     
    227253                    if command.endswith(lcmd[1:]): 
    228254                        lst.append( command ) 
    229                 print ' '.join(lst) 
     255                self.showCmds( lst ) 
    230256            elif lcmd.endswith('*'): 
    231257                lst = [] 
     
    233259                    if command.startswith(lcmd[:-1]): 
    234260                        lst.append( command ) 
    235                 print ' '.join(lst) 
     261                self.showCmds( lst ) 
    236262            else: 
    237263                print CommandDocs().getDoc(cmd) 
    238264        else: 
    239265            print firststeps 
     266     
     267    def showCmds( self, cmds ): 
     268        hiddencmds = ['memdebug','multinotch','plot','weekheatmap'] 
     269        totlth = 70 
     270        for cmd in sorted(set(cmds)-set(hiddencmds)): 
     271            key = '[no docs]' 
     272            for line in StringIO.StringIO(CommandDocs().getDoc(cmd)): 
     273                if line.startswith('=='): 
     274                    key = line.strip().strip('=').strip() 
     275                    break 
     276            dotlth = totlth - len(cmd) - len(key) - 2 
     277            print '  ', cmd, dotlth*'.', key 
  • SHX/trunk/SeismicHandler/commands/hide.py

    r1171 r1172  
    1818    [Wiki Doc Text] 
    1919 
    20     == hide traces == 
     20    == Hide traces == 
    2121 
    2222    '''command''': HIDE <trc-list> 
    2323 
    24     Removes traces from display but keeps them in memory. Hidden traces can be redisplayed with the [ShDisplay DISPLAY] command. 
     24    Removes traces from display but keeps them in memory. Hidden traces can be 
     25    redisplayed with the [ShDisplay DISPLAY] command. 
    2526 
    2627    === parameters === 
  • SHX/trunk/SeismicHandler/commands/int_.py

    r1171 r1172  
    2020    [Wiki Doc Text] 
    2121 
    22     == integrate traces == 
     22    == Integrate traces == 
    2323 
    2424    '''command''': INT <trc-list> 
  • SHX/trunk/SeismicHandler/commands/mark.py

    r1171 r1172  
    2020    [Wiki Doc Text] 
    2121 
    22     == mark time at trace == 
     22    == Mark time at trace == 
    2323 
    2424    '''command''': MARK <trc> <time> 
  • SHX/trunk/SeismicHandler/commands/maxampl.py

    r1171 r1172  
    1717    [Wiki Doc Text] 
    1818 
    19     == cut amplitudes == 
     19    == Cut amplitudes == 
    2020 
    2121    '''command''': MAXAMPL <trc-list> <ampl> [<lo-bound> <hi-bound>] 
  • SHX/trunk/SeismicHandler/commands/maximum.py

    r1171 r1172  
    1818    [Wiki Doc Text] 
    1919 
    20     == trace of maximum values == 
     20    == Trace of maximum values == 
    2121 
    2222    '''command''': MAXIMUM <trc-list> <info-entry> 
  • SHX/trunk/SeismicHandler/commands/mdir.py

    r1171 r1172  
    2020    [Wiki Doc Text] 
    2121 
    22     == direction of polarisation == 
     22    == Direction of polarisation == 
    2323 
    2424    '''command''': MDIR <trc-list> <wdw-lo> <wdw-hi> [<azim>] [<inci>] 
  • SHX/trunk/SeismicHandler/commands/mend.py

    r1171 r1172  
    2121    [Wiki Doc Text] 
    2222 
    23     == mends a trace == 
     23    == Mends a trace == 
    2424 
    2525    '''command''': MEND <trc> <order> <lo-bound> <hi-bound> 
  • SHX/trunk/SeismicHandler/commands/merge.py

    r1171 r1172  
    2020    [Wiki Doc Text] 
    2121 
    22     == merges two traces together == 
     22    == Merges two traces together == 
    2323 
    2424    '''command''': MERGE <trc1> <trc2> 
  • SHX/trunk/SeismicHandler/commands/mergepair.py

    r1171 r1172  
    1818    [Wiki Doc Text] 
    1919 
    20     == search for traces to be merged == 
     20    == Search for traces to be merged == 
    2121 
    2222    '''command''': MERGE_PAIR <&var1> <&var2> 
  • SHX/trunk/SeismicHandler/commands/mirror.py

    r1171 r1172  
    1717    [Wiki Doc Text] 
    1818 
    19     == mirror traces == 
     19    == Mirror traces == 
    2020 
    2121    '''command''': MIRROR <trc-list> 
  • SHX/trunk/SeismicHandler/commands/mplplot.py

    r1105 r1172  
    1717class mplplot(BaseCommand): 
    1818    """ 
    19     URI:http://www.seismic-handler.org/portal/wiki/ShDisplay 
     19    URI:http://www.seismic-handler.org/portal/wiki/ShMplPlot 
     20 
     21    [Wiki Doc Text] 
     22 
     23    == Create figure with traces on display (using matplotlib) == 
     24 
     25    '''command''': MPLPLOT <outfile> <norm> <colorlist> <title> 
     26 
     27    Create figure in an output file containing all traces on display. 
     28 
     29    === parameters === 
     30 
     31     * <outfile> ''parameter type: string''[[br]] 
     32       Name of output file, will be converted to lowercase. The format of the 
     33       graphics content is defined by the file extension. Various formats are 
     34       supported, e.g. 'png', 'svg' or 'jpg'. 
     35 
     36     * <norm> ''parameter type: string''[[br]] 
     37       Defines normalization of traces in the figure independently from the 
     38       current setting on the trace display. Possible values are 'sw' (all 
     39       traces drawn with the same amplitude) or 'aw' (all traces share the 
     40       same normalization (magnification). 
     41 
     42     * <colorlist> ''parameter type: string''[[br]] 
     43       Comma separated list of colors to apply to the traces. Integer 
     44       multipliers before color specification are allowed. The color list is 
     45       mapped onto the trace list, i.e. the first trace is colored with the 
     46       first color, second trace with the second color and so on. If the color 
     47       list has length N the trace N+1 (if existing) returns to color number 1. 
     48       If this parameter is left empty all traces have black color. 
     49       Examples: "red,blue" (traces get alternatingly red and blue colors), 
     50       "blue,2*lightblue" (first trace blue, second and third lightblue, 
     51       forth blue, ...), "3*#ff00fe,3*#00fffe" (length 6, colors specified 
     52       as rgb in hex code). 
     53 
     54     * <title> ''parameter type: string''[[br]] 
     55       Title put on the figure, underscores ("_") are converted to blanks. 
     56 
     57    === qualifiers === 
     58 
     59     * /TRACELABELSIZE=<pointsize>[[br]] 
     60       Changes size of traces labels to the left of the traces. If many traces 
     61       are to be plotted, a smaller scriptsize is recommended, e.g. 
     62       "/TRACELABELSIZE=5". 
     63 
     64     * /LABELSPEC=<pointsize>[[br]] 
     65       Changes label text to the left of the traces. Possible values are 
     66       "STATION-COMP" (default), "TIME_HH:MM" (begin time of each trace, 
     67       minute precision), "TIME_HH:MM:SS" (begin time of each trace, second 
     68       precision), DAY (date of the trace start). 
     69 
     70    === example === 
     71 
     72     `mplplot myfigure.png sw blue,2*lightblue my_trace_figure`:: 
     73     Create png file containing all traces on display. If three component data 
     74     are on display, starting with Z, the verticals are colored in blue, the 
     75     horizontals in light blue. 
    2076    """ 
    2177    numberOfParameters = [2,3,4] 
  • SHX/trunk/SeismicHandler/commands/norm.py

    r1063 r1172  
    1515    """ 
    1616    URI:http://www.seismic-handler.org/portal/wiki/ShNorm 
     17 
     18    [Wiki Doc Text] 
     19 
     20    ==  Normalisation of traces == 
     21 
     22    '''command''': NORM <kind> 
     23 
     24    Sets normalisation of traces in the current display window. 
     25 
     26    === parameters === 
     27 
     28     * <kind> ''parameter type: keyword''[[BR]] 
     29       Type of normalisation.  Valid values are: 
     30       * SF - traces separately, full length 
     31       * SW - traces separately, window length 
     32       * AF - all traces together, full length (default) 
     33       * AW - all traces together, window length 
     34 
     35    === example === 
     36 
     37     `norm SF`:: 
     38     display each trace on display with the same amplitude 
    1739    """ 
    1840    numberOfParameters = [1] 
  • SHX/trunk/SeismicHandler/commands/nr.py

    r1063 r1172  
    1515    """ 
    1616    URI:http://www.seismic-handler.org/portal/wiki/ShNr 
     17 
     18    [Wiki Doc Text] 
     19 
     20    == Switch redraw off == 
     21 
     22    '''command''': NR 
     23 
     24    Switches automatic redraw off. A [ShNr NR] command suppresses all display 
     25    redraws until a [ShRd RD] command is entered. Each [ShNr NR] command must 
     26    be disabled by a separate RD command, that means if there are two 
     27    consecutive NR commands, then two [ShRd RD] commands are needed to cause 
     28    a redraw. 
    1729    """ 
    1830    numberOfParameters = [0] 
  • SHX/trunk/SeismicHandler/commands/overlay.py

    r1072 r1172  
    1717    """ 
    1818    URI:http://www.seismic-handler.org/portal/wiki/ShZoom 
     19 
     20    [Wiki Doc Text] 
     21 
     22    == Overlay traces == 
     23 
     24    '''command''': OVERLAY <trc-list> 
     25 
     26    Defines overlay lists. If the /DEL qualifier is entered the trace list 
     27    parameter can be omitted. If the parameter is specified, first all 
     28    existing overlay lists are deleted and then the specified list is installed. 
     29 
     30    === parameters === 
     31 
     32     * <trc-list> ''parameter type: trace list''[[BR]] 
     33       List of traces to be overlayed (see above). 
     34 
     35    === qualifiers === 
     36 
     37     * /del[[br]] 
     38       Deletes all defines overlay lists. If the /DEL qualifier is entered the 
     39       trace list parameter can be omitted. If the parameter is specified, 
     40       first all existing overlay lists are deleted and then the specified 
     41       list is installed. 
     42 
     43    === example === 
     44 
     45     `overlay 1,3,5`:: 
     46     overlays traces 1, 3 and 5 
     47 
     48     `overlay/del`:: 
     49     deletes all overlay lists 
     50 
     51     `overlay 1,2`:: 
     52     deletes all overlay lists and creates new overlay of traces 1 and 2. 
    1953    """ 
    2054    numberOfParameters = [0,1] 
  • SHX/trunk/SeismicHandler/commands/param.py

    r1150 r1172  
    1616    """ 
    1717    URI:http://www.seismic-handler.org/portal/wiki/ShParam 
     18 
     19    [Wiki Doc Text] 
     20 
     21    == Handle analysis parameters == 
     22 
     23    '''command''': PARAM SET <parname> <parvalue>[[br]] 
     24    or[[br]] 
     25    '''command''': PARAM GET <parname> <outvar>[[br]] 
     26    or[[br]] 
     27    '''command''': PARAM <subcmd> [<filename>][[br]] 
     28 
     29    Manage parameter set of SHX. The parameters are used mainly in combination 
     30    with the GUI to offer a subset of commands without typing command lines. 
     31    Some of the parameters are changed by SHX commands, like e.g. FK which 
     32    sets 'fk_slowness' and 'fk_azimuth'. 
     33 
     34    === parameters === 
     35 
     36     * <parname> ''parameter type: string''[[br]] 
     37       Name of parameter. For a list of available parameters, see "param dump". 
     38 
     39     * <parvalue> ''parameter type: depending on parameter''[[br]] 
     40       New value of parameter. Only type-compatible values are accepted. 
     41 
     42     * <outvar> ''parameter type: string''[[br]] 
     43       Name of variable to take the current value of the specified parameter. 
     44 
     45     * <filename> ''parameter type: string''[[br]] 
     46       Name of input or output file (LOAD and SAVE subcommands). 
     47 
     48     * <subcmd> ''parameter type: string''[[br]] 
     49       Subcommand to operate on parameters. Possible are:[[br]] 
     50       SET: set parameter <parname> to value <value>.[[br]] 
     51       GET: get value of parameter <parname> into variable <outvar>.[[br]] 
     52       LOAD: load parameter set and phase picks from file <filename>.[[br]] 
     53       SAVE: save parameter set and phase picks into file <filename>.[[br]] 
     54       SAVEASCMD: save parameter set and phase picks in an SHX command file 
     55           <filename>.[[br]] 
     56       DUMP: list parameters and their values.[[br]] 
     57       RESET: reset values of all parameters, kind of factory reset.[[br]] 
     58       SAVETRACES: save trace input information into an SHX command file 
     59           <filename>. With this command file the traces on the display may be 
     60           recovered in a new SHX session. 
     61 
     62 
     63    === qualifiers === 
     64 
     65     * /APPEND[[BR]] 
     66       Append the command file output to an existing one (only relevant to 
     67       subcommands "SAVEASCMD" and "SAVETRACES". 
     68 
     69    === example === 
     70 
     71     `param get fk_slowness &slo`:: 
     72     Copy value of parameter "fk_slowness" into variable "slo" (to be defined 
     73     via "sdef" before). 
     74 
     75     `param save mypars.param`:: 
     76     Save all parameters and phase picks into file "MYPARS.PARAM". 
     77 
     78     `param savetraces recovery.shc`:: 
     79     Save all trace information into command file "RECOVERY.SHC". 
     80 
     81     `param saveascmd recovery.shc /append`:: 
     82     Append all parameters and phase picks to command file "RECOVERY.SHC". In 
     83     a new SHX session a call to the RECOVERY.SHC command procedure recovers 
     84     traces, phases and parameters of the saved session. 
    1885    """ 
    1986    numberOfParameters = [1,2,3] 
  • SHX/trunk/SeismicHandler/commands/phase.py

    r1166 r1172  
    3535    PHASE PLOT [<outfile>] 
    3636    PHASE SLOWNESS <phase> [<slovar>] [<azvar>] [<sloerrvar>] [<azerrvar>] 
     37 
     38    [Wiki Doc Text] 
     39     
     40    == Manage phase picks == 
     41 
     42    '''command''': PHASE DEFINE <station> <picktime> [<phasename>] [<picktype>] [<comp>][[br]] 
     43    or[[br]] 
     44    '''command''': PHASE LIST <station> [<picktype>] [<minweight>][[br]] 
     45    or[[br]] 
     46    '''command''': PHASE DEFAULT_PHASE <phasename>[[br]] 
     47    or[[br]] 
     48    '''command''': PHASE GET_DEFAULT_PHASE[[br]] 
     49    or[[br]] 
     50    '''command''': PHASE STATIONS[[br]] 
     51    or[[br]] 
     52    '''command''': PHASE CLEAR [<phasename>] [<station>] [<picktype>][[br]] 
     53    or[[br]] 
     54    '''command''': PHASE CLEAR_ALL[[br]] 
     55    or[[br]] 
     56    '''command''': PHASE DUMP[[br]] 
     57    or[[br]] 
     58    '''command''': PHASE PLOT[[br]] 
     59    or[[br]] 
     60    '''command''': PHASE SLOWNESS <phasename> [<slovar>] [<azvar>] [<sloerrvar>] [<azerrvar>] 
     61 
     62    Command to modify or operate on internal phase list. This command is not meant 
     63    to be used interactively. All phase picks and deletions of the GUI produce a 
     64    PHASE command and can be logged to reproduce the phase status. Also phase 
     65    picks can be imported from logs or other sources via this command. 
     66 
     67    === parameters === 
     68 
     69     * <station> ''parameter type: string''[[br]] 
     70       Station name including netcode, e.g. "GR.GRA1" 
     71 
     72     * <picktime> ''parameter type: string''[[br]] 
     73       Absolute time in SH notation, e.g. "12-May-2015_08:30:22.122" 
     74 
     75     * <phasename> ''parameter type: string''[[br]] 
     76       Name of phase (if necessary, switch off cap conversion of the command line"), e.g. "P", or "PcP" 
     77 
     78     * <picktype> ''parameter type: string''[[br]] 
     79       Type of phase pick, possible values are "manual" (manual pick), "theo" 
     80       (theoretical arrival time), "auto" (created by picker or detector) and 
     81       "mark" (special pick type used by the "mark" command, unlabeled picks 
     82       without uniqueness limitations). All phases except of type "mark" are 
     83       accepted only once per station and pick type. 
     84 
     85     * <comp> ''parameter type: string''[[br]] 
     86       Component in which phase was picked. 
     87 
     88     * <minweight> ''parameter type: int''[[br]] 
     89       Minimum weight of pick. Weights are numbers between 0 and 9. 
     90 
     91     * <subcmd> ''parameter type: string''[[br]] 
     92       Subcommand, possible values are:[[br]] 
     93       DEFINE: define new phase, default phasename is defined via subcommand "DEFAULT_PHASE", default pick type is "manual", default component is "Z".[[br]] 
     94       LIST: list all known phases of given station, possibly restricted by picktype and minimum weight.[[br]] 
     95       DEFAULT_PHASE: default phase used in "DEFINE" subcommand.[[br]] 
     96       GET_DEFAULT_PHASE: return default phase into variable.[[br]] 
     97       STATIONS: list of stations where phases are picked.[[br]] 
     98       CLEAR: clear selected phases, selection restricted by phasename, station and picktype. At least one out of <station>, <phasename> and <picktype> must be specified.[[br]] 
     99       CLEAR_ALL: delete all phases.[[br]] 
     100       DUMP: dump all known phases to screen.[[br]] 
     101       PLOT: create phase plot and show it on screen[[br]] 
     102       SLOWNESS: determine slowness and azimuth for specified phase including error estimates, results put in up to four variables[[br]] 
     103 
     104 
     105    === qualifiers === 
     106 
     107    None 
     108 
     109    === example === 
     110 
     111     `@PHASE DEFINE GR.GRA1 12-JUL-2014_23:59.37.112 Pg MANUAL Z`:: 
     112     Define Pg phase on station GRA1. 
     113 
     114     `phase clear ;; gr.gra1`:: 
     115     Delete all phases on station GRA1. 
     116 
     117     `phase clear ;;; theo`:: 
     118     Delete all theoretical phases on all stations. 
    37119    """ 
    38120    numberOfParameters = [1,2,3,4,5,6] 
  • SHX/trunk/SeismicHandler/commands/pick.py

    r1063 r1172  
    2121    """ 
    2222    URI:http://www.seismic-handler.org/portal/wiki/ShPick 
     23 
     24    [Wiki Doc Text] 
     25 
     26    == Phase picker == 
     27 
     28    '''command''': PICK <trace> [<start-time> <end-time>] [<onset-var>] 
     29 
     30    Implementation of M. Baer's and U. Kradolfer's phase picker (An Automatic 
     31    Phase Picker for Local and Teleseismic Events, BSSA, Vol. 77, No. 4, 
     32    pp. 1437-1445, Aug. 87). Within the specified time window (relative times) 
     33    on trace <trace> the onset time of the first phase found is marked and 
     34    returned (absolute time) in variable <onset-var> if specified. If no time 
     35    window is given the whole trace is used. The parameters of the picker can 
     36    be set via qualifiers /DURATION, /BREAKLTH and /THRESHOLD. 
     37 
     38    === parameters === 
     39 
     40     * <trace> ''parameter type: trace''[[BR]] 
     41       Selected trace. 
     42 
     43     * <start-time>, <end-time> ''parameter type: real''[[BR]] 
     44       Start and end time of window in which a phase is searched. If not 
     45       specified the whole trace is used. 
     46 
     47     * <onset-var> ''parameter type: symbol address''[[BR]] 
     48       Variable where to store the onset time found. Is empty if no onset can 
     49       be detected. 
     50 
     51    === qualifiers === 
     52 
     53     * /duration=<duration>[[BR]] 
     54       Selects the minimum duration (in sec) the signal on the characteristic 
     55       function must be over the threshold. Default is 1 sec. 
     56 
     57     * /breaklth=<breaklth>[[BR]] 
     58       Selects the maximum allowed break length within <duration> where the 
     59       signal is allowed to fall below the threshold. Default is 0 sec (no 
     60       interruptions of the signal within <duration> allowed). 
     61 
     62     * /threshold=<threshold>[[BR]] 
     63       Detection threshold. Default is 10. 
     64 
     65     * /keep[[BR]] 
     66       Keeps envelope (in power of 4) and characteristic function as additional 
     67       traces on screen. 
     68 
     69    === example === 
     70 
     71     `pick 1 80.0 110.0 &g1 /duration=0.3`:: 
     72     searches phase on trace 1 within time window from 80 to 110 sec and puts 
     73     result to variable g1. Uses duration of 0.3 sec. 
    2374    """ 
    2475    numberOfParameters = [1, 3, 4] 
  • SHX/trunk/SeismicHandler/commands/plot_stations.py

    r1145 r1172  
    2121    """ 
    2222    URI:http://www.seismic-handler.org/portal/wiki/ShPlotstations 
     23 
     24    [Wiki Doc Text] 
     25 
     26    == Create map with stations == 
     27 
     28    '''command''': PLOT_STATIONS <trclist> [<projection>] [<outfile>] 
     29 
     30    Create a map containing station locations for overview on what stations we 
     31    have. Uses obspy plot_basemap function. 
     32 
     33    === parameters === 
     34 
     35     * <trclist> ''parameter type: trace list''[[br]] 
     36       List of traces which should appear on the map. This command also accepts 
     37       the special list name 'withphases' using all traces which have picked 
     38       phases. 
     39 
     40     * <projection> ''parameter type: string''[[br]] 
     41       Projection to be used in map, possible are 'local' (default), 'ortho' 
     42       and 'global'. See obspy plot_basemap for details. 
     43 
     44     * <outfile> ''parameter type: string''[[br]] 
     45       Output file to be created. If omitted, a temporary filename is used and 
     46       the /SHOW qualifier is switched on. 
     47 
     48    === qualifiers === 
     49 
     50     * /SHOW[[br]] 
     51       Show created file on screen (in a spawned process). If an <outfile> is 
     52       specified the default behavior is not to show the result file. 
     53 
     54     * /ADDLOC=<lat>,<lon>[[br]] 
     55       Add a location on the map (labelled "EPI") at the point (lat,lon). 
     56 
     57     * /TITLE=<title>[[br]] 
     58       Add a title to the figure. Underscores '_' are converted to blanks. 
     59 
     60    === example === 
     61 
     62     `plot_stations all`:: 
     63     Plots station locations of all traces and opens plot file on screen. 
     64 
     65     `plot_stations withphases local mymap.png /addloc=49.,11. /title=My_stations_with_epicenter`:: 
     66     Plots station locations of all traces with phases picked, adds an 
     67     epicenter location and a title. Plot file is created, but not shown on 
     68     screen. 
    2369    """ 
    2470    numberOfParameters = [1,2,3] 
  • SHX/trunk/SeismicHandler/commands/polfil.py

    r1063 r1172  
    2020    """ 
    2121    URI:http://www.seismic-handler.org/portal/wiki/ShPolfil 
     22 
     23    [Wiki Doc Text] 
     24 
     25    == Polarisation filter == 
     26 
     27    '''command''': POLFIL <ZNE-list> [<coherence-lth>] [<lo-bound> <hi-bound>] 
     28 
     29    Applies a polarization filter to a 3-dimensional trace. Suppresses parts 
     30    of a seismogram which are not linearly polarized or not polarized in a 
     31    given direction. 
     32 
     33     * Default operation is a linear polarization filter: 
     34 
     35      Determines polarisation of a 3-dim seismogram given by the three traces 
     36      in <ZNE-list> in each data point and suppresses that parts which are not 
     37      linearly polarized. The polarisation is determined by evaluation of 
     38      eigenvalues of the covariance matrix, computed within a time window of 
     39      width <coherence-wdw> and centered at the sample point to be filtered. 
     40      Let the (real and non-negative) eigenvalues of the covariance matrix be 
     41      L1, L2 and L3 in descendent order. Then the filter factor of the filtered 
     42      sample point is given by the formula 
     43    {{{ 
     44       f = (1 - L2/L1) ^ p, 
     45    }}} 
     46      where p is an arbitrary exponent. The default value of p is 1.0. It can 
     47      be changed to <p> by the qualifier "/POWER=<p>". In this mode the 
     48      <coherence-lth> parameter is required. 
     49 
     50     * With qualifier "/POLVEC=<Z>,<N>,<E>": 
     51 
     52       Takes each 3-dim data point (from <ZNE-List>) and computes scalar 
     53       product with the given polarization vector. Both vectors are normalized 
     54       to one before. The result is used to rescale the 3 input traces. If 
     55       "/POWER=<p>" is specified the scaling factor is taken to the power of 
     56       <p>. In this mode the <coherence-lth> parameter is ignored. 
     57 
     58     * With qualifier "/BAZDIR=<baz>": 
     59 
     60       Computes a 2-dim scalar product of the N,E vector and the given 
     61       back-azimuth <baz> (in deg). Both vectors are normalized to 1 before. 
     62       The result is used to rescale the 3 input traces. If "/POWER=<p>" is 
     63       specified the scaling factor is taken to the power of <p>. In this mode 
     64       the <coherence-lth> parameter is ignored. 
     65 
     66    The input traces remain unchanged. There are created output traces 
     67    containing the filtered result. 
     68 
     69    === parameters === 
     70 
     71     * <ZNE-list> ''parameter type: trace list''[[BR]] 
     72       List of three traces containing Z, N and E component of seismogram to 
     73       be polarisation filtered. 
     74 
     75     * <coherence-lth> ''parameter type: real''[[BR]] 
     76       Length of time window in seconds where to compute the covariance matrix 
     77       of each sample point. 
     78 
     79     * <lo-bound>, <hi-bound> ''parameter type: real''[[BR]] 
     80       Time window on input traces to restrict the filtering. Otherwise the 
     81       current time window is used. 
     82 
     83    === qualifiers === 
     84 
     85     * /power=<p>[[BR]] 
     86       Exponent of filter factor (see above description). Maybe any positive real value. 
     87 
     88     * /cmreset=<n>[[BR]] 
     89       Only valid for default operation (no /POLVEC and no /BAZDIR). For 
     90       numerical stability the covariance matrix is recomputed completely 
     91       every <n> steps and not computed from the difference dyads to the 
     92       preceding one. <n> defaults to 100. 
     93 
     94     * /polvec=<Z>,<N>,<E>[[BR]] 
     95       See above. 
     96 
     97     * /bazdir=<baz>[[BR]] 
     98       See above. 
     99 
     100     * /eigen[[br]] 
     101       (undocumented) 
     102 
     103     * /vector[[br]] 
     104       (undocumented) 
     105 
     106    === examples === 
     107 
     108     `polfil/power=10. 1-3 1. 0. 100.`:: 
     109     filters traces 1-3 (Z,N,E-traces) uses exponent of 10. 
     110 
     111     `polfil/power=6. 1,3,5`:: 
     112     filters whole traces 1,3,5 (Z,N,E) 
     113 
     114     `polfil/power=3. 1-3 *`:: 
     115     filters traces 1-3 (Z,N,E) within time windows which can be selected by 
     116     graphic cursor 
    22117    """ 
    23118    numberOfParameters = [1, 2, 4] 
  • SHX/trunk/SeismicHandler/commands/psd.py

    r1073 r1172  
    1616    """ 
    1717    URI:http://www.seismic-handler.org/portal/wiki/ShPsd 
     18 
     19    [Wiki Doc Text] 
     20 
     21    == Compute power spectral density == 
     22 
     23    '''command''': PSD <trclist> [<start> <end>] 
     24 
     25    Computes power spectral density for all traces specified. Creates new 
     26    traces on display which should be plotted separately from time domain 
     27    seismograms. 
     28 
     29    === parameters === 
     30 
     31     * <trclist> ''parameter type: trace list''[[br]] 
     32       List of traces to be processed. 
     33 
     34     * <start> ''parameter type: float''[[br]] 
     35       Relative start time of time window. If omitted (together with <end>), 
     36       the whole trace is used. 
     37 
     38     * <end> ''parameter type: float''[[br]] 
     39       Relative end time of time window. If omitted (together with <start>), 
     40       the whole trace is used. 
     41 
     42    === qualifiers === 
     43 
     44     * /OVERLAP[[br]] 
     45       Use overlapping time windows for PSD computation (50% overlap). 
     46 
     47    === example === 
     48 
     49     `psd 1-3`:: 
     50     Computes PSD spectra for first three traces. 
    1851    """ 
    1952    numberOfParameters = [1,3,4] 
  • SHX/trunk/SeismicHandler/commands/rd.py

    r1063 r1172  
    1515    """ 
    1616    URI:http://www.seismic-handler.org/portal/wiki/ShRd 
     17 
     18    [Wiki Doc Text] 
     19 
     20    == Redraw display == 
     21 
     22    '''command''': RD [<reset>] 
     23 
     24    Redraws the display of the current graphics window if there is no previous 
     25    unmatched NR command or if <reset> equals 'R'. 
     26 
     27    === parameters === 
     28 
     29     * <reset> ''parameter type: char''[[BR]] 
     30       If <reset> equals 'R' a redraw is forced, otherwise previously entered 
     31       NR commands are matched. 
    1732    """ 
    1833    numberOfParameters = [0, 1] 
  • SHX/trunk/SeismicHandler/commands/read.py

    r1136 r1172  
    1919    """ 
    2020    URI:http://www.seismic-handler.org/portal/wiki/ShRead 
     21 
     22    [Wiki Doc Text] 
     23 
     24    == Read traces from q-file == 
     25 
     26    '''command''': READ <qfile> <rec-list> [<lo-bound> <hi-bound>] 
     27 
     28    Reads traces from a q-file. The traces read are added to the display list. 
     29 
     30    === parameters === 
     31 
     32     * <qfile> ''parameter type: filename (without extension)''[[BR]] 
     33       Name of the q-file to be read. 
     34 
     35     * <rec-list> ''parameter type: list of integer (or string "ALL")''[[BR]] 
     36       Position numbers of traces to be read. 
     37 
     38     * <lo-bound>, <hi-bound> ''parameter type: real''[[BR]] 
     39       Time window read from file. If not specified the whole traces are read. 
     40       The time window refers to the start time of each trace unless the 
     41       "/POS"-qualifer is used (see below). 
     42 
     43    === qualifiers === 
     44 
     45     * /swap[[BR]] 
     46       Swaps bytes of binary file after reading. 
     47 
     48     * /zero[[BR]] 
     49       Sets zoom value of new traces to zero. Useful for quick redraw. 
     50 
     51     * /pos=<time-info>[[BR]] 
     52       Changes the reference time of the time window specified by parameters 
     53       <lo-bound> and <hi-bound> from the start time of each trace to the 
     54       value specified time info entry <time-info>. In this case <time-info> 
     55       must be of time-type. If <time-info> is of real type it is assumed to 
     56       be a distance value which is used in combination with the value of a 
     57       "/vel=<velocity>" qualifier to compute a reduced velocity time window. 
     58 
     59    === examples === 
     60 
     61     `read MYQFILE 1-3,5,6`:: 
     62     reads traces 1,2,3,5,6 from q-file "MYQFILE" 
     63 
     64     `read MYQFILE ALL`:: 
     65     reads all traces from file "MYQFILE" 
     66 
     67     `read MYQFILE ALL 20 100`:: 
     68     reads all traces from file "MYQFILE" cutting the traces at 20 and 100 sec 
     69 
     70     `read/pos=P-ONSET MYQFILE ALL -20 100`:: 
     71     reads all traces from file "MYQFILE" and cuts each trace 20 sec before 
     72     P-ONSET and 100 sec after it. 
    2173    """ 
    2274 
  • SHX/trunk/SeismicHandler/commands/reada.py

    r1063 r1172  
    1818    """ 
    1919    URI:http://www.seismic-handler.org/portal/wiki/ShReada 
     20 
     21    [Wiki Doc Text] 
     22 
     23    == Read ASCII trace == 
     24 
     25    '''command''': READA <ascii-file> [<dt> <length>] 
     26 
     27    Reads ASCII trace from file <ascii-file>. The file may contain the sample 
     28    values in any floating format. The file may be started with info entry 
     29    keywords followed by the info values, e.g. the file may contain a line 
     30    "DELTA 0.05" or "START 1-JAN-90_5:30:20.3". The info values are assigned 
     31    to the specified info entries. If no DELTA and/or no LENGTH info is given 
     32    these values are prompted. 
     33 
     34    Please note that only one trace is read from file. Reading stops at the 
     35    first blank line. To skip lines (e.g. of the first trace) use the /SKIP 
     36    qualifier. 
     37 
     38    === parameters === 
     39 
     40     * <ascii-file> ''parameter type: filename''[[BR]] 
     41       Name of the file to be read in. 
     42 
     43     * <dt> ''parameter type: real''[[BR]] 
     44       Sample distance in sec. This parameter is used only if no DELTA 
     45       information is given in the file. 
     46 
     47     * <length> ''parameter type: integer''[[BR]] 
     48       Length of data array in samples. This parameter is used only if no 
     49       LENGTH info is given in the file. 
     50 
     51    === qualifiers === 
     52 
     53     * /skip=<n> 
     54       skips <n> lines of the file <ascii-file> before starting to read 
     55     * /all 
     56       read all traces in file (SHX only) 
     57 
     58    === examples === 
     59 
     60     `reada MYFILE.ASC`:: 
     61     reads data from file MYFILE.ASC. If no informations about sample distance 
     62     and array length are available these values are prompted. 
     63 
     64     `reada/skip=200 MYFILE.ASC 0.05 1000`:: 
     65     skips 200 lines from file MYFILE.ASC and then reads 1000 samples of a 
     66     sample distance 0.05 sec. 
    2067    """ 
    2168 
  • SHX/trunk/SeismicHandler/commands/reado.py

    r1136 r1172  
    1919    """ 
    2020    URI:http://www.seismic-handler.org/portal/wiki/ShReado 
     21 
     22    [Wiki Doc Text] 
     23 
     24    == Read data file == 
     25 
     26    '''command''': READO <file> [<recordlist>] 
     27 
     28    Reads all or a subset of traces from a data file. Uses obspy read, 
     29    therefore all formats supported known by this function: AH, CSS, GSE, 
     30    MSEED, Q, SAC, SEGY, SEISAN, WAV and others. View "obspy read" for more 
     31    details. Can also read from a URL (downloads the file and reads it). 
     32 
     33    === parameters === 
     34 
     35     * <file> ''parameter type: string''[[br]] 
     36       File name or URL of the data. Use backslashes instead of slashes on the 
     37       SHX command line to prevent problems with qualifier identification. If 
     38       necessary, switch off the cap conversion to be able to address lowercase 
     39       filenames ("switch capcnv off"). 
     40 
     41     * <recordlist> ''parameter type: integer list''[[br]] 
     42       If specified, reads only the listed records (traces) from the file, all 
     43       traces otherwise. 
     44 
     45    === qualifiers === 
     46 
     47    None 
     48 
     49    === example === 
     50 
     51     `@READO myfile.ah`:: 
     52     Read lowercase AH file 'myfile.ah'. 
     53 
     54     `reado http:\\examples.obspy.org\2001-01-13-1742-24S.KONO__004 2-4`:: 
     55     Read a SEISAN formatted file from a website and take traces 2 to 4 (omit 
     56     trace 1). 
    2157    """ 
    2258 
  • SHX/trunk/SeismicHandler/commands/reads.py

    r1136 r1172  
    2020    """ 
    2121    URI:http://www.seismic-handler.org/portal/wiki/ShReads 
     22 
     23    [Wiki Doc Text] 
     24 
     25    == Read from Mini-SEED == 
     26 
     27    '''command''': READS <path> <time> <seclength> <stations> <comps> <chan> 
     28 
     29    Reads traces from Mini-SEED files via a special directory file (sfd-file). 
     30    The traces read are added to the display list. 
     31 
     32    === parameters === 
     33 
     34     * <path> ''parameter type: string''[[BR]] 
     35       Specifies the path to the sfd-file. Usually this is the name of an 
     36       environment variable which points to this path followed by a colon 
     37       (like "sfd:"). 
     38 
     39     * <time> ''parameter type: time''[[BR]] 
     40       Absolute time to be read from file (string containing no blanks like 
     41       "25,2,96,3,27" or "25-feb-96_3:27"). [At SZGRF only: <time> == "ONLINE" 
     42       reads online data.] 
     43 
     44     * <seclength> ''parameter type: real''[[BR]] 
     45       Time window in seconds read in. 
     46 
     47     * <stations> ''parameter type: string''[[BR]] 
     48       Comma separated list of stations (no blanks !) or abbreviations "grf" 
     49       (all GRF stations) or "all" (all GRSN stations). 
     50 
     51     * <comps> ''parameter type: string''[[BR]] 
     52       List of components like "zne" or "z". 
     53 
     54     * <chan> ''parameter type: string''[[BR]] 
     55       2-character channel specifier (SEED naming conventions) like "bh", "lh" 
     56       and others. 
     57 
     58    === qualifiers === 
     59 
     60     * /close[[BR]] 
     61       Does not read but closes all previously opened SEED files. 
     62 
     63     * /force[[BR]] 
     64       Creates zero traces if specified time and channel is not available for 
     65       a station. 
     66 
     67     * /sfd=<sfdfile>[[BR]] 
     68       Name of sfd-file used in directory <path>. Necessary only if the name 
     69       is different from "sfdfile.sfd". 
     70 
     71     * /[no]swap 
     72       Requests/Prevents byte-swapping of data when reading SEED data. Default 
     73       is /SWAP. 
     74 
     75     * /[no]invhdr 
     76       Requests/Prevents byte-swapping of header information when reading SEED 
     77       data. Default is /NOINVHDR. 
     78 
     79     * /[no]timecorr 
     80       (undocumented) 
     81 
     82    === examples === 
     83 
     84     `reads SFD: 23-feb-96_8:23 600 GRF ZNE BH`:: 
     85     reads 10min of GRF data from sfd-path SFD 
     86 
     87     `reads %HERE 23,2,96,8,23 600 GRA1,GRB1,GRC1 Z BH`:: 
     88     reads 10 minutes of 3 stations GRA1, GRB1, GRC1 from sfd-file which is on 
     89     current working directory. 
    2290    """ 
    2391 
  • SHX/trunk/SeismicHandler/commands/resample.py

    r1063 r1172  
    1818    """ 
    1919    URI:http://www.seismic-handler.org/portal/wiki/ShResample 
     20    [Wiki Doc Text] 
     21 
     22    == Resample traces == 
     23 
     24    '''command''': RESAMPLE <trc-list> <new-dt> 
     25 
     26    Resamples traces specified in <trc-list> to <new-dt>. New sample points 
     27    are computed by linear interpolation. The input traces are modified, no 
     28    new traces are created. 
     29 
     30    === parameters === 
     31 
     32     * <trc-list> ''parameter type: trace list''[[BR]] 
     33       List of traces to be resampled. 
     34 
     35     * <new-dt> ''parameter type: real''[[BR]] 
     36       New sample distance in sec. 
     37 
     38    === example === 
     39 
     40     `resample ALL .1`:: 
     41     resamples all traces on display to a sample distance of 0.1 sec 
    2042    """ 
    2143    numberOfParameters = [2] 
  • SHX/trunk/SeismicHandler/commands/rms.py

    r1063 r1172  
    1717    """ 
    1818    URI:http://www.seismic-handler.org/portal/wiki/ShRms 
     19 
     20    [Wiki Doc Text] 
     21 
     22    == Compute RMS == 
     23 
     24    '''command''': RMS <trc> <lo-bound> <hi-bound> [<symbol>] 
     25 
     26    Computes RMS value for a trace or a part of a trace (sums all squared 
     27    samples, divides through number of samples and takes square root). The 
     28    resulting value is copied to the symbol specified or written to screen. 
     29 
     30    === parameters === 
     31 
     32     * <trc> ''parameter type: trace''[[BR]] 
     33       Trace to compute rms. 
     34 
     35     * <lo-bound>, <hi-bound> ''parameter type: real''[[BR]] 
     36       Time window used for RMS calculation, if not defined all trace will be 
     37       used. 
     38 
     39     * <symbol> ''parameters type: output symbol''[[BR]] 
     40       Variable to take the resulting rms value. 
     41 
     42    === qualifiers === 
     43 
     44     * /srs[[BR]] 
     45       Compute just the square root sum of the trace. 
     46 
     47     * /sam[[BR]] 
     48       Compute a "squared arithmetic mean" by summing all squared samples, 
     49       taking square root and dividing through number of samples. This was the 
     50       standard behaviour in versions before 2007 (but it violates the 
     51       definition of RMS). 
     52 
     53    === example === 
     54 
     55     `rms 1 ;;; &g1`:: 
     56     computed RMS value of whole trace 1 and puts result into variable G1 
    1957    """ 
    2058    numberOfParameters = [1, 3, 4] 
  • SHX/trunk/SeismicHandler/commands/rot.py

    r1063 r1172  
    1919    """ 
    2020    URI:http://www.seismic-handler.org/portal/wiki/ShRot 
     21 
     22    [Wiki Doc Text] 
     23 
     24    == Rotate traces == 
     25 
     26    '''command''': ROT <trc-list> <azim> [<p1>[ <p2>[ <p3>]]] 
     27 
     28    Rotates traces in two or three dimensions, depending on the length of the 
     29    <trc-list> parameter (two or three traces). The 2-dim rotation is described 
     30    by the usual 2-dim rotation matrix (determinant +1). 
     31 
     32    {{{ 
     33              /  cos<azim>  -sin<azim>  \ 
     34       R  =   |                         | , 
     35              \  sin<azim>   cos<azim>  / 
     36    }}} 
     37 
     38    the 3-dim rotation is a rotation from the left-handed coordinate system 
     39    (Z,N,E) to the right-handed system (L,Q,T) and has a determinant of -1 
     40 
     41    {{{ 
     42             /  cos<inci>  -cos<azim>*sin<inci>  -sin<azim>*sin<inci>  \ 
     43             |                                                         | 
     44       R  =  |  sin<inci>   cos<azim>*cos<inci>   sin<azim>*cos<inci>  | 
     45             |                                                         | 
     46             \  0           sin<azim>            -cos<azim>            / 
     47    }}} 
     48 
     49    === parameters === 
     50 
     51     * <trc-list> ''parameter type: trace list''[[BR]] 
     52       Specifies the traces to be rotated (length of list may be two or three). 
     53 
     54     * <azim> ''parameter type: real''[[BR]] 
     55       Azimuth of rotation (in degrees). 
     56 
     57    If two traces specified: 
     58 
     59     * <p1>, <p2> ''parameter type: real''[[BR]] 
     60       Time window of rotation. If no time window is passed the current display 
     61       window is used. 
     62 
     63    If three traces specified: 
     64 
     65     * <p1> ''parameter type: real''[[BR]] 
     66       Angle of incidence of rotation (in degrees). 
     67 
     68     * <p2>, <p3> ''parameter type: real''[[BR]] 
     69       Time window of rotation.  If no time window is passed the current 
     70       display window is used. 
     71 
     72    === qualifiers === 
     73 
     74    in case of 3-component rotation you can use the following quantifiers to 
     75    rotate between UVW (Galperin, e.g. STS-2) and ZNE orientation: 
     76 
     77    (comp. E. Wieland, Seismometry, in: International Handbook of Earthquake 
     78    and Engineering Seismology, 2002.)  
     79 
     80     * /uvw-zne 
     81 
     82    {{{ 
     83              /  1/SQRT(3)   1/SQRT(3)   1/SQRT(3)  \ 
     84         R =  |    0.0       1/SQRT(2)  -1/SQRT(2)  | 
     85              \ -2/SQRT(6)   1/SQRT(6)   1/SQRT(6)  / 
     86    }}} 
     87 
     88     * /zne-uvw 
     89 
     90    {{{ 
     91              /  1/SQRT(3)      0.0     -2/SQRT(6)  \ 
     92         R =  |  1/SQRT(3)   1/SQRT(2)   1/SQRT(6)  | 
     93              \  1/SQRT(3)  -1/SQRT(2)   1/SQRT(6)  / 
     94    }}} 
     95    === examples === 
     96 
     97     `rot 1,2 30.0`:: 
     98     rotates the first two traces by an azimuth of 30 degrees 
     99 
     100     `rot 1-3 30.0 10.0`:: 
     101     rotates the first three traces by an azimuth of 30 degrees an an angle of 
     102     incidence of 10 degrees 
    21103    """ 
    22104 
  • SHX/trunk/SeismicHandler/commands/sdef.py

    r1063 r1172  
    5757 
    5858    URI:http://www.seismic-handler.org/portal/wiki/ShDef 
     59 
     60    [Wiki Doc Text] 
     61 
     62    == Define symbol == 
     63 
     64    '''command''': SDEF <name>[ <value>] 
     65 
     66    Defines a new symbol. If the qualifier /GLOBAL is entered it is created in 
     67    the global symbol set, otherwise in the current local symbol set. The symbol 
     68    value is initialized to <value>, if <value> is omitted, the symbol is 
     69    initialized to a zero-length string. The length of a symbol name is 
     70    restricted to 15 characters, the length of the symbol value to 80 
     71    characters. 
     72 
     73    The local symbol set is saved and restored on each command level, the 
     74    global set is not. That means, the global symbol set is accessable (reading 
     75    and writing) from every command level, while the local set is accessable 
     76    only from the current level. Each call of a command file saves the current 
     77    local set and creates a new (empty) one, each [ShReturn RETURN] statement 
     78    deletes the local symbol set and restores the parent one. 
     79 
     80    If a symbol is defined in both symbol sets, the definition of the local 
     81    set takes preference to the definition of the global set. 
     82 
     83    === parameters === 
     84 
     85     * <name> ''parameter type: string''[[BR]] 
     86       Name of new symbol.  The length of the name is restricted to 15 
     87       characters. 
     88 
     89     * <value> ''parameter type: string''[[BR]] 
     90       Initialization value of new symbol. The length of <value> is restricted 
     91       to 80 characters. 
     92 
     93    === qualifiers === 
     94 
     95     * /global[[BR]] 
     96       The symbol is created in the global symbol set (see above). 
     97 
     98     * /replace[[BR]] 
     99       A previously defined symbol of the same name in the same set is deleted 
     100       before creating the new symbol. 
     101 
     102     * /check[[BR]] 
     103       If the symbol is already defined, the SDEF command is ignored. 
     104 
     105    === examples === 
     106 
     107     `sdef NEWSYM`:: 
     108     defines local symbol "NEWSYM" 
     109 
     110     `sdef NEWSYM 1`:: 
     111     defines local symbol "NEWSYM" and initialises it to "1" 
     112 
     113     `sdef/global VAL TST`:: 
     114     defines global symbol "VAL" and initialises it to "TST" 
    59115    """ 
    60116    numberOfParameters = [1, 2] 
  • SHX/trunk/SeismicHandler/commands/sdel.py

    r1063 r1172  
    5757 
    5858    URI:http://www.seismic-handler.org/portal/wiki/ShDef 
     59 
     60    [Wiki Doc Text] 
     61 
     62    == Delete symbol == 
     63 
     64    '''command''': SDEL <name> 
     65 
     66    Deletes a previously defined symbol in the current local symbol set or, if 
     67    qualifier /GLOBAL is entered, in the global symbol set. The whole local 
     68    symbol set is deleted also by the RETURN statement. 
     69 
     70    === parameters === 
     71 
     72     * <name> ''parameter type: string''[[BR]] 
     73       Name of symbol to be deleted. 
     74 
     75    === qualifiers === 
     76 
     77     * /global[[BR]] 
     78       The symbol is deleted in the global symbol set. 
     79 
     80    === examples === 
     81 
     82     `sdel OLDSYM`:: 
     83     deletes local symbol "OLDSYM" 
     84 
     85     `sdef/global OLDSYM`:: 
     86     deletes global symbol "OLDSYM" 
    5987    """ 
    6088    numberOfParameters = [1] 
  • SHX/trunk/SeismicHandler/commands/set.py

    r1073 r1172  
    1515    """ 
    1616    URI:http://www.seismic-handler.org/portal/wiki/ShSet 
     17 
     18    [Wiki Doc Text] 
     19 
     20    == Change value of info entry == 
     21 
     22    '''command''': SET <trc-list> <info-entry> <value> 
     23 
     24    Changes the value of info entries of one or more traces in the memory. 
     25    This change of the value is not stored in the q-file of the trace and 
     26    therefore the next seismhandler session uses the old value again. To 
     27    change the value permanently use the /FILE qualifier (see below). 
     28 
     29    === parameters === 
     30 
     31     * <trc-list> ''parameter type: trace list''[[BR]] 
     32       List of traces, which info values are to be changed. 
     33 
     34     * <info-entry> ''parameter type: info entry''[[BR]] 
     35       Name of info entry. See list of valid entry names by ENTRY LIST. 
     36 
     37     * <value> ''parameter type: depends on entry type''[[BR]] 
     38       New value of info entry. 
     39 
     40    === qualifiers === 
     41 
     42     * /file[[BR]] 
     43       The value of the info entry is set not only in the memory, but in the 
     44       source file of the trace as well (if there exists one). Thus the new 
     45       value is kept for all following sessions. 
     46 
     47     * /mod[[BR]] 
     48       Valid only in combination with "/FILE" qualifier. Performs value 
     49       insertion to header of q-file even if the specified trace is not the 
     50       original trace read from the file but a modified one, maybe filtered or 
     51       resampled. 
     52 
     53     * /default[[BR]] 
     54       The given value of an info entry is used as a default value for all new 
     55       created traces. The /DEFAULT qualifier is valid only in combination with 
     56       the following info entries: ATTRIB, REDUCTION, NORM, ZOOM, WEIGHT 
     57 
     58     * /priv[[BR]] 
     59       Change the value of read-only entry. 
     60 
     61    === examples === 
     62 
     63     `set 1 COMMENT |DISTANCE|$BLANK|^DISTANCE|`:: 
     64     set comment string of first trace to "DISTANCE " & distance value 
     65 
     66     `set/file 1 SLOWNESS 5.234`:: 
     67     set slowness value to 5.234 on file and in memory if the value is stored 
     68     in memory 
    1769    """ 
    1870    numberOfParameters = [3] 
  • SHX/trunk/SeismicHandler/commands/shift.py

    r1063 r1172  
    1515    """ 
    1616    URI:http://www.seismic-handler.org/portal/wiki/ShShift 
     17 
     18    [Wiki Doc Text] 
     19 
     20    == Shift traces in time == 
     21 
     22    '''command''': SHIFT [<trc-list> <time> [<p1> <p2> ... <pN>]] 
     23 
     24    Shifts traces by <time> seconds if <trc-list> and <time> are passed. If no 
     25    parameters are passed, the graphic cursor appears and one trace can be 
     26    shifted selecting the trace twice at different times. The trace is then 
     27    shifted by the difference of the two time picks. 
     28 
     29    If <time> is one of the following keywords a special shift is applied to 
     30    all traces of <trc-list>. 
     31 
     32     * ps_delay[[BR]] 
     33       Traces are shifted by the travel time difference of P and converted S, 
     34       where the S conversion is generated at a depth of <p1> km. If <p2> is 
     35       the string "slowness" the required slowness value is retrieved from the 
     36       "slowness" info entry on each trace. 
     37 
     38     * red_time:[[BR]] 
     39       Reduced time display. Traces are shifted by a reduction velocity of <p1>. 
     40       Each trace distance is retrieved from the "distance" info entry. 
     41 
     42     * time_al[[BR]] 
     43       Aligns traces in absolute time, that means the computed time delays 
     44       account for differences in the start times ("start" info entry) of the 
     45       traces. 
     46 
     47     * sd_delay[[BR]] 
     48       not documented :( 
     49 
     50    All computed time shifts are added to already existing delays of the traces, 
     51    i.e. they are relative time shifts. If the same shift command is applied 
     52    twice, the time shift is also twice as large. 
     53 
     54    === parameters === 
     55 
     56     * <trc-list> ''parameter type: trace list''[[BR]] 
     57       List of traces to be shifted by <time> seconds. If omitted one trace can 
     58       be shifted by graphic cursor (see above). 
     59 
     60     * <time> ''parameter type: real''[[BR]] 
     61       Time in seconds the traces in <trc-list> are to be shifted. Only valid 
     62       if <trc-list> is specified. <time> can also be a keyword determining a 
     63       shifting algorithm for the traces in <trc-list>. A list of valid 
     64       keywords if given above. 
     65 
     66    === qualifiers === 
     67 
     68     * /nomark[[BR]] 
     69       Only valid if <trc-list> is omitted. The selected time points at the 
     70       shift trace are not marked. 
     71 
     72    === examples === 
     73 
     74     `shift`:: 
     75     shift one trace by graphic cursor 
     76 
     77     `shift all -10`:: 
     78     shifts all traces by 10 sec to the left 
     79 
     80     `shift all ps_delay 640 slowness`:: 
     81     shift all traces to align a conversion depth coming from 640 km depth 
    1782    """ 
    1883    numberOfParameters = [2, 3, 4] 
  • SHX/trunk/SeismicHandler/commands/simulate.py

    r1147 r1172  
    2020    """ 
    2121    URI:http://www.seismic-handler.org/portal/wiki/ShSimulate 
     22 
     23    [Wiki Doc Text] 
     24 
     25    == Apply instrument simulation == 
     26 
     27    '''command''': SIMULATE <trc-list> <instrument> 
     28 
     29    This command applies a simulation instrument filter to <trc-list>. 
     30    Precondition is well filled meta data information! If a response function 
     31    is not found, no filtering will be done, otherwise this operation replaces 
     32    the original traces. 
     33 
     34    This command is only available in SHX! 
     35 
     36    === parameters === 
     37 
     38     * <trc-list> ''parameter type: trace list''[[BR]] 
     39       Specifies the traces to be filtered. 
     40 
     41     * <instrument> ''parameter type: text''[[br]] 
     42       Instrument code, see qualifier ''list''. 
     43 
     44    == qualifiers == 
     45 
     46     * /list[[BR]] 
     47       List all supported simulation instruments. 
     48     * /restore[[BR]] 
     49       Restores unfiltered traces. <instrument> parameter not necessary. 
     50 
     51    === example === 
     52 
     53     `simulate all wwssn-sp`:: 
     54     Apply simulation filter WWSSN-SP to all traces. 
     55 
     56     `simulate/restore all`:: 
     57     Restore unfiltered traces. 
     58 
     59     `simulate/list ;;`:: 
     60     List available simulation intruments. 
    2261    """ 
    2362    numberOfParameters = [0, 1, 2] 
  • SHX/trunk/SeismicHandler/commands/sleep.py

    r1115 r1172  
    1212    """ 
    1313    URI:http://www.seismic-handler.org/portal/wiki/ShNr 
     14 
     15    [Wiki Doc Text] 
     16 
     17    == Sleep a number of seconds == 
     18 
     19    '''command''': SLEEP <seclength> 
     20 
     21    Sleeps a number of seconds until continuing with next command. 
     22 
     23    === parameters === 
     24 
     25     * <seclength> ''parameter type: float''[[br]] 
     26       Number of seconds to sleep. 
     27 
     28    === qualifiers === 
     29 
     30    None 
     31 
     32    === example === 
     33 
     34     `sleep 2.`:: 
     35     Sleep for 2 seconds. 
    1436    """ 
    1537    numberOfParameters = [1] 
  • SHX/trunk/SeismicHandler/commands/sort_by_distance.py

    r1150 r1172  
    1818    """ 
    1919    URI:http://www.seismic-handler.org/portal/wiki/ShDisplay 
     20 
     21    [Wiki Doc Text] 
     22 
     23    == Sort traces by distance to epicenter == 
     24 
     25    '''command''': SORT_BY_DISTANCE <lat> <lon> 
     26 
     27    Sorts all traces (with metadata) by distance to a given epicenter. 
     28 
     29    === parameters === 
     30 
     31     * <lat> ''parameter type: float''[[br]] 
     32       Epicenter latitude. 
     33 
     34     * <lon> ''parameter type: float''[[br]] 
     35       Epicenter longitude. 
     36 
     37    === qualifiers === 
     38 
     39    None 
     40 
     41    === example === 
     42 
     43     `sort_by_distance -9.6 -71.3`:: 
     44     Sort all traces by distance to an epicenter in South America. 
    2045    """ 
    2146    numberOfParameters = [2] 
  • SHX/trunk/SeismicHandler/commands/spectrogram.py

    r1145 r1172  
    1616    """ 
    1717    URI:http://www.seismic-handler.org/portal/wiki/ShSpectrogram 
     18 
     19    [Wiki Doc Text] 
     20 
     21    == Spectrogram == 
     22 
     23    '''command''': SPECTROGRAM <trc> [<lo-t> <hi-t>] <spgwith> <spgstep> <outfile> 
     24 
     25    Computes spectrogram of a trace and writes the result to a file. 
     26 
     27    SH: 
     28    The result may be viewed with `mapspec`: 
     29    `setenv UIDPATH $SH_SOURCE/img/mapspec.uid`[[BR]] 
     30    `$SH_SOURCE/img/mapspec <datafile> 30` # 30 is number of colours used 
     31 
     32    SHX: 
     33    Creates png figure in specifed output file. Opened if /SHOW qualifier 
     34    specified or no output file is given. 
     35 
     36    SH: 
     37    The spectrogram is computed as follows: a subwindow of N samples of the 
     38    selected trace window is transformed to frequency domain using the FFT 
     39    algorithm (see Numerical Recipes, Press et al., Cambridge University Press, 
     40    1988). N is determined by the configuration parameter spectrogram_width 
     41    and must be a power of 2. Reasonable values are e.g. 512 or 1024. Before 
     42    FFT the input trace is tapered in time domain using a cosine taper 
     43    (2*cos(x)-1, -pi < x < pi). The squared frequency amplitudes are displayed 
     44    in a colour-coded vertical bar/line in the output window. The next 
     45    subwindow for FFT is found by shifting the last one by K samples to the 
     46    right. K is determined by the configuration parameter spectrogram_step. 
     47    The first subwindow starts with the first sample of the selected trace 
     48    part, the last subwindow ends between 0 and K-1 samples before the end of 
     49    the selected trace part. The output matrix contains frequency over time. 
     50    The header info of the output file contains DELTA (sample distance in time, 
     51    s), START (absolute start time of trace), LENGTH (number of frequency 
     52    samples on each time step), LINES (number of time steps), DF (frequency 
     53    sample distance in Hz). Following are LENGTH*LINES numbers giving frequency 
     54    amplitudes over the time steps. The first LENGTH samples refer to time 
     55    sample 1, the second LENGTH samples refer to time sample 2 and so on. 
     56 
     57    SHX: 
     58    Use obspy trace spectrogram method. 
     59 
     60    === qualifiers === 
     61 
     62     * /SHOW (SHX only) [[br]] 
     63       Open and show specified output file. 
     64 
     65    === parameters === 
     66 
     67     * <trc> ''parameter type: trace''[[BR]] 
     68       Trace to compute spectrogram. 
     69 
     70     * <lo-t>, <hi-t> ''parameter type: real''[[BR]] 
     71       Time window on input trace. If not specified the current display window is used. If <lo-t> is an astrisk ("*") you can select the window by graphic cursor. 
     72 
     73     * <spgwidth> ''parameter type: integer''[[BR]] 
     74       Width of an FFT window in samples. Must be a power of 2. Is number N in above description. 
     75 
     76     * <spgstep> ''parameter type: integer''[[BR]] 
     77       Step size in samples.  Is number K in above description. 
     78 
     79    === example === 
     80 
     81     `spectrogram 3 ;;; 512 5 SPEC.DAT`:: 
     82     computes spectrogram of trace number 3 on the total available time window 
     83     and writes the output to file SPEC.DAT (SH). 
    1884    """ 
    1985    numberOfParameters = [1,3,4] 
  • SHX/trunk/SeismicHandler/commands/spiking.py

    r1063 r1172  
    2222    """ 
    2323    URI:http://www.seismic-handler.org/portal/wiki/ShSpiking 
     24 
     25    [Wiki Doc Text] 
     26 
     27    == Compute spiking filter == 
     28 
     29    '''command''': SPIKING <trc> <lo-bound> <hi-bound> <reg> 
     30 
     31    Creates spiking filter (inverse wavelet) of a trace window given by <trc>, 
     32    <lo-bound> and <hi-bound>. The time response function of the filter is 
     33    added to the display. You can use the [ShFold FOLD] command to apply this 
     34    filter to other traces. 
     35 
     36    === parameters === 
     37 
     38     * <trc> ''parameter type: trace''[[BR]] 
     39       Trace to compute spiking filter 
     40 
     41     * <lo-bound>, <hi-bound> ''parameter type: real''[[BR]] 
     42       Time window on trace <trc> for computation of spiking filter 
     43 
     44     * <reg> ''parameter type: real''[[BR]] 
     45       Control parameter of spiking. The computation is done in time domain 
     46       using the toeplitz matrix made from the autocorrelation of the specified 
     47       window. Before evaluation the diagonal elements of the toeplitz matrix 
     48       are multiplied by <reg>+1. <reg>=0 means ordinary inversion. <reg> > 0 
     49       means low-frequent inversion (prewhitening). 
     50 
     51    === qualifiers === 
     52 
     53     * /pos=<spike-pos>[[BR]] 
     54       Specifies the spike position of the desired trace in seconds relative to 
     55       the start of the time window <lo-bound>. As a default, the spike is 
     56       positioned at the center of the signal 
     57       <spike-pos> = sum_i{i*dt*a[i]} / sum_i{a[i]*a[i]}, where a[i] are the 
     58       amplitude values in the window. You also can specify "/pos=max", then 
     59       the spike is positioned at the maximum amplitude inside the window. If 
     60       you enter "/pos=end" the spike is placed at the end of the wavelet. 
     61 
     62     * /lth=<lth-fac>[[BR]] 
     63       Determines the length of the filter trace in units of the length of the 
     64       specified window. Default is 0.5, i.e. the filter has half the length 
     65       of the signal window. 
     66 
     67    === examples === 
     68 
     69     `spiking 1 5.0 50.0 1.0`:: 
     70     computes spiking filter of trace 1 in window from 5.0 sec to 50.0 sec. A control parameter of 1.0 is used. 
     71 
     72     `spiking/lth=1.0 2 *;;0.0`:: 
     73     computes spiking filter of trace 2; the time window must be selected by graphic cursor. The output trace has the same length as the selected window.  Control parameter is 0.0. 
    2474    """ 
    2575    numberOfParameters = [4,] 
  • SHX/trunk/SeismicHandler/commands/stw.py

    r1063 r1172  
    1515    """ 
    1616    URI:http://www.seismic-handler.org/portal/wiki/ShStw 
     17 
     18    [Wiki Doc Text] 
     19 
     20    == Set time window == 
     21 
     22    '''command''': STW [<lo-bound> <hi-bound>] 
     23 
     24    Sets a time window on display. This time window remains valid until changed 
     25    explicitly or removed by [ShDtw DTW] command. If the parameters are omitted, 
     26    the time window can be selected by graphic cursor. 
     27 
     28    === parameters === 
     29 
     30     * <lo-bound>, <hi-bound> ''parameter type: real''[[BR]] 
     31       Time bounds of trace display. 
     32 
     33    === examples === 
     34 
     35     `stw`:: 
     36     let user select time window by graphic cursor 
     37 
     38     `stw 0. 100.`:: 
     39     set time time from 0 to 100 sec 
    1740    """ 
    1841    numberOfParameters = [0, 2] 
  • SHX/trunk/SeismicHandler/commands/sum_.py

    r1137 r1172  
    1919    """ 
    2020    URI:http://www.seismic-handler.org/portal/wiki/ShSum 
     21 
     22    [Wiki Doc Text] 
     23 
     24    == Sum traces == 
     25 
     26    '''command''': SUM <trc-list>[ <lo-bound> <hi-bound>] [<count>] 
     27 
     28    Sums all traces specified in <trc-list> with respect to lo- and hi-bound 
     29    and current time-window (see [ShStw STW]). The result is displayed in a 
     30    new created trace on top of the display. The sum trace is normalized by 
     31    the number of input traces unless the "/nonorm" qualifier is specified. 
     32 
     33    === parameters === 
     34 
     35     * <trc-list> ''parameter type: trace list''[[BR]] 
     36       List of traces to be summed. 
     37 
     38     * <lo-bound>, <hi-bound> ''parameter type: real''[[BR]] 
     39       The summation trace is restricted to this time window. If no time window 
     40       is entered the current display time window is used. 
     41 
     42     * <count> ''parameter type: symbol address''[[BR]] 
     43       Variable to store number of summed traces (useful e.g. when using "ALL"). 
     44 
     45    === qualifiers === 
     46 
     47     * /nonorm[[BR]] 
     48       If passed, the summation trace is the plain sum of the input traces and 
     49       is not normalised by the number of input traces. 
     50 
     51     * /stddev[[BR]] 
     52       (undocumented) 
     53 
     54     * /phases[[BR]] 
     55       (undocumented) 
     56 
     57    === examples === 
     58 
     59     `sum all`:: 
     60     creates sum of all traces and appends result trace to the top of the 
     61     display 
     62 
     63     `sum 1,3,5`:: 
     64     creates sum of listed traces 
     65 
     66     `sum _azimuth(0:180)`:: 
     67     sums all traces with an azimuth value between 0 and 180 degrees 
    2168    """ 
    2269    numberOfParameters = [1, 3, 4] 
  • SHX/trunk/SeismicHandler/commands/switch.py

    r1154 r1172  
    4848    >>> sw.switches["Echo"] 
    4949    True 
     50 
     51    [Wiki Doc Text] 
     52 
     53    == Set global switches == 
     54 
     55    '''command''': SWITCH <switchname> <on/off> 
     56 
     57    Turns an SH switch on or off. Unless the "/global"-qualifier is specified 
     58    the switch state is changed only locally. 
     59 
     60    === parameters === 
     61 
     62     * <switchname> ''parameter type: string''[[BR]] 
     63       Name of switch to be turned on or off. Valid names see below. 
     64 
     65     * <on/off> ''parameter type: string''[[BR]] 
     66       Either keyword "on" (turns switch on) of keyword "off" (turns switch off) 
     67 
     68    === switch names === 
     69    {{{ 
     70    #!rst 
     71     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     72     | cmderrstop | on  | On errors, command files are aborted, an error log file is created and SH returns to the interactive level (default).      | 
     73     |            +-----+----------------------------------------------------------------------------------------------------------------------------+ 
     74     |            | off | Command files don't care about errors and continue execution. Be careful turning this switch off, use it only in fail-safe | 
     75     |            |     | command files.                                                                                                             | 
     76     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     77     | sherrstop  | on  | On errors the whole Seismic Handler session is aborted. Useful mainly for batch jobs which should be terminated on errors  | 
     78     |            |     | to prevent them from working on erroneus data.                                                                             | 
     79     |            +-----+----------------------------------------------------------------------------------------------------------------------------+ 
     80     |            | off | Errors cause error messages but no program exit  (default).                                                                | 
     81     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     82     | verify     | on  | Each command (interactively entered or read from command file) is displayed on screen after translating all parameters.    | 
     83     |            +-----+----------------------------------------------------------------------------------------------------------------------------+ 
     84     |            | off | Commands are not displayed (default).                                                                                      | 
     85     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     86     | protocol   | on  | Each interactive command is logged in the session protocol file. The actual name of the session protocol file depends on   | 
     87     |            |     | the operating system (default).                                                                                            | 
     88     |            +-----+----------------------------------------------------------------------------------------------------------------------------+ 
     89     |            | off | The commands are not logged in the protocol file.                                                                          | 
     90     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     91     | echo       | on  | Each command is echoed on the info channel(s) before translation.                                                          | 
     92     |            +-----+----------------------------------------------------------------------------------------------------------------------------+ 
     93     |            | off | The commands are not echoed (default).                                                                                     | 
     94     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     95     | capcnv     | on  | The whole command line is converted to uppercase letters before translation (default).                                     | 
     96     |            +-----+----------------------------------------------------------------------------------------------------------------------------+ 
     97     |            | off | Lowercase letters are not converted. In this case you have to enter all command verbs and keywords in uppercase otherwise  | 
     98     |            |     | they will not be recognized.                                                                                               | 
     99     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     100     | step       | on  | Stops execution of a command procedure after each command, displays the original comand line and waits for input of <CR>.  | 
     101     |            +-----+----------------------------------------------------------------------------------------------------------------------------+ 
     102     |            | off | Command procedures are processed normally (default).                                                                       | 
     103     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     104     | noerrmsg   | on  | On errors no error messages are displayed and no warning bell is generated. Useful in combination with "cmderrstop" flag   | 
     105     |            |     | if possibly occurring errors are handled inside a command procedure.                                                       | 
     106     |            +-----+----------------------------------------------------------------------------------------------------------------------------+ 
     107     |            | off | Errors cause messages and warning bell (default).                                                                          | 
     108     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     109     | chatty     | on  | Some commands print an information message, for example "sum" or "write" (default).                                        | 
     110     |            +-----+----------------------------------------------------------------------------------------------------------------------------+ 
     111     |            | off | The information message is suppressed. This is useful in command procedures whode internal structure should be hidden from | 
     112     |            |     | the user.                                                                                                                  | 
     113     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     114     | startup    |     | Special flag. A startup file of SH must contain the command "switch startup off".                                          | 
     115     +------------+-----+----------------------------------------------------------------------------------------------------------------------------+ 
     116 
     117    }}} 
     118    === qualifiers === 
     119 
     120     * /global[[BR]] 
     121       The specified switch is changed globally and not only local to th 
     122       current command level. 
     123 
     124    === example === 
     125 
     126     `switch cmderrstop off`:: 
     127     switches cmderrstop flag off 
    50128    """ 
    51129    numberOfParameters = [2] 
  • SHX/trunk/SeismicHandler/commands/system.py

    r1063 r1172  
    2626    """ 
    2727    URI:http://www.seismic-handler.org/portal/wiki/ShSystem 
     28 
     29    [Wiki Doc Text] 
     30 
     31    == Call operating system == 
     32 
     33    '''command''': SYSTEM [<cmd>] 
     34 
     35    Calls the command interpreter of the operating system of the computer and 
     36    passes <cmd> as input. If the operating system is case-sensitive it is 
     37    necessary to switch off the automatic case conversion by 
     38    [ShSwitch SWITCH] `capcnv off`, but then you have to enter all following 
     39    command verbs and keywords in uppercase until the cap conversion is 
     40    switched on again by [ShSwitch SWITCH] `capcnv on`. 
     41 
     42    === parameters === 
     43 
     44     * <cmd> ''parameter type: string''[[BR]] 
     45       Machine dependent command string. 
     46 
     47    === qualifiers === 
     48 
     49     * /doslash[[BR]] 
     50       Replace all back-slashes by forward slashes. 
     51 
     52     * /echo[[BR]] 
     53       Echo the final command on screen. 
     54 
     55    === example === 
     56 
     57     `system`:: 
     58     enables the user to enter one command line to the operating system 
    2859    """ 
    2960    numberOfParameters = [1] 
  • SHX/trunk/SeismicHandler/commands/syw.py

    r1063 r1172  
    1616    """ 
    1717    URI:http://www.seismic-handler.org/portal/wiki/ShSyw 
    18     """ 
     18 
     19    [Wiki Doc Text] 
     20 
     21    == Select y-window == 
     22 
     23    '''command''': SYW [<lo-wdw> <hi-wdw>] 
     24 
     25    Only valid if "yinfo" is not "none" (which is default). Selects window on 
     26    y-coordinates. If <lo-wdw> and <hi-wdw> are not specified the window is 
     27    selected by graphic cursor. All following output is restricted to this 
     28    y-window until a new window is set or the window is deleted by [ShDyw DYW] 
     29    or [ShYinfo YINFO] is reset to "none". 
     30 
     31    === parameters === 
     32 
     33     * <lo-wdw>, <hi-wdw> ''parameter type: real''[[BR]] 
     34       Window on y-coordinates. If not specified the window is selected by 
     35       graphic cursor. 
     36 
     37    === example === 
     38 
     39     `syw -10.0 10.0`:: 
     40     selects y-window from -10.0 to 10.0    """ 
    1941    numberOfParameters = [2] 
    2042 
  • SHX/trunk/SeismicHandler/commands/theophase.py

    r1150 r1172  
    2222    """ 
    2323    URI:http://www.seismic-handler.org/portal/wiki/ShTheoPhase 
     24 
     25    [Wiki Doc Text] 
     26 
     27    == Compute and generate theo phases == 
     28 
     29    '''command''': THEOPHASE <method> <trclist> [<phaselist>] [<origintime>] [<epilat>] [<epilon>] [<srcdepth>] 
     30 
     31    Compute theoretical phases at traces specified. 
     32 
     33    === parameters === 
     34 
     35     * <method> ''parameter type: string''[[br]] 
     36       Computation method. Possible values are 'local' (model: layer over 
     37       halfspace, for local phases) and 'taupi' (obspy.taup, for teleseismic 
     38       phases). 
     39 
     40     * <trclist> ''parameter type: trace list''[[br]] 
     41       List of traces where to compute theoretical travel times. 
     42 
     43     * <phaselist> ''parameter type: string''[[br]] 
     44       Comma separated list of phases to compute on each trace/station. If 
     45       necessary switch off automatic cap conversion of the command parser 
     46       ("switch capcnv off"). If not specified taken from SHX variable 
     47       'phaselist'. 
     48 
     49     * <origintime> ''parameter type: string''[[br]] 
     50       Origin time of event. If not specified taken from SHX variable 
     51       'origin_time'. 
     52 
     53     * <epilat> ''parameter type: float''[[br]] 
     54       Latitude (in deg) of event epicenter. If not specified taken from SHX 
     55       variable 'epi_latitude'. 
     56 
     57     * <epilon> ''parameter type: float''[[br]] 
     58       Longitude (in deg) of event epicenter. If not specified taken from SHX 
     59       variable 'epi_longitude'. 
     60 
     61     * <srcdepth> ''parameter type: float''[[br]] 
     62       Source depth in km. If not specified taken from SHX variable 
     63       'source_depth'. 
     64    === qualifiers === 
     65 
     66     * /MODEL[[br]] 
     67       Specify velocity model. For 'taupi' look in obspy documentation for 
     68       details (default: 'iasp91'). For 'local' specify two layer model. 
     69 
     70    === example === 
     71 
     72     `@THEOPHASE LOCAL ALL Pg,Sg,Pn,Sn`:: 
     73     Compute local theoretical phases on all traces and takes origin info from 
     74     SHX variables. Computed phases are plotted in green color. 
    2475    """ 
    2576    numberOfParameters = [2,3,5,6,7] 
  • SHX/trunk/SeismicHandler/commands/time_.py

    r1083 r1172  
    1515    """ 
    1616    URI:http://www.seismic-handler.org/portal/wiki/ShTime 
     17 
     18    [Wiki Doc Text] 
     19 
     20    == Determine time position == 
     21 
     22    '''command''': TIME [<abspos>] [<relpos>] [<ypos>] [<trace>] [<key>] 
     23 
     24    The graphic cursor is displayed and the time values of user-selected 
     25    positions are returned. If no parameter is passed, the graphic cursor 
     26    remains on display until the "E"-key is pressed (Exit). Every selected 
     27    position is echoed on the current info channel. If any parameter is passed, 
     28    only one selection is possible and the result is not displayed on the text 
     29    channel but stored in the variable(s) passed as parameters. 
     30 
     31    === parameters === 
     32 
     33     * <abspos> ''parameter type: symbol address''[[BR]] 
     34       Symbol receiving the absolute time position 
     35       (example: "14-JUL-1990_18:30:20.021") 
     36 
     37     * <relpos> ''parameter type: symbol address''[[BR]] 
     38       Symbol receiving the relative time position with reference to the time 
     39       axis (example: "23.354") 
     40 
     41     * <ypos> ''parameter type: symbol address''[[BR]] 
     42       Symbol receiving the value of the y-coordinate (perpendicular to time 
     43       axis). 
     44 
     45     * <trace> ''parameter type: symbol address''[[BR]] 
     46       Symbol receiving the address of the selected trace. 
     47 
     48     * <key> ''parameter type: symbol address''[[BR]] 
     49       Symbol receiving the ASCII code of the key pressed. 
     50 
     51    === qualifiers === 
     52 
     53     * /nomark[[BR]] 
     54       Selected time points are not marked. 
     55 
     56     * /parent[[BR]] 
     57       The cursor input is read from the parent command level. 
     58 
     59     * /interactive[[BR]] 
     60       The cursor input is read from the main (interactive) input level. This 
     61       is default. 
     62 
     63    === examples === 
     64 
     65     `time`:: 
     66     select several time positions; exit with "E"-key 
     67 
     68     `time &abs`:: 
     69     select one position; the absolute time position is stored in the 
     70     (pre-defined) variable "abs" 
     71 
     72     `time ;; &rel`:: 
     73     select one position; the relative time position is stored in the 
     74     (pre-defined) variable "rel" 
    1775    """ 
    1876    numberOfParameters = [1,2,3,4] 
  • SHX/trunk/SeismicHandler/commands/title.py

    r1063 r1172  
    1616    """ 
    1717    URI:http://www.seismic-handler.org/portal/wiki/ShTitle 
     18 
     19    [Wiki Doc Text] 
     20 
     21    == Set title line == 
     22 
     23    '''command''': TITLE <line> <text> [<x-pos> <y-pos>] 
     24 
     25    Changes title line of display. There are three lines available (line 
     26    numbers 1,2,3). Each of them can be set independently in text and position. 
     27    If no position is entered, the last entered position is used. If a text 
     28    containing blank should be entered, use the query mode, i.e. enter just 
     29    "title" without any parameters and enter parameters <line> and <text> after 
     30    the correspondend prompts. After the "text: "-prompt any characters in the 
     31    title line are accepted. The style block number used for title output is 
     32    $titlestyle. 
     33 
     34    === parameters === 
     35 
     36     * <line> ''parameter type: integer''[[BR]] 
     37       Line number of title. There are three lines available (1, 2, 3). 
     38 
     39     * <text> ''parameter type: string''[[BR]] 
     40       New text of title line. If the text contains blanks use the query mode 
     41       (see above). If the <text> parameter is left empty the title line is 
     42       removed from display. 
     43 
     44     * <x-pos>, <y-pos> ''parameter type: real''[[BR]] 
     45       Position of text line in units of display width and display height. If 
     46       these parameters are omitted the last specified values are used. 
     47 
     48    === qualifiers === 
     49 
     50     * /wdw[[BR]] 
     51       (undocumented) 
     52 
     53    === example === 
     54 
     55     `title 1 WET`:: 
     56     Set title number one to "WET" 
    1857    """ 
    1958    numberOfParameters = [2, 4] 
  • SHX/trunk/SeismicHandler/commands/trcfct.py

    r1063 r1172  
    1717    """ 
    1818    URI:http://www.seismic-handler.org/portal/wiki/ShTrcfct 
     19 
     20    [Wiki Doc Text] 
     21 
     22    == Trace functions == 
     23 
     24    '''command''': TRCFCT <trc-list> <function> [<p1>] 
     25 
     26    Manipulates traces. Action depends on <function>. Valid values for 
     27    <function> see below. All input traces are changed, that means no 
     28    additional output traces are created. After execution trace info entries 
     29    ''MIN'' and ''MAX'' are updated. 
     30 
     31    === parameters === 
     32 
     33     * <trc-list> ''parameter type: trace list''[[BR]] 
     34       List of traces to be manipulated. 
     35 
     36     * <function> ''parameter type: string''[[BR]] 
     37       Function name.  Valid values are: 
     38 
     39       || mul      || multiplication with <p1>                                || 
     40       || add      || add <p1> to all samples                                 || 
     41       || square   || square all data samples                                 || 
     42       || ssquare  || square all samples, preserving the sign                 || 
     43       || spower   || takes <p1>-th power of all samples, preserving the sign || 
     44       || abs      || take absolute value                                     || 
     45       || remav    || subtract mean from samples                              || 
     46       || ln       || natural logarithm                                       || 
     47       || sign     || replace negative samples by -1.0, otherwise set to 1.0  || 
     48       || meanrepl || replace <p1> values by mean of remaining samples        || 
     49 
     50    === examples === 
     51 
     52     `trcfct all mul 10.0`:: 
     53     Amplifies all traces on display by factor of 10.0. The result is similar 
     54     to the command "[ShZoom ZOOM]` /rel all 10.0`", but here the sample 
     55     values are changed, not only the display. 
     56 
     57     `trcfct all spower 0.25`:: 
     58     Takes 4-th root of each sample of every trace on display preserving the 
     59     sign. 
    1960    """ 
    2061    numberOfParameters = [2, 3] 
  • SHX/trunk/SeismicHandler/commands/trend.py

    r1063 r1172  
    1313    """ 
    1414    URI:http://www.seismic-handler.org/portal/wiki/ShTrend 
     15    [ShCommands Return to command index] 
     16 
     17    == Remove linear trend == 
     18 
     19    '''command''': TREND <trc-list> 
     20 
     21    Removes linear trend from all traces specified in <trc-list>. The input 
     22    traces are modified. No respect is payed to a globally set time-window 
     23    (see ShStw STW). 
     24 
     25    === parameters === 
     26 
     27     * <trc-list> ''parameter type: trace list''[[BR]] 
     28       List of traces to be processed. These traces are modified. 
     29 
     30    === examples === 
     31 
     32     `trend 1`:: 
     33     removes trend of first trace on display 
     34 
     35     `trend all`:: 
     36     removes trend of all traces on display 
    1537    """ 
    1638    numberOfParameters = [1,] 
  • SHX/trunk/SeismicHandler/commands/ttt.py

    r1148 r1172  
    1717    """ 
    1818    URI:http://www.seismic-handler.org/portal/wiki/ShTtt 
     19 
     20    [Wiki Doc Text] 
     21 
     22    == Theoretical travel times == 
     23 
     24    '''command''': TTT <method> <delta> <depth> [<phaselist>] [<outvar>] 
     25 
     26    Compute theoretical travel times. Implemented is currently obspy-taupy for 
     27    teleseismic phases and a layer-over-halfspace model for local phases. 
     28 
     29    === parameters === 
     30 
     31     * <method> ''parameter type: string''[[br]] 
     32       Computation method. Possible is 'local' (for local phases) or 'taupi' 
     33       (for teleseismic phases). 
     34 
     35     * <delta> ''parameter type: float''[[br]] 
     36       Epicentral distance in km ('local') or degrees ('taupi'). 
     37 
     38     * <depth> ''parameter type: float''[[br]] 
     39       Source depth in km. 
     40 
     41     * <phaselist> ''parameter type: string''[[br]] 
     42       Comma separated list of phases to be computed. If necessary switch off 
     43       the automatic cap conversion of the command parser ("switch capcnv off"). 
     44       Default list for 'local' is 'Pg,Pn,Sg,Sn,PmP,SmS', for 'taupi' is 
     45       defined in the obspy.taup.get_travel_times method. 
     46 
     47     * <outvar> ''parameter type: string''[[br]] 
     48       Output variable for travel times(s). Contains a single number (travel 
     49       time in s) if only one phase in <phaselist> was specified. Otherwise a 
     50       comma separated list of phasenames and travel times. 
     51 
     52    === qualifiers === 
     53 
     54     * /MODEL[[br]] 
     55       Specify velocity model. For 'taupi' look at obspy taupy documentation 
     56       for possible values. For 'local' specify a two layer velocity model 
     57       (5 numbers: <vp1>,<vp2>,<vs1>,<vs2>,<d>; <vp1> = P velocity in upper 
     58       layer, <vp2> = P velocity in lower layer (halfspace), <vs1> = S velocity 
     59       in upper layer, <vs2> = S velocity in lower layer (halfspace), 
     60       <d> = thickness of upper layer in km). 
     61 
     62    === example === 
     63 
     64     `@TTT LOCAL 78. 10. Pg,Sg &G1`:: 
     65     Compute Pg and Sg travel times for a local event in 78. km distance and 
     66     10. km depth, put the result into variable g1. 
    1967    """ 
    2068    numberOfParameters = [3,4,5] 
  • SHX/trunk/SeismicHandler/commands/uitrigger.py

    r1143 r1172  
    1414    """ 
    1515    URI:http://www.seismic-handler.org/portal/wiki/ShUiTrigger 
     16 
     17    [Wiki Doc Text] 
     18 
     19    == Open GUI window == 
     20 
     21    '''command''': UITRIGGER <command> 
     22 
     23    Opens parameter or magnify window. 
     24 
     25    === parameters === 
     26 
     27     * <command> ''parameter type: string''[[br]] 
     28       Command to be sent to the GUI. Currently possible is "openparams" and 
     29       "openmagnify" to open the parameter window and the magnify window, 
     30       respectively. 
     31 
     32    === qualifiers === 
     33 
     34    None 
     35 
     36    === example === 
     37 
     38     `cmd`:: uitrigger openmagnify 
     39     Opens magnify window (SHM-like zoom window). 
    1640    """ 
    1741    numberOfParameters = [1] 
  • SHX/trunk/SeismicHandler/commands/unit.py

    r1074 r1172  
    1818    """ 
    1919    URI:http://www.seismic-handler.org/portal/wiki/ShUnit 
     20 
     21    [Wiki Doc Text] 
     22 
     23    == Normalize amplitudes == 
     24 
     25    '''command''': UNIT <trc-list> [<lo-wdw> <hi-wdw>] 
     26 
     27    Normalizes amplitudes of traces in <trc-list>. Finds maximum amplitude of 
     28    traces within specified time window (if not specified the current display 
     29    window is used) and multiplies all traces in <trc-list> with the reciprocal 
     30    value of this maximum. This command does not only affect the display of the 
     31    traces, it changes the sample values! Keep this in mind if you compute 
     32    rotations or sums of these traces later on. 
     33 
     34    === parameters === 
     35 
     36     * <trc-list> ''parameter type: trace list''[[BR]] 
     37       List of traces to be normalized. 
     38 
     39     * <lo-wdw>, <hi-wdw> ''parameter type: real''[[BR]] 
     40       Time window bounds for search of maximum amplitude. If not specified 
     41       the current display window is used. 
     42 
     43    === example === 
     44 
     45     `unit all`:: 
     46     normalizes all traces on display 
     47 
     48     `unit 1-3 0 100`:: 
     49     normalizes first three traces to the maximum amplitude between 0 and 10 sec 
    2050    """ 
    2151    numberOfParameters = [1, 3] 
  • SHX/trunk/SeismicHandler/commands/wdw.py

    r1153 r1172  
    1616    """ 
    1717    URI:http://www.seismic-handler.org/portal/wiki/ShWdw 
     18 
     19    [Wiki Doc Text] 
     20 
     21    == Window commands == 
     22 
     23    '''command''': WDW <keyword>[ <p1>[ <p2>[ ...<pN>]]] 
     24 
     25    Window control commands. Action depends on keyword. 
     26 
     27    === parameters === 
     28 
     29    {{{ 
     30    #!rst 
     31 
     32    +---------+-----------------------------------------------------------+ 
     33    | keyword | parameters                                                | 
     34    +---------+-----------------------------------------------------------+ 
     35    | size    | Change size of window                                     | 
     36    |         +-----------------------------------------------------------+ 
     37    |         | <p1> = window number (integer)                            | 
     38    |         +-----------------------------------------------------------+ 
     39    |         | <p2> = x-position of lower left corner in cm (real)       | 
     40    |         +-----------------------------------------------------------+ 
     41    |         | <p3> = y-position of lower left corner in cm (real)       | 
     42    |         +-----------------------------------------------------------+ 
     43    |         | <p4> = width in cm (real)                                 | 
     44    |         +-----------------------------------------------------------+ 
     45    |         | <p5> = height in cm (real)                                | 
     46    +---------+-----------------------------------------------------------+ 
     47    | top     | Put window on top of display                              | 
     48    |         +-----------------------------------------------------------+ 
     49    |         | <p1> = window number (integer)                            | 
     50    +---------+-----------------------------------------------------------+ 
     51    | create  | Create new window                                         | 
     52    |         +-----------------------------------------------------------+ 
     53    |         | <p1> = window number (integer)                            | 
     54    |         +-----------------------------------------------------------+ 
     55    |         | <p2> = x-position of lower left corner in cm (real)       | 
     56    |         +-----------------------------------------------------------+ 
     57    |         | <p3> = y-position of lower left corner in cm (real)       | 
     58    |         +-----------------------------------------------------------+ 
     59    |         | <p4> = width in cm (real)                                 | 
     60    |         +-----------------------------------------------------------+ 
     61    |         | <p5> = height in cm (real)                                | 
     62    +---------+-----------------------------------------------------------+ 
     63    | delete  | delete window                                             | 
     64    |         +-----------------------------------------------------------+ 
     65    |         | <p1> = window number (integer)                            | 
     66    +---------+-----------------------------------------------------------+ 
     67 
     68    }}} 
     69 
     70    Note: SH always assumes 75 dpi screen resolution. This is not true for most 
     71    cases. 
     72 
     73    === qualifiers === 
     74 
     75     * /dc /ic /gc /dc+ /ic+ /gc+ /dc- /ic- /gc- /flags /flags+ /flags- /global 
     76     /main /qual[[br]] 
     77    
     78     Description see [ShProcedures command procedures]. 
     79 
     80    === examples === 
     81 
     82     `wdw/gc=xh3 create xh3 0.0 4.5 20.0 10.0`:: 
     83     opens X-window number 1 and assigns graphic channel to it 
     84 
     85     `wdw/ic=vh1/dc=vh1 create vh1 0.0 0.0 20.0 5.0`:: 
     86     opens VWS window number 1 and assigns information and dialog channels to it 
     87 
     88     `wdw size p 0. 0. 10. 15.`:: 
     89     Changes size of !PostScript window (hardcopy) to 10cm x 15cm. 
    1890    """ 
    1991    numberOfParameters = [2, 6] 
  • SHX/trunk/SeismicHandler/commands/wiener.py

    r1063 r1172  
    2828    """ 
    2929    URI:http://www.seismic-handler.org/portal/wiki/ShWiener 
     30 
     31    [Wiki Doc Text] 
     32 
     33    == Apply noise suppression == 
     34 
     35    '''command''': WIENER <trclist> <wdwsize> 
     36 
     37    Apply wiener filter to selected traces. Creates new traces with suppressed 
     38    noise. This command is implemented as an example for access to python math 
     39    libraries with extensive documentation in the code. In a similar way many 
     40    other operations may be implemented as a SHX command. 
     41 
     42    === parameters === 
     43 
     44     * <trclist> ''parameter type: trace list''[[br]] 
     45       Traces to apply wiener filter. 
     46 
     47     * <wdwsize> ''parameter type: int''[[br]] 
     48       Window length in samples used for wiener filter. Longer time windows 
     49       produce output traces with lower frequencies. 
     50 
     51    === qualifiers === 
     52 
     53    None 
     54 
     55    === example === 
     56 
     57     `wiener 1.3 50`:: 
     58     Apply wiener filter to traces 1 to 3 using a window size of 50 samples. 
    3059    """ 
    3160    # Define number and type of parameters, possible qualifiers. 
  • SHX/trunk/SeismicHandler/commands/write.py

    r1063 r1172  
    1818    """ 
    1919    URI:http://www.seismic-handler.org/portal/wiki/ShWrite 
     20 
     21    [Wiki Doc Text] 
     22 
     23    == Write traces to q-file == 
     24 
     25    '''command''': WRITE <q-file> <trc-list> 
     26 
     27    Writes traces to q-file. Only the visible part of the traces (inside the 
     28    current display time window) is saved. All info entry values are stored in 
     29    the q-file. If the trace is read from q-file or is derived from another 
     30    trace which is read from a q-file, all info values stored on file only are 
     31    copied from the parent q-file to the new one. If the output q-file doesn't 
     32    exist a new file is created, otherwise the traces are appended at the end 
     33    of the file. 
     34 
     35    === parameters === 
     36 
     37     * <q-file> ''parameter type: filename (without extension)''[[BR]] 
     38       Name of q-file to be created or to append traces. 
     39 
     40     * <trc-list> ''parameter type: trace list''[[BR]] 
     41       List of traces to be written. 
     42 
     43    === qualifiers === 
     44 
     45     * /save_origin[[BR]] 
     46       Updates start time of each trace with respect to the relative time 
     47       position before writing trace. 
     48 
     49    === examples === 
     50 
     51     `write myqfile all`:: 
     52     Writes all traces on display within visible time window to file "MYQFILE". 
     53 
     54     `write myqfile 1-3,5-7`:: 
     55     Writes traces 1,2,3,5,6,7 on display within visible time window to file 
     56     "MYQFILE" 
    2057    """ 
    2158 
  • SHX/trunk/SeismicHandler/commands/writea.py

    r1063 r1172  
    1818    """ 
    1919    URI:http://www.seismic-handler.org/portal/wiki/ShWritea 
     20 
     21    [Wiki Doc Text] 
     22 
     23    == Write traces to ASCII file == 
     24 
     25    '''command''': WRITEA <ascii-file> <trc-list> [<i1> [<i2> [<i3> ... ]]] 
     26 
     27    Writes visible traces to ASCII file. If more than one trace is specified 
     28    then the ASCII data are concatenated. From each trace info entries can be 
     29    inserted to the ASCII file. The info's DELTA and LENGTH are written 
     30    automatically to the ASCII file. The parameters <iN> can contain additional 
     31    info entry description strings. Name and value of the info are then 
     32    inserted to the output file. Each information is placed in a separate line. 
     33    The sample data are written in exponential format, eight numbers per line 
     34    (to change this, see qualifiers). If an ASCII file of the name <ascii-file> 
     35    exists already, the new data file is appended (see also /REPLACE qualifier). 
     36    This means that you can write your own header of the ASCII file using the 
     37    commands [ShEchoCh ECHO_CH] and [ShEcho ECHO]. 
     38 
     39    === parameters === 
     40 
     41     * <ascii-file> ''parameter type: filename''[[BR]] 
     42       Name of the ASCII file to be created. 
     43 
     44     * <trc-list> ''parameter type: trace list''[[BR]] 
     45       List of traces to be written to the ASCII file. 
     46 
     47     * <i1>, <i2>, ... ''parameter type: info entry''[[BR]] 
     48       Additional info entries which should be inserted to the ASCII file for 
     49       each trace. 
     50 
     51    === qualifiers === 
     52 
     53     * /npl=<number>[[BR]] 
     54       Numbers per line in ASCII file.  Default is four. 
     55 
     56     * /fmt=<format>[[BR]] 
     57       Format of the floating point samples to be written to the ASCII file. 
     58       The default format is "%e " (to be entered as /fmt=<%@e_>). The angle 
     59       brackets must be specified in this case to denote a format string in SH. 
     60       The "@"-character makes the next character lowercase (remember the 
     61       automatic case conversion of the command line) and the "_" is translated 
     62       into a blank. If you omit the "_", then the output numbers are 
     63       concatenated without separation characters if the numbers overflow the 
     64       given format. 
     65 
     66     * /replace (only SHX)[[br]] 
     67       Do not append data to existing files. 
     68 
     69    === examples === 
     70 
     71     `writea myascii 1 distance depth`::  
     72     Writes trace 1 to ASCII file "myascii". Before the sample data there are 
     73     four info lines containing LENGTH, DELTA, DISTANCE and DEPTH. 
     74 
     75     `writea/npl=4 myascii 1-3`:: 
     76     Writes first three traces to ASCII file "myascii". Each trace is preceded 
     77     by two info lines containing LENGTH and DELTA. The ASCII file has 4 
     78     samples per line. 
     79 
     80     `writea/fmt=<%8.3@f_> myascii 1`:: 
     81     Writes first trace to ASCII file. The samples are preceded by two info 
     82     lines containing LENGTH and DELTA. The samples are written in floating 
     83     point format with three decimal digits. 
    2084    """ 
    2185 
  • SHX/trunk/SeismicHandler/commands/writeo.py

    r1123 r1172  
    1414    """ 
    1515    URI:http://www.seismic-handler.org/portal/wiki/ShPlotstations 
     16 
     17    [Wiki Doc Text] 
     18 
     19    == Write data file == 
     20 
     21    '''command''': WRITEO <filename> <trclist> <format> 
     22 
     23    Writes selected data traces into a file using a specified format. Uses 
     24    obspy write function, supported formats are GSE2, MSEED, Q, SAC, SEGY, 
     25    WAV and others. For Details see "obspy write". 
     26 
     27    === parameters === 
     28 
     29     * <filename> ''parameter type: string''[[br]] 
     30       Name file to write to. Overwrites already existing files. 
     31 
     32     * <trclist> ''parameter type: trace list''[[br]] 
     33       List of traces to be written to the file. 
     34 
     35     * <format> ''parameter type: string''[[br]] 
     36       Format to use, see above list of available formats. 
     37 
     38    === qualifiers === 
     39 
     40    None 
     41 
     42    === example === 
     43 
     44     `writeo save.mseed all`:: 
     45     Writes all traces of the display into an miniSEED file 'save.mseed'. 
    1646    """ 
    1747    numberOfParameters = [3] 
  • SHX/trunk/SeismicHandler/commands/yinfo.py

    r1063 r1172  
    1414    """ 
    1515    URI:http://www.seismic-handler.org/portal/wiki/ShYinfo 
     16 
     17    [Wiki Doc Text] 
     18 
     19    == Arrange y-position of traces == 
     20 
     21    '''command''': YINFO <info> 
     22 
     23    Use a real-valued info entry for determining the y-position of traces. For 
     24    instance "[ShYinfo YINFO]` distance`" switches to a distance proportional 
     25    display. Default yinfo is "none". To reset display to initial state enter 
     26    command "[ShYinfo YINFO]` none`". To set y-windows see [ShSyw SYW] command. 
     27 
     28    === parameters === 
     29 
     30     * <info> ''parameter type: info entry''[[BR]] 
     31       Real-valued info entry to be used to compute y-position of traces. 
     32 
     33    === examples === 
     34 
     35     `yinfo distance`:: 
     36     switch to distance proportional display 
     37 
     38     `yinfo none`:: 
     39     switch back to original state 
     40 
     41    A typical command sequence to switch to distance proportional display is: 
     42 
     43     `yinfo distance`:: 
     44     switch to distance proportional display 
     45     `trctxt`:: 
     46     switch off trace info text 
     47     `fct axis y-axis plot on`:: 
     48     switch on y-axis 
    1649    """ 
    1750    numberOfParameters = [1] 
  • SHX/trunk/SeismicHandler/commands/zoom.py

    r1063 r1172  
    1616    """ 
    1717    URI:http://www.seismic-handler.org/portal/wiki/ShZoom 
     18 
     19    [Wiki Doc Text] 
     20 
     21    == Zoom amplitudes == 
     22 
     23    '''command''': ZOOM <trc-list> <factor> 
     24 
     25    Changes the amplitudes of the traces in the display. The amplitudes of the 
     26    specified traces are multiplied by <factor>. The trace data are not changed, 
     27    the "zoom" command affects the display only. The zoom parameter is not 
     28    accumulative, that means if you specify the command "zoom all 2" twice, 
     29    then the second command doesn't change anything. To reset the amplitudes to 
     30    initial values enter the command "[ShZoom ZOOM]` all 1.0`". 
     31 
     32    === parameters === 
     33 
     34     * <trc-list> ''parameter type: trace list''[[BR]] 
     35       List of traces to be zoomed. 
     36 
     37     * <factor> ''parameter type: real''[[BR]] 
     38       Factor by which the trace amplitudes are multiplied. 
     39 
     40    === qualifiers === 
     41 
     42     * /default[[BR]] 
     43       The given value of <factor> as a zoom factor is used for all new created 
     44       traces as a default value. 
     45 
     46     * /rel[[BR]] 
     47       The specified zoom factor <zoom> is multiplied to the already existing 
     48       zoom factor of each trace, i.e. <zoom> is a relative zoom factor. 
     49 
     50    === examples === 
     51 
     52     `zoom all 2.0`:: 
     53     Doubles amplitudes of all traces on display of not yet zoomed. 
     54 
     55     `zoom 1-3 1.0`:: 
     56     Resets amplitudes of first three traces to initial values. 
     57 
     58     `zoom/default all 3.0`:: 
     59     Displays amplitudes of all traces on display three times larger than on 
     60     initial display. Also all traces created after this command will be 
     61     displayed with this magnified amplitude. 
     62 
     63     `zoom/rel all 2`:: 
     64     Amplifies all amplitudes by a factor of 2, no matter what the current zoom 
     65     factor is. 
    1866    """ 
    1967    numberOfParameters = [2,] 
  • SHX/trunk/SeismicHandler/modules/parse.py

    r1171 r1172  
    11671167                continue 
    11681168            if indoc: 
    1169                 txt.append( line[pos:] ) 
     1169                if line.strip() == '': 
     1170                    txt.append( '\n' ) 
     1171                else: 
     1172                    txt.append( line[pos:] ) 
    11701173        return ''.join(txt) 
    11711174    cmddoc = {} 
     
    11781181                if '[Wiki Doc Text]' in cls.__doc__: 
    11791182                    cmddoc[a.strip('_')] = prepdoc(cls.__doc__) 
     1183                else: 
     1184                    cmddoc[a.strip('_')] = None 
    11801185    return cmddoc 
    11811186 
Note: See TracChangeset for help on using the changeset viewer.