SelBox {ClimProjDiags} | R Documentation |
Select spatial region from multidimensional arrays
Description
Subset a spatial region from spatial data giving a vector with the maximum and minimum of latitudes and longitudes of the selected region.
Usage
SelBox(data, lon, lat, region, londim = "lon", latdim = "lat", mask = NULL)
Arguments
data |
An array with minimum two dimensions of latitude and longitude. |
lon |
Numeric vector of longitude locations of the cell centers of the
grid of |
lat |
Numeric vector of latitude locations of the cell centers of the
grid of |
region |
A vector of length four indicating the minimum longitude, the maximum longitude, the minimum latitude and the maximum latitude. |
londim |
A character string indicating the name of the longitudinal dimension. The default value is 'lon'. |
latdim |
A character string indicating the name of the latitudinal dimension. The default value is 'lat'. |
mask |
A matrix with the same spatial dimensions of |
Value
A list of length 4:
$data
, an array with the same dimensions as the inputdata
array, but with spatial dimension reduced to the selectedregion
.$lat
, a vector with the new corresponding latitudes for the selectedregion
.$lon
, a vector with the new corresponding longitudes for the selectedregion
.$mask
, if parametermask
is supplied, an array with reduced length of the dimensions to the selectedregion
. Otherwise, a NULL element is returned.
Examples
# Example with synthetic data:
data <- 1:(20 * 3 * 2 * 4)
dim(data) <- c(lon = 20, lat = 3, time = 2, model = 4)
lon <- seq(2, 40, 2)
lat <- c(1, 5, 10)
a <- SelBox(data = data, lon = lon, lat = lat, region = c(2, 20, 1, 5),
londim = "lon", latdim = "lat", mask = NULL)