Create an image mask based on a band and provided values to filter pixels of images
read by raster_cube
image_mask(
band,
min = NULL,
max = NULL,
values = NULL,
bits = NULL,
invert = FALSE
)
name of the mask band
minimum value, values between min
and max
will be masked
maximum value, values between min
and max
will be masked
numeric vector; specific values that will be masked.
for bitmasks, extract the given bits (integer vector) with a bitwise AND before filtering the mask values, bit indexes are zero-based
logical; invert mask
Values of the selected mask band can be based on a range (by passing min
and max
) or on a set of values (by passing values
). By default
pixels with mask values contained in the range or in the values are masked out, i.e. set to NA. Setting invert = TRUE
will invert the masking behavior.
Passing values
will override min
and max
.
image_mask("SCL", values = c(3,8,9)) # Sentinel 2 L2A: mask cloud and cloud shadows
image_mask("BQA", bits=4, values=16) # Landsat 8: mask clouds
image_mask("B10", min = 8000, max=65000)
Run the code above in your browser using DataLab