subtractBottomVelocity {oce}

Subtract Bottom Velocity From an adp Object

Description

Subtracts bottom tracking velocities from an "adp" object. Works for all coordinate systems (beam, xyz, and enu).

Usage

subtractBottomVelocity(x, despike = FALSE, debug = getOption("oceDebug"))

Arguments

x

an adp object that contains bottom-tracking velocities.

despike

either a logical value or a univariate function. This controls whether the bottom velocity (bv) values should be altered before they are subtracted from the beam velocities. If it is TRUE then the bv values are despiked first by calling despike(). If it is a function, then that function is used instead of despike(), e.g. function(x) despike(x, reference="smooth") would change the reference function for despiking from its default of "median".

debug

an integer specifying whether debugging information is to be printed during the processing. This is a general parameter that is used by many oce functions. Generally, setting debug=0 turns off the printing, while higher values suggest that more information be printed. If one function calls another, it usually reduces the value of debug first, so that a user can often obtain deeper debugging by specifying higher debug values.

Author(s)

Dan Kelley and Clark Richards

See Also

See read.adp() for notes on functions relating to "adp" objects, and adp for notes on the ADP object class.

Other things related to adp data: [[,adp-method, [[<-,adp-method, ad2cpCodeToName(), ad2cpHeaderValue(), adp-class, adpAd2cpFileTrim(), adpConvertRawToNumeric(), adpEnsembleAverage(), adpFlagPastBoundary(), adpRdiFileTrim(), adp_rdi.000, adp, applyMagneticDeclination,adp-method, as.adp(), beamName(), beamToXyzAdpAD2CP(), beamToXyzAdp(), beamToXyzAdv(), beamToXyz(), beamUnspreadAdp(), binmapAdp(), enuToOtherAdp(), enuToOther(), handleFlags,adp-method, is.ad2cp(), plot,adp-method, read.adp.ad2cp(), read.adp.nortek(), read.adp.rdi(), read.adp.sontek.serial(), read.adp.sontek(), read.adp(), read.aquadoppHR(), read.aquadoppProfiler(), read.aquadopp(), rotateAboutZ(), setFlags,adp-method, subset,adp-method, summary,adp-method, toEnuAdp(), toEnu(), velocityStatistics(), xyzToEnuAdpAD2CP(), xyzToEnuAdp(), xyzToEnu()