Skip to contents

Create and Export mosaics

Source: R/utils_mosaic.R
mosaic_input.Rd

Create and Export mosaics

Usage

mosaic_input(
  mosaic,
  mosaic_pattern = NULL,
  info = TRUE,
  check_16bits = FALSE,
  check_datatype = FALSE,
  ...
)

mosaic_export(mosaic, filename, datatype = NULL, overwrite = FALSE, ...)

Arguments

mosaic

  • For mosaic_input(), a file path to the raster to imported, a matrix, array or a list of SpatRaster objects.

  • For mosaic_export(), an SpatRaster object.

mosaic_pattern

A pattern name to import multiple mosaics into a list.

info

Print the mosaic informations (eg., CRS, extent). Defaults to TRUE

check_16bits

Checks if mosaic has maximum value in the 16-bits format (65535), and replaces it by NA. Defaults to FALSE.

check_datatype

Logical. If TRUE, checks and suggests the appropriate data type based on the raster values.

...

Additional arguments passed to terra::rast() (mosaic_input()) or terra::writeRaster() (mosaic_output())

filename

character. The Output filename.

datatype

The datatype. By default, the function will try to guess the data type that saves more memory usage and file size. See terra::writeRaster() and terra::datatype() for more details.

overwrite

logical. If TRUE, filename is overwritten.

Value

  • mosaic_input() returns an SpatRaster object.

  • mosaic_export() do not return an object.

Details

  • mosaic_input() is a simply wrapper around terra::rast(). It creates a SpatRaster object from scratch, from a filename, or from another object.

  • mosaic_export() is a simply wrapper around terra::writeRaster(). It write a SpatRaster object to a file.

Examples

if (interactive() && requireNamespace("EBImage")) {
library(pliman)

# create an SpatRaster object based on a matrix
x <- system.file("ex/logo.tif", package="terra")
rast <- mosaic_input(x)
mosaic_plot(rast)

# create a temporary filename for the example
f <- file.path(tempdir(), "test.tif")
mosaic_export(rast, f, overwrite=TRUE)
list.files(tempdir())
}