Description Usage Arguments Details Value Note See Also Examples
Function quiver2D
displays velocity vectors as arrows, using ordinary graphics.
Function quiver2Drgl
displays velocity vectors as arrows using rgl.
Function flowpath
displays the flow paths of particles, based on
velocity vectors.
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  quiver2D(u, ...)
## S3 method for class 'matrix'
quiver2D(u, v, x = NULL, y = NULL,
colvar = NULL, ...,
scale = 1, arr.max = 0.2, arr.min = 0, speed.max = NULL,
by = NULL, type = "triangle", col = NULL, NAcol = "white",
breaks = NULL, colkey = NULL, mask = NULL,
image = FALSE, contour = FALSE,
clim = NULL, clab = NULL,
add = FALSE, plot = TRUE)
## S3 method for class 'array'
quiver2D(u, v, margin = c(1, 2), subset, ask = NULL, ...)
quiver2Drgl (u, v, x = NULL, y = NULL, colvar = NULL, ...,
scale = 1, arr.max = 0.2, arr.min = 0, speed.max = NULL,
by = NULL, type = "triangle",
col = NULL, NAcol = "white", breaks = NULL,
mask = NULL, image = FALSE, contour = FALSE,
colkey = NULL, clim = NULL, clab = NULL, add = FALSE, plot = TRUE)
flowpath(u, v, x = NULL, y = NULL, startx = NULL, starty = NULL, ...,
scale = 1, numarr = 0, arr.length = 0.2, maxstep = 1000,
add = FALSE, plot = TRUE)

u 
A matrix ( 
v 
A matrix ( 
x 
Vector with xcoordinates of the velocities.
If 
y 
Vector with ycoordinates of the velocities. If 
startx 
Vector with the start position in xdirection of the flow paths.
Length > =1. If not specified, then all combinations of 
starty 
Vector with start position in ydirection of flow paths.
Length = length of 
colvar 
The variable used for coloring. It need
not be present, but if specified, it should be a vector of
dimension equal to 
col 
Colors to be used for coloring the arrows as specified by the

NAcol 
Colors to be used for 
breaks 
a set of finite numeric breakpoints for the colors; must have one more breakpoint than color and be in increasing order. Unsorted vectors will be sorted, with a warning. 
scale 
Scaling factor for the arrows.
When 
arr.max 
Maximal size of the arrowhead, in cm (approximately).
The arrows are scaled according to the velocity ( 
arr.min 
Minimal size of the arrowhead, in cm (approximately).
Set 
speed.max 
Speed that corresponds to 
by 
Number increment for plotting the vectors; one value or two (x, y) values.
For example, setting 
colkey 
A logical, The default is to draw the color key on side = 4, i.e. in the right margin.
If 
type 
The type of the arrow head, one of 
contour, image 
If present, then a contour2D or image2D
plot will be added to the quiver plot.
They should be a 
clim 
Only if 
clab 
Only if 
margin 
A vector giving the subscripts which the plotting
function will be applied over.
The plotting function will loop over the index that is not in 
ask 
A logical; if 
add 
If 
mask 
A If 
plot 
If 
numarr 
The number of arrows added on the flow paths. 
arr.length 
Constant size of the arrowhead, in cm (approximately). 
maxstep 
Maximum number of steps for calculating the flow paths. 
... 
Additional arguments passed to the plotting methods (arrows2D), The arguments after ... must be matched exactly. 
subset 
A logical expression indicating over which elements to loop;
missing values are taken as 
S3 function quiver2D
plots vectors specified by u, v
at the coordinates
x, y
.
flowpath
uses the velocities u, v
at the coordinates
x, y
to create trajectories, starting at points
startx, starty
. It can also be used to return the flow path
points by setting plot
equal to FALSE
.
It uses very simple Euler integration and may not be very accurate.
flowpath
returns (as invisible
) a 2column
matrix with the xy coordinates of the flow paths.
Separate flow paths are separated with NA
.
quiver2D
returns (as invisible
) a list
containing the
coordinates of the arrows (x0
, x1
, y0
, y1
),
the color of each arrow (col
), the length of the arrowhead
(length
) and the maximal speed corresponding to arr.max
(speed.max
).
This output can be used e.g. with function arrows.
There was a slight error in the scaling of the arrows in versions previous to 1.0.3, which has been corrected. See last example.
arrows3D for an arrows function from package plot3D
.
vectorplot for plotting velocity vectors as spikes.
Arrows for the arrow function from package shape
on which quiver2D is based.
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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199  ## =======================================================================
## EXAMPLE 1:
## =======================================================================
pm < par("mfrow")
par(mfrow = c(2, 2))
# generate velocities
x < seq(1, 1, by = 0.2)
y < seq(1, 1, by = 0.2)
dx < outer(x, y , function(x, y) y)
dy < outer(x, y , function(x, y) x)
# velocity plot, with legend
F < quiver2D(u = dx, v = dy, x = x, y = y)
legend("topright", bg = "white",
legend = paste("max = ", format(F$speed.max, digits = 2)))
# different color for up/downward pointing arrows
quiver2D(u = dx, v = dy, x = x, y = y, colvar = dx > 0,
col = c("red", "blue"), colkey = FALSE,
arr.max = 0.4, arr.min = 0.1)
# different scale
quiver2D(u = dx, v = dy, x = x, y = y, by = 2, scale = 2)
# three flow paths
flowpath(u = dx, v = dy, x = x, y = y, startx = 0.1, starty = 0.1)
flowpath(u = dx, v = dy, x = x, y = y,
startx = c(0.9, 0.9), starty = c(0.0, 0.0), col = "red",
numarr = 2, add = TRUE)
## =======================================================================
## EXAMPLE 2: note: has changed in version 1.0.3  uses contour2D!
## =======================================================================
par(mfrow = c(1, 1))
x < seq(2, 2, by = 0.2)
y < seq(1, 1, by = 0.2)
z < outer (x, y, function(x, y) x^3  3*x 2*y^2)
contour2D(x, y, z = z, col = jet.col(10))
# gradients in x and ydirection (analytical)
dX < outer(x, y, function(x,y) 3*x^2  3)
dY < outer(x, y, function(x,y) 4*y)
quiver2D(u = dX, v = dY, x = x, y = y, scale = 1, add = TRUE, by = 1)
flowpath(u = dX, v = dY, x = x, y = y, startx = c(2, 1.1),
starty = c(1, 1), add = TRUE, arr.length = 0.5,
col = "darkgreen", lwd = 3, numarr = 1)
## =======================================================================
## EXAMPLE 3:
## =======================================================================
x < y < 1:20
u < outer (x, y, function (x, y) cos(2*pi*y/10))
v < outer (x, y, function (x, y) cos(2*pi*x/10))
quiver2D(x = x, y = y, u = u, v = v, col = "grey")
# flowpaths using all combinations of x and y at edges
flowpath(x = x, y = y, u = u, v = v, add = TRUE,
lwd = 2, col = "orange")
## =======================================================================
## EXAMPLE 4: quiver of an array..
## =======================================================================
x < y < 1:20
u2 < outer (x, y, function (x, y) sin(2*pi*y/10))
v2 < outer (x, y, function (x, y) sin(2*pi*x/10))
# merge u, u2 and v, v2 to create an "array"
U < array(dim = c(dim(u2), 2), data = c(u, u2))
V < array(dim = c(dim(v2), 2), data = c(v, v2))
quiver2D(u = U, v = V, x = x, y = y, main = c("time 1", "time 2"))
# quiver over x and time, for a subset of yvalues:
quiver2D(u = U, v = V, x = x, y = 1:2,
margin = c(1, 3), main = paste("y ", y),
subset = y <= 4)
## Not run:
quiver2D(u = U, v = V, x = x, y = y, ask = TRUE,
mfrow = c(1, 1))
quiver2D(u = U, v = V, x = x, y = 1:2, ask = TRUE,
margin = c(1, 3), main = paste("y ", y),
mfrow = c(1, 1))
## End(Not run)
## =======================================================================
## EXAMPLE 5:
## =======================================================================
par(mfrow = c(1, 1))
image2D(x = 1:nrow(volcano), y = 1:ncol(volcano),
z = volcano, contour = TRUE)
# Assume these are streamfunctions, we calculate the velocity field as:
dx < dy < 1
v < (volcano[1, ]  volcano[nrow(volcano), ] )/dx
u <  (volcano[, 1]  volcano[ ,ncol(volcano)] )/dy
quiver2D(x = 1:nrow(u), y = 1:ncol(v),
u = u, v = v, add = TRUE, by = 3)
flowpath(x = 1:nrow(u), y = 1:ncol(v), numarr = 10,
u = u, v = v, add = TRUE, lwd = 2, col = "grey",
startx = 20, starty = 30)
## =======================================================================
## EXAMPLE 6: boundary mask, images, contours
## =======================================================================
par (mfrow = c(2, 2))
mask < volcano; mask[volcano < 120] < NA
quiver2D(by = c(3, 2), u = u, v = v, mask = mask)
quiver2D(by = c(3, 2), u = u, v = v,
image = list(z = mask, NAcol = "black"))
quiver2D(by = c(4, 3), u = u, v = v,
contour = list(z = volcano, lwd = 2))
quiver2D(by = c(4, 3), u = u, v = v,
contour = list(z = volcano, col = "black"),
image = list(z = volcano, NAcol = "black"))
## =======================================================================
## Same in rgl
## =======================================================================
## Not run:
quiver2Drgl(by = c(3, 2), u = u, v = v, mask = mask, NAcol = "black")
quiver2Drgl(by = c(3, 2), u = u, v = v,
image = list(z = volcano, NAcol = "black"))
quiver2Drgl(by = c(4, 3), u = u, v = v, scale = 2,
contour = list(z = volcano, lwd = 2))
quiver2Drgl(by = c(4, 3), u = u, v = v,
contour = list(z = volcano, col = "black"),
image = list(z = volcano, NAcol = "black"))
cutrgl()
uncutrgl()
## End(Not run)
## =============================================================================
## 2D Data set SyltSurf
## =============================================================================
par(mfrow = c(1, 1))
with (Syltsurf,
quiver2D(x = x, y = y, u = u[ , ,2], v = v[ , ,2],
xlim = c(5, 20), ylim = c(10, 25), by = 3,
main = paste(formatC(time[1]), " hr"), scale = 1.5,
image = list(z = depth, x = x, y = y, NAcol = "black",
colkey = TRUE),
contour = list(z = depth, x = x, y = y, col = "black",
drawlabels = FALSE)
)
)
## =============================================================================
## 2D Data set SyltSurf, several time points
## =============================================================================
# now for an array (first and 4th time point only)
ii < c(1, 4)
with (Syltsurf,
quiver2D(x = x, y = y, u = u[ ,,ii], v = v[ ,,ii],
xlim = c(5, 20), ylim = c(10, 25), by = 4,
mask = list(z = depth, x = x, y = y, NAcol = "blue"),
main = paste(formatC(time[ii]), " hr"), scale = 1.5,
contour = list(z = depth, x = x, y = y, drawlabels = FALSE)
)
)
## =============================================================================
## Adding quivers ...
## =============================================================================
x < 1:2
y < 1:3
u < matrix(1:6,2,3)
v < matrix(6:1,2,3)
par(mfrow = c(1, 1))
A < quiver2D(x = x, y = y, u = u, v = v)
B < quiver2D(x = x, y = y[1], u = u[,1], v = v[,1], col = 2, add = TRUE)
C < quiver2D(x = x, y = y[3], u = u[,3], v = v[,3], col = 3, add = TRUE)
# restore parameter settings
par(mfrow = pm)

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.
Please suggest features or report bugs in the GitHub issue tracker.
All documentation is copyright its authors; we didn't write any of that.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.