imagep: Plot an image with a colour palette

Description

Plot an image with a colour palette

Usage

imagep(x, y, z, 
      xlim, ylim, zlim, 
      flip.y=FALSE,
      xlab="", ylab="", zlab="",
      breaks, col,
      do.layout=TRUE,
      draw.contours=TRUE,
      draw.time.range=getOption("oce.draw.time.range"),
      mgp=getOption("oce.mgp"),
      mar=c(mgp[1]+if(nchar(xlab)>0) 1.5 else 1, mgp[1]+if(nchar(ylab)>0) 1.5 else 1, mgp[2]+1/2, 1/2),
      xaxs="i",
      yaxs="i",
      cex=par("cex"),
      adorn,
      axes=TRUE,
      debug=getOption("oce.debug"),
      ...)

Arguments

x,y

locations of grid lines along which values of z are measured. The values must be finite, non-missing, and in increasing order.

matrix containing data to be indicated on the plot. dim(z)[1] must equal length(x), and the same for y.

xlim,ylim,zlim

limits on x axis, y axis, and the image values.

flip.y

boolean, with TRUE indicating that the image should be flipped top to bottom (as to produce a profile image for a downward-looking acoustic-doppler profile).

xlab,ylab,zlab

names for x axis, y axis, and the image values.

breaks

the z values for breaks in the colour scheme.

col

either a vector of colours corresponding to the breaks, of length 1 plus the number of breaks, or a function specifying colours, e.g. oce.colors.jet for a rainbow.

do.layout

boolean, TRUE if imagep will be using the layout command to set up space for the image and the palette. If set to FALSE, the user must set the layout first

draw.contours

boolean, TRUE to get contours on the image, and palette, at the colour breaks. Images with a great deal of high-wavenumber variation look poor with contours.

draw.time.range

boolean, only used if the x axis is a time. If TRUE, then an indication of the time range of the data (not the axis) is indicated at the top-left margin of the graph. This is useful because the labels on time axes o

mgp

3-element numerical vector to use for par(mgp), and also for par(mar), computed from this. The default is tighter than the R default, in order to use more space for the data and less for the axes.

mar

value to be used with par("mar").

xaxs

character indicating whether image should extend to edge of x axis (with value "i") or not; see par("xaxs").

yaxs

as xaxs but for y axis.

cex

size of labels on axes and palette; see par("cex").

adorn

optional expression to be performed immediately after drawing the data panel.

axes

logical, set TRUE to get axes on the main image.

debug

a flag that turns on debugging. Set to 1 to get a moderate amount of debugging information, or to 2 to get more.

...

optional arguments passed to plotting functions.

Value

None.

Details

Creates an image with a colour palette to the right. The effect is similar to filled.contour except that with imagep it is possible to set the layout outside the function, which enables the creation of plots with many image-palette panels. Note that the contour lines may not coincide with the colour transitions, in the case of coarse images.

Examples

Run this code

library(oce)
h <- seq(0, 50, length.out=200)
drho <- seq(1, 3, length.out=200)
speed <- sqrt(9.8*outer(drho/1024, h, "*"))
imagep(h, drho, speed, xlab="Equivalent depth [m]",
  ylab=expression(paste(Delta*rho, "[kg/m^3]")),
  zlab="Internal-wave speed [m/s]")