landscapemetrics (version 1.4.4)

unpad_raster: unpad_raster

Description

Adding padding to raster

Usage

unpad_raster(landscape, unpad_raster_cells, return_raster, to_disk)
# S3 method for RasterLayer
unpad_raster(
  landscape,
  unpad_raster_cells = 1,
  return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE)
)
# S3 method for RasterStack
unpad_raster(
  landscape,
  unpad_raster_cells = 1,
  return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE)
)
# S3 method for RasterBrick
unpad_raster(
  landscape,
  unpad_raster_cells = 1,
  return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE)
)
# S3 method for stars
unpad_raster(
  landscape,
  unpad_raster_cells = 1,
  return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE)
)
# S3 method for list
unpad_raster(
  landscape,
  unpad_raster_cells = 1,
  return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE)
)
# S3 method for matrix
unpad_raster(
  landscape,
  unpad_raster_cells = 1,
  return_raster = FALSE,
  to_disk = getOption("to_disk", default = FALSE)
)

Arguments

landscape

Raster* Layer, Stack, Brick or a list of rasterLayers.

unpad_raster_cells

Number of rows and columns added

return_raster

If false, matrix is returned

to_disk

Logical argument, if FALSE results of get_patches are hold in memory. If true, unpad_raster writes temporary files and hence, does not hold everything in memory. Can be set with a global option, e.g. option(to_disk = TRUE).

Value

raster

Details

Removes equally (in all four directions) additional cells around the raster

Examples

# NOT RUN {
lsm_padded <- pad_raster(landscape, pad_raster_cells = 2, pad_raster_value = -1)
unpad_raster(lsm_padded[[1]], unpad_raster_cells = 2)

# }