forked from dankelley/oce
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathad.R
151 lines (145 loc) · 5.78 KB
/
ad.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
#' Report Statistics of adp or adv Velocities
#'
#' Report statistics of ADP or ADV velocities, such as means and variance
#' ellipses.
#'
#' @param x an \code{adp} or \code{adv} object, i.e. one inheriting from
#' \code{\link{adp-class}} or \code{\link{adv-class}}.
#' @param control An optional \code{\link{list}} used to specify more information.
#' This is presently ignored for \code{adv} objects. For \code{adp} objects, if
#' \code{control$bin} is an integer, it is taken as the bin to be selected
#' (otherwise, an average across bins is used).
#' @param \dots additional arguments that are used in the call to
#' \code{\link{mean}}.
#' @return A list containing items the major and minor axes of the covariance
#' ellipse (\code{ellipseMajor} and \code{ellipseMinor}), the angle of the
#' major axis anticlockwise of the horizontal axis (\code{ellipseAngle}), and
#' the x and y components of the mean velocity (\code{uMean} and \code{vMean}).
#' @author Dan Kelley
#' @examples
#' library(oce)
#' data(adp)
#' a <- velocityStatistics(adp)
#' print(a)
#' t <- seq(0, 2*pi, length.out=100)
#' theta <- a$ellipseAngle * pi / 180
#' y <- a$ellipseMajor * cos(t) * sin(theta) + a$ellipseMinor * sin(t) * cos(theta)
#' x <- a$ellipseMajor * cos(t) * cos(theta) - a$ellipseMinor * sin(t) * sin(theta)
#' plot(adp, which="uv+ellipse+arrow")
#' lines(x, y, col='blue', lty="dashed", lwd=5)
#' arrows(0, 0, a$uMean, a$vMean, lwd=5, length=1/10, col='blue', lty="dashed")
#'
#' @family things related to \code{adp} data
#' @family things related to \code{adv} data
velocityStatistics <- function(x, control, ...)
{
if (inherits(x, "adp")) {
if (!missing(control) && !is.null(control$bin)) {
if (control$bin < 1)
stop("cannot have control$bin less than 1, but got ", control$bin)
max.bin <- dim(x@data$v)[2]
if (control$bin > max.bin)
stop("cannot have control$bin larger than ", max.bin, " but got ", control$bin)
u <- x@data$v[, control$bin, 1]
v <- x@data$v[, control$bin, 2]
} else {
u <- apply(x@data$v[, , 1], 1, mean, na.rm=TRUE) # depth mean
v <- apply(x@data$v[, , 2], 1, mean, na.rm=TRUE) # depth mean
}
} else if (inherits(x, "adv")) {
u <- x@data$v[, 1]
v <- x@data$v[, 2]
}
ok <- !is.na(u) & !is.na(v)
u <- u[ok]
v <- v[ok]
e <- eigen(cov(data.frame(u, v)))
ellipseMajor <- sqrt(e$values[1])
ellipseMinor <- sqrt(e$values[2])
ellipseAngle <- atan2(e$vectors[2, 1], e$vectors[1, 1]) * 45 / atan2(1, 1)
uMean <- mean(u, ...)
vMean <- mean(v, ...)
list(ellipseMajor=ellipseMajor, ellipseMinor=ellipseMinor, ellipseAngle=ellipseAngle,
uMean=uMean, vMean=vMean)
}
#' Change ADV or ADP coordinate systems
#'
#' Convert velocity data from an acoustic-Doppler velocimeter or
#' acoustic-Doppler profiler from one coordinate system to another.
#'
#' @param x an \code{adp} or \code{adv} object, i.e. one inheriting from
#' \code{\link{adp-class}} or \code{\link{adv-class}}.
#' @param \dots extra arguments that are passed on to \code{\link{beamToXyzAdp}}
#' or \code{\link{beamToXyzAdv}}.
#' @return An object of the same type as \code{x}, but with velocities
#' in xyz coordinates instead of beam coordinates.
#' @author Dan Kelley
#'
#' @family things related to \code{adp} data
#' @family things related to \code{adv} data
beamToXyz <- function(x, ...)
{
if (inherits(x, "adp"))
beamToXyzAdp(x, ...)
else if (inherits(x, "adv"))
beamToXyzAdv(x, ...)
else
stop("class of object must inherit from either 'adv' or 'adp'")
}
#' Convert acoustic-Doppler data from xyz coordinates to enu coordinates
#' @param x an \code{adp} or \code{adv} object, i.e. one inheriting from
#' \code{\link{adp-class}} or \code{\link{adv-class}}.
#' @param \dots extra arguments that are passed on to \code{\link{xyzToEnuAdp}}
#' or \code{\link{xyzToEnuAdv}}.
#' @return An object of the same type as \code{x}, but with velocities
#' in east-north-up coordinates instead of xyz coordinates.
#'
#' @family things related to \code{adp} data
#' @family things related to \code{adv} data
xyzToEnu <- function(x, ...)
{
if (inherits(x, "adp"))
xyzToEnuAdp(x=x, ...)
else if (inherits(x, "adv"))
xyzToEnuAdv(x=x, ...)
else
stop("class of object must inherit from either 'adv' or 'adp'")
}
#' Rotate acoustic-Doppler data to a new coordinate system
#' @param x an \code{adp} or \code{adv} object, i.e. one inheriting from
#' \code{\link{adp-class}} or \code{\link{adv-class}}.
#' @param \dots extra arguments that are passed on to \code{\link{enuToOtherAdp}}
#' or \code{\link{enuToOtherAdv}}.
#' @return An object of the same type as \code{x}, but with velocities
#' in the rotated coordinate system
#'
#' @family things related to \code{adp} data
#' @family things related to \code{adv} data
enuToOther <- function(x, ...)
{
if (inherits(x, "adp"))
enuToOtherAdp(x, ...)
else if (inherits(x, "adv"))
enuToOtherAdv(x, ...)
else
stop("class of object must inherit from either 'adv' or 'adp'")
}
#' Rotate acoustic-Doppler data to the enu coordinate system
#' @param x an \code{adp} or \code{adv} object, i.e. one inheriting from
#' \code{\link{adp-class}} or \code{\link{adv-class}}.
#' @param \dots extra arguments that are passed on to \code{\link{toEnuAdp}}
#' or \code{\link{toEnuAdv}}.
#' @return An object of the same type as \code{x}, but with velocities
#' in the enu coordinate system
#'
#' @family things related to \code{adp} data
#' @family things related to \code{adv} data
toEnu <- function(x, ...)
{
if (inherits(x, "adp"))
toEnuAdp(x, ...)
else if (inherits(x, "adv"))
toEnuAdv(x, ...)
else
stop("class of object must inherit from either 'adv' or 'adp'")
}