Extension to spatstatLocator

Author: baddstats

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: spatstat.utils
-Version: 3.1-5
-Date: 2025-07-17
+Version: 3.1-5.001
+Date: 2025-07-25
 Title: Utility Functions for 'spatstat'
 Authors@R: c(person("Adrian", "Baddeley", 
                     role = c("aut", "cre"),

NAMESPACE

@@ -177,6 +177,7 @@ export("sideCode")
 export("simplenumber")
 export("simplify.xypolygon")
 export("singlestring")
+export("snapxy")
 export("sortunique")
 export("spatstatLocator")
 export("splat")

NEWS

@@ -1,4 +1,10 @@
 
+        CHANGES IN spatstat.utils VERSION 3.1-5.001
+
+OVERVIEW
+
+    o spatstatLocator now supports `snap' behaviour (rounding).
+
         CHANGES IN spatstat.utils VERSION 3.1-5
 
 OVERVIEW

R/locator.R

@@ -3,7 +3,7 @@
 #'
 #'    Replacement for locator()
 #' 
-#'    $Revision: 1.9 $  $Date: 2023/09/18 08:47:45 $
+#'    $Revision: 1.10 $  $Date: 2025/07/25 06:12:11 $
 
 .spatstatLocatorEnv <- new.env()
 
@@ -29,7 +29,8 @@ queueSpatstatLocator <- function(x, y) {
   return(nrow(locatorqueue))
 }
 
-spatstatLocator <- function(n, type=c("p","l","o","n"), ...) {
+spatstatLocator <- function(n, type=c("p","l","o","n"), ...,
+                            snap.step=NULL, snap.origin=c(0,0)) {
   #' Replacement for locator()
   #' Remedy for failure of locator(type="p") in RStudio
   #' Also allows software testing in non-interactive sessions
@@ -40,6 +41,8 @@ spatstatLocator <- function(n, type=c("p","l","o","n"), ...) {
     navail <- nrow(locatorqueue)
     popoff <- (seq_len(navail) <= n)
     result <- locatorqueue[popoff, , drop=FALSE]
+    if(!is.null(snap.step)) 
+      result[,c("x","y")] <- with(result, snapxy(x, y, snap.step, snap.origin))
     locatorqueue <- locatorqueue[!popoff, , drop=FALSE]
     putSpatstatLocatorQueue(locatorqueue)
     return(as.list(result))
@@ -61,6 +64,8 @@ spatstatLocator <- function(n, type=c("p","l","o","n"), ...) {
   while(i<=n){
     tmp <- locator(n=1)
     if(is.null(tmp)) return(res)
+    if(!is.null(snap.step)) 
+      tmp <- with(tmp, snapxy(x, y, snap.step, snap.origin))
     if(do.points)
       do.call.matched(points.default, append(tmp, argh), extrargs=pointsArgs)
     res$x <- c(res$x,tmp$x)
@@ -74,3 +79,11 @@ spatstatLocator <- function(n, type=c("p","l","o","n"), ...) {
   return(res)
 }
 
+snapxy <- function(x, y, step=c(1,1), origin=c(0,0)) {
+  step <- ensure2vector(step)
+  origin <- ensure2vector(origin)
+  xx <- origin[1] + step[1] * round((x-origin[1])/step[1])
+  yy <- origin[2] + step[2] * round((y-origin[2])/step[2])
+  result <- list(x=xx, y=yy)
+  return(result)
+}

inst/doc/packagesizes.txt

@@ -30,3 +30,4 @@ date version nhelpfiles nobjects ndatasets Rlines srclines
 "2025-03-15" "3.1-3" 42 192 0 3650 2429
 "2025-05-15" "3.1-4" 42 193 0 3689 2462
 "2025-07-17" "3.1-5" 42 194 0 3703 2462
+"2025-07-25" "3.1-5.001" 42 195 0 3716 2462

inst/info/packagesizes.txt

@@ -30,3 +30,4 @@ date version nhelpfiles nobjects ndatasets Rlines srclines
 "2025-03-15" "3.1-3" 42 192 0 3650 2429
 "2025-05-15" "3.1-4" 42 193 0 3689 2462
 "2025-07-17" "3.1-5" 42 194 0 3703 2462
+"2025-07-25" "3.1-5.001" 42 195 0 3716 2462

man/macros/defns.Rd

@@ -50,6 +50,6 @@
 %% ROC paper
 \newcommand{\rocketAuthors}{\adrian, \ege and \suman}
 \newcommand{\rocpapercite}{Baddeley et al (2025)}
-\newcommand{\rocpaper}{Baddeley, A., Rubak, E., Rakshit, S. and Nair, G. (2025) ROC curves for spatial point patterns and presence-absence data. \url{https://doi.org/10.48550/arXiv.2506.03414}.}
+\newcommand{\rocpaper}{Baddeley, A., Rubak, E., Rakshit, S. and Nair, G. (2025) ROC curves for spatial point patterns and presence-absence data. \doi{10.48550/arXiv.2506.03414}.}
 
 

man/spatstat.utils-internal.Rd

@@ -78,6 +78,7 @@
 \alias{short.deparse}
 \alias{sideCode}
 \alias{singlestring}
+\alias{snapxy}
 \alias{sortunique}
 \alias{startinrange}
 \alias{strsplitretain}
@@ -189,6 +190,7 @@ sensiblevarname(guess, fallback, maxlen)
 short.deparse(x, maxlen)
 sideCode(side, what)
 singlestring(s, coll)
+snapxy(x, y, step, origin)
 sortunique(x)
 startinrange(x0, dx, r)
 strsplitretain(x, split)

man/spatstatLocator.Rd

@@ -9,7 +9,8 @@
   \code{RStudio}.
 }
 \usage{
-spatstatLocator(n, type = c("p", "l", "o", "n"), \dots)
+spatstatLocator(n, type = c("p", "l", "o", "n"), \dots,
+                snap.step=NULL, snap.origin=c(0,0))
 }
 \arguments{
   \item{n}{
@@ -23,6 +24,16 @@ spatstatLocator(n, type = c("p", "l", "o", "n"), \dots)
   \item{\dots}{
     Additional graphics parameters used to plot the locations.
   }
+  \item{snap.step}{
+    Optional. Spatial coordinates will be rounded to the nearest
+    multiple of \code{snap.step}. A positive number specifying the step
+    length, or a vector of 2 positive numbers specifying step lengths
+    for the \eqn{x} and \eqn{y} coordinates.
+  }
+  \item{snap.origin}{
+    Optional. Numeric vector of length 2. Coordinates of the origin
+    that will be used when rounding coordinates.
+  }
 }
 \details{
   This is a replacement/workaround for the \code{\link{locator}}
@@ -31,6 +42,9 @@ spatstatLocator(n, type = c("p", "l", "o", "n"), \dots)
 
   See \code{\link[graphics]{locator}} for a description of the
   behaviour.
+
+  If \code{snap.step} is given, then the coordinates of the selected
+  locations will be rounded to the nearest multiple of \code{snap.step}.
 }
 \section{Software Testing}{
   Programmers may like to know that