tsar: scalable time-series computations on 3D raster stacks

Description Usage Arguments Value See Also

View source: R/tsar.R

Description

scalable time-series computations on 3D raster stacks

Usage

1
2
3
4
tsar(raster.name, workers, cores, out.name, out.bandnames = NULL,
  out.dtype = "FLT4S", separate = T, na.in = NA, na.out = -99,
  overwrite = F, verbose = T, nodelist = NULL, bandorder = "BSQ",
  maxmemory = 100, compress_tif = F, mask = NULL)

Arguments

raster.name

a 3D raster object with dimensions in order lines-samples-time

workers

a named list containing the functions for computation

cores

the number of parallel processes per node

out.name

the name of the output. Either a single file or a folder of separate files (determined by parameter separate)

out.bandnames

(optional) the names of the output bands; names are determined from the function names in workers if left empty

out.dtype

the datatype of the written files. See dataType for options.

separate

should the resulting bands be written to individual files? Otherwise a single ENVI block is written.

na.in

the pixel value for NA in raster.name

na.out

the pixel value for NA in the output files

overwrite

should the output files be overwritten if they already exist? If separate all output files are checked

verbose

write detailed information on the progress of function execution?

nodelist

the names of additional server computing nodes accessible via SSH without password

bandorder

the output file pixel arrangement,one of 'BIL', 'BIP' or 'BSQ'

maxmemory

the maximum memory in Mb used per node

compress_tif

should the written GeoTiff files be compressed?

mask

an additional file or raster layer; computations on raster.name are only performed where mask is 1, otherwise NA is returned for all resulting layers

Value

None

See Also

stack, calc, clusterR, makeCluster


johntruckenbrodt/tsar documentation built on Feb. 3, 2018, 8 p.m.