`whitebox`

Tool MetadataThis vignette provides an introduction to the data sets included in the `whitebox`

package. These data sets contain names, arguments and other metadata for tools available in WhiteboxTools.

These data sets are built to correspond to tool names available in the most recent version of WhiteboxTools and correspond to tools available in the R package.

- Current version:
**2.0.0**

If you have a relatively recent version of WhiteboxTools the version should not be an issue, but the data sets are not dynamically generated from your whitebox installation.

The first data set provides the relationship between tool names in WhiteboxTools and the corresponding exported function in the R package.

It also gives the WhiteboxTools Toolbox name and a brief description.

```
data("wbttools", package = "whitebox")
str(wbttools)
#> 'data.frame': 448 obs. of 4 variables:
#> $ function_name: chr "wbt_absolute_value" "wbt_adaptive_filter" "wbt_add" "wbt_add_point_coordinates_to_table" ...
#> $ tool_name : chr "AbsoluteValue" "AdaptiveFilter" "Add" "AddPointCoordinatesToTable" ...
#> $ toolbox_name : chr "Math and Stats Tools" "Image Processing Tools/Filters" "Math and Stats Tools" "Data Tools" ...
#> $ description : chr "Calculates the absolute value of every cell in a raster." "Performs an adaptive filter on an image." "Performs an addition operation on two rasters or a raster and a constant value." "Modifies the attribute table of a point vector by adding fields containing each point's X and Y coordinates." ...
#> - attr(*, "version")= chr "2.0.0"
```

The `wbttools`

data set is a data.frame with 448 tools and 4 variables

`"tool_name"`

- WhiteboxTools tool name`"toolbox_name"`

- WhiteboxTools toolbox name`"description"`

- Brief description`"function_name"`

- R function name

```
head(wbttools)
#> function_name tool_name
#> 1 wbt_absolute_value AbsoluteValue
#> 2 wbt_adaptive_filter AdaptiveFilter
#> 3 wbt_add Add
#> 4 wbt_add_point_coordinates_to_table AddPointCoordinatesToTable
#> 5 wbt_aggregate_raster AggregateRaster
#> 6 wbt_and And
#> toolbox_name
#> 1 Math and Stats Tools
#> 2 Image Processing Tools/Filters
#> 3 Math and Stats Tools
#> 4 Data Tools
#> 5 GIS Analysis
#> 6 Math and Stats Tools
#> description
#> 1 Calculates the absolute value of every cell in a raster.
#> 2 Performs an adaptive filter on an image.
#> 3 Performs an addition operation on two rasters or a raster and a constant value.
#> 4 Modifies the attribute table of a point vector by adding fields containing each point's X and Y coordinates.
#> 5 Aggregates a raster to a lower resolution.
#> 6 Performs a logical AND operator on two Boolean raster images.
```

The R function naming style differs from the tool names in WhiteboxTools, but the core words are the same.

There are two steps to converting WhiteboxTools to R (if not using `wbttools`

!)

`CamelCase`

tool names change to`snake_case`

R function namesAll R function names have the prefix

`wbt_`

and add`()`

So, `StreamSlopeContinuous`

becomes `wbt_stream_slope_continuous()`

in R, for instance.

The second data set provides details about the options by tool name.

`data("wbttoolparameters", package = "whitebox")`

The `wbttoolparameters`

data set is a *data.frame* with 1710 parameters and 13 variables:

`"function_name"`

- R function name`"tool_name"`

- WhiteboxTools tool name`"name"`

- WhiteboxTools tool parameter name`"flags"`

- flags used to specify parameter on command line; comma-separated`"description"`

- parameter description`"parameter_class"`

- parameter type`"parameter_detail"`

- parameter details; character: data type followed by colon and more specifics, For OptionList possible values, comma-separated (if defined)`"default_value"`

- parameter default value, if any`"optional"`

- parameter “optional” flag; note that some combination of optional parameters may be required for certain conditions`"argument_name"`

- labels for selected subset of`"flags"`

**used as R function argument names**for`wbt_`

functions`"is_input"`

- logical. Classification of ‘input’ parameters`"is_output"`

- logical. Classification of ‘output’ parameters

```
head(wbttoolparameters)
#> function_name tool_name toolbox_name
#> 1 wbt_absolute_value AbsoluteValue Math and Stats Tools
#> 2 wbt_absolute_value AbsoluteValue Math and Stats Tools
#> 3 wbt_adaptive_filter AdaptiveFilter Image Processing Tools/Filters
#> 4 wbt_adaptive_filter AdaptiveFilter Image Processing Tools/Filters
#> 5 wbt_adaptive_filter AdaptiveFilter Image Processing Tools/Filters
#> 6 wbt_adaptive_filter AdaptiveFilter Image Processing Tools/Filters
#> name flags description
#> 1 Input File -i, --input Input raster file.
#> 2 Output File -o, --output Output raster file.
#> 3 Input File -i, --input Input raster file.
#> 4 Output File -o, --output Output raster file.
#> 5 Filter X-Dimension --filterx Size of the filter kernel in the x-direction.
#> 6 Filter Y-Dimension --filtery Size of the filter kernel in the y-direction.
#> default_value optional parameter_class parameter_detail argument_name
#> 1 <NA> FALSE ExistingFile Raster input
#> 2 <NA> FALSE NewFile Raster output
#> 3 <NA> FALSE ExistingFile Raster input
#> 4 <NA> FALSE NewFile Raster output
#> 5 11 TRUE Integer filterx
#> 6 11 TRUE Integer filtery
#> is_input is_output
#> 1 TRUE FALSE
#> 2 FALSE TRUE
#> 3 TRUE FALSE
#> 4 FALSE TRUE
#> 5 FALSE FALSE
#> 6 FALSE FALSE
```

Several fields in this table such as `flags`

and `parameter_type`

are “flattened” relative to the nested `wbt_tool_parameters()`

output.

The nested `parameter_type`

from the JSON result is replaced with two variables in the data set: `parameter_class`

and `parameter_details`

This parameter *data.frame* is useful to construct your own functions with `wbt_run_tool()`

or for inspecting the types of tools that can be run on particular data types.

```
str(wbttoolparameters, max.level = 1)
#> 'data.frame': 1710 obs. of 13 variables:
#> $ function_name : chr "wbt_absolute_value" "wbt_absolute_value" "wbt_adaptive_filter" "wbt_adaptive_filter" ...
#> $ tool_name : chr "AbsoluteValue" "AbsoluteValue" "AdaptiveFilter" "AdaptiveFilter" ...
#> $ toolbox_name : chr "Math and Stats Tools" "Math and Stats Tools" "Image Processing Tools/Filters" "Image Processing Tools/Filters" ...
#> $ name : chr "Input File" "Output File" "Input File" "Output File" ...
#> $ flags : chr "-i, --input" "-o, --output" "-i, --input" "-o, --output" ...
#> $ description : chr "Input raster file." "Output raster file." "Input raster file." "Output raster file." ...
#> $ default_value : chr NA NA NA NA ...
#> $ optional : logi FALSE FALSE FALSE FALSE TRUE TRUE ...
#> $ parameter_class : chr "ExistingFile" "NewFile" "ExistingFile" "NewFile" ...
#> $ parameter_detail: chr "Raster" "Raster" "Raster" "Raster" ...
#> $ argument_name : chr "input" "output" "input" "output" ...
#> $ is_input : logi TRUE FALSE TRUE FALSE FALSE FALSE ...
#> $ is_output : logi FALSE TRUE FALSE TRUE FALSE FALSE ...
#> - attr(*, "version")= chr "2.0.0"
```

You will find that both `tool_name`

and `function_name`

are present, so you can look up by whatever is convenient.

The variable `argument_name`

is processed to be the subset of `flags`

that corresponds to arguments to R functions, which are denoted with `function_name`

.

To find the tools that have an “OptionList” argument with parameter label “variant” (flag: `--variant=`

) we can use `subset()`

```
subset(wbttoolparameters, grepl("OptionList", parameter_class) & grepl("variant", argument_name))
#> function_name tool_name
#> 418 wbt_extract_valleys ExtractValleys
#> 701 wbt_laplacian_filter LaplacianFilter
#> 920 wbt_line_detection_filter LineDetectionFilter
#> 1453 wbt_sobel_filter SobelFilter
#> 1577 wbt_tophat_transform TophatTransform
#> toolbox_name name flags
#> 418 Stream Network Analysis Variant --variant
#> 701 Image Processing Tools/Filters Variant --variant
#> 920 Image Processing Tools/Filters Variant --variant
#> 1453 Image Processing Tools/Filters Variant --variant
#> 1577 Image Processing Tools Variant --variant
#> description
#> 418 Options include 'LQ' (lower quartile), 'JandR' (Johnston and Rosenfeld), and 'PandD' (Peucker and Douglas); default is 'LQ'.
#> 701 Optional variant value. Options include 3x3(1), 3x3(2), 3x3(3), 3x3(4), 5x5(1), and 5x5(2) (default is 3x3(1)).
#> 920 Optional variant value. Options include 'v' (vertical), 'h' (horizontal), '45', and '135' (default is 'v').
#> 1453 Optional variant value. Options include 3x3 and 5x5 (default is 3x3).
#> 1577 Optional variant value. Options include 'white' and 'black'.
#> default_value optional parameter_class
#> 418 LQ FALSE OptionList
#> 701 3x3(1) TRUE OptionList
#> 920 vertical TRUE OptionList
#> 1453 3x3 TRUE OptionList
#> 1577 white TRUE OptionList
#> parameter_detail argument_name is_input
#> 418 LQ, JandR, PandD variant FALSE
#> 701 3x3(1), 3x3(2), 3x3(3), 3x3(4), 5x5(1), 5x5(2) variant FALSE
#> 920 vertical, horizontal, 45, 135 variant FALSE
#> 1453 3x3, 5x5 variant FALSE
#> 1577 white, black variant FALSE
#> is_output
#> 418 FALSE
#> 701 FALSE
#> 920 FALSE
#> 1453 FALSE
#> 1577 FALSE
```

Check out the code that builds the data in `/data-raw/`

on GitHub to see how these objects can be generated for any version of WhiteboxTools that supports JSON output for parameter metadata.

The remainder of this vignette are tables of R function names and tool descriptions from `wbttoolparameters`

, organized by WhiteboxTools toolbox name.

function_name | description |
---|---|

`wbt_add_point_coordinates_to_table()` |
Modifies the attribute table of a point vector by adding fields containing each point’s X and Y coordinates. |

`wbt_clean_vector()` |
Removes null features and lines/polygons with fewer than the required number of vertices. |

`wbt_convert_nodata_to_zero()` |
Converts nodata values in a raster to zero. |

`wbt_convert_raster_format()` |
Converts raster data from one format to another. |

`wbt_csv_points_to_vector()` |
Converts a CSV text file to vector points. |

`wbt_export_table_to_csv()` |
Exports an attribute table to a CSV text file. |

`wbt_join_tables()` |
Merge a vector’s attribute table with another table based on a common field. |

`wbt_lines_to_polygons()` |
Converts vector polylines to polygons. |

`wbt_merge_table_with_csv()` |
Merge a vector’s attribute table with a table contained within a CSV text file. |

`wbt_merge_vectors()` |
Combines two or more input vectors of the same ShapeType creating a single, new output vector. |

`wbt_modify_no_data_value()` |
Converts nodata values in a raster to zero. |

`wbt_multi_part_to_single_part()` |
Converts a vector file containing multi-part features into a vector containing only single-part features. |

`wbt_new_raster_from_base()` |
Creates a new raster using a base image. |

`wbt_polygons_to_lines()` |
Converts vector polygons to polylines. |

`wbt_print_geo_tiff_tags()` |
Prints the tags within a GeoTIFF. |

`wbt_raster_to_vector_lines()` |
Converts a raster lines features into a vector of the POLYLINE shapetype |

`wbt_raster_to_vector_points()` |
Converts a raster dataset to a vector of the POINT shapetype. |

`wbt_raster_to_vector_polygons()` |
Converts a raster dataset to a vector of the POLYGON shapetype. |

`wbt_reinitialize_attribute_table()` |
Reinitializes a vector’s attribute table deleting all fields but the feature ID (FID). |

`wbt_remove_polygon_holes()` |
Removes holes within the features of a vector polygon file. |

`wbt_set_nodata_value()` |
Assign a specified value in an input image to the NoData value. |

`wbt_single_part_to_multi_part()` |
Converts a vector file containing multi-part features into a vector containing only single-part features. |

`wbt_vector_lines_to_raster()` |
Converts a vector containing polylines into a raster. |

`wbt_vector_points_to_raster()` |
Converts a vector containing points into a raster. |

`wbt_vector_polygons_to_raster()` |
Converts a vector containing polygons into a raster. |

function_name | description |
---|---|

`wbt_aggregate_raster()` |
Aggregates a raster to a lower resolution. |

`wbt_block_maximum_gridding()` |
Creates a raster grid based on a set of vector points and assigns grid values using a block maximum scheme. |

`wbt_block_minimum_gridding()` |
Creates a raster grid based on a set of vector points and assigns grid values using a block minimum scheme. |

`wbt_centroid()` |
Calculates the centroid, or average location, of raster polygon objects. |

`wbt_centroid_vector()` |
Identifes the centroid point of a vector polyline or polygon feature or a group of vector points. |

`wbt_clump()` |
Groups cells that form discrete areas, assigning them unique identifiers. |

`wbt_construct_vector_tin()` |
Creates a vector triangular irregular network (TIN) for a set of vector points. |

`wbt_create_hexagonal_vector_grid()` |
Creates a hexagonal vector grid. |

`wbt_create_plane()` |
Creates a raster image based on the equation for a simple plane. |

`wbt_create_rectangular_vector_grid()` |
Creates a rectangular vector grid. |

`wbt_dissolve()` |
Removes the interior, or shared, boundaries within a vector polygon coverage. |

`wbt_eliminate_coincident_points()` |
Removes any coincident, or nearly coincident, points from a vector points file. |

`wbt_extend_vector_lines()` |
Extends vector lines by a specified distance. |

`wbt_extract_nodes()` |
Converts vector lines or polygons into vertex points. |

`wbt_extract_raster_values_at_points()` |
Extracts the values of raster(s) at vector point locations. |

`wbt_filter_raster_features_by_area()` |
Removes small-area features from a raster. |

`wbt_find_lowest_or_highest_points()` |
Locates the lowest and/or highest valued cells in a raster. |

`wbt_idw_interpolation()` |
Interpolates vector points into a raster surface using an inverse-distance weighted scheme. |

`wbt_layer_footprint()` |
Creates a vector polygon footprint of the area covered by a raster grid or vector layer. |

`wbt_medoid()` |
Calculates the medoid for a series of vector features contained in a shapefile. |

`wbt_minimum_bounding_box()` |
Creates a vector minimum bounding rectangle around vector features. |

`wbt_minimum_bounding_circle()` |
Delineates the minimum bounding circle (i.e. smallest enclosing circle) for a group of vectors. |

`wbt_minimum_bounding_envelope()` |
Creates a vector axis-aligned minimum bounding rectangle (envelope) around vector features. |

`wbt_minimum_convex_hull()` |
Creates a vector convex polygon around vector features. |

`wbt_natural_neighbour_interpolation()` |
Creates a raster grid based on Sibson’s natural neighbour method. |

`wbt_nearest_neighbour_gridding()` |
Creates a raster grid based on a set of vector points and assigns grid values using the nearest neighbour. |

`wbt_polygon_area()` |
Calculates the area of vector polygons. |

`wbt_polygon_long_axis()` |
This tool can be used to map the long axis of polygon features. |

`wbt_polygon_perimeter()` |
Calculates the perimeter of vector polygons. |

`wbt_polygon_short_axis()` |
This tool can be used to map the short axis of polygon features. |

`wbt_radial_basis_function_interpolation()` |
Interpolates vector points into a raster surface using a radial basis function scheme. |

`wbt_raster_area()` |
Calculates the area of polygons or classes within a raster image. |

`wbt_raster_cell_assignment()` |
Assign row or column number to cells. |

`wbt_raster_perimeter()` |
Calculates the perimeters of polygons or classes within a raster image. |

`wbt_reclass()` |
Reclassifies the values in a raster image. |

`wbt_reclass_equal_interval()` |
Reclassifies the values in a raster image based on equal-ranges. |

`wbt_reclass_from_file()` |
Reclassifies the values in a raster image using reclass ranges in a text file. |

`wbt_smooth_vectors()` |
Smooths a vector coverage of either a POLYLINE or POLYGON base ShapeType. |

`wbt_tin_gridding()` |
Creates a raster grid based on a triangular irregular network (TIN) fitted to vector points. |

`wbt_vector_hex_binning()` |
Hex-bins a set of vector points. |

`wbt_voronoi_diagram()` |
Creates a vector Voronoi diagram for a set of vector points. |

function_name | description |
---|---|

`wbt_buffer_raster()` |
Maps a distance-based buffer around each non-background (non-zero/non-nodata) grid cell in an input image. |

`wbt_cost_allocation()` |
Identifies the source cell to which each grid cell is connected by a least-cost pathway in a cost-distance analysis. |

`wbt_cost_distance()` |
Performs cost-distance accumulation on a cost surface and a group of source cells. |

`wbt_cost_pathway()` |
Performs cost-distance pathway analysis using a series of destination grid cells. |

`wbt_euclidean_allocation()` |
Assigns grid cells in the output raster the value of the nearest target cell in the input image, measured by the Shih and Wu (2004) Euclidean distance transform. |

`wbt_euclidean_distance()` |
Calculates the Shih and Wu (2004) Euclidean distance transform. |

function_name | description |
---|---|

`wbt_average_overlay()` |
Calculates the average for each grid cell from a group of raster images. |

`wbt_clip()` |
Extract all the features, or parts of features, that overlap with the features of the clip vector. |

`wbt_clip_raster_to_polygon()` |
Clips a raster to a vector polygon. |

`wbt_count_if()` |
Counts the number of occurrences of a specified value in a cell-stack of rasters. |

`wbt_difference()` |
Outputs the features that occur in one of the two vector inputs but not both, i.e. no overlapping features. |

`wbt_erase()` |
Removes all the features, or parts of features, that overlap with the features of the erase vector polygon. |

`wbt_erase_polygon_from_raster()` |
Erases (cuts out) a vector polygon from a raster. |

`wbt_highest_position()` |
Identifies the stack position of the maximum value within a raster stack on a cell-by-cell basis. |

`wbt_intersect()` |
Identifies the parts of features in common between two input vector layers. |

`wbt_line_intersections()` |
Identifies points where the features of two vector line layers intersect. |

`wbt_lowest_position()` |
Identifies the stack position of the minimum value within a raster stack on a cell-by-cell basis. |

`wbt_max_absolute_overlay()` |
Evaluates the maximum absolute value for each grid cell from a stack of input rasters. |

`wbt_max_overlay()` |
Evaluates the maximum value for each grid cell from a stack of input rasters. |

`wbt_merge_line_segments()` |
Merges vector line segments into larger features. |

`wbt_min_absolute_overlay()` |
Evaluates the minimum absolute value for each grid cell from a stack of input rasters. |

`wbt_min_overlay()` |
Evaluates the minimum value for each grid cell from a stack of input rasters. |

`wbt_percent_equal_to()` |
Calculates the percentage of a raster stack that have cell values equal to an input on a cell-by-cell basis. |

`wbt_percent_greater_than()` |
Calculates the percentage of a raster stack that have cell values greater than an input on a cell-by-cell basis. |

`wbt_percent_less_than()` |
Calculates the percentage of a raster stack that have cell values less than an input on a cell-by-cell basis. |

`wbt_pick_from_list()` |
Outputs the value from a raster stack specified by a position raster. |

`wbt_polygonize()` |
Creates a polygon layer from two or more intersecting line features contained in one or more input vector line files. |

`wbt_split_with_lines()` |
Splits the lines or polygons in one layer using the lines in another layer. |

`wbt_sum_overlay()` |
Calculates the sum for each grid cell from a group of raster images. |

`wbt_symmetrical_difference()` |
Outputs the features that occur in one of the two vector inputs but not both, i.e. no overlapping features. |

`wbt_union()` |
Splits vector layers at their overlaps, creating a layer containing all the portions from both input and overlay layers. |

`wbt_update_nodata_cells()` |
Replaces the NoData values in an input raster with the corresponding values contained in a second update layer. |

`wbt_weighted_overlay()` |
Performs a weighted sum on multiple input rasters after converting each image to a common scale. The tool performs a multi-criteria evaluation (MCE). |

`wbt_weighted_sum()` |
Performs a weighted-sum overlay on multiple input raster images. |

function_name | description |
---|---|

`wbt_boundary_shape_complexity()` |
Calculates the complexity of the boundaries of raster polygons. |

`wbt_compactness_ratio()` |
Calculates the compactness ratio (A/P), a measure of shape complexity, for vector polygons. |

`wbt_edge_proportion()` |
Calculate the proportion of cells in a raster polygon that are edge cells. |

`wbt_elongation_ratio()` |
Calculates the elongation ratio for vector polygons. |

`wbt_find_patch_or_class_edge_cells()` |
Finds all cells located on the edge of patch or class features. |

`wbt_hole_proportion()` |
Calculates the proportion of the total area of a polygon’s holes relative to the area of the polygon’s hull. |

`wbt_linearity_index()` |
Calculates the linearity index for vector polygons. |

`wbt_narrowness_index()` |
Calculates the narrowness of raster polygons. |

`wbt_patch_orientation()` |
Calculates the orientation of vector polygons. |

`wbt_perimeter_area_ratio()` |
Calculates the perimeter-area ratio of vector polygons. |

`wbt_radius_of_gyration()` |
Calculates the distance of cells from their polygon’s centroid. |

`wbt_related_circumscribing_circle()` |
Calculates the related circumscribing circle of vector polygons. |

`wbt_shape_complexity_index()` |
Calculates overall polygon shape complexity or irregularity. |

`wbt_shape_complexity_index_raster()` |
Calculates the complexity of raster polygons or classes. |

function_name | description |
---|---|

`wbt_aspect()` |
Calculates an aspect raster from an input DEM. |

`wbt_average_normal_vector_angular_deviation()` |
Calculates the circular variance of aspect at a scale for a DEM. |

`wbt_circular_variance_of_aspect()` |
Calculates the circular variance of aspect at a scale for a DEM. |

`wbt_contours_from_points()` |
Creates a contour coverage from a set of input points. |

`wbt_contours_from_raster()` |
Derives a vector contour coverage from a raster surface. |

`wbt_dev_from_mean_elev()` |
Calculates deviation from mean elevation. |

`wbt_diff_from_mean_elev()` |
Calculates difference from mean elevation (equivalent to a high-pass filter). |

`wbt_directional_relief()` |
Calculates relief for cells in an input DEM for a specified direction. |

`wbt_downslope_index()` |
Calculates the Hjerdt et al. (2004) downslope index. |

`wbt_edge_density()` |
Calculates the density of edges, or breaks-in-slope within DEMs. |

`wbt_elev_above_pit()` |
Calculate the elevation of each grid cell above the nearest downstream pit cell or grid edge cell. |

`wbt_elev_percentile()` |
Calculates the elevation percentile raster from a DEM. |

`wbt_elev_relative_to_min_max()` |
Calculates the elevation of a location relative to the minimum and maximum elevations in a DEM. |

`wbt_elev_relative_to_watershed_min_max()` |
Calculates the elevation of a location relative to the minimum and maximum elevations in a watershed. |

`wbt_embankment_mapping()` |
Maps and/or removes road embankments from an input fine-resolution DEM. |

`wbt_feature_preserving_smoothing()` |
Reduces short-scale variation in an input DEM using a modified Sun et al. (2007) algorithm. |

`wbt_fetch_analysis()` |
Performs an analysis of fetch or upwind distance to an obstacle. |

`wbt_fill_missing_data()` |
Fills NoData holes in a DEM. |

`wbt_find_ridges()` |
Identifies potential ridge and peak grid cells. |

`wbt_hillshade()` |
Calculates a hillshade raster from an input DEM. |

`wbt_horizon_angle()` |
Calculates horizon angle (maximum upwind slope) for each grid cell in an input DEM. |

`wbt_hypsometric_analysis()` |
Calculates a hypsometric curve for one or more DEMs. |

`wbt_hypsometrically_tinted_hillshade()` |
Creates an colour shaded relief image from an input DEM. |

`wbt_map_off_terrain_objects()` |
Maps off-terrain objects in a digital elevation model (DEM). |

`wbt_max_anisotropy_dev()` |
Calculates the maximum anisotropy (directionality) in elevation deviation over a range of spatial scales. |

`wbt_max_anisotropy_dev_signature()` |
Calculates the anisotropy in deviation from mean for points over a range of spatial scales. |

`wbt_max_branch_length()` |
Lindsay and Seibert’s (2013) branch length index is used to map drainage divides or ridge lines. |

`wbt_max_difference_from_mean()` |
Calculates the maximum difference from mean elevation over a range of spatial scales. |

`wbt_max_downslope_elev_change()` |
Calculates the maximum downslope change in elevation between a grid cell and its eight downslope neighbors. |

`wbt_max_elev_dev_signature()` |
Calculates the maximum elevation deviation over a range of spatial scales and for a set of points. |

`wbt_max_elevation_deviation()` |
Calculates the maximum elevation deviation over a range of spatial scales. |

`wbt_min_downslope_elev_change()` |
Calculates the minimum downslope change in elevation between a grid cell and its eight downslope neighbors. |

`wbt_multidirectional_hillshade()` |
Calculates a multi-direction hillshade raster from an input DEM. |

`wbt_multiscale_elevation_percentile()` |
Calculates surface roughness over a range of spatial scales. |

`wbt_multiscale_roughness()` |
Calculates surface roughness over a range of spatial scales. |

`wbt_multiscale_roughness_signature()` |
Calculates the surface roughness for points over a range of spatial scales. |

`wbt_multiscale_std_dev_normals()` |
Calculates surface roughness over a range of spatial scales. |

`wbt_multiscale_std_dev_normals_signature()` |
Calculates the surface roughness for points over a range of spatial scales. |

`wbt_multiscale_topographic_position_image()` |
Creates a multiscale topographic position image from three DEVmax rasters of differing spatial scale ranges. |

`wbt_num_downslope_neighbours()` |
Calculates the number of downslope neighbours to each grid cell in a DEM. |

`wbt_num_upslope_neighbours()` |
Calculates the number of upslope neighbours to each grid cell in a DEM. |

`wbt_pennock_landform_class()` |
Classifies hillslope zones based on slope, profile curvature, and plan curvature. |

`wbt_percent_elev_range()` |
Calculates percent of elevation range from a DEM. |

`wbt_plan_curvature()` |
Calculates a plan (contour) curvature raster from an input DEM. |

`wbt_profile()` |
Plots profiles from digital surface models. |

`wbt_profile_curvature()` |
Calculates a profile curvature raster from an input DEM. |

`wbt_relative_aspect()` |
Calculates relative aspect (relative to a user-specified direction) from an input DEM. |

`wbt_relative_topographic_position()` |
Calculates the relative topographic position index from a DEM. |

`wbt_remove_off_terrain_objects()` |
Removes off-terrain objects from a raster digital elevation model (DEM). |

`wbt_ruggedness_index()` |
Calculates the Riley et al.’s (1999) terrain ruggedness index from an input DEM. |

`wbt_sediment_transport_index()` |
Calculates the sediment transport index. |

`wbt_slope()` |
Calculates a slope raster from an input DEM. |

`wbt_slope_vs_elevation_plot()` |
Creates a slope vs. elevation plot for one or more DEMs. |

`wbt_spherical_std_dev_of_normals()` |
Calculates the spherical standard deviation of surface normals for a DEM. |

`wbt_standard_deviation_of_slope()` |
Calculates the standard deviation of slope from an input DEM. |

`wbt_stream_power_index()` |
Calculates the relative stream power index. |

`wbt_surface_area_ratio()` |
Calculates a the surface area ratio of each grid cell in an input DEM. |

`wbt_tangential_curvature()` |
Calculates a tangential curvature raster from an input DEM. |

`wbt_time_in_daylight()` |
Calculates the proportion of time a location is not within an area of shadow. |

`wbt_total_curvature()` |
Calculates a total curvature raster from an input DEM. |

`wbt_viewshed()` |
Identifies the viewshed for a point or set of points. |

`wbt_visibility_index()` |
Estimates the relative visibility of sites in a DEM. |

`wbt_wetness_index()` |
Calculates the topographic wetness index, Ln(A / tan(slope)). |

function_name | description |
---|---|

`wbt_average_flowpath_slope()` |
Measures the average slope gradient from each grid cell to all upslope divide cells. |

`wbt_average_upslope_flowpath_length()` |
Measures the average length of all upslope flowpaths draining each grid cell. |

`wbt_basins()` |
Identifies drainage basins that drain to the DEM edge. |

`wbt_breach_depressions()` |
Breaches all of the depressions in a DEM using Lindsay’s (2016) algorithm. This should be preferred over depression filling in most cases. |

`wbt_breach_depressions_least_cost()` |
Breaches the depressions in a DEM using a least-cost pathway method. |

`wbt_breach_single_cell_pits()` |
Removes single-cell pits from an input DEM by breaching. |

`wbt_burn_streams_at_roads()` |
Burns-in streams at the sites of road embankments. |

`wbt_d8_flow_accumulation()` |
Calculates a D8 flow accumulation raster from an input DEM or flow pointer. |

`wbt_d8_mass_flux()` |
Performs a D8 mass flux calculation. |

`wbt_d8_pointer()` |
Calculates a D8 flow pointer raster from an input DEM. |

`wbt_d_inf_flow_accumulation()` |
Calculates a D-infinity flow accumulation raster from an input DEM. |

`wbt_d_inf_mass_flux()` |
Performs a D-infinity mass flux calculation. |

`wbt_d_inf_pointer()` |
Calculates a D-infinity flow pointer (flow direction) raster from an input DEM. |

`wbt_depth_in_sink()` |
Measures the depth of sinks (depressions) in a DEM. |

`wbt_downslope_distance_to_stream()` |
Measures distance to the nearest downslope stream cell. |

`wbt_downslope_flowpath_length()` |
Calculates the downslope flowpath length from each cell to basin outlet. |

`wbt_elevation_above_stream()` |
Calculates the elevation of cells above the nearest downslope stream cell. |

`wbt_elevation_above_stream_euclidean()` |
Calculates the elevation of cells above the nearest (Euclidean distance) stream cell. |

`wbt_fd8_flow_accumulation()` |
Calculates an FD8 flow accumulation raster from an input DEM. |

`wbt_fd8_pointer()` |
Calculates an FD8 flow pointer raster from an input DEM. |

`wbt_fill_burn()` |
Burns streams into a DEM using the FillBurn (Saunders, 1999) method. |

`wbt_fill_depressions()` |
Fills all of the depressions in a DEM. Depression breaching should be preferred in most cases. |

`wbt_fill_depressions_planchon_and_darboux()` |
Fills all of the depressions in a DEM using the Planchon and Darboux (2002) method. |

`wbt_fill_depressions_wang_and_liu()` |
Fills all of the depressions in a DEM using the Wang and Liu (2006) method. Depression breaching should be preferred in most cases. |

`wbt_fill_single_cell_pits()` |
Raises pit cells to the elevation of their lowest neighbour. |

`wbt_find_no_flow_cells()` |
Finds grid cells with no downslope neighbours. |

`wbt_find_parallel_flow()` |
Finds areas of parallel flow in D8 flow direction rasters. |

`wbt_flatten_lakes()` |
Flattens lake polygons in a raster DEM. |

`wbt_flood_order()` |
Assigns each DEM grid cell its order in the sequence of inundations that are encountered during a search starting from the edges, moving inward at increasing elevations. |

`wbt_flow_accumulation_full_workflow()` |
Resolves all of the depressions in a DEM, outputting a breached DEM, an aspect-aligned non-divergent flow pointer, and a flow accumulation raster. |

`wbt_flow_length_diff()` |
Calculates the local maximum absolute difference in downslope flowpath length, useful in mapping drainage divides and ridges. |

`wbt_hillslopes()` |
Identifies the individual hillslopes draining to each link in a stream network. |

`wbt_impoundment_size_index()` |
Calculates the impoundment size resulting from damming a DEM. |

`wbt_insert_dams()` |
Calculates the impoundment size resulting from damming a DEM. |

`wbt_isobasins()` |
Divides a landscape into nearly equal sized drainage basins (i.e. watersheds). |

`wbt_jenson_snap_pour_points()` |
Moves outlet points used to specify points of interest in a watershedding operation to the nearest stream cell. |

`wbt_longest_flowpath()` |
Delineates the longest flowpaths for a group of subbasins or watersheds. |

`wbt_md_inf_flow_accumulation()` |
Calculates an FD8 flow accumulation raster from an input DEM. |

`wbt_max_upslope_flowpath_length()` |
Measures the maximum length of all upslope flowpaths draining each grid cell. |

`wbt_num_inflowing_neighbours()` |
Computes the number of inflowing neighbours to each cell in an input DEM based on the D8 algorithm. |

`wbt_raise_walls()` |
Raises walls in a DEM along a line or around a polygon, e.g. a watershed. |

`wbt_rho8_pointer()` |
Calculates a stochastic Rho8 flow pointer raster from an input DEM. |

`wbt_sink()` |
Identifies the depressions in a DEM, giving each feature a unique identifier. |

`wbt_snap_pour_points()` |
Moves outlet points used to specify points of interest in a watershedding operation to the cell with the highest flow accumulation in its neighbourhood. |

`wbt_stochastic_depression_analysis()` |
Performs a stochastic analysis of depressions within a DEM. |

`wbt_strahler_order_basins()` |
Identifies Strahler-order basins from an input stream network. |

`wbt_subbasins()` |
Identifies the catchments, or sub-basin, draining to each link in a stream network. |

`wbt_trace_downslope_flowpaths()` |
Traces downslope flowpaths from one or more target sites (i.e. seed points). |

`wbt_unnest_basins()` |
Extract whole watersheds for a set of outlet points. |

`wbt_upslope_depression_storage()` |
Estimates the average upslope depression storage depth. |

`wbt_watershed()` |
Identifies the watershed, or drainage basin, draining to a set of target cells. |

function_name | description |
---|---|

`wbt_change_vector_analysis()` |
Performs a change vector analysis on a two-date multi-spectral dataset. |

`wbt_closing()` |
A closing is a mathematical morphology operation involving an erosion (min filter) of a dilation (max filter) set. |

`wbt_create_colour_composite()` |
Creates a colour-composite image from three bands of multispectral imagery. |

`wbt_flip_image()` |
Reflects an image in the vertical or horizontal axis. |

`wbt_ihs_to_rgb()` |
Converts intensity, hue, and saturation (IHS) images into red, green, and blue (RGB) images. |

`wbt_image_stack_profile()` |
Plots an image stack profile (i.e. signature) for a set of points and multispectral images. |

`wbt_integral_image()` |
Transforms an input image (summed area table) into its integral image equivalent. |

`wbt_line_thinning()` |
Performs line thinning a on Boolean raster image; intended to be used with the RemoveSpurs tool. |

`wbt_mosaic()` |
Mosaics two or more images together. |

`wbt_mosaic_with_feathering()` |
Mosaics two images together using a feathering technique in overlapping areas to reduce edge-effects. |

`wbt_normalized_difference_index()` |
Calculate a normalized-difference index (NDI) from two bands of multispectral image data. |

`wbt_opening()` |
An opening is a mathematical morphology operation involving a dilation (max filter) of an erosion (min filter) set. |

`wbt_remove_spurs()` |
Removes the spurs (pruning operation) from a Boolean line image; intended to be used on the output of the LineThinning tool. |

`wbt_resample()` |
Resamples one or more input images into a destination image. |

`wbt_rgb_to_ihs()` |
Converts red, green, and blue (RGB) images into intensity, hue, and saturation (IHS) images. |

`wbt_split_colour_composite()` |
This tool splits an RGB colour composite image into separate multispectral images. |

`wbt_thicken_raster_line()` |
Thickens single-cell wide lines within a raster image. |

`wbt_tophat_transform()` |
Performs either a white or black top-hat transform on an input image. |

`wbt_write_function_memory_insertion()` |
Performs a write function memory insertion for single-band multi-date change detection. |

function_name | description |
---|---|

`wbt_k_means_clustering()` |
Performs a k-means clustering operation on a multi-spectral dataset. |

`wbt_modified_k_means_clustering()` |
Performs a modified k-means clustering operation on a multi-spectral dataset. |

function_name | description |
---|---|

`wbt_adaptive_filter()` |
Performs an adaptive filter on an image. |

`wbt_bilateral_filter()` |
A bilateral filter is an edge-preserving smoothing filter introduced by Tomasi and Manduchi (1998). |

`wbt_conservative_smoothing_filter()` |
Performs a conservative-smoothing filter on an image. |

`wbt_corner_detection()` |
Identifies corner patterns in boolean images using hit-and-miss pattern matching. |

`wbt_diff_of_gaussian_filter()` |
Performs a Difference of Gaussian (DoG) filter on an image. |

`wbt_diversity_filter()` |
Assigns each cell in the output grid the number of different values in a moving window centred on each grid cell in the input raster. |

`wbt_edge_preserving_mean_filter()` |
Performs a simple edge-preserving mean filter on an input image. |

`wbt_emboss_filter()` |
Performs an emboss filter on an image, similar to a hillshade operation. |

`wbt_fast_almost_gaussian_filter()` |
Performs a fast approximate Gaussian filter on an image. |

`wbt_gaussian_filter()` |
Performs a Gaussian filter on an image. |

`wbt_high_pass_filter()` |
Performs a high-pass filter on an input image. |

`wbt_high_pass_median_filter()` |
Performs a high pass median filter on an input image. |

`wbt_k_nearest_mean_filter()` |
A k-nearest mean filter is a type of edge-preserving smoothing filter. |

`wbt_laplacian_filter()` |
Performs a Laplacian filter on an image. |

`wbt_laplacian_of_gaussian_filter()` |
Performs a Laplacian-of-Gaussian (LoG) filter on an image. |

`wbt_lee_sigma_filter()` |
Performs a Lee (Sigma) smoothing filter on an image. |

`wbt_line_detection_filter()` |
Performs a line-detection filter on an image. |

`wbt_majority_filter()` |
Assigns each cell in the output grid the most frequently occurring value (mode) in a moving window centred on each grid cell in the input raster. |

`wbt_maximum_filter()` |
Assigns each cell in the output grid the maximum value in a moving window centred on each grid cell in the input raster. |

`wbt_mean_filter()` |
Performs a mean filter (low-pass filter) on an input image. |

`wbt_median_filter()` |
Performs a median filter on an input image. |

`wbt_minimum_filter()` |
Assigns each cell in the output grid the minimum value in a moving window centred on each grid cell in the input raster. |

`wbt_olympic_filter()` |
Performs an olympic smoothing filter on an image. |

`wbt_percentile_filter()` |
Performs a percentile filter on an input image. |

`wbt_prewitt_filter()` |
Performs a Prewitt edge-detection filter on an image. |

`wbt_range_filter()` |
Assigns each cell in the output grid the range of values in a moving window centred on each grid cell in the input raster. |

`wbt_roberts_cross_filter()` |
Performs a Robert’s cross edge-detection filter on an image. |

`wbt_scharr_filter()` |
Performs a Scharr edge-detection filter on an image. |

`wbt_sobel_filter()` |
Performs a Sobel edge-detection filter on an image. |

`wbt_standard_deviation_filter()` |
Assigns each cell in the output grid the standard deviation of values in a moving window centred on each grid cell in the input raster. |

`wbt_total_filter()` |
Performs a total filter on an input image. |

`wbt_unsharp_masking()` |
An image sharpening technique that enhances edges. |

`wbt_user_defined_weights_filter()` |
Performs a user-defined weights filter on an image. |

function_name | description |
---|---|

`wbt_balance_contrast_enhancement()` |
Performs a balance contrast enhancement on a colour-composite image of multispectral data. |

`wbt_correct_vignetting()` |
Corrects the darkening of images towards corners. |

`wbt_direct_decorrelation_stretch()` |
Performs a direct decorrelation stretch enhancement on a colour-composite image of multispectral data. |

`wbt_gamma_correction()` |
Performs a gamma correction on an input images. |

`wbt_gaussian_contrast_stretch()` |
Performs a Gaussian contrast stretch on input images. |

`wbt_histogram_equalization()` |
Performs a histogram equalization contrast enhancement on an image. |

`wbt_histogram_matching()` |
Alters the statistical distribution of a raster image matching it to a specified PDF. |

`wbt_histogram_matching_two_images()` |
This tool alters the cumulative distribution function of a raster image to that of another image. |

`wbt_min_max_contrast_stretch()` |
Performs a min-max contrast stretch on an input greytone image. |

`wbt_panchromatic_sharpening()` |
Increases the spatial resolution of image data by combining multispectral bands with panchromatic data. |

`wbt_percentage_contrast_stretch()` |
Performs a percentage linear contrast stretch on input images. |

`wbt_sigmoidal_contrast_stretch()` |
Performs a sigmoidal contrast stretch on input images. |

`wbt_standard_deviation_contrast_stretch()` |
Performs a standard-deviation contrast stretch on input images. |

function_name | description |
---|---|

`wbt_ascii_to_las()` |
Converts one or more ASCII files containing LiDAR points into LAS files. |

`wbt_classify_buildings_in_lidar()` |
Reclassifies a LiDAR points that lie within vector building footprints. |

`wbt_classify_overlap_points()` |
Classifies or filters LAS points in regions of overlapping flight lines. |

`wbt_clip_lidar_to_polygon()` |
Clips a LiDAR point cloud to a vector polygon or polygons. |

`wbt_erase_polygon_from_lidar()` |
Erases (cuts out) a vector polygon or polygons from a LiDAR point cloud. |

`wbt_filter_lidar_classes()` |
Removes points in a LAS file with certain specified class values. |

`wbt_filter_lidar_scan_angles()` |
Removes points in a LAS file with scan angles greater than a threshold. |

`wbt_find_flightline_edge_points()` |
Identifies points along a flightline’s edge in a LAS file. |

`wbt_flightline_overlap()` |
Reads a LiDAR (LAS) point file and outputs a raster containing the number of overlapping flight lines in each grid cell. |

`wbt_height_above_ground()` |
Normalizes a LiDAR point cloud, providing the height above the nearest ground-classified point. |

`wbt_las_to_ascii()` |
Converts one or more LAS files into ASCII text files. |

`wbt_las_to_multipoint_shapefile()` |
Converts one or more LAS files into MultipointZ vector Shapefiles. When the input parameter is not specified, the tool grids all LAS files contained within the working directory. |

`wbt_las_to_shapefile()` |
Converts one or more LAS files into a vector Shapefile of POINT ShapeType. |

`wbt_las_to_zlidar()` |
Converts one or more LAS files into the zlidar compressed LiDAR data format. |

`wbt_lidar_block_maximum()` |
Creates a block-maximum raster from an input LAS file. When the input/output parameters are not specified, the tool grids all LAS files contained within the working directory. |

`wbt_lidar_block_minimum()` |
Creates a block-minimum raster from an input LAS file. When the input/output parameters are not specified, the tool grids all LAS files contained within the working directory. |

`wbt_lidar_classify_subset()` |
Classifies the values in one LiDAR point cloud that correpond with points in a subset cloud. |

`wbt_lidar_colourize()` |
Adds the red-green-blue colour fields of a LiDAR (LAS) file based on an input image. |

`wbt_lidar_digital_surface_model()` |
Creates a top-surface digital surface model (DSM) from a LiDAR point cloud. |

`wbt_lidar_elevation_slice()` |
Outputs all of the points within a LiDAR (LAS) point file that lie between a specified elevation range. |

`wbt_lidar_ground_point_filter()` |
Identifies ground points within LiDAR dataset using a slope-based method. |

`wbt_lidar_hex_binning()` |
Hex-bins a set of LiDAR points. |

`wbt_lidar_hillshade()` |
Calculates a hillshade value for points within a LAS file and stores these data in the RGB field. |

`wbt_lidar_histogram()` |
Creates a histogram of LiDAR data. |

`wbt_lidar_idw_interpolation()` |
Interpolates LAS files using an inverse-distance weighted (IDW) scheme. When the input/output parameters are not specified, the tool interpolates all LAS files contained within the working directory. |

`wbt_lidar_info()` |
Prints information about a LiDAR (LAS) dataset, including header, point return frequency, and classification data and information about the variable length records (VLRs) and geokeys. |

`wbt_lidar_join()` |
Joins multiple LiDAR (LAS) files into a single LAS file. |

`wbt_lidar_kappa_index()` |
Performs a kappa index of agreement (KIA) analysis on the classifications of two LAS files. |

`wbt_lidar_nearest_neighbour_gridding()` |
Grids LiDAR files using nearest-neighbour scheme. When the input/output parameters are not specified, the tool grids all LAS files contained within the working directory. |

`wbt_lidar_point_density()` |
Calculates the spatial pattern of point density for a LiDAR data set. When the input/output parameters are not specified, the tool grids all LAS files contained within the working directory. |

`wbt_lidar_point_stats()` |
Creates several rasters summarizing the distribution of LAS point data. When the input/output parameters are not specified, the tool works on all LAS files contained within the working directory. |

`wbt_lidar_ransac_planes()` |
Performs a RANSAC analysis to identify points within a LiDAR point cloud that belong to linear planes. |

`wbt_lidar_rbf_interpolation()` |
Interpolates LAS files using a radial basis function (RBF) scheme. When the input/output parameters are not specified, the tool interpolates all LAS files contained within the working directory. |

`wbt_lidar_remove_duplicates()` |
Removes duplicate points from a LiDAR data set. |

`wbt_lidar_remove_outliers()` |
Removes outliers (high and low points) in a LiDAR point cloud. |

`wbt_lidar_rooftop_analysis()` |
Identifies roof segments in a LiDAR point cloud. |

`wbt_lidar_segmentation()` |
Segments a LiDAR point cloud based on differences in the orientation of fitted planar surfaces and point proximity. |

`wbt_lidar_segmentation_based_filter()` |
Identifies ground points within LiDAR point clouds using a segmentation based approach. |

`wbt_lidar_tin_gridding()` |
Creates a raster grid based on a Delaunay triangular irregular network (TIN) fitted to LiDAR points. |

`wbt_lidar_thin()` |
Thins a LiDAR point cloud, reducing point density. |

`wbt_lidar_thin_high_density()` |
Thins points from high density areas within a LiDAR point cloud. |

`wbt_lidar_tile()` |
Tiles a LiDAR LAS file into multiple LAS files. |

`wbt_lidar_tile_footprint()` |
Creates a vector polygon of the convex hull of a LiDAR point cloud. When the input/output parameters are not specified, the tool works with all LAS files contained within the working directory. |

`wbt_lidar_tophat_transform()` |
Performs a white top-hat transform on a Lidar dataset; as an estimate of height above ground, this is useful for modelling the vegetation canopy. |

`wbt_normal_vectors()` |
Calculates normal vectors for points within a LAS file and stores these data (XYZ vector components) in the RGB field. |

`wbt_select_tiles_by_polygon()` |
Copies LiDAR tiles overlapping with a polygon into an output directory. |

`wbt_zlidar_to_las()` |
Converts one or more zlidar files into the LAS data format. |

function_name | description |
---|---|

`wbt_absolute_value()` |
Calculates the absolute value of every cell in a raster. |

`wbt_add()` |
Performs an addition operation on two rasters or a raster and a constant value. |

`wbt_and()` |
Performs a logical AND operator on two Boolean raster images. |

`wbt_anova()` |
Performs an analysis of variance (ANOVA) test on a raster dataset. |

`wbt_arc_cos()` |
Returns the inverse cosine (arccos) of each values in a raster. |

`wbt_arc_sin()` |
Returns the inverse sine (arcsin) of each values in a raster. |

`wbt_arc_tan()` |
Returns the inverse tangent (arctan) of each values in a raster. |

`wbt_arcosh()` |
Returns the inverse hyperbolic cosine (arcosh) of each values in a raster. |

`wbt_arsinh()` |
Returns the inverse hyperbolic sine (arsinh) of each values in a raster. |

`wbt_artanh()` |
Returns the inverse hyperbolic tangent (arctanh) of each values in a raster. |

`wbt_atan2()` |
Returns the 2-argument inverse tangent (atan2). |

`wbt_attribute_correlation()` |
Performs a correlation analysis on attribute fields from a vector database. |

`wbt_attribute_correlation_neighbourhood_analysis()` |
Performs a correlation on two input vector attributes within a neighbourhood search windows. |

`wbt_attribute_histogram()` |
Creates a histogram for the field values of a vector’s attribute table. |

`wbt_attribute_scattergram()` |
Creates a scattergram for two field values of a vector’s attribute table. |

`wbt_ceil()` |
Returns the smallest (closest to negative infinity) value that is greater than or equal to the values in a raster. |

`wbt_cos()` |
Returns the cosine (cos) of each values in a raster. |

`wbt_cosh()` |
Returns the hyperbolic cosine (cosh) of each values in a raster. |

`wbt_crispness_index()` |
Calculates the Crispness Index, which is used to quantify how crisp (or conversely how fuzzy) a probability image is. |

`wbt_cross_tabulation()` |
Performs a cross-tabulation on two categorical images. |

`wbt_cumulative_distribution()` |
Converts a raster image to its cumulative distribution function. |

`wbt_decrement()` |
Decreases the values of each grid cell in an input raster by 1.0 (see also InPlaceSubtract). |

`wbt_divide()` |
Performs a division operation on two rasters or a raster and a constant value. |

`wbt_equal_to()` |
Performs a equal-to comparison operation on two rasters or a raster and a constant value. |

`wbt_exp()` |
Returns the exponential (base e) of values in a raster. |

`wbt_exp2()` |
Returns the exponential (base 2) of values in a raster. |

`wbt_floor()` |
Returns the largest (closest to positive infinity) value that is less than or equal to the values in a raster. |

`wbt_greater_than()` |
Performs a greater-than comparison operation on two rasters or a raster and a constant value. |

`wbt_image_autocorrelation()` |
Performs Moran’s I analysis on two or more input images. |

`wbt_image_correlation()` |
Performs image correlation on two or more input images. |

`wbt_image_correlation_neighbourhood_analysis()` |
Performs image correlation on two input images neighbourhood search windows. |

`wbt_image_regression()` |
Performs image regression analysis on two input images. |

`wbt_in_place_add()` |
Performs an in-place addition operation (input1 += input2). |

`wbt_in_place_divide()` |
Performs an in-place division operation (input1 /= input2). |

`wbt_in_place_multiply()` |
Performs an in-place multiplication operation (input1 *= input2). |

`wbt_in_place_subtract()` |
Performs an in-place subtraction operation (input1 -= input2). |

`wbt_increment()` |
Increases the values of each grid cell in an input raster by 1.0. (see also InPlaceAdd) |

`wbt_integer_division()` |
Performs an integer division operation on two rasters or a raster and a constant value. |

`wbt_is_no_data()` |
Identifies NoData valued pixels in an image. |

`wbt_kappa_index()` |
Performs a kappa index of agreement (KIA) analysis on two categorical raster files. |

`wbt_ks_test_for_normality()` |
Evaluates whether the values in a raster are normally distributed. |

`wbt_less_than()` |
Performs a less-than comparison operation on two rasters or a raster and a constant value. |

`wbt_list_unique_values()` |
Lists the unique values contained in a field within a vector’s attribute table. |

`wbt_ln()` |
Returns the natural logarithm of values in a raster. |

`wbt_log10()` |
Returns the base-10 logarithm of values in a raster. |

`wbt_log2()` |
Returns the base-2 logarithm of values in a raster. |

`wbt_max()` |
Performs a MAX operation on two rasters or a raster and a constant value. |

`wbt_min()` |
Performs a MIN operation on two rasters or a raster and a constant value. |

`wbt_modulo()` |
Performs a modulo operation on two rasters or a raster and a constant value. |

`wbt_multiply()` |
Performs a multiplication operation on two rasters or a raster and a constant value. |

`wbt_negate()` |
Changes the sign of values in a raster or the 0-1 values of a Boolean raster. |

`wbt_not()` |
Performs a logical NOT operator on two Boolean raster images. |

`wbt_not_equal_to()` |
Performs a not-equal-to comparison operation on two rasters or a raster and a constant value. |

`wbt_or()` |
Performs a logical OR operator on two Boolean raster images. |

`wbt_paired_sample_t_test()` |
Performs a 2-sample K-S test for significant differences on two input rasters. |

`wbt_power()` |
Raises the values in grid cells of one rasters, or a constant value, by values in another raster or constant value. |

`wbt_principal_component_analysis()` |
Performs a principal component analysis (PCA) on a multi-spectral dataset. |

`wbt_quantiles()` |
Transforms raster values into quantiles. |

`wbt_random_field()` |
Creates an image containing random values. |

`wbt_random_sample()` |
Creates an image containing randomly located sample grid cells with unique IDs. |

`wbt_raster_histogram()` |
Creates a histogram from raster values. |

`wbt_raster_summary_stats()` |
Measures a rasters min, max, average, standard deviation, num. non-nodata cells, and total. |

`wbt_reciprocal()` |
Returns the reciprocal (i.e. 1 / z) of values in a raster. |

`wbt_rescale_value_range()` |
Performs a min-max contrast stretch on an input greytone image. |

`wbt_root_mean_square_error()` |
Calculates the RMSE and other accuracy statistics. |

`wbt_round()` |
Rounds the values in an input raster to the nearest integer value. |

`wbt_sin()` |
Returns the sine (sin) of each values in a raster. |

`wbt_sinh()` |
Returns the hyperbolic sine (sinh) of each values in a raster. |

`wbt_square()` |
Squares the values in a raster. |

`wbt_square_root()` |
Returns the square root of the values in a raster. |

`wbt_subtract()` |
Performs a differencing operation on two rasters or a raster and a constant value. |

`wbt_tan()` |
Returns the tangent (tan) of each values in a raster. |

`wbt_tanh()` |
Returns the hyperbolic tangent (tanh) of each values in a raster. |

`wbt_to_degrees()` |
Converts a raster from radians to degrees. |

`wbt_to_radians()` |
Converts a raster from degrees to radians. |

`wbt_trend_surface()` |
Estimates the trend surface of an input raster file. |

`wbt_trend_surface_vector_points()` |
Estimates a trend surface from vector points. |

`wbt_truncate()` |
Truncates the values in a raster to the desired number of decimal places. |

`wbt_turning_bands_simulation()` |
Creates an image containing random values based on a turning-bands simulation. |

`wbt_two_sample_ks_test()` |
Performs a 2-sample K-S test for significant differences on two input rasters. |

`wbt_wilcoxon_signed_rank_test()` |
Performs a 2-sample K-S test for significant differences on two input rasters. |

`wbt_xor()` |
Performs a logical XOR operator on two Boolean raster images. |

`wbt_z_scores()` |
Standardizes the values in an input raster by converting to z-scores. |

`wbt_zonal_statistics()` |
Extracts descriptive statistics for a group of patches in a raster. |

function_name | description |
---|---|

`wbt_distance_to_outlet()` |
Calculates the distance of stream grid cells to the channel network outlet cell. |

`wbt_extract_streams()` |
Extracts stream grid cells from a flow accumulation raster. |

`wbt_extract_valleys()` |
Identifies potential valley bottom grid cells based on local topolography alone. |

`wbt_farthest_channel_head()` |
Calculates the distance to the furthest upstream channel head for each stream cell. |

`wbt_find_main_stem()` |
Finds the main stem, based on stream lengths, of each stream network. |

`wbt_hack_stream_order()` |
Assigns the Hack stream order to each tributary in a stream network. |

`wbt_horton_stream_order()` |
Assigns the Horton stream order to each tributary in a stream network. |

`wbt_length_of_upstream_channels()` |
Calculates the total length of channels upstream. |

`wbt_long_profile()` |
Plots the stream longitudinal profiles for one or more rivers. |

`wbt_long_profile_from_points()` |
Plots the longitudinal profiles from flow-paths initiating from a set of vector points. |

`wbt_raster_streams_to_vector()` |
Converts a raster stream file into a vector file. |

`wbt_rasterize_streams()` |
Rasterizes vector streams based on Lindsay (2016) method. |

`wbt_remove_short_streams()` |
Removes short first-order streams from a stream network. |

`wbt_shreve_stream_magnitude()` |
Assigns the Shreve stream magnitude to each link in a stream network. |

`wbt_strahler_stream_order()` |
Assigns the Strahler stream order to each link in a stream network. |

`wbt_stream_link_class()` |
Identifies the exterior/interior links and nodes in a stream network. |

`wbt_stream_link_identifier()` |
Assigns a unique identifier to each link in a stream network. |

`wbt_stream_link_length()` |
Estimates the length of each link (or tributary) in a stream network. |

`wbt_stream_link_slope()` |
Estimates the average slope of each link (or tributary) in a stream network. |

`wbt_stream_slope_continuous()` |
Estimates the slope of each grid cell in a stream network. |

`wbt_topological_stream_order()` |
Assigns each link in a stream network its topological order. |

`wbt_tributary_identifier()` |
Assigns a unique identifier to each tributary in a stream network. |