38  psp

ImportantDisclaimer

These packages (Note 1) are a one-person project undergoing rapid evolution. Backward compatibility (per Hadley Wickham) is provided as a courtesy rather than a guarantee.

Until further notice, these packages should

  • not be used as a basis for research grant applications,
  • not be cited as an actively maintained tool in a peer-reviewed manuscript,
  • not be used to support or fulfill requirements for pursuing an academic degree.

In addition, work primarily based on these packages (Note 1) should not be presented at academic conferences or similar scholarly venues.

Furthermore, a person’s ability to use these packages (Note 1) does not necessarily imply an understanding of their underlying mechanisms. Accordingly, demonstration of their use alone should not be considered sufficient evidence of expertise, nor should it be credited as a basis for academic promotion or advancement.

These statements do not apply to the contributors (Tip 1) to these packages (Note 1) with respect to their specific contributions.

These statements do not apply when the maintainer of these packages (Note 1), Tingting Zhan, is credited as the first author, the lead author, and/or the corresponding author in a peer-reviewed manuscript, or as the Principal Investigator or Co-Principal Investigator in a research grant application and/or a final research progress report.

These statements are advisory in nature and do not modify or restrict the rights granted under the GNU General Public License https://www.r-project.org/Licenses/.

The function psp() (v3.7.3, GPL (>= 2)) creates a line-segment-pattern (psp.object), i.e., an R object of S3 class 'psp'.

The S3 generic function as.psp() (v3.7.3, GPL (>= 2)) converts R objects of various classes into a line-segment-pattern. Listing 38.1 summarizes the S3 methods for the generic function as.psp() in the spatstat.* family of packages,

Listing 38.1: S3 methods spatstat.*::as.psp.*
Code 
library(spatstat)
.S3methods(generic.function = 'as.psp', all.names = TRUE) |> 
  attr(which = 'info', exact = TRUE) |>
  subset.data.frame(subset = grepl(pattern = '^spatstat\\.', x = from))
#                   visible            from generic  isS4
# as.psp.data.frame    TRUE   spatstat.geom  as.psp FALSE
# as.psp.default       TRUE   spatstat.geom  as.psp FALSE
# as.psp.linnet        TRUE spatstat.linnet  as.psp FALSE
# as.psp.lpp           TRUE spatstat.linnet  as.psp FALSE
# as.psp.matrix        TRUE   spatstat.geom  as.psp FALSE
# as.psp.owin          TRUE   spatstat.geom  as.psp FALSE
# as.psp.psp           TRUE   spatstat.geom  as.psp FALSE

Listing 38.2 summarizes the S3 methods for the class 'psp' in the spatstat.* family of packages,

Listing 38.2: S3 methods spatstat.*::*.psp
Code 
library(spatstat)
.S3methods(class = 'psp', all.names = TRUE) |> 
  attr(which = 'info', exact = TRUE) |>
  subset.data.frame(subset = grepl(pattern = '^spatstat\\.', x = from))
#                   visible             from       generic  isS4
# [.psp                TRUE    spatstat.geom             [ FALSE
# affine.psp           TRUE    spatstat.geom        affine FALSE
# as.data.frame.psp    TRUE    spatstat.geom as.data.frame FALSE
# as.linnet.psp        TRUE  spatstat.linnet     as.linnet FALSE
# as.owin.psp          TRUE    spatstat.geom       as.owin FALSE
# as.ppp.psp           TRUE    spatstat.geom        as.ppp FALSE
# as.psp.psp           TRUE    spatstat.geom        as.psp FALSE
# boundingbox.psp      TRUE    spatstat.geom   boundingbox FALSE
# closing.psp          TRUE    spatstat.geom       closing FALSE
# crossdist.psp        TRUE    spatstat.geom     crossdist FALSE
# density.psp          TRUE spatstat.explore       density FALSE
# dilation.psp         TRUE    spatstat.geom      dilation FALSE
# distfun.psp          TRUE    spatstat.geom       distfun FALSE
# distmap.psp          TRUE    spatstat.geom       distmap FALSE
# domain.psp           TRUE    spatstat.geom        domain FALSE
# edit.psp             TRUE    spatstat.geom          edit FALSE
# erosion.psp          TRUE    spatstat.geom       erosion FALSE
# flipxy.psp           TRUE    spatstat.geom        flipxy FALSE
# head.psp             TRUE    spatstat.geom          head FALSE
# identify.psp         TRUE    spatstat.geom      identify FALSE
# intensity.psp        TRUE    spatstat.geom     intensity FALSE
# is.empty.psp         TRUE    spatstat.geom      is.empty FALSE
# is.marked.psp        TRUE    spatstat.geom     is.marked FALSE
# markformat.psp       TRUE    spatstat.geom    markformat FALSE
# marks.psp            TRUE    spatstat.geom         marks FALSE
# marks<-.psp          TRUE    spatstat.geom       marks<- FALSE
# nndist.psp           TRUE    spatstat.geom        nndist FALSE
# nnfun.psp            TRUE    spatstat.geom         nnfun FALSE
# nobjects.psp         TRUE    spatstat.geom      nobjects FALSE
# nsegments.psp        TRUE    spatstat.geom     nsegments FALSE
# opening.psp          TRUE    spatstat.geom       opening FALSE
# pairdist.psp         TRUE    spatstat.geom      pairdist FALSE
# periodify.psp        TRUE    spatstat.geom     periodify FALSE
# pixellate.psp        TRUE    spatstat.geom     pixellate FALSE
# plot.psp             TRUE    spatstat.geom          plot FALSE
# print.psp            TRUE    spatstat.geom         print FALSE
# rebound.psp          TRUE    spatstat.geom       rebound FALSE
# rescale.psp          TRUE    spatstat.geom       rescale FALSE
# rjitter.psp          TRUE  spatstat.random       rjitter FALSE
# rotate.psp           TRUE    spatstat.geom        rotate FALSE
# rshift.psp           TRUE  spatstat.random        rshift FALSE
# scalardilate.psp     TRUE    spatstat.geom  scalardilate FALSE
# shift.psp            TRUE    spatstat.geom         shift FALSE
# subset.psp           TRUE    spatstat.geom        subset FALSE
# summary.psp          TRUE    spatstat.geom       summary FALSE
# superimpose.psp      TRUE    spatstat.geom   superimpose FALSE
# tail.psp             TRUE    spatstat.geom          tail FALSE
# text.psp             TRUE    spatstat.geom          text FALSE
# unitname.psp         TRUE    spatstat.geom      unitname FALSE
# unitname<-.psp       TRUE    spatstat.geom    unitname<- FALSE
# unmark.psp           TRUE    spatstat.geom        unmark FALSE
# unstack.psp          TRUE    spatstat.geom       unstack FALSE
# Window.psp           TRUE    spatstat.geom        Window FALSE
# Window<-.psp         TRUE    spatstat.geom      Window<- FALSE
Note

The examples in Chapter 38 require

library(groupedHyperframe)

Table 38.1 summarizes the S3 methods for the class 'psp' in package groupedHyperframe (v0.4.0, GPL-2),

Table 38.1: S3 methods groupedHyperframe::*.psp (v0.4.0)
visible generic isS4
append_marks<-.psp FALSE groupedHyperframe::`append_marks<-` FALSE
Math.psp FALSE methods::Math FALSE
Summary.psp FALSE methods::Summary FALSE

38.1 Group-Generic of Numeric Mark(s)

38.1.1 🚧 Math

The S3 method Math.psp() 🚧

38.1.2 🚧 Summary

The S3 method Summary.psp() 🚧

38.2 🚧 Append to (Existing) Marks

The S3 method `append_marks<-.psp` (Section 36.8, Table 36.11) 🚧