Construct neighbours list from polygon list
The function builds a neighbours list based on regions with contiguous boundaries, that is sharing one or more boundary point. The current function is in part interpreted and may run slowly for many regions or detailed boundaries, but from 0.2-16 should not fail because of lack of memory when single polygons are built of very many border coordinates.
poly2nb(pl, row.names = NULL, snap=sqrt(.Machine$double.eps), queen=TRUE, useC=TRUE, foundInBox=NULL)
- list of polygons of class extending
- character vector of region ids to be added to the neighbours list as attribute
seq(1, nrow(x)); if
region.idattribute, it is copied to the neighbours list.
- boundary points less than
snapdistance apart are considered to indicate contiguity
- if TRUE, a single shared boundary point meets the contiguity condition, if FALSE, more than one shared point is required; note that more than one shared boundary point does not necessarily mean a shared boundary line
- default TRUE, doing the work loop in C, may be set to false to revert to R code calling two C functions in an
n*kwork loop, where
kis the average number of candidate neighbours
- default NULL using R code, possibly parallelised if a snow cluster is available, otherwise a list of length
(n-1)with integer vectors of candidate neighbours
(j > i), or NULL if all candidates were
(j < i)(as created by the
poly_findInBoxGEOSfunction in rgeos for clean polygons)
A neighbours list with class
cardfor details of nb objects.
From 0.5-8, the function includes faster bounding box indexing and other improvements contributed by Micah Altman. If a cluster is provided using
set.ClusterOption, it will be used for finding candidate bounding box overlaps for exact testing for contiguity.
example(columbus) coords <- coordinates(columbus) xx <- poly2nb(columbus) dxx <- diffnb(xx, col.gal.nb) plot(columbus, border="grey") plot(col.gal.nb, coords, add=TRUE) plot(dxx, coords, add=TRUE, col="red") title(main=paste("Differences (red) in Columbus GAL weights (black)", "and polygon generated queen weights", sep="\n")) xxx <- poly2nb(columbus, queen=FALSE) dxxx <- diffnb(xxx, col.gal.nb) plot(columbus, border = "grey") plot(col.gal.nb, coords, add = TRUE) plot(dxxx, coords, add = TRUE, col = "red") title(main=paste("Differences (red) in Columbus GAL weights (black)", "and polygon generated rook weights", sep="\n")) cards <- card(xx) maxconts <- which(cards == max(cards)) if(length(maxconts) > 1) maxconts <- maxconts fg <- rep("grey", length(cards)) fg[maxconts] <- "red" fg[xx[[maxconts]]] <- "green" plot(columbus, col=fg) title(main="Region with largest number of contiguities") example(nc.sids) system.time(xxnb <- poly2nb(nc.sids)) plot(nc.sids) plot(xxnb, coordinates(nc.sids), add=TRUE, col="blue")