NAME

     vsmx  - module to mix traces from the input data to  produce
     the  output,  using  one of several nonlinear stacking algo-
     rithms.  One output trace is produced for each input trace.


SYNOPSIS

     vsmx  [ -Nntap ]  [ -O1otap1 ]  [ -O2otap2 ]  [ -Cparmfile ]
     [ -Llistfile ] [ -V ] [ -H ] [ -? ]
     [ -algalgorithm ] [ -modmode ] [ -cdfcdflag ] [ -dffdfflag ]
     [ -nmxnmix ] [ -lmxlmix ]
     [ -rngrange ]


DESCRIPTION

     vsmx will laterally mix the traces from the input  data  set
     over  a  specified  trace window width using a selected non-
     linear mixing algorithm.

     vsmx will process all input records,  producing  one  output
     trace for each input trace.

  Command line arguments
     -N ntap
          Enter the full path name of the file containing the in-
          put  data  set.  If not specified, input is expected to
          be on the standard input. The program will give an  er-
          ror message if the input file is read protected.  If no
          input file is given, and there is  no  standard  input,
          the program will hang.  (default is standard input )

     -O1 otap1
          Enter the full path name for the output file to receive
          the mixed data.  If not specified, the output data will
          be written to the standard  output.  The  program  will
          give an error message if the output is being written to
          a directory which has write  protection.   (default  is
          standard output )

     -O2 otap2
          This output file name must be specified if option  -dff
          below  is  0.   Enter the full path name for the output
          file to receive the input data minus  the  mixed  data.
          If  not  specified,  this output will be written to the
          standard output. The program will give an error message
          if  this file is being written to a directory which has
          write protection.  An error message will also occur  if
          both  otap1  and  otap2  are  allowed to default to the
          standard output if option -dff below is 0.   Of  course
          is you are executing this routine with XIKP you may at-
          tach output files to both outputs (1 - stdout) and (3 -
          socket)  and  get -O1 and -O2 simultaneously.  (default
          is standard output )

     -C parmfile
          File from which processing parameters algorithm,  mode,
          cdflag, dfflag, nmix, lmix, and range are to be read if
          not explicitly included in the command line.  An  error
          message  will  be issued if parmfile does not exist. If
          -C is present on the command  line  with  no  argument,
          parameters  are assumed to be in-line in the job script
          marked with the flag -vsmx.crd. By  using  this  method
          (described in the STARTJOB section of this manual), the
          user is allowed to specify the vsmx parameters  in-line
          with the processing sequence. If flag -C is not present
          on the command line, the  parameters  algorithm,  mode,
          cdflag,  dfflag,  nmix,  lmix, and range are explicitly
          read from the command line.   The  parameter  card  for
          vsmx is:

               Column          Variable
                  1-5          card number and name
                 6-10          dfflag, difference flag
                11-15          cdflag, constant distance flag
                16-20          mode
                21-25          algorithm
                26-30          nmix, mixing window size
                31-35          lmix, inner mixing window size
                36-40          range


     -L listfile
          File to which the run time listing (i.e.,  sysout)  for
          this  program  is sent.  If option -L is present on the
          command line with no argument, the name of the file  to
          receive the run time information is generated automati-
          cally as VSMX.XXX.YYY where XXX  and  YYY  are  derived
          from  the  least significant digits of the process i.d.
          (PID) and parent process i.d. (PPID) of  this  process.
          If  option -L is not specified on the command line, the
          name of the file to receive the run time information is
          generated  automatically  as VS.XXXXX.YYYYY where XXXXX
          and YYYYY are derived from the process i.d.  (PID)  and
          parent process i.d. (PPID) of this job.  This is compa-
          tible  with  the  naming  convention  required  by  the
          STARTJOB  system,  so to use that system the -L flag is
          not used.

     -V   Verbose mode.  Detailed information about processing is
          sent to the output listing device.

     -?  or -H
          Query mode.  With this flag, vsmx will send a  descrip-
          tion  of the command line arguments to the standard er-
          ror output and stop.

     -alg algorithm
          Algorithm to be used to perform the  mixing  operation:
          1)  median
          2)  alpha trimmed mean
          3)  range trimmed mean
          4)  double window range trimmed mean
          5)  asymmetric range trimmed mean
          6)  modified trimmed mean.
          7)  double window modified trimmed mean.
          (default = 1 )

     -mod mode
          Mixing mode:
               1)  sequential by line,
               2)  sequential by record.
          (default = 2 )

     -cdf cdflag
          Constant distance flag:
               0)  mixing window covers a constant distance,
               1)  mixing window covers a constant number of live
               traces.
          (default = 1 )

     -dff dfflag
          Difference flag:
               0)  output both mixed data (to  otap1)  and  input
               minus mixed data (to otap2),
               1)  output to otap1 is mixed data,
               2)  output to otap1 is input minus mixed data.
          (default = 1 )

     -nmx nmix
          Mixing window size.  If using  a  double  window  algo-
          rithm, this is the outer window size.  (default = 11 )

     -lmx lmix
          Inner mixing window size.  Valid when  using  a  double
          window  algorithm, this is the inner window size.  (de-
          fault = 5 )

     -rng range
          Trim range for trimmed mean algorithms,  in  per  cent.
          In the alpha trimmed mean algorithm, 100% is equivalent
          to averaging (normal mixing) and 0%  is  equivalent  to
          the median mix.  (default = 0 )


BUGS

     No trap for running program without an input file and  noth-
     ing in the standard input.



SEE ALSO

     rost(n)


AUTHOR

     W. J. Done (1987)


COPYRIGHT

     copyright 2001, Amoco Production Company
               All Rights Reserved
          an affiliate of BP America Inc.











































Man(1) output converted with man2html