Further options in plot.colourmap

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: spatstat.geom
-Version: 3.2-9.016
+Version: 3.2-9.017
 Date: 2024-05-02
 Title: Geometrical Functionality of the 'spatstat' Family 
 Authors@R: c(person("Adrian", "Baddeley", 

NEWS

@@ -1,4 +1,4 @@
-        CHANGES IN spatstat.geom VERSION 3.2-9.016
+        CHANGES IN spatstat.geom VERSION 3.2-9.017
 
 OVERVIEW
 
@@ -32,6 +32,9 @@ SIGNIFICANT USER-VISIBLE CHANGES
     New argument 'nticks' controls the number of axis tick marks
     when the colourmap is defined on a continuous range of numerical values.
 
+    o plot.colourmap
+    New argument 'box' controls whether a box will be drawn around the colours.
+
     o plot.tess
     Changed the default values for do.col and do.labels
 

R/colourtables.R

@@ -3,7 +3,7 @@
 #
 # support for colour maps and other lookup tables
 #
-# $Revision: 1.51 $ $Date: 2024/05/02 03:50:40 $
+# $Revision: 1.52 $ $Date: 2024/05/02 06:19:31 $
 #
 
 colourmap <- function(col, ..., range=NULL, breaks=NULL, inputs=NULL, gamma=1) {
@@ -247,7 +247,7 @@ plot.colourmap <- local({
   plot.colourmap <- function(x, ..., main,
                              xlim=NULL, ylim=NULL, vertical=FALSE, axis=TRUE,
                              labelmap=NULL, gap=0.25, add=FALSE,
-                             increasing=NULL, nticks=5) {
+                             increasing=NULL, nticks=5, box=NULL) {
     if(missing(main))
       main <- short.deparse(substitute(x))
     stuff <- attr(x, "stuff")
@@ -403,6 +403,12 @@ plot.colourmap <- local({
                                             col=col)),
                       extrargs=imageparams)
     }
+    #' draw box around colours?
+    #' default is TRUE unless drawing blocks of colour with gaps between.
+    if(is.null(box)) box <- !separate
+    if(!isFALSE(box))
+      rect(xlim[1], ylim[1], xlim[2], ylim[2])
+
     if(axis) {
       # ................. draw annotation ..................
       if(!vertical) {

inst/doc/packagesizes.txt

@@ -26,4 +26,4 @@ date version nhelpfiles nobjects ndatasets Rlines srclines
 "2023-10-20" "3.2-7" 451 1203 0 35983 15822
 "2024-01-26" "3.2-8" 452 1204 0 36234 15822
 "2024-02-28" "3.2-9" 452 1209 0 36325 15824
-"2024-05-02" "3.2-9.016" 443 1188 0 35712 15596
+"2024-05-02" "3.2-9.017" 443 1188 0 35718 15596

man/plot.colourmap.Rd

@@ -7,7 +7,7 @@
 \usage{
 \method{plot}{colourmap}(x, ...,
        main, xlim = NULL, ylim = NULL, vertical = FALSE, axis = TRUE,
-       labelmap=NULL, gap=0.25, add=FALSE, increasing=NULL, nticks=5)
+       labelmap=NULL, gap=0.25, add=FALSE, increasing=NULL, nticks=5, box=NULL)
 }
 \arguments{
   \item{x}{Colour map to be plotted. An object of class \code{"colourmap"}.}
@@ -56,6 +56,12 @@
     drawn next to the colour map. Applies only when the colour map
     inputs are numeric values.
   }
+  \item{box}{
+    Optional. Logical value specifying whether to draw a black box
+    around the colour ribbon. Default is \code{box=FALSE} when plotting
+    separate blocks of colour (i.e. when the colourmap is discrete
+    and \code{gap > 0}) and \code{box=TRUE} otherwise.
+  }
 }
 \details{
   This is the plot method for the class \code{"colourmap"}.

man/plot.ppp.Rd

@@ -445,12 +445,16 @@
    colmap <- colourmap(terrain.colors(20), range=ra)
    ## filled plot characters are the codes 21-25
    ## fill colour is indicated by 'bg'
-   sy <- symbolmap(pch=21, bg=colmap, range=ra)
+   ## outline colour is 'fg'
+   sy <- symbolmap(pch=21, bg=colmap, fg=colmap, range=ra)
    plot(longleaf, symap=sy)
 
    ## or more compactly..
    plot(longleaf, bg=terrain.colors(20), pch=21, cex=1)
 
+   ## plot only the colour map (since the symbols have fixed size and shape)
+   plot(longleaf, symap=sy, leg.args=list(colour.only=TRUE))
+
    ## clipping
    plot(humberside)
    B <- owin(c(4810, 5190), c(4180, 4430))