spatstat (version 1.20-5)

as.ppp: Convert Data To Class ppp

Description

Tries to coerce any reasonable kind of data to a point pattern (an object of class "ppp") for use by the spatstat package).

Usage

as.ppp(X, ..., fatal=TRUE)
  ## S3 method for class 'ppp':
as.ppp(X, \dots, fatal=TRUE)
  ## S3 method for class 'quad':
as.ppp(X, \dots, fatal=TRUE)
  ## S3 method for class 'matrix':
as.ppp(X, W=NULL, \dots, fatal=TRUE)
  ## S3 method for class 'data.frame':
as.ppp(X, W=NULL, \dots, fatal=TRUE)
  ## S3 method for class 'default':
as.ppp(X, W=NULL, \dots, fatal=TRUE)

Arguments

X

Data which will be converted into a point pattern

W

Data which define a window for the pattern when X does not contain a window

...

Ignored.

fatal

Logical value. See Details.

Value

• An object of class "ppp" (see ppp.object) describing the point pattern and its window of observation. The value NULL may also be returned; see Details.

Warnings

If the format of spp objects is changed in future versions of the spatial library, then as.ppp may not be able to interpret them. It currently handles all versions of spatial up to 7.1-4.

Details

Converts the dataset X to a point pattern (an object of class "ppp"; see ppp.object for an overview).

This function is normally used to convert an existing point pattern dataset, stored in another format, to the "ppp" format. To create a new point pattern from raw data such as $x,y$ coordinates, it is normally easier to use the creator function ppp.

The dataset X may be:

• an object of class"ppp"
• an object of class"spp"as defined in thespatiallibrary
• an object of class"quad"representing a quadrature scheme (seequad.object)
• a two-column or three-column matrix or data frame
• a structure with entriesx,ywhich are numeric vectors of equal length
• a numeric vector of length 2, interpreted as the coordinates of a single point.

In the last three cases, we need the second argument W which is converted to a window object by the function as.owin. In the first three cases, W will be ignored.

If X is a three-column matrix or data frame, the third column will be interpreted as containing marks, and the result will be a marked point pattern. The argument fatal indicates what to do when W is missing and X contains no information about the window. If fatal=TRUE, a fatal error will be generated; if fatal=FALSE, the value NULL is returned.

An spp object is the representation of a point pattern in the spatial library. Our implementation recognises the following formats:

• a structure with entriesx,yxl,xu,yl,yu
• a structure with entriesx,yandarea, whereareais a structure with entriesxl,xu,yl,yu

(used in spatial versions 1 to 6 and version 7.1 respectively) where x and y are vectors of equal length giving the point coordinates, and xl, xu, yl, yu are numbers giving the dimensions of a rectangular window.

The function as.ppp is generic, with methods for the classes "ppp", "quad", "matrix" and a default method. Point pattern datasets can also be created by the function ppp.

See Also

ppp, ppp.object, as.owin, owin.object

Examples

xy <- matrix(runif(40), ncol=2)
 pp <- as.ppp(xy, c(0,1,0,1))
 
 # Venables-Ripley format
 # check for 'spatial' package
 spatialpath <- .find.package("spatial", quiet=TRUE)
 if(length(spatialpath) != 0) {
   require(spatial)
   towns <- ppinit("towns.dat")
   pp <- as.ppp(towns)   # converted to our format
   detach(package:spatial)
 }