R/cut_raster.R

In elpidiofilho/mdsFuncs: Auxiliar functions to pre-process raster data and modelling with machine learning models using caret package

#' cut raster
#' @description cut raster by polygon
#' @param r  raster
#' @param poly mask polygon of sf class
#' @return raster cutted and masked
#' @export
#' @importFrom terra crop mask
#' @examples
#' # cut_raster <- function(r, poly)
cut_raster <- function(r, poly) {
  if (class(r) %in% c("RasterStack", "RasterLayer")) {
    r <- terra::rast(r)
  } else {
    if (class(r) != "SpatRaster") {
      stop("Error : file must be in RasterStack, RasterLayer or SpatRaster format")
    }
  }
  if (class(poly) == "sf" ) {
    poly = terra::vect(poly)
  }
  if (terra::is.polygons(poly) == FALSE) {
    stop("Error : poly must be a  polygon object")
  }

  r1 <- r |>
    terra::crop(poly) |>
    terra::mask(poly)
  return(r1)
}