x3p_add_mask_layer {x3ptools}

Add a layer to the mask

Description

Add a region a mask. The region is specfied as TRUE values in a matrix of the same dimensions as the existing mask. In case no mask exists, one is created.

Usage

x3p_add_mask_layer(x3p, mask, color = "red", annotation = "")

Arguments

x3p

x3p object

mask

logical matrix of the same dimension as the surface matrix. Values of TRUE are assumed to be added in the mask, values of FALSE are being ignored.

color

name or hex value of color

annotation

character value describing the region

Value

x3p object with changed mask