NAME

     clean  - clean up data: ie.  zero,  resurrect,  create  dead
     traces,  check  for  bad  IEEE data values or those out of a
     specified range, perform smoothing, etc.

SYNOPSIS

     clean [ -Nntap ] [ -Ootap ]  [  -nsnstr  ]  [  -nenetr  ]  [
     -rsnrst  ] [ -renred ] [ -Eieee ] [ -tthresh ] [ -F ] [ -S ]
     [ -R ] [ -D ] [ -L ] [ -Z ] [ -pcpc ] [ -M ] [ -V ] [ -? ]

DESCRIPTION

     clean zeros out traces flagged with a 30000  static,  checks
     for  bad  IEEE  real  numbers  (Sun  only),  zeroes out real
     numbers less than some threshold, and using  Tukey's  3rrrsh
     method  optionally smooths or roughens the data.  Reports on
     traces comprised of extremely small ( < thresh )  values  or
     extremely  large  ( > 1/thresh ) values and optionally marks
     these as dead or resurrects formerly dead traces for  active
     processing.

     Clean gets both its data and  its  parameters  from  command
     line  arguments.  These arguments specify the input, output,
     the start and end traces, the start  and  end  records,  and
     verbose

  Command line arguments
     -N ntap
          Enter the input data set name or file immediately after
          typing  -N  (can  be  piped).   This  input file should
          include the complete path name if the file resides in a
          different  directory.   Example  -N/vsp/dummy tells the
          program to look for file 'dummy' in directory 'vsp'.

     -O otap
          Enter the output data  set  name  or  file  immediately
          after typing -O (see above).

     -ns nstr
          Enter the processing start trace number.  Trace numbers
          below  this  value  will  not  be processed but will be
          passed.  The default is 1.

     -ne netr
          Enter the processing end trace number.   Trace  numbers
          above  this  value  will  not  be processed but will be
          passed.  The default is the last trace  number  on  the
          input data set.

     -rs nrst
          Enter processing start record number.   Record  numbers
          below  this  value  will  not  be processed but will be
          passed. Default value is the first record.

     -re nred
          Enter processing end  record  number.   Record  numbers
          above  this  value  will  not  be processed but will be
          passed. Default value is last record.
















































     -E ieee
          Enter the IEEE condition flag, i.e.  the  type  of  bad
          number you're looking for:
          ieee = all: stops at the trace having anything funny in
          it (except inexact values)
          ieee = inexact: stops at the trace  having  an  inexact
          value
          ieee = invalid: stops at the trace  having  an  invalid
          value
          ieee = underflow: stops at the trace having  an  under-
          flow value
          ieee = overflow: stops at the trace having an  overflow
          value

     -F   Enter the command line argument '-F' to zero  out  sam-
          ples  less  than  1.E-15 (i.e. those that will probably
          cause underflows in this and other programs.

     -t thresh
          Enter tiny value threshold  for  trace  sample  fixing,
          i.e. values smaller in magnitude than this will be hard
          set to zero if the fix option is set.  On the suns this
          will  clean  the  data  such that subsequent processing
          will not emit annoying messages  about  IEEE  problems.
          Default  value  =  1.E-15.   A minimum value for 32-bit
          machines should be 1.E-30

     -S   Enter the command line  argument  '-S'  to  smooth  the
          input data with Tukey's 3rssh exploratory data analysis
          technique.

     -R   Enter the command line  argument  '-R'  to  output  the
          "rough"  part  of  the input data.  Note: if neither -S
          nor -R are entered then clean merely passes through the
          data zeroing traces flagged with a 30000 static.

     -D   Enter the command line argument '-D' to either  re-kill
          formerly  dead traces resurrected for active processing
          during a previous clean run with -L (see below).

     -L   Enter the command line argument '-L' to cause currently
          dead  traces  to  be zeroed and then unflagged as dead.
          The trace is then marked in such a way that  issuing  a
          -D in a subsequent run will re-kill these traces.

     -Z   Enter the command line argument '-Z'  to  automatically
          flag  zero  traces as dead.  This option cannot be used
          if either -D or  -L  are  chosen  above.   Also  traces
          flagged  as  dead  (static word = 30000) will be zeroed
          out.


     -pc pc
          For use with the -Z option above: enter  %  of  samples
          which  are  zero  above  which  the trace is flagged as
          dead.  Default is 100% i.e. the option is  turned  off.
          This  is  invoked  only  when  the  -Z  option above is
          flagged.

     -M   Enter the command line argument '-M' to remove the mean
          from each trace.  Default is not to do this.

     -V   Enter the command line argument '-V' to get  additional
          printout.

     -?   Enter this (or '-?' if you are running in  c-shell)  to
          get  online  help.   The  program  will terminate after
          printing this.

BUGS

     unknown

AUTHOR

     Paul R. Gutowski  (8-17-87)


     Proprietary - for the exclusive use of Amoco Production Com-
     pany and other wholly owned subsidiaries of Amoco Production

COPYRIGHT

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