.. ......................................
.. UHDAS/CODAS restructured text document
.. ......................................

Reference Layer as an Editing Tool
----------------------------------

Gautoedit uses an new variable-depth reference layer scheme
(`"refsm" <refsm.html>`_) which is
more robust than a the old method of simply averaging over a fixed
reference layer. However, the old fixed-range reference layer method
still provides a useful editing tool and a good diagnostic. (Reference
layer plots and water track calibration still use this older method).

Because the reference layer is so important in determining ocean
velocity, it may be desirable to flag certain profiles as bad if the
velocities within a certain range fail a Percent Good criteria. This
is what the reference layer editing parameters do.  

Two examples of
profiles flagged using the reference layer criteria are shown below:


.. -------------------------------------------
.. |refl_and_shallow_bottom| image:: refl_and_shallow_bottomt.png
                   :alt: velocity plot
.. _refl_and_shallow_bottom: refl_and_shallow_bottom.png
.. -------------------------------------------
.. |deep_refl| image:: deep_reflt.png
                   :alt: velocity plot
.. _deep_refl: deep_refl.png
.. -------------------------------------------

+---------------------------------------------+----------------------------------------------+
| - Reference Layer: 5 to 20                  | - Reference Layer: 20 to 35                  |
| - require 15 bins with 80PG                 | - require 14 bins with over 80PG             |
|                                             |                                              |
| One profile at 244.4 failed because the     | In this example (for illustration only)      |
| depth there is shallow enough that          | the reference layer was chosen to            |
| there were simply not enough valid          | show the effect of the low PG stripe         |
| bins in the reference layer chosen.         | at about bin 30.  Any profiles in which      |
| Beware of losing profiles in shallow        | PG was below 80 for that bin range           |
| regions from the defaults: quick_adcp.py    | is flagged as bad, having failed to          |
| reference layer defaults at bins 4-12, so   | have "enough good data'.                     |
| you will lose profiles in water shallower   |                                              |
| than 4 bins.                                |                                              |
+---------------------------------------------+----------------------------------------------+
|                                             |                                              |
|   |refl_and_shallow_bottom|_                |           |deep_refl|_                       |
+---------------------------------------------+----------------------------------------------+