This function computes the Delaunay triangulation (and hence the
Dirichlet or Voronoi tesselation) of a planar point set according
to the second (iterative) algorithm of Lee and Schacter ---
see REFERENCES. The triangulation is made to be with respect to
the whole plane by suspending
it from so-called ideal points
(-Inf,-Inf), (Inf,-Inf) (Inf,Inf), and (-Inf,Inf). The triangulation
is also enclosed in a finite rectangular window. A set of dummy
points may be added, in various ways, to the set of data points
being triangulated.
deldir(x, y, dpl=NULL, rw=NULL, eps=1e-09, sort=TRUE, plotit=FALSE,
digits=6, z=NULL, zdum=NULL, suppressMsge=FALSE, …)
These arguments specify the coordinates of the point set being
triangulated or tessellated. These can be given by two separate
arguments x and y which are vectors or by a single argument x
which is either a data frame or a generic list, possibly one of
class ppp
. (See package spatstat
.)
If x
is a data frame then the x
coordinates of the
points to be triangulated or tessellated are taken to be the column
of this data frame which is named “x” if there is one,
else the first column of the data frame which is not named either
“y” or “z”. The y
coordinates are taken to be
the column of this data frame which is named “y” if there is
one. If there is no column named “y” but there are columns
named “x” and “z” then the y
coordinates
are taken to be the first “other” column. If there no
columns named either “x” or “y”, then the x
coordinates are taken to be the first column not named “z”
and the y
coordinates are taken to be the second
column not named “z”.
If there is a column named “z” and if the argument z
(see below) is NULL, then this the column named “z” is taken
to be the value of z
.
If x
is a list (but not a data frame) then it must have
components named x
and y
, and possibly a component
named z
. The x
and y
components give the
x
and y
coordinates respectively of the points to
be triangulated or tessellated. If x
is not of class
ppp
, if it has a component z
and if argument z
is NULL
, then the z
argument is set equal to this
component z
. If x
is of class “ppp”, if
the argument z
is NULL
, if x
is “marked”
(see package spatstat
) and if the marks of x
are a
vector or a factor (as opposed to a data frame) then the z
argument is set equal to these marks. In this case x
should not have a component z
, and at any rate such
a component would be ignored.
A list describing the structure of the dummy points to be added to the data being triangulated. The addition of these dummy points is effected by the auxiliary function dumpts(). The list may have components:
ndx
: The x-dimension of a rectangular grid; if either
ndx or ndy is null, no grid is constructed.
ndy
: The y-dimension of the aforementioned rectangular
grid.
nrad
: The number of radii or “spokes”, emanating from
each data point, along which dummy points are to be added.
nper
: The number of dummy points per spoke.
fctr
: A numeric “multiplicative factor”
determining the length of each spoke; each spoke is of length equal
to fctr times the mean nearest neighbour distance of the data.
(This distance is calculated by the auxiliary function mnnd().)
x
: A vector of x-coordinates of “ad hoc” dummy points
y
: A vector of the corresponding y-coordinates of
“ad hoc” dummy points
The coordinates of the corners of the rectangular window enclosing the triangulation, in the order (xmin, xmax, ymin, ymax). Any data points (including dummy points) outside this window are discarded. If this argument is omitted, it defaults to values given by the range of the data, plus and minus 10 percent.
A value of epsilon used in testing whether a quantity is zero, mainly in the context of whether points are collinear. If anomalous errors arise, it is possible that these may averted by adjusting the value of eps upward or downward.
Logical argument; if TRUE
(the default) the data (including dummy
points) are sorted into a sequence of “bins” prior to triangulation;
this makes the algorithm slightly more efficient. Normally one would
set sort
equal to FALSE
only if one wished to observe some of the
fine detail of the way in which adding a point to a data set affected
the triangulation, and therefore wished to make sure that the point
in question was added last. Essentially this argument would get used
only in a de-bugging process.
Logical argument; if TRUE
a plot is produced. The nature
of the plot may be controlled by using the …
argument
to pass appropriate arguments to plot.deldir()
. Without
“further instruction” a plot of the points being triangulated
and of both the triangulation and the tessellation is produced;
The number of decimal places to which all numeric values in the returned list should be rounded. Defaults to 6.
An optional vector of “auxiliary” values or “weights”
associated with the respective points. (NOTE: These
“weights” are values associated with the points and hence
with the tiles of the tessellation produced. They DO NOT
affect the tessellation, i.e. the tessellation produced is the
same as is it would be if there were no weights. The deldir
package DOES NOT do weighted tessellation. The so-called
weights in fact need not be numeric.)
If z
is left NULL
then it is taken to be the third
column of x
, if x
is a data frame or to be the z
component of x
if x
is a generic list. If z
is left NULL
and if x
is of class “ppp” and is
“marked” (see package spatstat
) and if in addition
the marks are atomic (i.e. not a data frame) then z
is taken to be the marks of x
.
Values of z
to be associated with any dummy points that are
created. See Warnings.
Logical scalar indicating whether a message (alerting the user to
changes from previous versions of deldir
) should be
suppressed.
Auxiliary arguments add
, wlines
, wpoints
,
number
, nex
, col
, lty
, pch
,
xlim
, and ylim
(and possibly other plotting parameters)
may be passed to plot.deldir()
through …
if plotit=TRUE
.
A list (of class deldir
), invisible if plotit=TRUE
, with components:
A data frame with 6 columns. The first 4 entries of each row are the
coordinates of the points joined by an edge of a Delaunay triangle,
in the order (x1,y1,x2,y2)
. The last two entries are the indices
of the two points which are joined.
A data frame with 10 columns. The first 4 entries of each
row are the coordinates of the endpoints of one the edges of a
Dirichlet tile, in the order (x1,y1,x2,y2)
. The fifth and
sixth entries, in the columns named ind1
and ind2
,
are the indices of the two points, in the set being triangulated,
which are separated by that edge. The seventh and eighth entries,
in the columns named bp1
and bp2
are logical values.
The entry in column bp1
indicates whether the first endpoint
of the corresponding edge of a Dirichlet tile is a boundary point
(a point on the boundary of the rectangular window). Likewise for
the entry in column bp2
and the second endpoint of the edge.
The nineth and tenth entries, in columns named thirdv1
and thirdv2
are the indices of the respective third
vertices of the Delaunay triangle whose circumcentres constitute
the corresponding endpoints of the edge under consideration.
(The other two vertices of the triangle in question are indexed by
the entries of columns ind1
and ind2
.)
The entries of columns thirdv1
and thirdv2
may (also)
take the values $-1, -2, -3$, and $-4$. This will be the case
if the circumcentre in question lies outside of the rectangular
window rw
. In these circumstances the corresponding
endpoint of the tile edge is the intersection of the line joining
the two circumcentres with the boundary of rw
, and the
numeric value of the entry of column “thirdv1” (respectively
“thirdv2”) indicates which side. The numbering follows the
convention for numbering the sides of a plot region in R
:
1 for the bottom side, 2 for the left hand side, 3 for the top side
and 4 for the right hand side.
Note that the entry in column thirdv1
will be negative if and
only if the corresponding entry in column bp1
is TRUE
.
Similarly for columns thirdv2
and bp2
.
a data frame with 9, 10 or 11 columns and n.data + n.dum
rows
(see below). The rows correspond to the points in the set being
triangulated. Note that the row names are the indices of the points
in the orginal sequence of points being triangulated/tessellated.
Usually these will be the sequence 1, 2, ..., npd ("n plus dummy").
However if there were duplicated points then the row name
corresponding to a point is the first of the indices of
the set of duplicated points in which the given point appears.
The columns are:
x
(the \(x\)-coordinate of the point)
y
(the \(y\)-coordinate of the point)
pt.type
(a character vector with entries “data”
and “dummy”; present only if n.dum > 0
)
z
(the auxiliary values or “weights”; present
only if these were specified)
n.tri
(the number of Delaunay triangles emanating from
the point)
del.area
(1/3 of the total area of all the Delaunay
triangles emanating from the point)
del.wts
(the corresponding entry of the del.area
column divided by the sum of this column)
n.tside
(the number of sides --- within the rectangular
window --- of the Dirichlet tile surrounding the point)
nbpt
(the number of points in which the Dirichlet tile
intersects the boundary of the rectangular window)
dir.area
(the area of the Dirichlet tile surrounding
the point)
dir.wts
(the corresponding entry of the dir.area
column divided by the sum of this column).
Note that the factor of 1/3 associated with the del.area column arises because each triangle occurs three times --- once for each corner.
the number of real (as opposed to dummy) points in the set which was
triangulated, with any duplicate points eliminated. The first n.data
rows of summary
correspond to real points.
the number of dummy points which were added to the set being triangulated,
with any duplicate points (including any which duplicate real points)
eliminated. The last n.dum rows of summary
correspond to dummy
points.
the area of the convex hull of the set of points being triangulated,
as formed by summing the del.area
column of summary
.
the area of the rectangular window enclosing the points being triangulated,
as formed by summing the dir.area
column of summary
.
the specification of the corners of the rectangular window enclosing the data, in the order (xmin, xmax, ymin, ymax).
A vector of the indices of the points (x,y) in the
set of coordinates initially supplied (as data points or as dummy
points) to deldir()
before duplicate points (if any) were
removed. These indices are used by triang.list()
.
If ndx >= 2 and ndy >= 2, then the rectangular window IS the convex
hull, and so the values of del.area and dir.area (if the latter is
not NULL
) are identical.
If plotit=TRUE
a plot of the triangulation and/or tessellation
is produced or added to an existing plot.
In the underlying Fortran code, error traps have been set for
17 different errors, which are identified by an error number
nerror
. When one of these traps detects an error, the
value of nerror
is passed back along the call stack to the
R
function deldir()
that calls the Fortran subroutines.
(I.e. to this function, the documentation of which you are
currently reading.) The deldir()
function then prints out a
message and returns (invisibly) a NULL
value. The message
consists only of the value of nerror
. A glossary of the
meanings of the values of nerror
is to be found in the file
err.list
, located in the top level of the package directory
(“folder” if you are a Windoze weenie).
Note that the values 4, 14 and 15 of nerror
do not cause
deldir()
to return a NULL
value but rather cause
a message to be printed, storage (memory) to be re-allocated
(increased) and deldir()
to be re-started so as to take
advantage of the increased amount of storage.
In version 0.1-16
of deldir
a new error trap was
introduced, and this new trap triggers a genuine error and does
so in a direct and perspicuous manner.
This new error trap relates to “triangle problems”. It was
drawn to my attention by Adam Dadvar (on 18 December, 2018) that in
some data sets collinearity problems may cause the “triangle
finding” procedure, used by the algorithm to successively add new
points to a tessellation, to go into an infinite loop. A symptom of
the collinearity is that the vertices of a putative triangle appear
not to be in anticlockwise order irrespective of whether
they are presented in the order i, j, k
or k, j, i
.
The result of this anomaly is that the procedure keeps alternating
between moving to “triangle” i, j, k
and moving to
“triangle” k, j, i
, forever.
The new error trap, set in trifnd
, the triangle finding
subroutine, detects such occurrences of “clockwise in either
orientation” vertices. The trap causes the deldir()
function
to throw an error rather than disappearing into a black hole.
The error is thrown “directly” rather than via passing a
nerror
number back up the call stack. The facility for
triggering an error in this manner was not available when the
deldir
package was originally written. In the reasonably
near future the deldir
package will be adjusted so that all
error traps throw errors in the “direct” manner, and use of
the nerror
numbers will be eliminated.
When an error of the “triangle problems” nature occurs, a
possible remedy is to increase the value of the eps
argument of deldir()
. (See the Examples.) There may
conceiveably be other problems that lead to infinite loops and so I
have put in another error trap to detect whether the procedure has
inspected more triangles than actually exist, and if so to throw
an error.
Note that the strategy of increasing the value of eps
is probably the appropriate one in most (if not all)
of the cases where errors of this nature arise. (Similarly this
strategy is probably the appropriate response to errors with
nerror
equal to 3, 12 and 13.) However it is impossible to
be sure. The intricacy and numerical delicacy of triangulations
is too great for anyone to be able to foresee all the possibilities
that could arise.
If there is any doubt as the appropriateness of the “increase
eps
” strategy, the user is advised to do his or her best to
explore the data set, graphically or by other means, and thereby
determine what is actually going on and why problems are occurring.
The process for determining if points are duplicated
changed between versions 0.1-9 and 0.1-10. Previously there
was an argument frac
for this function, which defaulted
to 0.0001. Points were deemed to be duplicates if the difference
in x
-coordinates was less than frac
times the width
of rw
and y
-coordinates was less than frac
times the height of rw
. This process has been changed to
one which uses duplicated()
on the data frame whose
columns are x
and y
.
As a result it may happen that points which were previously eliminated as duplicates will no longer be eliminated. (And possibly vice-versa.)
The components delsgs
and summary
of the value
returned by deldir()
are now data frames rather than
matrices. The component summary
was changed to allow the
“auxiliary” values z
to be of arbitrary mode (i.e.
not necessarily numeric). The component delsgs
was then
changed for consistency. Note that the other “matrix-like”
component dirsgs
has been a data frame since time immemorial.
A message alerting the user to the foregoing two items is printed
out the first time that deldir()
is called with
suppressMsge=FALSE
in a given session. In succeeding
calls to deldir()
in the same session, no message is printed.
(I.e. the “alerting” message is printed at most once
in any given session.)
The “alerting” message is not produced via the
warning()
function, so suppressWarnings()
will
not suppress its appearance. To effect such suppression
(necessary only on the first call to deldir()
in a
given session) one must set the suppressMsge
argument of
deldir
equal to TRUE
.
If any dummy points are created, and if a vector z
, of
“auxiliary” values or “weights” associated with the
points being triangulated, is supplied, then it is up to the user to
supply the corresponding auxiliary values or weights associated with
the dummy points. These values should be supplied as zdum
.
If zdum
is not supplied then the auxiliary values or weights
associated with the dummy points are all taken to be missing values
(i.e. NA
).
This package is a (straightforward) adaptation of the Splus library section ``delaunay'' to R. That library section is an implementation of the Lee-Schacter algorithm, which was originally written as a stand-alone Fortran program in 1987/88 by Rolf Turner, while with the Division of Mathematics and Statistics, CSIRO, Sydney, Australia. It was re-written as an Splus function (using dynamically loaded Fortran code), by Rolf Turner while visiting the University of Western Australia, May, 1995.
Further revisions were made December 1996. The author gratefully acknowledges the contributions, assistance, and guidance of Mark Berman, of D.M.S., CSIRO, in collaboration with whom this project was originally undertaken. The author also acknowledges much useful advice from Adrian Baddeley, formerly of D.M.S., CSIRO (now Professor of Statistics at Curtin University). Daryl Tingley of the Department of Mathematics and Statistics, University of New Brunswick provided some helpful insight. Special thanks are extended to Alan Johnson, of the Alaska Fisheries Science Centre, who supplied two data sets which were extremely valuable in tracking down some errors in the code.
Don MacQueen, of Lawrence Livermore National Lab, wrote an Splus driver function for the old stand-alone version of this software. That driver, which was available on Statlib, is now deprecated in favour of the current package ``delaunay'' package. Don also collaborated in the preparation of that package.
See the ChangeLog
for information about further revisions
and bug-fixes.
Lee, D. T., and Schacter, B. J. Two algorithms for constructing a Delaunay triangulation, Int. J. Computer and Information Sciences, Vol. 9, No. 3, 1980, pp. 219 -- 242.
Ahuja, N. and Schacter, B. J. (1983). Pattern Models. New York: Wiley.
plot.deldir()
, tile.list()
, triang.list()
# NOT RUN {
x <- c(2.3,3.0,7.0,1.0,3.0,8.0)
y <- c(2.3,3.0,2.0,5.0,8.0,9.0)
# Let deldir() choose the rectangular window.
dxy1 <- deldir(x,y)
# User chooses the rectangular window.
dxy2 <- deldir(x,y,rw=c(0,10,0,10))
# Put dummy points at the corners of the rectangular
# window, i.e. at (0,0), (10,0), (10,10), and (0,10)
dxy3 <- deldir(x,y,dpl=list(ndx=2,ndy=2),rw=c(0,10,0,10))
# Plot the triangulation created (but not the tesselation).
# }
# NOT RUN {
dxy2 <- deldir(x,y,rw=c(0,10,0,10),plot=TRUE,wl='tr')
# }
# NOT RUN {
# Auxiliary values associated with points; 4 dummy points to be
# added so 4 dummy "z-values" provided.
z <- c(1.63,0.79,2.84,1.56,0.22,1.07)
zdum <- rep(42,4)
dxy4 <- deldir(x,y,dpl=list(ndx=2,ndy=2),rw=c(0,10,0,10),z=z,zdum=zdum)
# Example of collinearity error.
# }
# NOT RUN {
dniP <- deldir(niProperties) # Throws an error
# }
# NOT RUN {
dniP <- deldir(niProperties,eps=1e-8) # No error.
# }
Run the code above in your browser using DataLab