LADCP_w: comparison defaults.pl

equal deleted inserted replaced

-:cc6c4309828a
+:2ccb81b7cea5
 #======================================================================
 #                    D E F A U L T S . P L
 #                    doc: Tue Oct 11 17:11:21 2011
-#                    dlm: Tue Mar 29 07:23:24 2016
+#                    dlm: Mon Jun  6 22:07:19 2016
 #                    (c) 2011 A.M. Thurnherr
-#                    uE-Info: 74 39 NIL 0 0 72 0 2 4 NIL ofnI
+#                    uE-Info: 179 18 NIL 0 0 72 0 2 4 NIL ofnI
 #======================================================================
 # HISTORY:
 #	Oct 11, 2011: - created
 #	Oct 12, 2011: - added $processing_param_file
 #	Mar 16, 2016: - added auto creation of output directory
 #	Mar 18, 2016: - added comments about -l
 #	Mar 19, 2016: - improved docu
 #	Mar 29, 2016: - moved out dir creation to [LADCP_w_ocean]
 #				  - added opt_r support
+#	May 26, 2016: - added RDI_Coords::binMapping
+#	May 28, 2016: - added delta-residual filter (-r)
+#	Jun  1, 2016: - added $plotting_level
+#	Jun  2, 2016: - added $tilt_correction_*
 #======================================================================
 # Output Log Files
 #	- there are 4 verbosity levels, selected by -v
 #		0 :	errors
 #======================================================================
 &antsCardOpt(\$opt_v,$ENV{VERB});
 $opt_v = 1 unless numberp($opt_v);
+#======================================================================
-#======================================================================
+# Output Plots
-# Data Input
+#	- there are 3 plotting levels
+#		0 : suppress all plots
+#		1* : produce default plots; *DEFAULT
+#		2 : produce default and diagnostic plots
+#		>2: produce all plots, including useless ones
+#======================================================================
+$plotting_level = 1;
+#======================================================================
+# Input Data
 #======================================================================
 # Set $opt_4 to 1 (or use the -4 option) to suppress 3-beam LADCP
-# solutions
+# solutions. This only has an effect for beam-coordinate data.
 #$opt_4 = 1;
+# Set $RDI_Coords::binMapping to 'none' or use -d to disable
+# linear bin interpolation (which is better than bin mapping).
+# This only has an effect for beam-coordinate data.
+$RDI_Coords::binMapping = $opt_d ? 'none' : 'linterp';
 # The following variables allow bias-correcting the attiude
 # sensors.
 # NB: heading is not used for vertical-velocity processing!
 #======================================================================
 # Data Editing
 #======================================================================
-# The following sets the max allowable rms residual w per ensemble;
+# The following sets the max allowable rms residual w per ensemble, as
-# data from ensembles with larger rms residuals are discarded.
+# well as the max allowable difference between the two beam-pair
+# residuals. Measurements that fail either of these tests are are
-&antsFloatOpt(\$opt_r,0.04);
+# discarded. The limiting values were chosed by inspection of
+# log files and diagnostic plots of a few example profiles. In case of
+# the delta-residual limit, histograms of this parameter show a very
+# steep cutoff at 0.05 cm/s for both IWISE and 2016_I08S data.
+&antsFloatOpt(\$opt_r,'0.06,0.06');
 # By default, ensembles with uncertain time-lagging are discarded.
 # This allows profiles with dropped CTD scans to be processed without
 # manual intervention. For profiles collected in very calm conditions
 # correlations below this limit are discarded.
 &antsFloatOpt(\$opt_c,70);
-# The following sets the default limit for instrument attitude
+# Instrument Tilt
-# (pitch/roll).
-#
-# The default value was established with IWISE profiles 004, 005, 045
-# and 049, which all show considerabe tilt-related discrepancies between
-# the corresponding 2-beam solutions. The first and second pair of
-# profiles were collected with 8 and 6m bins, respectively, without
-# bin re-mapping. The original default of 15 degrees led to large
-# beam-pair differences. Based on diagnostic plots it appears that
-# only tilt angles smaller than 9 degrees or so are satisfactory.
-# In case of the IWISE data set, such a tight constraint causes
-# too many data gaps. The compromise of 12 degrees seems to work
-# quite well, based on the p0 vs epsilon correlation across 5
-# data sets.
 #
-# NB: if this default is changed, the usage message in [LADCP_w]
+# It is not fully clear what tilt angles are acceptable for
-#	  needs to be updated as well.
+# obtaining good vertical velocities. Up to 2016 (V1.3) the
+# default limit was 12 degrees based on an analysis of
-&antsFloatOpt(\$opt_t,12);
+# the 2010 IWISE data with inaccurate 2-beam transformations.
+# As re-processing with a limit of 20 degrees improves the
+# agreement between DL and UL data (R = 0.77/0.67 => 0.79/0.74)
+# the limit was changed to 22 degrees, the same used
+# in Martin Visbeck's inversion code.
+&antsFloatOpt(\$opt_t,22);
 # The following sets the default error velocity limit; measurements
 # with error velocities below this limit are discarded.
 $surface_layer_depth = 25;
 # Previous Ping Interference editing as described in [edit_data.pl]
 #	- enabled by default for WH150 data
-#	- the variable defines a string with a perl expression, which is
+#	- PPI_seabed_editing_required defines a string with a perl expression
-#	  evaluated once the data are loaded
+#	  that is evaluated once the data are loaded; if true, seabed PPI
+#	  editing is enabled
+#	- to enable PPI editing without condition, set $PPI_editing = 1;
 #	- 2014 CLIVAR P16 #47 has a slight discontinuity at 4000m; this
 #	  discontinuity is there without PPI filtering but gets slightly
 #	  worse with PPI filtering. Setting $PPI_extend_upper_limit to
 #	  1.03-1.05 partially removes the discontinuity but the profile
 #	  never gets better than the profile wihtout PPI editing. Note
 #	  the only reason why the upper PPI should be extended is if the
 #	  recorded ping intervals are inaccurate as the upper limit is
 #	  set by the shortest acoustic path between the ADCP and the
 #	  seabed.
-$PPI_editing_required = '($LADCP{BEAM_FREQUENCY} < 300)';
+$PPI_seabed_editing_required = '($LADCP{BEAM_FREQUENCY} < 300)';
+#$PPI_editing = 1;						# uncomment to enable PPI always
 #$PPI_extend_upper_limit = 1.03;		# see comments above
 # The following variables control the "non-obvious" sidelobe editing for
 # contamination from the seabed for the UL and from the sea surface for the
 # After applying the method of Deines (1999), an empirical correction
 # for Sv is applied to the data. The following variable determines which
 # bin is chosen to construct a reference profile for Sv. The bin number
 # is automatically increased if the selected bin does not contain valid
 # data, i.e. the default value of 1 ensures that the closest valid bin
-# is used to construct the reference profile.
+# is used to construct the reference profile. The empirical correction
+# causes artifacts every 100m. To disable the empirical
+# correction, undefine the following variable.
 $Sv_ref_bin = 1;
 # Set to folloing variable to 1 to use ADCP BT data to detect seabed

changeset 47	2ccb81b7cea5
parent 42	f7690c7b92e0
child 48	d9309804b6cf