stackApply: Apply a function on subsets of a RasterStack or RasterBrick

In raster: Geographic Data Analysis and Modeling

Description

Apply a function on subsets of a RasterStack or RasterBrick. The layers to be combined are indicated with the vector indices. The function used should return a single value, and the number of layers in the output Raster* equals the number of unique values in indices. For example, if you have a RasterStack with 6 layers, you can use indices=c(1,1,1,2,2,2) and fun=sum. This will return a RasterBrick with two layers. The first layer is the sum of the first three layers in the input RasterStack, and the second layer is the sum of the last three layers in the input RasterStack. Indices are recycled such that indices=c(1,2) would also return a RasterBrick with two layers (one based on the odd layers (1,3,5), the other based on the even layers (2,4,6)).

See calc if you want to use a more efficient function that returns multiple layers based on _all_ layers in the Raster* object.

Usage

stackApply(x, indices, fun, filename='', na.rm=TRUE, ...) 

Arguments

x	Raster* object
indices	integer. Vector of length nlayers(x) (shorter vectors are recycled) containing all integer values between 1 and the number of layers of the output Raster*
fun	function that returns a single value, e.g. mean or min, and that takes a na.rm argument (or can pass through arguments via ...)
na.rm	logical. If TRUE, NA cells are removed from calculations
filename	character. Optional output filename
...	additional arguments as for writeRaster

Value

A new Raster* object, and in some cases the side effect of a new file on disk.

See Also

calc, stackSelect

Examples

r <- raster(ncol=10, nrow=10)
values(r) <- 1:ncell(r)
s <- brick(r,r,r,r,r,r)
s <- s * 1:6
b1 <- stackApply(s, indices=c(1,1,1,2,2,2), fun=sum)
b1
b2 <- stackApply(s, indices=c(1,2,3,1,2,3), fun=sum)
b2

Example output

Loading required package: sp
class       : RasterBrick 
dimensions  : 10, 10, 100, 2  (nrow, ncol, ncell, nlayers)
resolution  : 36, 18  (x, y)
extent      : -180, 180, -90, 90  (xmin, xmax, ymin, ymax)
coord. ref. : +proj=longlat +datum=WGS84 
data source : in memory
names       : index_1, index_2 
min values  :       6,      15 
max values  :     600,    1500 

class       : RasterBrick 
dimensions  : 10, 10, 100, 3  (nrow, ncol, ncell, nlayers)
resolution  : 36, 18  (x, y)
extent      : -180, 180, -90, 90  (xmin, xmax, ymin, ymax)
coord. ref. : +proj=longlat +datum=WGS84 
data source : in memory
names       : index_1, index_2, index_3 
min values  :       5,       7,       9 
max values  :     500,     700,     900 

raster documentation built on Jan. 5, 2021, 3:01 a.m.