quantiles: Quantiles

In tabrasel/WetlandTools: General utility functions for TerrainWorks

Quantiles

Description

Program Quantiles reads a raster file and computes quantiles over a moving circular window. For each iteration of the window, the interquartile range is determined and outliers, based on a Tukey's fence with k = 1.5, are removed. Quartiles are then recalculated using the remaining values. Each pixel of the raster with a value z less than q1 is assigned a value (z-q1)/(q3-q1) and each pixel with a value greater than q3 is assigned a value of (z-q3)/(q3-q1). This shows how many interquartile ranges the pixel value is from the first or third quartile and serves as a measure of how extreme the value is. Quantiles will also output z scores for each pixel.

Usage

quantiles(
  in_raster = "nofile",
  radius = 0,
  buffer = 0,
  out_outlier = "nofile",
  out_q1 = "nofile",
  out_q2 = "nofile",
  out_q3 = "nofile",
  out_mean = "nofile",
  out_zscore = "nofile",
  out_prob = "nofile",
  scratch_dir = "none",
  executable_dir = "none",
  program_name = "quantiles"
)

Arguments

in_raster	Character: The file name (full path) for the input raster.
radius	Numeric (dbl): radius in meters for the moving window
buffer	Numeric (dbl): spacign between moving window center points, in raster cells.
out_outlier	Character: output file name (full path) for the outlier raster (optional)
out_q1	Character: output file name (full path) for the first-quartile raster (optional)
out_q2	Character: output file name (full path) for the median raster (optional)
out_q3	Character: output file name (full path) for the third-quartile raster (optional)
out_mean	Character: output file name (full path) for the mean raster
out_zscore	Character: output file name (full path) for the z-score raster
out_prob	Character: output file name (full path) for the probability raster (optional)
scratch_dir	Charcter: scratch directory
executable_dir	Character: directory where the executable is located
program_name	Character: name of the executable

Value

error code

tabrasel/WetlandTools documentation built on June 1, 2025, 8:07 p.m.