R/rasterize_and_mask.R

Defines functions rasterize_and_mask

Documented in rasterize_and_mask

#' Convert spatial data to raster and mask using a shapefile
#'
#' Function converts gridded spatial data with coordinates (eg. SpatialGrid) to a raster, then applies a spatial mask.
#'
#' @param sgrid Gridded spatial data
#' @param amask Object to use as an area mask (simple features object or one of many sp objects)
#' @param touches Passed to mask().
#' @export

rasterize_and_mask <- function(sgrid, amask, touches = FALSE) {

  if(!(class(sgrid)[1] %in% c("SpatRaster", "SpatRasterDataset", "SpatRasterCollection"))) {
    sgrid <- terra::rast(sgrid)
  }
  return(terra::mask(sgrid, amask, touches = touches))

}
afsc-gap-products/akgfmaps documentation built on April 14, 2025, 7:13 p.m.