saveDynamicChips: saveDynamicChips

View source: R/saveDynamicChips.R

saveDynamicChipsR Documentation

saveDynamicChips

Description

Save chips meant to be generated dynamically to disk.

Usage

saveDynamicChips(
  chipsSF,
  chipSize = 512,
  cellSize = 1,
  outDir,
  mode = "All",
  useExistingDir = FALSE,
  doJitter = FALSE,
  jitterSD = 15,
  useSeed = TRUE,
  seed = 42
)

Arguments

chipsSF

output from defineDynmaicChips().

chipSize

size of chips to generate. Default is 512 (512-by512 cells).

cellSize

cell size of input and output data. Default is 1 m.

outDir

full or relative path to output directory. Must include final forward slash in path.

mode

either "All", "Positive", or "Divided". If "All", all chips and masks are saved. If "Positive", only chips and masks containing positive cells are maintained. if "Divided", background-only and positive-containing chips are saved but written to separate directories. For multiclass, use "All". Default is "All".

useExistingDir

TRUE or FALSE. Whether or not to use a directory that that already contains chips. Default is FALSE.

doJitter

whether or not to add random jitter to center coordinate of chips. Default is FALSE.

jitterSD

standard deviation to use when applying jitter. Default is 15.

useSeed

whether or not to use a random seed when incorporating jitter. Default is TRUE but only applies if using jitter.

seed

random seed value. Default is 42.

Details

Save chips defined by defineDynamicChips() to disk. It is not required to save dynamically generated chips to disk. This is primarily a utility function.

Value

chips and masks written to disk. No R object is returned.


geodl documentation built on Nov. 12, 2025, 5:07 p.m.