x3p_add_mask: Add/Exchange a mask for an x3p object

Description Usage Arguments Value Examples

View source: R/mask_x3p.R

Description

Create a mask for an x3p object in case it does not have a mask yet. Masks are used for overlaying colors on the bullets surface.

Usage

1
x3p_add_mask(x3p, mask = NULL)

Arguments

x3p

x3p object

mask

raster matrix of colors with the same dimensions as the x3p surface. If NULL, an object of the right size will be created.

Value

x3p object with added/changed mask

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
x3p <- x3p_read(system.file("sample-land.x3p", package="x3ptools"))
# x3p file has mask consisting color raster image:
x3p$mask[1:5,1:5]
## Not run: 
logo <- x3p_read(system.file("csafe-logo.x3p", package="x3ptools"))
color_logo <- png::readPNG(system.file("csafe-color.png", package="x3ptools"))
logoplus <- x3p_add_mask(logo, as.raster(color_logo))
x3p_image(logoplus, multiply=50, size = c(741, 419),zoom = 0.5)

## End(Not run)

x3ptools documentation built on Nov. 27, 2021, 1:06 a.m.