xxxxxxxxxxxxxxxxxxxxxxxxx Revision History for Open File Report 00–458, version 4 By Jessica M. Cτtι, Frances S. Hotchkiss, Marinna Martini, and Charles R. Denham Revisions by: Andrιe L. Ramsey, Stephen Ruane Acoustic Doppler Current Profiler (ADCP) Data Processing System Manual ----------------------------------------------------- Posted online November 2000 ----------------------------------------------------- Revised June 4, 2012 Removed text on the Index page, under Abstract "The software is continuously being updated and revised as improvements are required. The most recent revision may be downloaded from: http://woodshole.er.usgs.gov/operations/stg/Pubs/ADCPtools/adcp_index.htm The USGS makes this software available at the user’s discretion and responsibility." We will no longer be supporting this code due to changes in the way MATLAB accesses netCDF. MATLAB versions 2011 and higher have new built in functions for netCDF access, but older netCDF access code no longer works well with these new versions of MATLAB. This has severely impacted the ADCP toolbox. As a result, at the USGS in Woods Hole, we are converting to the new MATLAB netCDF techniques. This, and developments by ADCP vendors to provide more comprehensive processing software, have made this toolbox obsolete. You may still download the old ADCP and netcdf toolboxes here to use as you see fit, but we will not be able to provide resources for support. ------------------------------------------------------ Revised and reposted September 2011 List of Modifications The following is a list of major additions and revisions that have been made to the Acoustic Doppler Current Profiler Data Processing System since the third release, which was in September 2005. Additions: • Added the ability to use structures and a script file to run the toolbox non-interactively. • Treats the attribute WATER_DEPTH as a metadata element which gets updated later if surface track and pressure information are available. • Added the ability to use an m-file to perform surface detect on the ADCP backscatter data. Writes and integrates findsurface.m. The toolbox is now platform independent. • Added the bindist variable, which contains the distance from the ADCP head to the center of each bin. • Added range to surface, which is our boundary variable, with data taken from surface detect algorithm used on backscatter data. • Routinely checks for the problem of ADCP data not indicating the correct orientation when deployed by including fixorientation.m in runadcp.m. Interactive users will be asked which way the instrument was deployed. For script users, the item "settings.deployed_orientation" can now be set. • Added the coordinate dimension "ensemble" to *.cdf files created by rdi2cdf so that ncBrowse displays the true ensemble numbers in its plots (otherwise it will use a simple index and show the dimension name). • User has a choice in how close to the surface bins are trimmed as a fraction of the total water depth (1 = water depth, 1.25 = 125% of water depth) • Created the pressuremask.m function, which will mask points above the surface following (a) pressure sensor data, (b) surface output, or (c) user- provided surface time series. This also serves as an example of how to create code to mask data. • Created the function maskADCP to replace starbare and allow masking of data via a graphical user interface, which is more compatible with later versions of MATLAB. • Added two more Demo data sets, one a moored, down-looking ADCP with bottom track data. • Added the function splitadcp.m to separate current velocity data from wave packets and removed dependence on TRDI tools that work only in the Windows operating system. Revisions: • Adapted to changes in wavesmon by TRDI. Wavesmon v3.04 would output currents files (*.PD0) in beam coordinates, but wavesmon v3.06 (and possibly later versions) forces the same data into earth coordinates. This is not a problem for these programs; however, extra caution is advised when applying declination corrections. Rdi2cdf.m no longer corrects the heading; this is done only in adcp2ep.m. In adcp2ep.m, user must supply both a declination value to be stored as metadata and a value by which the vectors and heading shall be rotated. • Removed automatic start and end ensemble trimming; user will now enter first good and last good ensemble even when interactive. • Removed starbare, starbeam and starbuck viewers, as they are no longer stable in more recent versions of MATLAB. • Updated metadata. • Provided a more detailed discussion in this document about the application of declination. • Recalculated depth of bins in fix orientation.m so that depths turn out correctly in the final processed file. • Detects the presence of wave packets data and warns the user to split the data. • Simplifies handling of magnetic variation corrections to make it easier to apply these to current data generated by waves deployments. • Clarifies definitions, names, and contents of WATER_DEPTH, instrument_depth, height, range to boundary, and so on, and adds more meaningful explanatory comments. • Modified trimbins.m to do all the work of finding the ADCP's depth, either by the pressure sensor, range to surface, or user input, and set the bin depths. • Removed tilttrim.m because it is superseded by findsurface.m in trimbins.m, which uses beam angles, rotations, pitch, and roll to estimate range to surface, and therefore should work at extreme angles. • Removed presto, proxy, form, and epic code parts, as they do not work well with the most recent version of MATLAB and are not compatible with MATLAB's new embedded NetCDF interface.