raster2rgb: Produce an RGB image from a singleband raster file.

View source: R/s2_thumbnails.R

raster2rgbR Documentation

Produce an RGB image from a singleband raster file.

Description

Internal function to create JPEG or PNG images from a singleband raster file. This function is used by s2_thumbnails, and it will be exported when it would be more generalised.

Usage

raster2rgb(
  in_rast,
  out_file = NULL,
  palette = "generic_ndsi_2",
  minval = -1,
  maxval = 1,
  bigtiff = FALSE,
  tmpdir = NA
)

Arguments

in_rast

Path of the input multiband raster.

out_file

(optional) Path of the output RGB JPEG image; if NULL (default), a RasterLayer will be returned.

palette

Path of the palette file to be used (cpt or txt), or character value of a builtin palette ("SCL", "NDVI", the default "generic_ndsi" or "generic_ndsi_2").

minval

(to be implemented) the value corresponding to the minimum value of the palette (for now, only -1 is used). A quantile will be also accepted.

maxval

(to be implemented) the value corresponding to the maximum value of the palette (for now, only 1 is used). A quantile will be also accepted.

bigtiff

(optional) Logical: if TRUE, the creation of a BigTIFF is forced (default is FALSE). This option is used only in the case a GTiff format was chosen.

tmpdir

(optional) Path where intermediate files (VRT) will be created. Default is a temporary directory. If tmpdir is a non-empty folder, a random subdirectory will be used.

Value

The path of the output image; alternatively, the output image as RasterLayer (if out_rast = NULL).

Note

License: GPL 3.0

Author(s)

Luigi Ranghetti, phD (2019)

References

L. Ranghetti, M. Boschetti, F. Nutini, L. Busetto (2020). "sen2r": An R toolbox for automatically downloading and preprocessing Sentinel-2 satellite data. Computers & Geosciences, 139, 104473. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1016/j.cageo.2020.104473")}, URL: https://sen2r.ranghetti.info/.


sen2r documentation built on Nov. 10, 2023, 9:08 a.m.