https://github.com/cran/spatstat
Tip revision: d606122dc24b56ecf537d55eda38f4bf5ac4de1f authored by Adrian Baddeley on 25 October 2010, 10:40:51 UTC
version 1.20-5
version 1.20-5
Tip revision: d606122
contour.im.Rd
\name{contour.im}
\alias{contour.im}
\title{Contour plot of pixel image}
\description{
Generates a contour plot of a pixel image.
}
\usage{
\method{contour}{im}(x, \dots, main, axes=TRUE, add=FALSE)
}
\arguments{
\item{x}{
Pixel image to be plotted.
An object of class \code{"im"}.
}
\item{main}{
Character string to be displayed as the main title.
}
\item{axes}{
Logical. If \code{TRUE}, coordinate axes are plotted
(with tick marks) around a region slightly larger than the image window.
If \code{FALSE}, no axes are plotted,
and a box is drawn tightly around the image window.
Ignored if \code{add=TRUE}.
}
\item{add}{
Logical. If \code{FALSE}, a new plot is created. If \code{TRUE},
the contours are drawn over the existing plot.
}
\item{\dots}{
Other arguments passed to \code{\link{contour.default}}
controlling the contour plot; see Details.
}
}
\details{
This is a method for the generic \code{contour} function,
for objects of the class \code{"im"}.
An object of class \code{"im"} represents a pixel image;
see \code{\link{im.object}}.
This function displays the values of the pixel image \code{x}
as a contour plot on the current plot device,
using equal scales on the \eqn{x} and \eqn{y} axes.
The appearance of the plot can be modified
using any of the arguments listed in the help for
\code{\link{contour.default}}.
Useful ones include:
\describe{
\item{nlevels}{
Number of contour levels to plot.
}
\item{drawlabels}{
Whether to label the contour lines with text.
}
\item{col,lty,lwd}{
Colour, type, and width of contour lines.
}
}
See \code{\link{contour.default}} for a full list of these arguments.
The defaults for any of the abovementioned arguments
can be reset using \code{\link{spatstat.options}}.
}
\value{
none.
}
\examples{
# an image
Z <- setcov(owin())
contour(Z)
contour(Z, axes=FALSE)
}
\seealso{
\code{\link{im.object}},
\code{\link{plot.im}},
\code{\link{persp.im}}
}
\author{Adrian Baddeley
\email{adrian@maths.uwa.edu.au}
\url{http://www.maths.uwa.edu.au/~adrian/}
and Rolf Turner
\email{r.turner@auckland.ac.nz}
}
\keyword{spatial}
\keyword{hplot}