| initializeMKDE2D {mkde} | R Documentation |
Set up a 2D MKDE object.
Description
Define the spatial extent and resolution of a 2D MKDE and create an 2D MKDE list object for use in other functions in the package.
Usage
initializeMKDE2D(xLL, xCellSize, nX, yLL, yCellSize, nY)
Arguments
xLL |
Lower bounds of the grid in the x-dimension |
xCellSize |
Cell size in the x-dimension |
nX |
Number of cells in the x-dimension |
yLL |
Lower bounds of the grid in the y-dimension |
yCellSize |
Cell size in the y-dimension |
nY |
Number of cells in the y-dimension |
Details
It is strongly recommended that the same value is used for xCellSize and yCellSize. The grid should be defined so that it covers the area that the animal used, plus a sufficient buffer so that the density is negligable beyond the grid.
Value
A list representing an MKDE object is returned with the following elements:
dimension |
The dimension of the MKDE; that is, 2. |
x |
A grid of points along the x-axis where the cell centers occur. |
y |
A grid of points along the y-axis where the cell centers occur. |
z |
A grid of points along the z-axis where the cell centers occur. For a 2D MKDE z = NA. |
z.min |
A 2D array representing the lower bounds of space in the z-dimension at each x and y coordinate. Defaults to -Inf. |
z.max |
A 2D array representing the upper bounds of space in the z-dimension at each x and y coordinate. Defaults to Inf. |
nx |
Number of cells in the x-dimension. |
ny |
Number of cells in the y-dimension. |
nz |
Number of cells in the z-dimension. For a 2D MKDE nz = 1. |
d |
A 2D array with dimensions (nx, ny) that stores the density. The elements are initialized to NA. |
Author(s)
Jeff A. Tracey, PhD
USGS Western Ecological Research Center, San Diego Field Station
jatracey@usgs.gov
James Sheppard, PhD
San Diego Zoo Institute for Conservation Research
jsheppard@sandiegozoo.org
Examples
library(terra)
fpath <- system.file("extdata", "pandadem.RDS", package="mkde")
pandadem <- terra::readRDS(fpath)
cell.sz <- mean(res(pandadem))
ext <- ext(pandadem)
nx <- ncol(pandadem)
ny <- nrow(pandadem)
mkde.obj <- initializeMKDE2D(ext$xmin, cell.sz, nx, ext$ymin, cell.sz, ny)