LADCPproc.defaults
changeset 0 de00d0f32431
child 1 54222c82435f
new file mode 100644
--- /dev/null
+++ b/LADCPproc.defaults
@@ -0,0 +1,187 @@
+#======================================================================
+#                    L A D C P P R O C . D E F A U L T S 
+#                    doc: Fri Sep 17 09:44:21 2010
+#                    dlm: Tue Oct 26 14:18:20 2010
+#                    (c) 2010 A.M. Thurnherr
+#                    uE-Info: 182 36 NIL 0 0 72 0 2 4 NIL ofnI
+#======================================================================
+
+# default parameters for [mkShearProf]
+
+# NOTES:
+#	- defaults are taken:
+#		1) from my current UH processing merge control files
+#		2) from the defaults set in Eric's [merge.c]
+#	- the default version in the ANTS bin dir is always loaded
+#	- if there is a version in the current processing directory it is loaded 
+#	  afterwards
+# 	- for additional notes, see [mkShearProf]
+
+# HISTORY:
+#	Sep 17, 2010: - created
+
+##   u_bin0, u_bin1, w_bin0, w_bin1: These set the first and
+##      last bin indices used when integrating horizontal and
+##      vertical velocity, respectively.  The indices start
+##      from 1 and are inclusive.  These parameters do not  
+##      affect the calculation of shear.  They should specify
+##      a good reference layer (for the calculation of the
+##      barotropic component) such as bins 1 to 4.
+
+$wbin_start	= 1;	## These parameters start from 1, not zero
+$wbin_end 	= 5;
+$ubin_start	= 1;
+$ubin_end	= 5;
+
+##   sh_bin0, sh_bin1: These are like the above except that  
+##      they affect the shear calculation only.  They can
+##      normally be left at the default range of 1 to 128  
+##      (disabled).
+
+$shbin_start	= 1;
+$shbin_end		= $LADCP{N_BINS};
+
+##   w_ref_bin, w_dif: These control one of the editing  
+##      criteria recommended by Fischer and Visbeck, or rather
+##      a modification of it.  All velocity data are rejected
+##      below the point at which the vertical velocity
+##      estimate is w_dif larger or smaller than the estimate
+##      in w_ref_bin.  I have not found this criterion
+##      helpful.  94/12/22: changed, so that only those points
+##      where w actually deviates from the mean from 0 to w_ref_bin
+##      are flagged.
+
+$w_ref_bin = 10;
+$w_dif	   = 0.05;
+
+##   wake_hd_dif, wake_ang_min, min_wake_w, n_wake_bins:  These control
+##      editing based upon the direction and inclination of the package wake,
+##      calculated from reference layer U,V, and W.  wake_hd_dif
+##      sets how close to the heading of the wake must be to
+##      the heading of any beam for interference (in degrees).
+##      wake_ang_min sets the minimum wake angle from the
+##      vertical for interference (in degrees).  min_wake_w sets
+##      the minimum package speed required for wake interference
+##      (although upward speed is measured negative, this parameter
+##      is input as a positive value).  All three criteria
+##      must be satisfied for the wake flag to be set.  n_wake_bins
+##      determines how many bins from the top are removed from a
+##      flagged profile, the default is 1 (top bin only).
+##      Additionally, if the previous ensemble met all
+##      interference criteria, the present ensemble
+##      will be flagged even if the criteria are not met.
+##      Default values are wake_hd_dif=0.0, wake_ang_min=90.0,
+##      and min_wake_w=0.1, which results in no wake editing.
+
+$wake_hd_dif  = 0.0;   ## set wake editing defaults so that no wake editing
+$wake_ang_min = 90.0;  ## occurs
+$min_wake_w	  = 0.1;
+$n_wake_bins  = 1;     ## wake editing default - top bin only
+
+##   e_max is the maximum error velocity.  An error velocity
+##         greater than e_max will flag the other velocity
+##         components.  For the BB with 2-ping ensembles, 0.01
+##         m/s looks about right for this parameter.  It
+##         knocks out the incorrect ambiguity glitches as well
+##         as some smaller but still significant glitches.
+##         Note that for the BB, the PG criteria operate on
+##         percent 4-beam solutions, so PG combined with the
+##         e_max provides a reliable filter against big
+##         glitches.
+##         For the NB with 18-ping ensembles, it is not yet
+##         clear whether there is any benefit in using e_max
+##         at all.  To be effective, the value will have to be
+##         small, something like 0.015 or 0.02.  Note also
+##         that for the NB, the pg array holds pg counting
+##         both 4-beam and 3-beam solutions, so 3-beam
+##         glitches will slip through the e_max net.
+##         Default is e_max= 10.0, which effectively disables
+##         it.
+
+$e_max = 0.1;
+
+##   min_correlation (BB only) is the minimum correlation, in
+##      counts, for each beam in a given bin.
+
+$min_cor = 70;
+
+##   Shear editing:  This requires 2 passes through the
+##      database, one using the option
+##            binned_shear_time_range:
+##      to set the time range for a pass during which the
+##      shear statistics will be calculated on a relatively
+##      coarsely grid by binning rather than interpolation,
+##      then using the usual option
+##            time_range:
+##      for the normal pass in which the results of the
+##      previous pass can be used to flag bad velocity values
+##      based on anomalous shears.  The first pass can include
+##      both up and down casts if desired, in which case it
+##      would be followed by a second pass for the up and
+##      downcasts separately.  The binned shear statistics are
+##      saved until they are explicitly recalculated with the
+##      "binned_shear_time_range:" option.
+##      The shear editing is controlled by these parameters:
+##         shear_dev_max= x.x, where x.x is a floating point
+##            number giving a threshold in standard
+##            deviations.  Any shear component deviating from
+##            the binned mean by more than this times the
+##            local standard deviation will raise a flag.
+##            Suitable values for this parameter are probably
+##            in the range 3-5.  Less than 3 is likely to
+##            start trimming too many valid samples, more than
+##            4 or 5 is likely to do nothing at all.
+##         shear_sum_dev_max= x.x gives a threshold used in
+##            detecting isolated bad velocity points.  If the
+##            sum of two successive bad shears (based on
+##            shear_dev_max), divided by the
+##            standard deviation, is LESS THAN this amount,
+##            then the common velocity point is considered to
+##            be an isolated glitch, and it alone is flagged.
+##            Otherwise, both velocity samples contributing to
+##            a flagged shear will be flagged.  A reasonable
+##            value for this parameter is probably around 1-2,
+##            but I don't yet have enough experience to be
+##            sure.
+##         Warning: don't forget to reset the first_x=,
+##         first_y=, and first_z= parameters after pass 1
+##         (with binned_shear_time_range:).  If you don't, and
+##         the depths are not in the database, then the depths
+##         will be completely wrong in pass 2 (with
+##         time_range:).  You may also want to use a different
+##         output file name for pass 1, so that the binned
+##         shear statistics file will not be overwritten
+##         during pass 2.
+
+$max_shdev     = 3.5;	## to disable, set to nan
+$max_shdev_sum = 1.5;
+
+##   previous ping bottom bounce interference editing is controlled by:
+##   clip_margin 0.0 turns off this editing; otherwise, it is the margin in
+##      meters (on each side) by which the calculated range of the
+##      interference is expanded before clipping.  A reasonable value would
+##      be something like 32 (2 depth bins).
+
+# NOTES:
+# 	- default value (90m) taken from comment in merge control files
+#	- clipping is disabled if water_depth cannot be determined
+
+$clip_margin	= 90;  			## default: no previous ping bottom bounce editing
+$first_clip_bin	= 1; 			## default: apply previous ping clipping to all bins */
+
+# tilt editing as in Visbeck's code
+
+$max_tilt 		= 22;			# max allowed angle from vertical
+$max_delta_tilt = 4;			# max allowed ping-to-ping tilt difference
+
+# On DIMES US2 stations in Drake Passage it was found that the ambiguity velocity had been
+# set too low. It appears, however, that aliased velocities are easy to detect because aliasing
+# causes a large positive velocity to appear as a large negative one, and vice versa.
+# The following defines the maximum allowed discrepancy between the vertical velocity from CTD
+# pressure and the LADCP reference-layer w. This parameter should probably be set to something
+# similar as the ambiguity velocity.
+
+$w_max_err = 2.5;
+
+
+1;