22  owin

The function owin() (v3.7.3, GPL (>= 2)) creates an observation window in the two-dimensional plane, i.e., an R object of S3 class 'owin' (owin.object). An observation window can be

• rectangle, e.g., that of the point-pattern anemones (Section 9.1);
• polygonal, e.g., that of the point-pattern ants (Section 9.2);
• binary mask, e.g., that of the pixel-image (im, Chapter 18) object gorillas.extra$aspect (Section 9.14).

The S3 generic function as.owin() (v3.7.3, GPL (>= 2)) converts R objects of various classes into an observation window. Listing 22.1 summarizes the S3 methods for the generic function as.owin() in the spatstat.* family of packages,

Listing 22.1: S3 methods spatstat.*::as.owin.*

library(spatstat)
.S3methods(generic.function = 'as.owin', all.names = TRUE) |> 
  attr(which = 'info', exact = TRUE) |>
  subset.data.frame(subset = grepl(pattern = '^spatstat\\.', x = from))

                           visible             from generic  isS4
as.owin.boxx                  TRUE    spatstat.geom as.owin FALSE
as.owin.data.frame            TRUE    spatstat.geom as.owin FALSE
as.owin.default               TRUE    spatstat.geom as.owin FALSE
as.owin.distfun               TRUE    spatstat.geom as.owin FALSE
as.owin.dppm                  TRUE   spatstat.model as.owin FALSE
as.owin.funxy                 TRUE    spatstat.geom as.owin FALSE
as.owin.im                    TRUE    spatstat.geom as.owin FALSE
as.owin.influence.ppm         TRUE   spatstat.model as.owin FALSE
as.owin.kppm                  TRUE   spatstat.model as.owin FALSE
as.owin.layered               TRUE    spatstat.geom as.owin FALSE
as.owin.leverage.ppm          TRUE   spatstat.model as.owin FALSE
as.owin.linearquadratcount    TRUE  spatstat.linnet as.owin FALSE
as.owin.linfun                TRUE  spatstat.linnet as.owin FALSE
as.owin.linnet                TRUE  spatstat.linnet as.owin FALSE
as.owin.lintess               TRUE  spatstat.linnet as.owin FALSE
as.owin.lpp                   TRUE  spatstat.linnet as.owin FALSE
as.owin.lppm                  TRUE  spatstat.linnet as.owin FALSE
as.owin.msr                   TRUE   spatstat.model as.owin FALSE
as.owin.NAobject              TRUE    spatstat.geom as.owin FALSE
as.owin.nnfun                 TRUE    spatstat.geom as.owin FALSE
as.owin.owin                  TRUE    spatstat.geom as.owin FALSE
as.owin.ppm                   TRUE   spatstat.model as.owin FALSE
as.owin.ppp                   TRUE    spatstat.geom as.owin FALSE
as.owin.psp                   TRUE    spatstat.geom as.owin FALSE
as.owin.quad                  TRUE    spatstat.geom as.owin FALSE
as.owin.quadratcount          TRUE    spatstat.geom as.owin FALSE
as.owin.quadrattest           TRUE spatstat.explore as.owin FALSE
as.owin.rmhmodel              TRUE  spatstat.random as.owin FALSE
as.owin.slrm                  TRUE   spatstat.model as.owin FALSE
as.owin.tess                  TRUE    spatstat.geom as.owin FALSE

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

Listing 22.2: S3 methods spatstat.*::*.owin

library(spatstat)
.S3methods(class = 'owin', all.names = TRUE) |> 
  attr(which = 'info', exact = TRUE) |>
  subset.data.frame(subset = grepl(pattern = '^spatstat\\.', x = from))

                    visible            from        generic  isS4
[.owin                 TRUE   spatstat.geom              [ FALSE
affine.owin            TRUE   spatstat.geom         affine FALSE
area.owin              TRUE   spatstat.geom           area FALSE
as.data.frame.owin     TRUE   spatstat.geom  as.data.frame FALSE
as.function.owin       TRUE   spatstat.geom    as.function FALSE
as.im.owin             TRUE   spatstat.geom          as.im FALSE
as.matrix.owin         TRUE   spatstat.geom      as.matrix FALSE
as.owin.owin           TRUE   spatstat.geom        as.owin FALSE
as.psp.owin            TRUE   spatstat.geom         as.psp FALSE
as.tess.owin           TRUE   spatstat.geom        as.tess FALSE
boundingbox.owin       TRUE   spatstat.geom    boundingbox FALSE
boundingcentre.owin    TRUE   spatstat.geom boundingcentre FALSE
boundingcircle.owin    TRUE   spatstat.geom boundingcircle FALSE
boundingradius.owin    TRUE   spatstat.geom boundingradius FALSE
circumradius.owin      TRUE   spatstat.geom   circumradius FALSE
closing.owin           TRUE   spatstat.geom        closing FALSE
connected.owin         TRUE   spatstat.geom      connected FALSE
diameter.owin          TRUE   spatstat.geom       diameter FALSE
dilation.owin          TRUE   spatstat.geom       dilation FALSE
dim.owin               TRUE   spatstat.geom            dim FALSE
distfun.owin           TRUE   spatstat.geom        distfun FALSE
distmap.owin           TRUE   spatstat.geom        distmap FALSE
erosion.owin           TRUE   spatstat.geom        erosion FALSE
fardist.owin           TRUE   spatstat.geom        fardist FALSE
flipxy.owin            TRUE   spatstat.geom         flipxy FALSE
Frame<-.owin           TRUE   spatstat.geom        Frame<- FALSE
harmonise.owin         TRUE   spatstat.geom      harmonise FALSE
harmonize.owin         TRUE   spatstat.geom      harmonize FALSE
is.empty.owin          TRUE   spatstat.geom       is.empty FALSE
nvertices.owin         TRUE   spatstat.geom      nvertices FALSE
opening.owin           TRUE   spatstat.geom        opening FALSE
periodify.owin         TRUE   spatstat.geom      periodify FALSE
pixellate.owin         TRUE   spatstat.geom      pixellate FALSE
plot.owin              TRUE   spatstat.geom           plot FALSE
print.owin             TRUE   spatstat.geom          print FALSE
quantess.owin          TRUE   spatstat.geom       quantess FALSE
rebound.owin           TRUE   spatstat.geom        rebound FALSE
rescale.owin           TRUE   spatstat.geom        rescale FALSE
rotate.owin            TRUE   spatstat.geom         rotate FALSE
rSSIengine.owin        TRUE spatstat.random     rSSIengine FALSE
scalardilate.owin      TRUE   spatstat.geom   scalardilate FALSE
shift.owin             TRUE   spatstat.geom          shift FALSE
shortside.owin         TRUE   spatstat.geom      shortside FALSE
sidelengths.owin       TRUE   spatstat.geom    sidelengths FALSE
summary.owin           TRUE   spatstat.geom        summary FALSE
unitname.owin          TRUE   spatstat.geom       unitname FALSE
unitname<-.owin        TRUE   spatstat.geom     unitname<- FALSE
vertices.owin          TRUE   spatstat.geom       vertices FALSE
volume.owin            TRUE   spatstat.geom         volume FALSE

Package groupedHyperframe (v0.4.0, GPL-2) does not implement any S3 method to the class 'owin'.