| domain.ppm {spatstat.model} | R Documentation |
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
## S3 method for class 'ppm'
domain(X, ..., from=c("points", "covariates"))
## S3 method for class 'kppm'
domain(X, ..., from=c("points", "covariates"))
## S3 method for class 'dppm'
domain(X, ..., from=c("points", "covariates"))
## S3 method for class 'slrm'
domain(X, ..., from=c("points", "covariates"))
## S3 method for class 'msr'
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. |
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 Window(X).
Exceptions occur for methods related to linear networks.
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.
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").
Author(s)
Adrian Baddeley Adrian.Baddeley@curtin.edu.au, Rolf Turner rolfturner@posteo.net and Ege Rubak rubak@math.aau.dk.
See Also
domain,
domain.quadratcount,
domain.quadrattest,
domain.rmhmodel,
domain.lpp.
Window,
Frame.
Examples
domain(ppm(redwood ~ 1))