File: as.data.frame.lintess.Rd

package info (click to toggle)
r-cran-spatstat.linnet 3.2-5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,664 kB
  • sloc: ansic: 2,107; makefile: 32; sh: 13
file content (65 lines) | stat: -rw-r--r-- 2,280 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
\name{as.data.frame.lintess}
\alias{as.data.frame.lintess}
\title{Convert Network Tessellation to Data Frame}
\description{
  Converts a tessellation on a linear network into a data frame.
}
\usage{
\method{as.data.frame}{lintess}(x, \dots)
}
\arguments{
  \item{x}{
    Tessellation on a linear network (object of class \code{"lintess"}).
  }
  \item{\dots}{Further arguments passed to
    \code{\link[base:as.data.frame]{as.data.frame.default}}
    to determine the row names and other features.
  }
}
\details{
  A tessellation on a linear network is a partition of the
  network into non-overlapping pieces (tiles). Each tile consists of one
  or more line segments which are subsets of the line segments making up
  the network. A tile can consist of several disjoint pieces.

  This function converts the tessellation \code{x} to a data frame.
  Each row of the data frame specifies one sub-segment of the network,
  and allocates it to a particular tile. The data frame has the
  following columns:
  \itemize{
    \item The \code{seg} column specifies which line segment of the network
    contains the sub-segment. Values of \code{seg} are integer indices
    for the network segments in \code{as.psp(as.linnet(x))}.
    \item The \code{t0} and \code{t1} columns specify the start and end points
    of the sub-segment. They are numeric values between 0 and 1
    inclusive, where the values 0 and 1 representing the network vertices
    that are joined by this network segment.
    \item The \code{tile} column specifies which tile of the tessellation
    includes this sub-segment. It is a factor whose 
    levels are the names of the tiles.
  }

  The tessellation may have marks, which are attached to the \emph{tiles}
  of the tessellation. If marks are present, the resulting data frame
  includes columns containing, for each sub-segment,
  the mark value of the corresponding tile.
}
\value{
  A data frame with columns named \code{seg}, \code{t0}, \code{t1},
  \code{tile}, and possibly other columns.
}
\author{
  \spatstatAuthors.
}
\seealso{
  \code{\link{lintess}}
}
\examples{
  X <- lineardirichlet(runiflpp(3, simplenet))
  marks(X) <- letters[1:3]
  as.data.frame(X)
}
\keyword{spatial}
\keyword{methods}
\concept{Linear network}
\concept{Tessellation}