spatstat.geom (version 2.1-0)

Frame: Extract or Change the Containing Rectangle of a Spatial Object

Description

Given a spatial object (such as a point pattern or pixel image) in two dimensions, these functions extract or change the containing rectangle inside which the object is defined.

Usage

Frame(X)
   # S3 method for default
Frame(X)
   Frame(X) <- value
   # S3 method for owin
Frame(X) <- value
   # S3 method for ppp
Frame(X) <- value
   # S3 method for im
Frame(X) <- value
   # S3 method for default
Frame(X) <- value

Arguments

X

A spatial object such as a point pattern, line segment pattern or pixel image.

value

A rectangular window (object of class "owin" of type "rectangle") to be used as the new containing rectangle for X.

Value

The result of Frame is a rectangular window (object of class "owin" of type "rectangle").

The result of Frame<- is the updated object X, of the same class as X.

Details

The functions Frame and Frame<- are generic.

Frame(X) extracts the rectangle inside which X is defined.

Frame(X) <- R changes the rectangle inside which X is defined to the new rectangle R.

See Also

Window

Examples

# NOT RUN {
   Frame(cells)
   X <- demopat
   Frame(X)
   Frame(X) <- owin(c(0, 11000), c(400, 8000))
# }