psp

0th

Percentile

Create a Line Segment Pattern

Creates an object of class "psp" representing a line segment pattern in the two-dimensional plane.

Keywords
spatial, datagen
Usage
psp(x0,y0, x1, y1, window, marks=NULL,
        check=spatstat.options("checksegments"))
Arguments
x0
Vector of $x$ coordinates of first endpoint of each segment
y0
Vector of $y$ coordinates of first endpoint of each segment
x1
Vector of $x$ coordinates of second endpoint of each segment
y1
Vector of $y$ coordinates of second endpoint of each segment
window
window of observation, an object of class "owin"
marks
(optional) vector of mark values
check
Logical value indicating whether to check that the line segments lie inside the window.
Details

In the spatstat library, a spatial pattern of line segments is described by an object of class "psp". This function creates such objects.

The vectors x0, y0, x1 and y1 must be numeric vectors of equal length. They are interpreted as the cartesian coordinates of the endpoints of the line segments.

A line segment pattern is assumed to have been observed within a specific region of the plane called the observation window. An object of class "psp" representing a point pattern contains information specifying the observation window. This window must always be specified when creating a point pattern dataset; there is intentionally no default action of ``guessing'' the window dimensions from the data points alone.

The argument window must be an object of class "owin". It is a full description of the window geometry, and could have been obtained from owin or as.owin, or by just extracting the observation window of another dataset, or by manipulating such windows. See owin or the Examples below.

The optional argument marks is given if the line segment pattern is marked, i.e. if each line segment carries additional information. For example, line segments which are classified into two or more different types, or colours, may be regarded as having a mark which identifies which colour they are.

In the current implementation, marks must be a vector, of the same length as x0, which is interpreted so that marks[i] is the mark attached to the $i$th line segment. If the mark is a real number then marks should be a numeric vector, while if the mark takes only a finite number of possible values (e.g. colours or types) then marks should be a factor. See psp.object for a description of the class "psp".

Users would normally invoke psp to create a line segment pattern, and the function as.psp to convert data in another format into a line segment pattern.

Value

  • An object of class "psp" describing a line segment pattern in the two-dimensional plane (see psp.object).

See Also

psp.object, as.psp, owin.object, owin, as.owin

Aliases
  • psp
Examples
X <- psp(runif(20), runif(20), runif(20), runif(20),  window=owin())
Documentation reproduced from package spatstat, version 1.16-2, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.