Nothing
#' And
#'
#' Performs a logical AND operator on two Boolean raster images.
#'
#' @param input1 Input raster file.
#' @param input2 Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_and <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Not
#'
#' Performs a logical NOT operator on two Boolean raster images.
#'
#' @param input1 Input raster file.
#' @param input2 Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_not <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Or
#'
#' Performs a logical OR operator on two Boolean raster images.
#'
#' @param input1 Input raster file.
#' @param input2 Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_or <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Absolute value
#'
#' Calculates the absolute value of every cell in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_absolute_value <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Add
#'
#' Performs an addition operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_add <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Anova
#'
#' Performs an analysis of variance (ANOVA) test on a raster dataset.
#'
#' @param input Input raster file.
#' @param features Feature definition (or class) raster.
#' @param output Output HTML file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_anova <- function(input, features, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--features=", features))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Arc cos
#'
#' Returns the inverse cosine (arccos) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_arc_cos <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Arc sin
#'
#' Returns the inverse sine (arcsin) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_arc_sin <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Arc tan
#'
#' Returns the inverse tangent (arctan) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_arc_tan <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Arcosh
#'
#' Returns the inverse hyperbolic cosine (arcosh) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_arcosh <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Arsinh
#'
#' Returns the inverse hyperbolic sine (arsinh) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_arsinh <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Artanh
#'
#' Returns the inverse hyperbolic tangent (arctanh) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_artanh <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Atan2
#'
#' Returns the 2-argument inverse tangent (atan2).
#'
#' @param input_y Input y raster file or constant value (rise).
#' @param input_x Input x raster file or constant value (run).
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_atan2 <- function(input_y, input_x, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input_y=", input_y))
args <- paste(args, paste0("--input_x=", input_x))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Attribute correlation
#'
#' Performs a correlation analysis on attribute fields from a vector database.
#'
#' @param input Input vector file.
#' @param output Output HTML file (default name will be based on input file if unspecified).
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_attribute_correlation <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
if (!is.null(output)) {
args <- paste(args, paste0("--output=", output))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Attribute correlation neighbourhood analysis
#'
#' Performs a correlation on two input vector attributes within a neighbourhood search windows.
#'
#' @param input Input vector file.
#' @param field1 First input field name (dependent variable) in attribute table.
#' @param field2 Second input field name (independent variable) in attribute table.
#' @param radius Search Radius (in map units).
#' @param min_points Minimum number of points.
#' @param stat Correlation type; one of 'pearson' (default) and 'spearman'.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_attribute_correlation_neighbourhood_analysis <- function(input, field1, field2, radius=NULL, min_points=NULL, stat="pearson", wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--field1=", field1))
args <- paste(args, paste0("--field2=", field2))
if (!is.null(radius)) {
args <- paste(args, paste0("--radius=", radius))
}
if (!is.null(min_points)) {
args <- paste(args, paste0("--min_points=", min_points))
}
if (!is.null(stat)) {
args <- paste(args, paste0("--stat=", stat))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Attribute histogram
#'
#' Creates a histogram for the field values of a vector's attribute table.
#'
#' @param input Input raster file.
#' @param field Input field name in attribute table.
#' @param output Output HTML file (default name will be based on input file if unspecified).
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_attribute_histogram <- function(input, field, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--field=", field))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Attribute scattergram
#'
#' Creates a scattergram for two field values of a vector's attribute table.
#'
#' @param input Input raster file.
#' @param fieldx Input field name in attribute table for the x-axis.
#' @param fieldy Input field name in attribute table for the y-axis.
#' @param output Output HTML file (default name will be based on input file if unspecified).
#' @param trendline Draw the trendline.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_attribute_scattergram <- function(input, fieldx, fieldy, output, trendline=FALSE, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--fieldx=", fieldx))
args <- paste(args, paste0("--fieldy=", fieldy))
args <- paste(args, paste0("--output=", output))
if (trendline) {
args <- paste(args, "--trendline")
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Ceil
#'
#' Returns the smallest (closest to negative infinity) value that is greater than or equal to the values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_ceil <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Cos
#'
#' Returns the cosine (cos) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_cos <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Cosh
#'
#' Returns the hyperbolic cosine (cosh) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_cosh <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Crispness index
#'
#' Calculates the Crispness Index, which is used to quantify how crisp (or conversely how fuzzy) a probability image is.
#'
#' @param input Input raster file.
#' @param output Optional output html file (default name will be based on input file if unspecified).
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_crispness_index <- function(input, output=NULL, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
if (!is.null(output)) {
args <- paste(args, paste0("--output=", output))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Cross tabulation
#'
#' Performs a cross-tabulation on two categorical images.
#'
#' @param input1 Input raster file 1.
#' @param input2 Input raster file 1.
#' @param output Output HTML file (default name will be based on input file if unspecified).
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_cross_tabulation <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Cumulative distribution
#'
#' Converts a raster image to its cumulative distribution function.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_cumulative_distribution <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Decrement
#'
#' Decreases the values of each grid cell in an input raster by 1.0 (see also InPlaceSubtract).
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_decrement <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Divide
#'
#' Performs a division operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_divide <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Equal to
#'
#' Performs a equal-to comparison operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Exp
#'
#' Returns the exponential (base e) of values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_exp <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Exp2
#'
#' Returns the exponential (base 2) of values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_exp2 <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Floor
#'
#' Returns the largest (closest to positive infinity) value that is less than or equal to the values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_floor <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Greater than
#'
#' Performs a greater-than comparison operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param incl_equals Perform a greater-than-or-equal-to operation.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_greater_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (incl_equals) {
args <- paste(args, "--incl_equals")
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Image autocorrelation
#'
#' Performs Moran's I analysis on two or more input images.
#'
#' @param inputs Input raster files.
#' @param contiguity Contiguity type.
#' @param output Output HTML file (default name will be based on input file if unspecified).
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_image_autocorrelation <- function(inputs, output, contiguity="Rook", wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--inputs=", inputs))
args <- paste(args, paste0("--output=", output))
if (!is.null(contiguity)) {
args <- paste(args, paste0("--contiguity=", contiguity))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Image correlation
#'
#' Performs image correlation on two or more input images.
#'
#' @param inputs Input raster files.
#' @param output Output HTML file (default name will be based on input file if unspecified).
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_image_correlation <- function(inputs, output=NULL, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--inputs=", inputs))
if (!is.null(output)) {
args <- paste(args, paste0("--output=", output))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Image correlation neighbourhood analysis
#'
#' Performs image correlation on two input images neighbourhood search windows.
#'
#' @param input1 Input raster file.
#' @param input2 Input raster file.
#' @param output1 Output correlation (r-value or rho) raster file.
#' @param output2 Output significance (p-value) raster file.
#' @param filter Size of the filter kernel.
#' @param stat Correlation type; one of 'pearson' (default) and 'spearman'.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_image_correlation_neighbourhood_analysis <- function(input1, input2, output1, output2, filter=11, stat="pearson", wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output1=", output1))
args <- paste(args, paste0("--output2=", output2))
if (!is.null(filter)) {
args <- paste(args, paste0("--filter=", filter))
}
if (!is.null(stat)) {
args <- paste(args, paste0("--stat=", stat))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Image regression
#'
#' Performs image regression analysis on two input images.
#'
#' @param input1 Input raster file (independent variable, X).
#' @param input2 Input raster file (dependent variable, Y).
#' @param output Output HTML file for regression summary report.
#' @param out_residuals Output raster regression resdidual file.
#' @param standardize Optional flag indicating whether to standardize the residuals map.
#' @param scattergram Optional flag indicating whether to output a scattergram.
#' @param num_samples Number of samples used to create scattergram.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_image_regression <- function(input1, input2, output, out_residuals=NULL, standardize=FALSE, scattergram=FALSE, num_samples=1000, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(out_residuals)) {
args <- paste(args, paste0("--out_residuals=", out_residuals))
}
if (standardize) {
args <- paste(args, "--standardize")
}
if (scattergram) {
args <- paste(args, "--scattergram")
}
if (!is.null(num_samples)) {
args <- paste(args, paste0("--num_samples=", num_samples))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' In place add
#'
#' Performs an in-place addition operation (input1 += input2).
#'
#' @param input1 Input raster file.
#' @param input2 Input raster file or constant value.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_in_place_add <- function(input1, input2, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' In place divide
#'
#' Performs an in-place division operation (input1 /= input2).
#'
#' @param input1 Input raster file.
#' @param input2 Input raster file or constant value.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_in_place_divide <- function(input1, input2, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' In place multiply
#'
#' Performs an in-place multiplication operation (input1 *= input2).
#'
#' @param input1 Input raster file.
#' @param input2 Input raster file or constant value.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_in_place_multiply <- function(input1, input2, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' In place subtract
#'
#' Performs an in-place subtraction operation (input1 -= input2).
#'
#' @param input1 Input raster file.
#' @param input2 Input raster file or constant value.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_in_place_subtract <- function(input1, input2, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Increment
#'
#' Increases the values of each grid cell in an input raster by 1.0. (see also InPlaceAdd).
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_increment <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Integer division
#'
#' Performs an integer division operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_integer_division <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Is no data
#'
#' Identifies NoData valued pixels in an image.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_is_no_data <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Kappa index
#'
#' Performs a kappa index of agreement (KIA) analysis on two categorical raster files.
#'
#' @param input1 Input classification raster file.
#' @param input2 Input reference raster file.
#' @param output Output HTML file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_kappa_index <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Ks test for normality
#'
#' Evaluates whether the values in a raster are normally distributed.
#'
#' @param input Input raster file.
#' @param output Output HTML file.
#' @param num_samples Number of samples. Leave blank to use whole image.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_ks_test_for_normality <- function(input, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(num_samples)) {
args <- paste(args, paste0("--num_samples=", num_samples))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Less than
#'
#' Performs a less-than comparison operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param incl_equals Perform a less-than-or-equal-to operation.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_less_than <- function(input1, input2, output, incl_equals=FALSE, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (incl_equals) {
args <- paste(args, "--incl_equals")
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' List unique values
#'
#' Lists the unique values contained in a field witin a vector's attribute table.
#'
#' @param input Input raster file.
#' @param field Input field name in attribute table.
#' @param output Output HTML file (default name will be based on input file if unspecified).
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_list_unique_values <- function(input, field, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--field=", field))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Ln
#'
#' Returns the natural logarithm of values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_ln <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Log10
#'
#' Returns the base-10 logarithm of values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_log10 <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Log2
#'
#' Returns the base-2 logarithm of values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_log2 <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Max
#'
#' Performs a MAX operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_max <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Min
#'
#' Performs a MIN operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_min <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Modulo
#'
#' Performs a modulo operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_modulo <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Multiply
#'
#' Performs a multiplication operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_multiply <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Negate
#'
#' Changes the sign of values in a raster or the 0-1 values of a Boolean raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_negate <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Not equal to
#'
#' Performs a not-equal-to comparison operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_not_equal_to <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Paired sample t test
#'
#' Performs a 2-sample K-S test for significant differences on two input rasters.
#'
#' @param input1 First input raster file.
#' @param input2 Second input raster file.
#' @param output Output HTML file.
#' @param num_samples Number of samples. Leave blank to use whole image.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_paired_sample_t_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(num_samples)) {
args <- paste(args, paste0("--num_samples=", num_samples))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Power
#'
#' Raises the values in grid cells of one rasters, or a constant value, by values in another raster or constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_power <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Principal component analysis
#'
#' Performs a principal component analysis (PCA) on a multi-spectral dataset.
#'
#' @param inputs Input raster files.
#' @param output Output HTML report file.
#' @param num_comp Number of component images to output; <= to num. input images.
#' @param standardized Perform standardized PCA?.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_principal_component_analysis <- function(inputs, output, num_comp=NULL, standardized=FALSE, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--inputs=", inputs))
args <- paste(args, paste0("--output=", output))
if (!is.null(num_comp)) {
args <- paste(args, paste0("--num_comp=", num_comp))
}
if (standardized) {
args <- paste(args, "--standardized")
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Quantiles
#'
#' Transforms raster values into quantiles.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param num_quantiles Number of quantiles.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_quantiles <- function(input, output, num_quantiles=5, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(num_quantiles)) {
args <- paste(args, paste0("--num_quantiles=", num_quantiles))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Random field
#'
#' Creates an image containing random values.
#'
#' @param base Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_random_field <- function(base, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--base=", base))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Random sample
#'
#' Creates an image containing randomly located sample grid cells with unique IDs.
#'
#' @param base Input raster file.
#' @param output Output raster file.
#' @param num_samples Number of samples.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_random_sample <- function(base, output, num_samples=1000, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--base=", base))
args <- paste(args, paste0("--output=", output))
if (!is.null(num_samples)) {
args <- paste(args, paste0("--num_samples=", num_samples))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Raster histogram
#'
#' Creates a histogram from raster values.
#'
#' @param input Input raster file.
#' @param output Output HTML file (default name will be based on input file if unspecified).
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_raster_histogram <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Raster summary stats
#'
#' Measures a rasters min, max, average, standard deviation, num. non-nodata cells, and total.
#'
#' @param input Input raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_raster_summary_stats <- function(input, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Reciprocal
#'
#' Returns the reciprocal (i.e. 1 / z) of values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_reciprocal <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Rescale value range
#'
#' Performs a min-max contrast stretch on an input greytone image.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param out_min_val New minimum value in output image.
#' @param out_max_val New maximum value in output image.
#' @param clip_min Optional lower tail clip value.
#' @param clip_max Optional upper tail clip value.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_rescale_value_range <- function(input, output, out_min_val, out_max_val, clip_min=NULL, clip_max=NULL, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
args <- paste(args, paste0("--out_min_val=", out_min_val))
args <- paste(args, paste0("--out_max_val=", out_max_val))
if (!is.null(clip_min)) {
args <- paste(args, paste0("--clip_min=", clip_min))
}
if (!is.null(clip_max)) {
args <- paste(args, paste0("--clip_max=", clip_max))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Root mean square error
#'
#' Calculates the RMSE and other accuracy statistics.
#'
#' @param input Input raster file.
#' @param base Input base raster file used for comparison.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_root_mean_square_error <- function(input, base, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--base=", base))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Round
#'
#' Rounds the values in an input raster to the nearest integer value.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_round <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Sin
#'
#' Returns the sine (sin) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_sin <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Sinh
#'
#' Returns the hyperbolic sine (sinh) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_sinh <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Square
#'
#' Squares the values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_square <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Square root
#'
#' Returns the square root of the values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_square_root <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Subtract
#'
#' Performs a differencing operation on two rasters or a raster and a constant value.
#'
#' @param input1 Input raster file or constant value.
#' @param input2 Input raster file or constant value.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_subtract <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Tan
#'
#' Returns the tangent (tan) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_tan <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Tanh
#'
#' Returns the hyperbolic tangent (tanh) of each values in a raster.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_tanh <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' To degrees
#'
#' Converts a raster from radians to degrees.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_to_degrees <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' To radians
#'
#' Converts a raster from degrees to radians.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_to_radians <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Trend surface
#'
#' Estimates the trend surface of an input raster file.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param order Polynomial order (1 to 10).
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_trend_surface <- function(input, output, order=1, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(order)) {
args <- paste(args, paste0("--order=", order))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Trend surface vector points
#'
#' Estimates a trend surface from vector points.
#'
#' @param input Input vector Points file.
#' @param field Input field name in attribute table.
#' @param output Output raster file.
#' @param order Polynomial order (1 to 10).
#' @param cell_size Optionally specified cell size of output raster. Not used when base raster is specified.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_trend_surface_vector_points <- function(input, field, output, cell_size, order=1, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--field=", field))
args <- paste(args, paste0("--output=", output))
args <- paste(args, paste0("--cell_size=", cell_size))
if (!is.null(order)) {
args <- paste(args, paste0("--order=", order))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Truncate
#'
#' Truncates the values in a raster to the desired number of decimal places.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param num_decimals Number of decimals left after truncation (default is zero).
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_truncate <- function(input, output, num_decimals=NULL, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(num_decimals)) {
args <- paste(args, paste0("--num_decimals=", num_decimals))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Turning bands simulation
#'
#' Creates an image containing random values based on a turning-bands simulation.
#'
#' @param base Input base raster file.
#' @param output Output file.
#' @param range The field's range, in xy-units, related to the extent of spatial autocorrelation.
#' @param iterations The number of iterations.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_turning_bands_simulation <- function(base, output, range, iterations=1000, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--base=", base))
args <- paste(args, paste0("--output=", output))
args <- paste(args, paste0("--range=", range))
if (!is.null(iterations)) {
args <- paste(args, paste0("--iterations=", iterations))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Two sample ks test
#'
#' Performs a 2-sample K-S test for significant differences on two input rasters.
#'
#' @param input1 First input raster file.
#' @param input2 Second input raster file.
#' @param output Output HTML file.
#' @param num_samples Number of samples. Leave blank to use whole image.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_two_sample_ks_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(num_samples)) {
args <- paste(args, paste0("--num_samples=", num_samples))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Wilcoxon signed rank test
#'
#' Performs a 2-sample K-S test for significant differences on two input rasters.
#'
#' @param input1 First input raster file.
#' @param input2 Second input raster file.
#' @param output Output HTML file.
#' @param num_samples Number of samples. Leave blank to use whole image.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_wilcoxon_signed_rank_test <- function(input1, input2, output, num_samples=NULL, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(num_samples)) {
args <- paste(args, paste0("--num_samples=", num_samples))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Xor
#'
#' Performs a logical XOR operator on two Boolean raster images.
#'
#' @param input1 Input raster file.
#' @param input2 Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_xor <- function(input1, input2, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input1=", input1))
args <- paste(args, paste0("--input2=", input2))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Z scores
#'
#' Standardizes the values in an input raster by converting to z-scores.
#'
#' @param input Input raster file.
#' @param output Output raster file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_z_scores <- function(input, output, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--output=", output))
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
#' Zonal statistics
#'
#' Extracts descriptive statistics for a group of patches in a raster.
#'
#' @param input Input data raster file.
#' @param features Input feature definition raster file.
#' @param output Output raster file.
#' @param stat Statistic to extract, including 'mean', 'median', 'minimum', 'maximum', 'range', 'standard deviation', and 'total'.
#' @param out_table Output HTML Table file.
#' @param wd Changes the working directory.
#' @param verbose_mode Sets verbose mode. If verbose mode is False, tools will not print output messages.
#'
#' @return Returns the tool text outputs.
#' @export
wbt_zonal_statistics <- function(input, features, output=NULL, stat="mean", out_table=NULL, wd=NULL, verbose_mode=FALSE) {
wbt_init()
args <- ""
args <- paste(args, paste0("--input=", input))
args <- paste(args, paste0("--features=", features))
if (!is.null(output)) {
args <- paste(args, paste0("--output=", output))
}
if (!is.null(stat)) {
args <- paste(args, paste0("--stat=", stat))
}
if (!is.null(out_table)) {
args <- paste(args, paste0("--out_table=", out_table))
}
if (!is.null(wd)) {
args <- paste(args, paste0("--wd=", wd))
}
tool_name <- as.character(match.call()[[1]])
wbt_run_tool(tool_name, args, verbose_mode)
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.