spatstat (version 1.56-1)

domain: Extract the Domain of any Spatial Object

Description

Given a spatial object such as a point pattern, in any number of dimensions, this function extracts the spatial domain in which the object is defined.

Usage

domain(X, …)
   # S3 method for ppp
domain(X, …)
   # S3 method for psp
domain(X, …)
   # S3 method for im
domain(X, …)
   # S3 method for ppx
domain(X, …)
   # S3 method for pp3
domain(X, …)
   # S3 method for lpp
domain(X, …)
 # S3 method for ppm
domain(X, …, from=c("points", "covariates"))
 # S3 method for kppm
domain(X, …, from=c("points", "covariates"))
 # S3 method for dppm
domain(X, …, from=c("points", "covariates"))
 # S3 method for lpp
domain(X, …)
 # S3 method for lppm
domain(X, …)
 # S3 method for msr
domain(X, …)
 # S3 method for quad
domain(X, …)
 # S3 method for quadratcount
domain(X, …)
 # S3 method for quadrattest
domain(X, …)
 # S3 method for tess
domain(X, …)
 # S3 method for linfun
domain(X, …)
 # S3 method for lintess
domain(X, …)
 # S3 method for im
domain(X, …)
 # S3 method for layered
domain(X, …)
 # S3 method for distfun
domain(X, …)
 # S3 method for nnfun
domain(X, …)
 # S3 method for funxy
domain(X, …)
 # S3 method for rmhmodel
domain(X, …)
 # S3 method for leverage.ppm
domain(X, …)
 # S3 method for influence.ppm
domain(X, …)

Arguments

X

A spatial object such as a point pattern (in any number of dimensions), line segment pattern or pixel image.

…

Extra arguments. They are ignored by all the methods listed here.

from

Character string. See Details.

Value

A spatial object representing the domain of X. Typically a window (object of class "owin"), a three-dimensional box ("box3"), a multidimensional box ("boxx") or a linear network ("linnet").

Details

The function domain is generic.

For a spatial object X in any number of dimensions, domain(X) extracts the spatial domain in which X is defined.

For a two-dimensional object X, typically domain(X) is the same as domain(X).

The exception is that, if X is a point pattern on a linear network (class "lpp") or a point process model on a linear network (class "lppm"), then domain(X) is the linear network on which the points lie, while Window(X) is the two-dimensional window containing the linear network.

The argument from applies when X is a fitted point process model (object of class "ppm", "kppm" or "dppm"). If from="data" (the default), domain extracts the window of the original point pattern data to which the model was fitted. If from="covariates" then domain returns the window in which the spatial covariates of the model were provided.

See Also

Window, Frame

Examples

# NOT RUN {
  domain(cells)
  domain(bei.extra$elev)
  domain(chicago)
# }