hiPassThresh: Using high-pass filter and thresholds to filter image

View source: R/hiPassThresh.R

hiPassThreshR Documentation

Using high-pass filter and thresholds to filter image

Description

This function performs a high-pass filter followed by a thresholding procedure in order to select specific cluster of cells.

Usage

hiPassThresh(x, scale.factor, threshold, path.output = NULL,
  do.sieve = TRUE, sieve.mode = "0", sieve.thresh = 4,
  do.shrink.expand = TRUE, expand = 4, do.buf = FALSE,
  buf.size = 1, do.use.temp.HPF = FALSE, do.use.temp.Thresh = FALSE,
  path.save = tempdir(), NoData = -99999, env.rsaga = NULL,
  show.output.on.console = FALSE, quiet = TRUE, ...)

Arguments

x

raster object or input path of file

scale.factor

scale factor

threshold

threshold

path.output

= NULL

do.sieve

= TRUE

sieve.mode

mode of cell-neighborhood, Neumann [0]: the four horizontally and vertically neighboured cells; Moore [1]: all eight adjacent cells. Default: "0"

sieve.thresh

minimum number of cells in a group of adjacent cells (minimum 2). Default: 4

do.shrink.expand

regions with valid data in the input grid can be shrinked or expanded by a certain amount (radius). Default: TRUE

expand

maximum expansion distance (radius). Default: 4 [cells]

do.buf

= FALSE

buf.size

buffer size in cell's value. Default: 1

do.use.temp.HPF

already existing high-pass filter files are used. Default: FALSE

do.use.temp.Thresh

already existing thresholding files are used. Default: FALSE

path.save

output path for saving objects. Default: tempdir()

NoData

no data value. Default: -99999

env.rsaga

environment of SAGA GIS. As default, the environment will be automatically estimated. Default: NULL

show.output.on.console

show output on console. Default: FALSE

quiet

no outputs in console. Default: TRUE

Value

raster object

Note

  • SAGA GIS must be installed.


raff-k/Lslide documentation built on March 29, 2022, 6:52 p.m.