landscapemetrics (version 1.1)

pad_raster: pad_raster

Description

Adding padding to raster

Usage

pad_raster(landscape, pad_raster_value, pad_raster_cells, global,
  return_raster, to_disk)
# S3 method for RasterLayer
pad_raster(landscape, pad_raster_value = -999,
  pad_raster_cells = 1, global = FALSE, return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE))
# S3 method for RasterStack
pad_raster(landscape, pad_raster_value = -999,
  pad_raster_cells = 1, global = FALSE, return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE))
# S3 method for RasterBrick
pad_raster(landscape, pad_raster_value = -999,
  pad_raster_cells = 1, global = FALSE, return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE))
# S3 method for stars
pad_raster(landscape, pad_raster_value = -999,
  pad_raster_cells = 1, global = FALSE, return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE))
# S3 method for list
pad_raster(landscape, pad_raster_value = -999,
  pad_raster_cells = 1, global = FALSE, return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE))
# S3 method for matrix
pad_raster(landscape, pad_raster_value = -999,
  pad_raster_cells = 1, global = FALSE, return_raster = TRUE,
  to_disk = getOption("to_disk", default = FALSE))

Arguments

landscape

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

pad_raster_value

Value of cells added

pad_raster_cells

Number of rows and columns added

global

Only pad around the raster extent or also NA holes "inside"

return_raster

If false, matrix is returned

to_disk

Logical argument, if FALSE results of get_patches are hold in memory. If true, pad_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

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

Examples

# NOT RUN {
pad_raster(landscape, pad_raster_value = -1, pad_raster_cells = 2)

# }