chronosphere: mask-RasterArray-methods – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

mask-RasterArray-methods

Methods to mask RasterArray objects, or to mask with them

Description

Additional functions to mask generic function involving the RasterArray class. The following methods are implemented:

Usage

## S4 method for signature 'RasterArray,RasterLayer'
mask(
  x,
  mask,
  inverse = FALSE,
  maskvalue = NA,
  updatevalue = NA,
  updateNA = FALSE,
  ...
)

## S4 method for signature 'RasterArray,RasterArray'
mask(
  x,
  mask,
  inverse = FALSE,
  maskvalue = NA,
  updatevalue = NA,
  updateNA = FALSE,
  ...
)

## S4 method for signature 'RasterArray,Spatial'
mask(x, mask, inverse = FALSE, updatevalue = NA, updateNA = FALSE, ...)

## S4 method for signature 'RasterArray,RasterStackBrick'
mask(
  x,
  mask,
  inverse = FALSE,
  maskvalue = NA,
  updatevalue = NA,
  updateNA = FALSE,
  ...
)

## S4 method for signature 'RasterLayer,RasterArray'
mask(
  x,
  mask,
  filename = "",
  inverse = FALSE,
  maskvalue = NA,
  updatevalue = NA,
  updateNA = FALSE,
  ...
)

## S4 method for signature 'RasterStackBrick,RasterArray'
mask(
  x,
  mask,
  filename = "",
  inverse = FALSE,
  maskvalue = NA,
  updatevalue = NA,
  updateNA = FALSE,
  ...
)

Arguments

`x`	Raster* object
`mask`	Raster* object or a Spatial* object
`inverse`	logical. If `TRUE`, areas on mask that are _not_ the `maskvalue` are masked
`maskvalue`	numeric. The value in `mask` that indicates the cells of `x` that should become `updatevalue (default = NA)`
`updatevalue`	numeric. The value that cells of `x` should become if they are not covered by `mask` (and not `NA`)
`updateNA`	logical. If `TRUE`, `NA` values outside the masked area are also updated to the `updatevalue` (only relevant if the `updatevalue` is not `NA`.
`...`	additional arguments as in `writeRaster`.
`filename`	character. Optional output filename (only if x is a RasterLayer and RasterStackBrick)

Details

RasterArray masked with RasterLayer: every RasterLayer in the stack masked.

RasterArray masked with another RasterArray: one-to-one match between RasterLayers.

RasterArray masked with RasterStack: one-to-one match between RasterLayers.

RasterArray masked with Spatial: all layers masked with an Sp object

RasterLayer masked with RasterArray: layer is masked out iteratively with every member of RasterArray.

Value

A RasterArray or RasterLayer class object (see detaisl above).

Examples

data(dems)

# land
lands <- dems
for(i in 1:length(lands)){
  values(lands[i])[values(lands[i])<0] <- NA
  values(lands[i])[!is.na(values(lands[i]))] <- 1
}

# land topographies
landTopo<- mask(dems, lands)

chronosphere

Earth System History Variables

v0.4.1

CC BY 4.0

Authors

Adam T. Kocsis, Nussaibah B. Raja

Initial release

2021-04-16