Reference

And(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

Performs a logical AND operator on two Boolean raster images.

Arguments

• input1: Input raster file.
• input2: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

Not(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

Performs a logical NOT operator on two Boolean raster images.

Arguments

• input1: Input raster file.
• input2: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

Or(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

Performs a logical OR operator on two Boolean raster images.

Arguments

• input1: Input raster file.
• input2: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

absolute_value(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Calculates the absolute value of every cell in a raster.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

adaptive_filter(wbt_info::WhiteboxTools = wbt_info; i, output, filterx=11, filtery=11, threshold=2.0, callback::Union{Nothing,Function}=nothing)

Performs an adaptive filter on an image.

Arguments

• i: Input raster file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• threshold: Difference from mean threshold, in standard deviations.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

add(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

Performs an addition operation on two rasters or a raster and a constant value.

Arguments

• input1: Input raster file or constant value.
• input2: Input raster file or constant value.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

add_point_coordinates_to_table(wbt_info::WhiteboxTools = wbt_info; i, callback::Union{Nothing,Function}=nothing)

Modifies the attribute table of a point vector by adding fields containing each point's X and Y coordinates.

Arguments

• i: Input vector Points file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

aggregate_raster(wbt_info::WhiteboxTools = wbt_info; i, output, agg_factor=2, type="mean", callback::Union{Nothing,Function}=nothing)

Aggregates a raster to a lower resolution.

Arguments

• i: Input raster file.
• output: Output raster file.
• agg_factor: Aggregation factor, in pixels.
• type: Statistic used to fill output pixels.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

anova(wbt_info::WhiteboxTools = wbt_info; i, features, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• features: Feature definition (or class) raster.
• output: Output HTML file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

arc_cos(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

arc_sin(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

arc_tan(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

arcosh(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

arsinh(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

artanh(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

ascii_to_las(wbt_info::WhiteboxTools = wbt_info; inputs, pattern, proj=nothing, callback::Union{Nothing,Function}=nothing)

Converts one or more ASCII files containing LiDAR points into LAS files.

Arguments

• inputs: Input LiDAR ASCII files (.csv).
• pattern: Input field pattern.
• proj: Well-known-text string or EPSG code describing projection.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

aspect(wbt_info::WhiteboxTools = wbt_info; dem, output, zfactor=nothing, callback::Union{Nothing,Function}=nothing)

Calculates an aspect raster from an input DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• zfactor: Optional multiplier for when the vertical and horizontal units are not the same.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

atan2(wbt_info::WhiteboxTools = wbt_info; input_y, input_x, output, callback::Union{Nothing,Function}=nothing)

Returns the 2-argument inverse tangent (atan2).

Arguments

• input_y: Input y raster file or constant value (rise).
• input_x: Input x raster file or constant value (run).
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

attribute_correlation(wbt_info::WhiteboxTools = wbt_info; i, output=nothing, callback::Union{Nothing,Function}=nothing)

Performs a correlation analysis on attribute fields from a vector database.

Arguments

• i: Input vector file.
• output: Output HTML file (default name will be based on input file if unspecified).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

attribute_correlation_neighbourhood_analysis(wbt_info::WhiteboxTools = wbt_info; i, field1, field2, radius=nothing, min_points=nothing, stat="pearson", callback::Union{Nothing,Function}=nothing)

Performs a correlation on two input vector attributes within a neighbourhood search windows.

Arguments

• i: Input vector file.
• field1: First input field name (dependent variable) in attribute table.
• field2: Second input field name (independent variable) in attribute table.
• radius: Search Radius (in map units).
• min_points: Minimum number of points.
• stat: Correlation type; one of 'pearson' (default) and 'spearman'.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

attribute_histogram(wbt_info::WhiteboxTools = wbt_info; i, field, output, callback::Union{Nothing,Function}=nothing)

Creates a histogram for the field values of a vector's attribute table.

Arguments

• i: Input raster file.
• field: Input field name in attribute table.
• output: Output HTML file (default name will be based on input file if unspecified).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

attribute_scattergram(wbt_info::WhiteboxTools = wbt_info; i, fieldx, fieldy, output, trendline=false, callback::Union{Nothing,Function}=nothing)

Creates a scattergram for two field values of a vector's attribute table.

Arguments

• i: Input raster file.
• fieldx: Input field name in attribute table for the x-axis.
• fieldy: Input field name in attribute table for the y-axis.
• output: Output HTML file (default name will be based on input file if unspecified).
• trendline: Draw the trendline.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

average_flowpath_slope(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Measures the average slope gradient from each grid cell to all upslope divide cells.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

average_normal_vector_angular_deviation(wbt_info::WhiteboxTools = wbt_info; dem, output, filter=11, callback::Union{Nothing,Function}=nothing)

Calculates the circular variance of aspect at a scale for a DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• filter: Size of the filter kernel.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

average_overlay(wbt_info::WhiteboxTools = wbt_info; inputs, output, callback::Union{Nothing,Function}=nothing)

Calculates the average for each grid cell from a group of raster images.

Arguments

• inputs: Input raster files.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

average_upslope_flowpath_length(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Measures the average length of all upslope flowpaths draining each grid cell.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

balance_contrast_enhancement(wbt_info::WhiteboxTools = wbt_info; i, output, band_mean=100.0, callback::Union{Nothing,Function}=nothing)

Performs a balance contrast enhancement on a colour-composite image of multispectral data.

Arguments

• i: Input colour composite image file.
• output: Output raster file.
• band_mean: Band mean value.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

basins(wbt_info::WhiteboxTools = wbt_info; d8_pntr, output, esri_pntr=false, callback::Union{Nothing,Function}=nothing)

Identifies drainage basins that drain to the DEM edge.

Arguments

• d8_pntr: Input raster D8 pointer file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

bilateral_filter(wbt_info::WhiteboxTools = wbt_info; i, output, sigma_dist=0.75, sigma_int=1.0, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• sigma_dist: Standard deviation in distance in pixels.
• sigma_int: Standard deviation in intensity in pixels.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

block_maximum_gridding(wbt_info::WhiteboxTools = wbt_info; i, field, output, use_z=false, cell_size=nothing, base=nothing, callback::Union{Nothing,Function}=nothing)

Creates a raster grid based on a set of vector points and assigns grid values using a block maximum scheme.

Arguments

• i: Input vector Points file.
• field: Input field name in attribute table.
• use_z: Use z-coordinate instead of field?.
• output: Output raster file.
• cell_size: Optionally specified cell size of output raster. Not used when base raster is specified.
• base: Optionally specified input base raster file. Not used when a cell size is specified.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

block_minimum_gridding(wbt_info::WhiteboxTools = wbt_info; i, field, output, use_z=false, cell_size=nothing, base=nothing, callback::Union{Nothing,Function}=nothing)

Creates a raster grid based on a set of vector points and assigns grid values using a block minimum scheme.

Arguments

• i: Input vector Points file.
• field: Input field name in attribute table.
• use_z: Use z-coordinate instead of field?.
• output: Output raster file.
• cell_size: Optionally specified cell size of output raster. Not used when base raster is specified.
• base: Optionally specified input base raster file. Not used when a cell size is specified.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

boundary_shape_complexity(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Calculates the complexity of the boundaries of raster polygons.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

breach_depressions(wbt_info::WhiteboxTools = wbt_info; dem, output, max_depth=nothing, max_length=nothing, flat_increment=nothing, fill_pits=false, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• max_depth: Optional maximum breach depth (default is Inf).
• max_length: Optional maximum breach channel length (in grid cells; default is Inf).
• flat_increment: Optional elevation increment applied to flat areas.
• fill_pits: Optional flag indicating whether to fill single-cell pits.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

breach_depressions_least_cost(wbt_info::WhiteboxTools = wbt_info; dem, output, dist, max_cost=nothing, min_dist=true, flat_increment=nothing, fill=true, callback::Union{Nothing,Function}=nothing)

Breaches the depressions in a DEM using a least-cost pathway method.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• dist: Maximum search distance for breach paths in cells.
• max_cost: Optional maximum breach cost (default is Inf).
• min_dist: Optional flag indicating whether to minimize breach distances.
• flat_increment: Optional elevation increment applied to flat areas.
• fill: Optional flag indicating whether to fill any remaining unbreached depressions.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

breach_single_cell_pits(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Removes single-cell pits from an input DEM by breaching.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

buffer_raster(wbt_info::WhiteboxTools = wbt_info; i, output, size, gridcells=false, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• size: Buffer size.
• gridcells: Optional flag to indicate that the 'size' threshold should be measured in grid cells instead of the default map units.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

burn_streams_at_roads(wbt_info::WhiteboxTools = wbt_info; dem, streams, roads, output, width=nothing, callback::Union{Nothing,Function}=nothing)

Burns-in streams at the sites of road embankments.

Arguments

• dem: Input raster digital elevation model (DEM) file.
• streams: Input vector streams file.
• roads: Input vector roads file.
• output: Output raster file.
• width: Maximum road embankment width, in map units.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

ceil(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

centroid(wbt_info::WhiteboxTools = wbt_info; i, output, text_output=false, callback::Union{Nothing,Function}=nothing)

Calculates the centroid, or average location, of raster polygon objects.

Arguments

• i: Input raster file.
• output: Output raster file.
• text_output: Optional text output.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

centroid_vector(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Identifies the centroid point of a vector polyline or polygon feature or a group of vector points.

Arguments

• i: Input vector file.
• output: Output vector file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

change_vector_analysis(wbt_info::WhiteboxTools = wbt_info; date1, date2, magnitude, direction, callback::Union{Nothing,Function}=nothing)

Performs a change vector analysis on a two-date multi-spectral dataset.

Arguments

• date1: Input raster files for the earlier date.
• date2: Input raster files for the later date.
• magnitude: Output vector magnitude raster file.
• direction: Output vector Direction raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

circular_variance_of_aspect(wbt_info::WhiteboxTools = wbt_info; dem, output, filter=11, callback::Union{Nothing,Function}=nothing)

Calculates the circular variance of aspect at a scale for a DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• filter: Size of the filter kernel.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

classify_buildings_in_lidar(wbt_info::WhiteboxTools = wbt_info; i, buildings, output, callback::Union{Nothing,Function}=nothing)

Reclassifies a LiDAR points that lie within vector building footprints.

Arguments

• i: Input LiDAR file.
• buildings: Input vector polygons file.
• output: Output LiDAR file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

classify_overlap_points(wbt_info::WhiteboxTools = wbt_info; i, output, resolution=2.0, filter=false, callback::Union{Nothing,Function}=nothing)

Classifies or filters LAS points in regions of overlapping flight lines.

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• resolution: The size of the square area used to evaluate nearby points in the LiDAR data.
• filter: Filter out points from overlapping flightlines? If false, overlaps will simply be classified.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

clean_vector(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Removes null features and lines/polygons with fewer than the required number of vertices.

Arguments

• i: Input vector file.
• output: Output vector file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

clip(wbt_info::WhiteboxTools = wbt_info; i, clip, output, callback::Union{Nothing,Function}=nothing)

Extract all the features, or parts of features, that overlap with the features of the clip vector.

Arguments

• i: Input vector file.
• clip: Input clip polygon vector file.
• output: Output vector file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

clip_lidar_to_polygon(wbt_info::WhiteboxTools = wbt_info; i, polygons, output, callback::Union{Nothing,Function}=nothing)

Clips a LiDAR point cloud to a vector polygon or polygons.

Arguments

• i: Input LiDAR file.
• polygons: Input vector polygons file.
• output: Output LiDAR file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

clip_raster_to_polygon(wbt_info::WhiteboxTools = wbt_info; i, polygons, output, maintain_dimensions=false, callback::Union{Nothing,Function}=nothing)

Clips a raster to a vector polygon.

Arguments

• i: Input raster file.
• polygons: Input vector polygons file.
• output: Output raster file.
• maintain_dimensions: Maintain input raster dimensions?.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

closing(wbt_info::WhiteboxTools = wbt_info; i, output, filterx=11, filtery=11, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

clump(wbt_info::WhiteboxTools = wbt_info; i, output, diag=true, zero_back=false, callback::Union{Nothing,Function}=nothing)

Groups cells that form discrete areas, assigning them unique identifiers.

Arguments

• i: Input raster file.
• output: Output raster file.
• diag: Flag indicating whether diagonal connections should be considered.
• zero_back: Flag indicating whether zero values should be treated as a background.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

compactness_ratio(wbt_info::WhiteboxTools = wbt_info; i, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input vector polygon file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

conditional_evaluation(wbt_info::WhiteboxTools = wbt_info; i, output, statement="", true=nothing, false=nothing, callback::Union{Nothing,Function}=nothing)

This tool performs a conditional evaluation (if-then-else) operation on a raster.

Arguments

• i: Name of the input raster file.
• statement: Conditional statement e.g. value > 35.0. This statement must be a valid Rust statement.
• True: Value where condition evaluates TRUE (input raster or constant value).
• False: Value where condition evaluates FALSE (input raster or constant value).
• output: Name of the output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

conservative_smoothing_filter(wbt_info::WhiteboxTools = wbt_info; i, output, filterx=3, filtery=3, callback::Union{Nothing,Function}=nothing)

Performs a conservative-smoothing filter on an image.

Arguments

• i: Input raster file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

construct_vector_tin(wbt_info::WhiteboxTools = wbt_info; i, output, field=nothing, use_z=false, max_triangle_edge_length=nothing, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input vector points file.
• field: Input field name in attribute table.
• use_z: Use the 'z' dimension of the Shapefile's geometry instead of an attribute field?.
• output: Output vector polygon file.
• max_triangle_edge_length: Optional maximum triangle edge length; triangles larger than this size will not be gridded.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

contours_from_points(wbt_info::WhiteboxTools = wbt_info; i, output, field=nothing, use_z=false, max_triangle_edge_length=nothing, interval=10.0, base=0.0, smooth=5, callback::Union{Nothing,Function}=nothing)

Creates a contour coverage from a set of input points.

Arguments

• i: Input vector points file.
• field: Input field name in attribute table.
• use_z: Use the 'z' dimension of the Shapefile's geometry instead of an attribute field?.
• output: Output vector lines file.
• max_triangle_edge_length: Optional maximum triangle edge length; triangles larger than this size will not be gridded.
• interval: Contour interval.
• base: Base contour height.
• smooth: Smoothing filter size (in num. points), e.g. 3, 5, 7, 9, 11.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

contours_from_raster(wbt_info::WhiteboxTools = wbt_info; i, output, interval=10.0, base=0.0, smooth=9, tolerance=10.0, callback::Union{Nothing,Function}=nothing)

Derives a vector contour coverage from a raster surface.

Arguments

• i: Input surface raster file.
• output: Output vector contour file.
• interval: Contour interval.
• base: Base contour height.
• smooth: Smoothing filter size (in num. points), e.g. 3, 5, 7, 9, 11.
• tolerance: Tolerance factor, in degrees (0-45); determines generalization level.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

convert_nodata_to_zero(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Converts nodata values in a raster to zero.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

convert_raster_format(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Converts raster data from one format to another.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

corner_detection(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Identifies corner patterns in boolean images using hit-and-miss pattern matching.

Arguments

• i: Input boolean image.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

correct_vignetting(wbt_info::WhiteboxTools = wbt_info; i, pp, output, focal_length=304.8, image_width=228.6, n=4.0, callback::Union{Nothing,Function}=nothing)

Corrects the darkening of images towards corners.

Arguments

• i: Input raster file.
• pp: Input principal point file.
• output: Output raster file.
• focal_length: Camera focal length, in millimeters.
• image_width: Distance between photograph edges, in millimeters.
• n: The 'n' parameter.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

cos(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

cosh(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

cost_allocation(wbt_info::WhiteboxTools = wbt_info; source, backlink, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• source: Input source raster file.
• backlink: Input backlink raster file generated by the cost-distance tool.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

cost_distance(wbt_info::WhiteboxTools = wbt_info; source, cost, out_accum, out_backlink, callback::Union{Nothing,Function}=nothing)

Performs cost-distance accumulation on a cost surface and a group of source cells.

Arguments

• source: Input source raster file.
• cost: Input cost (friction) raster file.
• out_accum: Output cost accumulation raster file.
• out_backlink: Output backlink raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

cost_pathway(wbt_info::WhiteboxTools = wbt_info; destination, backlink, output, zero_background=false, callback::Union{Nothing,Function}=nothing)

Performs cost-distance pathway analysis using a series of destination grid cells.

Arguments

• destination: Input destination raster file.
• backlink: Input backlink raster file generated by the cost-distance tool.
• output: Output cost pathway raster file.
• zero_background: Flag indicating whether zero values should be treated as a background.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

count_if(wbt_info::WhiteboxTools = wbt_info; inputs, output, value, callback::Union{Nothing,Function}=nothing)

Counts the number of occurrences of a specified value in a cell-stack of rasters.

Arguments

• inputs: Input raster files.
• output: Output raster file.
• value: Search value (e.g. countif value = 5.0).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

create_colour_composite(wbt_info::WhiteboxTools = wbt_info; red, green, blue, output, opacity=nothing, enhance=true, zeros=false, callback::Union{Nothing,Function}=nothing)

Creates a colour-composite image from three bands of multispectral imagery.

Arguments

• red: Input red band image file.
• green: Input green band image file.
• blue: Input blue band image file.
• opacity: Input opacity band image file (optional).
• output: Output colour composite file.
• enhance: Optional flag indicating whether a balance contrast enhancement is performed.
• zeros: Optional flag to indicate if zeros are nodata values.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

create_hexagonal_vector_grid(wbt_info::WhiteboxTools = wbt_info; i, output, width, orientation="horizontal", callback::Union{Nothing,Function}=nothing)

Creates a hexagonal vector grid.

Arguments

• i: Input base file.
• output: Output vector polygon file.
• width: The grid cell width.
• orientation: Grid Orientation, 'horizontal' or 'vertical'.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

create_plane(wbt_info::WhiteboxTools = wbt_info; base, output, gradient=15.0, aspect=90.0, constant=0.0, callback::Union{Nothing,Function}=nothing)

Creates a raster image based on the equation for a simple plane.

Arguments

• base: Input base raster file.
• output: Output raster file.
• gradient: Slope gradient in degrees (-85.0 to 85.0).
• aspect: Aspect (direction) in degrees clockwise from north (0.0-360.0).
• constant: Constant value.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

create_rectangular_vector_grid(wbt_info::WhiteboxTools = wbt_info; i, output, width, height, xorig=0, yorig=0, callback::Union{Nothing,Function}=nothing)

Creates a rectangular vector grid.

Arguments

• i: Input base file.
• output: Output vector polygon file.
• width: The grid cell width.
• height: The grid cell height.
• xorig: The grid origin x-coordinate.
• yorig: The grid origin y-coordinate.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

crispness_index(wbt_info::WhiteboxTools = wbt_info; i, output=nothing, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Optional output html file (default name will be based on input file if unspecified).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

cross_tabulation(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

Performs a cross-tabulation on two categorical images.

Arguments

• input1: Input raster file 1.
• input2: Input raster file 1.
• output: Output HTML file (default name will be based on input file if unspecified).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

csv_points_to_vector(wbt_info::WhiteboxTools = wbt_info; i, output, xfield=0, yfield=1, epsg=nothing, callback::Union{Nothing,Function}=nothing)

Converts a CSV text file to vector points.

Arguments

• i: Input CSV file (i.e. source of data to be imported).
• output: Output vector file.
• xfield: X field number (e.g. 0 for first field).
• yfield: Y field number (e.g. 1 for second field).
• epsg: EPSG projection (e.g. 2958).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

cumulative_distribution(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Converts a raster image to its cumulative distribution function.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

d8_flow_accumulation(wbt_info::WhiteboxTools = wbt_info; i, output, out_type="cells", log=false, clip=false, pntr=false, esri_pntr=false, callback::Union{Nothing,Function}=nothing)

Calculates a D8 flow accumulation raster from an input DEM or flow pointer.

Arguments

• i: Input raster DEM or D8 pointer file.
• output: Output raster file.
• out_type: Output type; one of 'cells' (default), 'catchment area', and 'specific contributing area'.
• log: Optional flag to request the output be log-transformed.
• clip: Optional flag to request clipping the display max by 1%.
• pntr: Is the input raster a D8 flow pointer rather than a DEM?.
• esri_pntr: Input D8 pointer uses the ESRI style scheme.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

d8_mass_flux(wbt_info::WhiteboxTools = wbt_info; dem, loading, efficiency, absorption, output, callback::Union{Nothing,Function}=nothing)

Performs a D8 mass flux calculation.

Arguments

• dem: Input raster DEM file.
• loading: Input loading raster file.
• efficiency: Input efficiency raster file.
• absorption: Input absorption raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

d8_pointer(wbt_info::WhiteboxTools = wbt_info; dem, output, esri_pntr=false, callback::Union{Nothing,Function}=nothing)

Calculates a D8 flow pointer raster from an input DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

d_inf_flow_accumulation(wbt_info::WhiteboxTools = wbt_info; i, output, out_type="Specific Contributing Area", threshold=nothing, log=false, clip=false, pntr=false, callback::Union{Nothing,Function}=nothing)

Calculates a D-infinity flow accumulation raster from an input DEM.

Arguments

• i: Input raster DEM or D-infinity pointer file.
• output: Output raster file.
• out_type: Output type; one of 'cells', 'sca' (default), and 'ca'.
• threshold: Optional convergence threshold parameter, in grid cells; default is infinity.
• log: Optional flag to request the output be log-transformed.
• clip: Optional flag to request clipping the display max by 1%.
• pntr: Is the input raster a D-infinity flow pointer rather than a DEM?.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

d_inf_mass_flux(wbt_info::WhiteboxTools = wbt_info; dem, loading, efficiency, absorption, output, callback::Union{Nothing,Function}=nothing)

Performs a D-infinity mass flux calculation.

Arguments

• dem: Input raster DEM file.
• loading: Input loading raster file.
• efficiency: Input efficiency raster file.
• absorption: Input absorption raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

d_inf_pointer(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

decrement(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

default_callback(value)

A simple default callback that outputs using the print function. When tools are called without providing a custom callback, this function will be used to print to standard output.

depth_in_sink(wbt_info::WhiteboxTools = wbt_info; dem, output, zero_background=false, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• zero_background: Flag indicating whether the background value of zero should be used.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

dev_from_mean_elev(wbt_info::WhiteboxTools = wbt_info; dem, output, filterx=11, filtery=11, callback::Union{Nothing,Function}=nothing)

Calculates deviation from mean elevation.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

diff_from_mean_elev(wbt_info::WhiteboxTools = wbt_info; dem, output, filterx=11, filtery=11, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

diff_of_gaussian_filter(wbt_info::WhiteboxTools = wbt_info; i, output, sigma1=2.0, sigma2=4.0, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• sigma1: Standard deviation distance in pixels.
• sigma2: Standard deviation distance in pixels.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

difference(wbt_info::WhiteboxTools = wbt_info; i, overlay, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input vector file.
• overlay: Input overlay vector file.
• output: Output vector file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

direct_decorrelation_stretch(wbt_info::WhiteboxTools = wbt_info; i, output, k=0.5, clip=1.0, callback::Union{Nothing,Function}=nothing)

Performs a direct decorrelation stretch enhancement on a colour-composite image of multispectral data.

Arguments

• i: Input colour composite image file.
• output: Output raster file.
• k: Achromatic factor (k) ranges between 0 (no effect) and 1 (full saturation stretch), although typical values range from 0.3 to 0.7.
• clip: Optional percent to clip the upper tail by during the stretch.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

directional_relief(wbt_info::WhiteboxTools = wbt_info; dem, output, azimuth=0.0, max_dist=nothing, callback::Union{Nothing,Function}=nothing)

Calculates relief for cells in an input DEM for a specified direction.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• azimuth: Wind azimuth in degrees.
• max_dist: Optional maximum search distance (unspecified if none; in xy units).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

dissolve(wbt_info::WhiteboxTools = wbt_info; i, output, field=nothing, snap=0.0, callback::Union{Nothing,Function}=nothing)

Removes the interior, or shared, boundaries within a vector polygon coverage.

Arguments

• i: Input vector file.
• field: Dissolve field attribute (optional).
• output: Output vector file.
• snap: Snap tolerance.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

distance_to_outlet(wbt_info::WhiteboxTools = wbt_info; d8_pntr, streams, output, esri_pntr=false, zero_background=false, callback::Union{Nothing,Function}=nothing)

Calculates the distance of stream grid cells to the channel network outlet cell.

Arguments

• d8_pntr: Input raster D8 pointer file.
• streams: Input raster streams file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• zero_background: Flag indicating whether a background value of zero should be used.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

diversity_filter(wbt_info::WhiteboxTools = wbt_info; i, output, filterx=11, filtery=11, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input raster file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

divide(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

Performs a division operation on two rasters or a raster and a constant value.

Arguments

• input1: Input raster file or constant value.
• input2: Input raster file or constant value.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

downslope_distance_to_stream(wbt_info::WhiteboxTools = wbt_info; dem, streams, output, dinf=false, callback::Union{Nothing,Function}=nothing)

Measures distance to the nearest downslope stream cell.

Arguments

• dem: Input raster DEM file.
• streams: Input raster streams file.
• output: Output raster file.
• dinf: Use the D-infinity flow algorithm instead of D8?.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

downslope_flowpath_length(wbt_info::WhiteboxTools = wbt_info; d8_pntr, output, watersheds=nothing, weights=nothing, esri_pntr=false, callback::Union{Nothing,Function}=nothing)

Calculates the downslope flowpath length from each cell to basin outlet.

Arguments

• d8_pntr: Input D8 pointer raster file.
• watersheds: Optional input watershed raster file.
• weights: Optional input weights raster file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

downslope_index(wbt_info::WhiteboxTools = wbt_info; dem, output, drop=2.0, out_type="tangent", callback::Union{Nothing,Function}=nothing)

Calculates the Hjerdt et al. (2004) downslope index.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• drop: Vertical drop value (default is 2.0).
• out_type: Output type, options include 'tangent', 'degrees', 'radians', 'distance' (default is 'tangent').
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

edge_contamination(wbt_info::WhiteboxTools = wbt_info; dem, output, flow_type="mfd", zfactor="", callback::Union{Nothing,Function}=nothing)

This tool identifies grid cells within an input DEM that may be impacted by edge contamination for hydrological applications.

Arguments

• dem: Name of the input DEM raster file; must be depressionless.
• output: Name of the output raster file.
• flow_type: Flow algorithm type, one of 'd8', 'mfd', or 'dinf'.
• zfactor: Optional multiplier for when the vertical and horizontal units are not the same.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

edge_density(wbt_info::WhiteboxTools = wbt_info; dem, output, filter=11, norm_diff=5.0, zfactor=nothing, callback::Union{Nothing,Function}=nothing)

Calculates the density of edges, or breaks-in-slope within DEMs.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• filter: Size of the filter kernel.
• norm_diff: Maximum difference in normal vectors, in degrees.
• zfactor: Optional multiplier for when the vertical and horizontal units are not the same.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

edge_preserving_mean_filter(wbt_info::WhiteboxTools = wbt_info; i, output, threshold, filter=11, callback::Union{Nothing,Function}=nothing)

Performs a simple edge-preserving mean filter on an input image.

Arguments

• i: Input raster file.
• output: Output raster file.
• filter: Size of the filter kernel.
• threshold: Maximum difference in values.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

edge_proportion(wbt_info::WhiteboxTools = wbt_info; i, output, output_text=false, callback::Union{Nothing,Function}=nothing)

Calculate the proportion of cells in a raster polygon that are edge cells.

Arguments

• i: Input raster file.
• output: Output raster file.
• output_text: flag indicating whether a text report should also be output.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

elev_above_pit(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Calculate the elevation of each grid cell above the nearest downstream pit cell or grid edge cell.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

elev_percentile(wbt_info::WhiteboxTools = wbt_info; dem, output, filterx=11, filtery=11, sig_digits=2, callback::Union{Nothing,Function}=nothing)

Calculates the elevation percentile raster from a DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• sig_digits: Number of significant digits.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

elev_relative_to_min_max(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Calculates the elevation of a location relative to the minimum and maximum elevations in a DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

elev_relative_to_watershed_min_max(wbt_info::WhiteboxTools = wbt_info; dem, watersheds, output, callback::Union{Nothing,Function}=nothing)

Calculates the elevation of a location relative to the minimum and maximum elevations in a watershed.

Arguments

• dem: Input raster DEM file.
• watersheds: Input raster watersheds file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

elevation_above_stream(wbt_info::WhiteboxTools = wbt_info; dem, streams, output, callback::Union{Nothing,Function}=nothing)

Calculates the elevation of cells above the nearest downslope stream cell.

Arguments

• dem: Input raster DEM file.
• streams: Input raster streams file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

elevation_above_stream_euclidean(wbt_info::WhiteboxTools = wbt_info; dem, streams, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• streams: Input raster streams file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

eliminate_coincident_points(wbt_info::WhiteboxTools = wbt_info; i, output, tolerance, callback::Union{Nothing,Function}=nothing)

Removes any coincident, or nearly coincident, points from a vector points file.

Arguments

• i: Input vector file.
• output: Output vector polygon file.
• tolerance: The distance tolerance for points.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

elongation_ratio(wbt_info::WhiteboxTools = wbt_info; i, callback::Union{Nothing,Function}=nothing)

Calculates the elongation ratio for vector polygons.

Arguments

• i: Input vector polygon file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

embankment_mapping(wbt_info::WhiteboxTools = wbt_info; dem, road_vec, output, search_dist=2.5, min_road_width=6.0, typical_width=30.0, max_height=2.0, max_width=60.0, max_increment=0.05, spillout_slope=4.0, remove_embankments=false, callback::Union{Nothing,Function}=nothing)

Maps and/or removes road embankments from an input fine-resolution DEM.

Arguments

• dem: Input raster DEM file.
• road_vec: Input vector polygons file.
• output: Output raster file.
• search_dist: Search distance used to reposition transportation vectors onto road embankments (in map units).
• min_road_width: Minimum road width; this is the width of the paved road surface (in map units).
• typical_width: Typical embankment width; this is the maximum width of an embankment with roadside ditches (in map units).
• max_height: Typical embankment maximum height; this is the height a typical embankment with roadside ditches (in map units).
• max_width: Maximum embankment width, typically where embankments traverse steep-sided valleys (in map units).
• max_increment: Maximum upwards increment between neighbouring cells on an embankment (in elevation units).
• spillout_slope: Spillout slope (in degrees).
• remove_embankments: Optional flag indicating whether to output a DEM with embankments removed (true) or an embankment raster map (false).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

emboss_filter(wbt_info::WhiteboxTools = wbt_info; i, output, direction="n", clip=0.0, callback::Union{Nothing,Function}=nothing)

Performs an emboss filter on an image, similar to a hillshade operation.

Arguments

• i: Input raster file.
• output: Output raster file.
• direction: Direction of reflection; options include 'n', 's', 'e', 'w', 'ne', 'se', 'nw', 'sw'.
• clip: Optional amount to clip the distribution tails by, in percent.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

equal_to(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

Performs a equal-to comparison operation on two rasters or a raster and a constant value.

Arguments

• input1: Input raster file or constant value.
• input2: Input raster file or constant value.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

erase(wbt_info::WhiteboxTools = wbt_info; i, erase, output, callback::Union{Nothing,Function}=nothing)

Removes all the features, or parts of features, that overlap with the features of the erase vector polygon.

Arguments

• i: Input vector file.
• erase: Input erase polygon vector file.
• output: Output vector file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

erase_polygon_from_lidar(wbt_info::WhiteboxTools = wbt_info; i, polygons, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input LiDAR file.
• polygons: Input vector polygons file.
• output: Output LiDAR file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

erase_polygon_from_raster(wbt_info::WhiteboxTools = wbt_info; i, polygons, output, callback::Union{Nothing,Function}=nothing)

Erases (cuts out) a vector polygon from a raster.

Arguments

• i: Input raster file.
• polygons: Input vector polygons file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

euclidean_allocation(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

euclidean_distance(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

exp(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

exp2(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

export_table_to_csv(wbt_info::WhiteboxTools = wbt_info; i, output, headers=true, callback::Union{Nothing,Function}=nothing)

Exports an attribute table to a CSV text file.

Arguments

• i: Input vector file.
• output: Output csv file.
• headers: Export field names as file header?.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

exposure_towards_wind_flux(wbt_info::WhiteboxTools = wbt_info; dem, output, azimuth="", max_dist="", zfactor="", callback::Union{Nothing,Function}=nothing)

This tool evaluates hydrologic connectivity within a DEM.

Arguments

• dem: Name of the input DEM raster file.
• output: Name of the output raster file.
• azimuth: Wind azimuth, in degrees.
• max_dist: Optional maximum search distance. Minimum value is 5 x cell size.
• zfactor: Optional multiplier for when the vertical and horizontal units are not the same.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

extend_vector_lines(wbt_info::WhiteboxTools = wbt_info; i, output, dist, extend="both ends", callback::Union{Nothing,Function}=nothing)

Extends vector lines by a specified distance.

Arguments

• i: Input vector polyline file.
• output: Output vector polyline file.
• dist: The distance to extend.
• extend: Extend direction, 'both ends' (default), 'line start', 'line end'.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

extract_nodes(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Converts vector lines or polygons into vertex points.

Arguments

• i: Input vector lines or polygon file.
• output: Output vector points file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

extract_raster_values_at_points(wbt_info::WhiteboxTools = wbt_info; inputs, points, out_text=false, callback::Union{Nothing,Function}=nothing)

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

Arguments

• inputs: Input raster files.
• points: Input vector points file.
• out_text: Output point values as text? Otherwise, the only output is to to the points file's attribute table.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

extract_streams(wbt_info::WhiteboxTools = wbt_info; flow_accum, output, threshold, zero_background=false, callback::Union{Nothing,Function}=nothing)

Extracts stream grid cells from a flow accumulation raster.

Arguments

• flow_accum: Input raster D8 flow accumulation file.
• output: Output raster file.
• threshold: Threshold in flow accumulation values for channelization.
• zero_background: Flag indicating whether a background value of zero should be used.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

extract_valleys(wbt_info::WhiteboxTools = wbt_info; dem, output, variant="LQ", line_thin=true, filter=5, callback::Union{Nothing,Function}=nothing)

Identifies potential valley bottom grid cells based on local topolography alone.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• variant: Options include 'LQ' (lower quartile), 'JandR' (Johnston and Rosenfeld), and 'PandD' (Peucker and Douglas); default is 'LQ'.
• line_thin: Optional flag indicating whether post-processing line-thinning should be performed.
• filter: Optional argument (only used when variant='lq') providing the filter size, in grid cells, used for lq-filtering (default is 5).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

farthest_channel_head(wbt_info::WhiteboxTools = wbt_info; d8_pntr, streams, output, esri_pntr=false, zero_background=false, callback::Union{Nothing,Function}=nothing)

Calculates the distance to the furthest upstream channel head for each stream cell.

Arguments

• d8_pntr: Input raster D8 pointer file.
• streams: Input raster streams file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• zero_background: Flag indicating whether a background value of zero should be used.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

fast_almost_gaussian_filter(wbt_info::WhiteboxTools = wbt_info; i, output, sigma=1.8, callback::Union{Nothing,Function}=nothing)

Performs a fast approximate Gaussian filter on an image.

Arguments

• i: Input raster file.
• output: Output raster file.
• sigma: Standard deviation distance in pixels.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

fd8_flow_accumulation(wbt_info::WhiteboxTools = wbt_info; dem, output, out_type="specific contributing area", exponent=1.1, threshold=nothing, log=false, clip=false, callback::Union{Nothing,Function}=nothing)

Calculates an FD8 flow accumulation raster from an input DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• out_type: Output type; one of 'cells', 'specific contributing area' (default), and 'catchment area'.
• exponent: Optional exponent parameter; default is 1.1.
• threshold: Optional convergence threshold parameter, in grid cells; default is infinity.
• log: Optional flag to request the output be log-transformed.
• clip: Optional flag to request clipping the display max by 1%.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

fd8_pointer(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Calculates an FD8 flow pointer raster from an input DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

feature_preserving_smoothing(wbt_info::WhiteboxTools = wbt_info; dem, output, filter=11, norm_diff=15.0, num_iter=3, max_diff=0.5, zfactor=nothing, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• filter: Size of the filter kernel.
• norm_diff: Maximum difference in normal vectors, in degrees.
• num_iter: Number of iterations.
• max_diff: Maximum allowable absolute elevation change (optional).
• zfactor: Optional multiplier for when the vertical and horizontal units are not the same.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

fetch_analysis(wbt_info::WhiteboxTools = wbt_info; dem, output, azimuth=0.0, hgt_inc=0.05, callback::Union{Nothing,Function}=nothing)

Performs an analysis of fetch or upwind distance to an obstacle.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• azimuth: Wind azimuth in degrees in degrees.
• hgt_inc: Height increment value.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

fill_burn(wbt_info::WhiteboxTools = wbt_info; dem, streams, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• streams: Input vector streams file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

fill_depressions(wbt_info::WhiteboxTools = wbt_info; dem, output, fix_flats=true, flat_increment=nothing, max_depth=nothing, callback::Union{Nothing,Function}=nothing)

Fills all of the depressions in a DEM. Depression breaching should be preferred in most cases.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• fix_flats: Optional flag indicating whether flat areas should have a small gradient applied.
• flat_increment: Optional elevation increment applied to flat areas.
• max_depth: Optional maximum depression depth to fill.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

fill_depressions_planchon_and_darboux(wbt_info::WhiteboxTools = wbt_info; dem, output, fix_flats=true, flat_increment=nothing, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• fix_flats: Optional flag indicating whether flat areas should have a small gradient applied.
• flat_increment: Optional elevation increment applied to flat areas.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

fill_depressions_wang_and_liu(wbt_info::WhiteboxTools = wbt_info; dem, output, fix_flats=true, flat_increment=nothing, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• fix_flats: Optional flag indicating whether flat areas should have a small gradient applied.
• flat_increment: Optional elevation increment applied to flat areas.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

fill_missing_data(wbt_info::WhiteboxTools = wbt_info; i, output, filter=11, weight=2.0, no_edges=true, callback::Union{Nothing,Function}=nothing)

Fills NoData holes in a DEM.

Arguments

• i: Input raster file.
• output: Output raster file.
• filter: Filter size (cells).
• weight: IDW weight value.
• no_edges: Optional flag indicating whether to exclude NoData cells in edge regions.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

fill_single_cell_pits(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Raises pit cells to the elevation of their lowest neighbour.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

filter_lidar_classes(wbt_info::WhiteboxTools = wbt_info; i, output, exclude_cls=nothing, callback::Union{Nothing,Function}=nothing)

Removes points in a LAS file with certain specified class values.

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• exclude_cls: Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, –exclude_cls='3,4,5,6,7,18'.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

filter_lidar_scan_angles(wbt_info::WhiteboxTools = wbt_info; i, output, threshold, callback::Union{Nothing,Function}=nothing)

Removes points in a LAS file with scan angles greater than a threshold.

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• threshold: Scan angle threshold.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

filter_raster_features_by_area(wbt_info::WhiteboxTools = wbt_info; i, output, threshold, background="zero", callback::Union{Nothing,Function}=nothing)

Removes small-area features from a raster.

Arguments

• i: Input raster file.
• output: Output raster file.
• threshold: Remove features with fewer grid cells than this threshold value.
• background: Background value.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

find_flightline_edge_points(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Identifies points along a flightline's edge in a LAS file.

Arguments

• i: Input LiDAR file.
• output: Output file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

find_lowest_or_highest_points(wbt_info::WhiteboxTools = wbt_info; i, output, out_type="lowest", callback::Union{Nothing,Function}=nothing)

Locates the lowest and/or highest valued cells in a raster.

Arguments

• i: Input raster file.
• output: Output vector points file.
• out_type: Output type; one of 'area' (default) and 'volume'.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

find_main_stem(wbt_info::WhiteboxTools = wbt_info; d8_pntr, streams, output, esri_pntr=false, zero_background=false, callback::Union{Nothing,Function}=nothing)

Finds the main stem, based on stream lengths, of each stream network.

Arguments

• d8_pntr: Input raster D8 pointer file.
• streams: Input raster streams file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• zero_background: Flag indicating whether a background value of zero should be used.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

find_no_flow_cells(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Finds grid cells with no downslope neighbours.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

find_parallel_flow(wbt_info::WhiteboxTools = wbt_info; d8_pntr, streams, output, callback::Union{Nothing,Function}=nothing)

Finds areas of parallel flow in D8 flow direction rasters.

Arguments

• d8_pntr: Input D8 pointer raster file.
• streams: Input raster streams file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

find_patch_or_class_edge_cells(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Finds all cells located on the edge of patch or class features.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

find_ridges(wbt_info::WhiteboxTools = wbt_info; dem, output, line_thin=true, callback::Union{Nothing,Function}=nothing)

Identifies potential ridge and peak grid cells.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• line_thin: Optional flag indicating whether post-processing line-thinning should be performed.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

flatten_lakes(wbt_info::WhiteboxTools = wbt_info; dem, lakes, output, callback::Union{Nothing,Function}=nothing)

Flattens lake polygons in a raster DEM.

Arguments

• dem: Input raster DEM file.
• lakes: Input lakes vector polygons file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

flightline_overlap(wbt_info::WhiteboxTools = wbt_info; i=nothing, output=nothing, resolution=1.0, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input LiDAR file.
• output: Output file.
• resolution: Output raster's grid resolution.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

flip_image(wbt_info::WhiteboxTools = wbt_info; i, output, direction="vertical", callback::Union{Nothing,Function}=nothing)

Reflects an image in the vertical or horizontal axis.

Arguments

• i: Input raster file.
• output: Output raster file.
• direction: Direction of reflection; options include 'v' (vertical), 'h' (horizontal), and 'b' (both).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

flood_order(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

floor(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

flow_accumulation_full_workflow(wbt_info::WhiteboxTools = wbt_info; dem, out_dem, out_pntr, out_accum, out_type="Specific Contributing Area", log=false, clip=false, esri_pntr=false, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• out_dem: Output raster DEM file.
• out_pntr: Output raster flow pointer file.
• out_accum: Output raster flow accumulation file.
• out_type: Output type; one of 'cells', 'sca' (default), and 'ca'.
• log: Optional flag to request the output be log-transformed.
• clip: Optional flag to request clipping the display max by 1%.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

flow_length_diff(wbt_info::WhiteboxTools = wbt_info; d8_pntr, output, esri_pntr=false, callback::Union{Nothing,Function}=nothing)

Calculates the local maximum absolute difference in downslope flowpath length, useful in mapping drainage divides and ridges.

Arguments

• d8_pntr: Input D8 pointer raster file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

gamma_correction(wbt_info::WhiteboxTools = wbt_info; i, output, gamma=0.5, callback::Union{Nothing,Function}=nothing)

Performs a gamma correction on an input images.

Arguments

• i: Input raster file.
• output: Output raster file.
• gamma: Gamma value.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

gaussian_contrast_stretch(wbt_info::WhiteboxTools = wbt_info; i, output, num_tones=256, callback::Union{Nothing,Function}=nothing)

Performs a Gaussian contrast stretch on input images.

Arguments

• i: Input raster file.
• output: Output raster file.
• num_tones: Number of tones in the output image.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

gaussian_curvature(wbt_info::WhiteboxTools = wbt_info; dem, output, log=false, zfactor=nothing, callback::Union{Nothing,Function}=nothing)

Calculates a mean curvature raster from an input DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• log: Display output values using a log-scale.
• zfactor: Optional multiplier for when the vertical and horizontal units are not the same.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

gaussian_filter(wbt_info::WhiteboxTools = wbt_info; i, output, sigma=0.75, callback::Union{Nothing,Function}=nothing)

Performs a Gaussian filter on an image.

Arguments

• i: Input raster file.
• output: Output raster file.
• sigma: Standard deviation distance in pixels.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

gaussian_scale_space(wbt_info::WhiteboxTools = wbt_info; dem, output, output_zscore, output_scale, points=nothing, sigma=0.5, step=0.5, num_steps=10, lsp="Slope", z_factor=nothing, callback::Union{Nothing,Function}=nothing)

This tool uses the fast Gaussian approximation algorithm to produce scaled land-surface parameter measurements from an input DEM.

Arguments

• dem: Name of the input DEM raster file.
• points: Name of the input vector points shapefile.
• output: Name of the output land-surface parameter raster file.
• output_zscore: Name of the output z-score raster file.
• output_scale: Name of the output scale raster file.
• sigma: Initial sigma value (cells).
• step: Step size as any positive non-zero integer.
• num_steps: Number of steps.
• lsp: Output land-surface parameter; one of 'AnisotropyLTP', 'Aspect', 'DiffMeanElev', 'Eastness', 'Elevation', 'Hillshade', 'MeanCurvature', 'Northness', 'PlanCurvature', 'ProfileCurvature', 'Ruggedness', 'Slope', 'TanCurvature', 'TotalCurvature'.
• z_factor: Optional multiplier for when the vertical and horizontal units are not the same.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

geomorphons(wbt_info::WhiteboxTools = wbt_info; dem, output, search=50, threshold=0.0, tdist=0, forms=true, callback::Union{Nothing,Function}=nothing)

Computes geomorphon patterns.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• search: Look up distance.
• threshold: Flatness threshold for the classification function (in degrees).
• tdist: Distance (in cells) to begin reducing the flatness threshold to avoid problems with pseudo-flat lines-of-sight.
• forms: Classify geomorphons into 10 common land morphologies, else, output ternary code.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

greater_than(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, incl_equals=false, callback::Union{Nothing,Function}=nothing)

Performs a greater-than comparison operation on two rasters or a raster and a constant value.

Arguments

• input1: Input raster file or constant value.
• input2: Input raster file or constant value.
• output: Output raster file.
• incl_equals: Perform a greater-than-or-equal-to operation.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

hack_stream_order(wbt_info::WhiteboxTools = wbt_info; d8_pntr, streams, output, esri_pntr=false, zero_background=false, callback::Union{Nothing,Function}=nothing)

Assigns the Hack stream order to each tributary in a stream network.

Arguments

• d8_pntr: Input raster D8 pointer file.
• streams: Input raster streams file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• zero_background: Flag indicating whether a background value of zero should be used.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

height_above_ground(wbt_info::WhiteboxTools = wbt_info; i=nothing, output=nothing, callback::Union{Nothing,Function}=nothing)

Normalizes a LiDAR point cloud, providing the height above the nearest ground-classified point.

Arguments

• i: Input LiDAR file (including extension).
• output: Output raster file (including extension).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

help(wbt_info::WhiteboxTools = wbt_info)

Retrieves the help description for WhiteboxTools.

high_pass_filter(wbt_info::WhiteboxTools = wbt_info; i, output, filterx=11, filtery=11, callback::Union{Nothing,Function}=nothing)

Performs a high-pass filter on an input image.

Arguments

• i: Input raster file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

high_pass_median_filter(wbt_info::WhiteboxTools = wbt_info; i, output, filterx=11, filtery=11, sig_digits=2, callback::Union{Nothing,Function}=nothing)

Performs a high pass median filter on an input image.

Arguments

• i: Input raster file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• sig_digits: Number of significant digits.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

highest_position(wbt_info::WhiteboxTools = wbt_info; inputs, output, callback::Union{Nothing,Function}=nothing)

Identifies the stack position of the maximum value within a raster stack on a cell-by-cell basis.

Arguments

• inputs: Input raster files.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

hillshade(wbt_info::WhiteboxTools = wbt_info; dem, output, azimuth=315.0, altitude=30.0, zfactor=nothing, callback::Union{Nothing,Function}=nothing)

Calculates a hillshade raster from an input DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• azimuth: Illumination source azimuth in degrees.
• altitude: Illumination source altitude in degrees.
• zfactor: Optional multiplier for when the vertical and horizontal units are not the same.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

hillslopes(wbt_info::WhiteboxTools = wbt_info; d8_pntr, streams, output, esri_pntr=false, callback::Union{Nothing,Function}=nothing)

Identifies the individual hillslopes draining to each link in a stream network.

Arguments

• d8_pntr: Input raster D8 pointer file.
• streams: Input raster streams file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

histogram_equalization(wbt_info::WhiteboxTools = wbt_info; i, output, num_tones=256, callback::Union{Nothing,Function}=nothing)

Performs a histogram equalization contrast enhancement on an image.

Arguments

• i: Input raster file.
• output: Output raster file.
• num_tones: Number of tones in the output image.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

histogram_matching(wbt_info::WhiteboxTools = wbt_info; i, histo_file, output, callback::Union{Nothing,Function}=nothing)

Alters the statistical distribution of a raster image matching it to a specified PDF.

Arguments

• i: Input raster file.
• histo_file: Input reference probability distribution function (pdf) text file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

histogram_matching_two_images(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

This tool alters the cumulative distribution function of a raster image to that of another image.

Arguments

• input1: Input raster file to modify.
• input2: Input reference raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

hole_proportion(wbt_info::WhiteboxTools = wbt_info; i, callback::Union{Nothing,Function}=nothing)

Calculates the proportion of the total area of a polygon's holes relative to the area of the polygon's hull.

Arguments

• i: Input vector polygon file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

horizon_angle(wbt_info::WhiteboxTools = wbt_info; dem, output, azimuth=0.0, max_dist=100.0, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• azimuth: Azimuth, in degrees.
• max_dist: Optional maximum search distance (unspecified if none; in xy units). Minimum value is 5 x cell size.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

horton_stream_order(wbt_info::WhiteboxTools = wbt_info; d8_pntr, streams, output, esri_pntr=false, zero_background=false, callback::Union{Nothing,Function}=nothing)

Assigns the Horton stream order to each tributary in a stream network.

Arguments

• d8_pntr: Input raster D8 pointer file.
• streams: Input raster streams file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• zero_background: Flag indicating whether a background value of zero should be used.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

hypsometric_analysis(wbt_info::WhiteboxTools = wbt_info; inputs, output, watershed=nothing, callback::Union{Nothing,Function}=nothing)

Calculates a hypsometric curve for one or more DEMs.

Arguments

• inputs: Input DEM files.
• watershed: Input watershed files (optional).
• output: Output HTML file (default name will be based on input file if unspecified).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

hypsometrically_tinted_hillshade(wbt_info::WhiteboxTools = wbt_info; dem, output, altitude=45.0, hs_weight=0.5, brightness=0.5, atmospheric=0.0, palette="atlas", reverse=false, zfactor=nothing, full_mode=false, callback::Union{Nothing,Function}=nothing)

Creates an colour shaded relief image from an input DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• altitude: Illumination source altitude in degrees.
• hs_weight: Weight given to hillshade relative to relief (0.0-1.0).
• brightness: Brightness factor (0.0-1.0).
• atmospheric: Atmospheric effects weight (0.0-1.0).
• palette: Options include 'atlas', 'highrelief', 'arid', 'soft', 'muted', 'purple', 'viridi', 'gnyl', 'piyg', 'blylrd', and 'deep'.
• reverse: Optional flag indicating whether to use reverse the palette.
• zfactor: Optional multiplier for when the vertical and horizontal units are not the same.
• full_mode: Optional flag indicating whether to use full 360-degrees of illumination sources.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

idw_interpolation(wbt_info::WhiteboxTools = wbt_info; i, field, output, use_z=false, weight=2.0, radius=nothing, min_points=nothing, cell_size=nothing, base=nothing, callback::Union{Nothing,Function}=nothing)

Interpolates vector points into a raster surface using an inverse-distance weighted scheme.

Arguments

• i: Input vector Points file.
• field: Input field name in attribute table.
• use_z: Use z-coordinate instead of field?.
• output: Output raster file.
• weight: IDW weight value.
• radius: Search Radius in map units.
• min_points: Minimum number of points.
• cell_size: Optionally specified cell size of output raster. Not used when base raster is specified.
• base: Optionally specified input base raster file. Not used when a cell size is specified.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

ihs_to_rgb(wbt_info::WhiteboxTools = wbt_info; intensity, hue, saturation, red=nothing, green=nothing, blue=nothing, output=nothing, callback::Union{Nothing,Function}=nothing)

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

Arguments

• intensity: Input intensity file.
• hue: Input hue file.
• saturation: Input saturation file.
• red: Output red band file. Optionally specified if colour-composite not specified.
• green: Output green band file. Optionally specified if colour-composite not specified.
• blue: Output blue band file. Optionally specified if colour-composite not specified.
• output: Output colour-composite file. Only used if individual bands are not specified.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

image_autocorrelation(wbt_info::WhiteboxTools = wbt_info; inputs, output, contiguity="Rook", callback::Union{Nothing,Function}=nothing)

Performs Moran's I analysis on two or more input images.

Arguments

• inputs: Input raster files.
• contiguity: Contiguity type.
• output: Output HTML file (default name will be based on input file if unspecified).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

image_correlation(wbt_info::WhiteboxTools = wbt_info; inputs, output=nothing, callback::Union{Nothing,Function}=nothing)

Performs image correlation on two or more input images.

Arguments

• inputs: Input raster files.
• output: Output HTML file (default name will be based on input file if unspecified).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

image_correlation_neighbourhood_analysis(wbt_info::WhiteboxTools = wbt_info; input1, input2, output1, output2, filter=11, stat="pearson", callback::Union{Nothing,Function}=nothing)

Performs image correlation on two input images neighbourhood search windows.

Arguments

• input1: Input raster file.
• input2: Input raster file.
• output1: Output correlation (r-value or rho) raster file.
• output2: Output significance (p-value) raster file.
• filter: Size of the filter kernel.
• stat: Correlation type; one of 'pearson' (default) and 'spearman'.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

image_regression(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, out_residuals=nothing, standardize=false, scattergram=false, num_samples=1000, callback::Union{Nothing,Function}=nothing)

Performs image regression analysis on two input images.

Arguments

• input1: Input raster file (independent variable, X).
• input2: Input raster file (dependent variable, Y).
• output: Output HTML file for regression summary report.
• out_residuals: Output raster regression residual file.
• standardize: Optional flag indicating whether to standardize the residuals map.
• scattergram: Optional flag indicating whether to output a scattergram.
• num_samples: Number of samples used to create scattergram.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

image_stack_profile(wbt_info::WhiteboxTools = wbt_info; inputs, points, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• inputs: Input multispectral image files.
• points: Input vector points file.
• output: Output HTML file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

impoundment_size_index(wbt_info::WhiteboxTools = wbt_info; dem, damlength, out_mean=nothing, out_max=nothing, out_volume=nothing, out_area=nothing, out_dam_height=nothing, callback::Union{Nothing,Function}=nothing)

Calculates the impoundment size resulting from damming a DEM.

Arguments

• dem: Input raster DEM file.
• out_mean: Output mean flooded depth file.
• out_max: Output maximum flooded depth file.
• out_volume: Output flooded volume file.
• out_area: Output flooded area file.
• out_dam_height: Output dam height file.
• damlength: Maximum length of the dam.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

in_place_add(wbt_info::WhiteboxTools = wbt_info; input1, input2, callback::Union{Nothing,Function}=nothing)

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

Arguments

• input1: Input raster file.
• input2: Input raster file or constant value.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

in_place_divide(wbt_info::WhiteboxTools = wbt_info; input1, input2, callback::Union{Nothing,Function}=nothing)

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

Arguments

• input1: Input raster file.
• input2: Input raster file or constant value.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

in_place_multiply(wbt_info::WhiteboxTools = wbt_info; input1, input2, callback::Union{Nothing,Function}=nothing)

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

Arguments

• input1: Input raster file.
• input2: Input raster file or constant value.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

in_place_subtract(wbt_info::WhiteboxTools = wbt_info; input1, input2, callback::Union{Nothing,Function}=nothing)

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

Arguments

• input1: Input raster file.
• input2: Input raster file or constant value.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

increment(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

insert_dams(wbt_info::WhiteboxTools = wbt_info; dem, dam_pts, output, damlength, callback::Union{Nothing,Function}=nothing)

Calculates the impoundment size resulting from damming a DEM.

Arguments

• dem: Input raster DEM file.
• dam_pts: Input vector dam points file.
• output: Output file.
• damlength: Maximum length of the dam.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

integer_division(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

Performs an integer division operation on two rasters or a raster and a constant value.

Arguments

• input1: Input raster file or constant value.
• input2: Input raster file or constant value.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

integral_image(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

intersect(wbt_info::WhiteboxTools = wbt_info; i, overlay, output, snap=0.0, callback::Union{Nothing,Function}=nothing)

Identifies the parts of features in common between two input vector layers.

Arguments

• i: Input vector file.
• overlay: Input overlay vector file.
• output: Output vector file.
• snap: Snap tolerance.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

is_no_data(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Identifies NoData valued pixels in an image.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

isobasins(wbt_info::WhiteboxTools = wbt_info; dem, output, size, connections=false, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• size: Target basin size, in grid cells.
• connections: Output upstream-downstream flow connections among basins?.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

jenson_snap_pour_points(wbt_info::WhiteboxTools = wbt_info; pour_pts, streams, output, snap_dist, callback::Union{Nothing,Function}=nothing)

Moves outlet points used to specify points of interest in a watershedding operation to the nearest stream cell.

Arguments

• pour_pts: Input vector pour points (outlet) file.
• streams: Input raster streams file.
• output: Output vector file.
• snap_dist: Maximum snap distance in map units.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

join_tables(wbt_info::WhiteboxTools = wbt_info; input1, pkey, input2, fkey, import_field, callback::Union{Nothing,Function}=nothing)

Merge a vector's attribute table with another table based on a common field.

Arguments

• input1: Input primary vector file (i.e. the table to be modified).
• pkey: Primary key field.
• input2: Input foreign vector file (i.e. source of data to be imported).
• fkey: Foreign key field.
• import_field: Imported field (all fields will be imported if not specified).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

k_means_clustering(wbt_info::WhiteboxTools = wbt_info; inputs, output, classes, out_html=nothing, max_iterations=10, class_change=2.0, initialize="diagonal", min_class_size=10, callback::Union{Nothing,Function}=nothing)

Performs a k-means clustering operation on a multi-spectral dataset.

Arguments

• inputs: Input raster files.
• output: Output raster file.
• out_html: Output HTML report file.
• classes: Number of classes.
• max_iterations: Maximum number of iterations.
• class_change: Minimum percent of cells changed between iterations before completion.
• initialize: How to initialize cluster centres?.
• min_class_size: Minimum class size, in pixels.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

k_nearest_mean_filter(wbt_info::WhiteboxTools = wbt_info; i, output, filterx=11, filtery=11, k=5, callback::Union{Nothing,Function}=nothing)

A k-nearest mean filter is a type of edge-preserving smoothing filter.

Arguments

• i: Input raster file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• k: k-value in pixels; this is the number of nearest-valued neighbours to use.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

kappa_index(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• input1: Input classification raster file.
• input2: Input reference raster file.
• output: Output HTML file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

ks_test_for_normality(wbt_info::WhiteboxTools = wbt_info; i, output, num_samples=nothing, callback::Union{Nothing,Function}=nothing)

Evaluates whether the values in a raster are normally distributed.

Arguments

• i: Input raster file.
• output: Output HTML file.
• num_samples: Number of samples. Leave blank to use whole image.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

laplacian_filter(wbt_info::WhiteboxTools = wbt_info; i, output, variant="3x3(1)", clip=0.0, callback::Union{Nothing,Function}=nothing)

Performs a Laplacian filter on an image.

Arguments

• i: Input raster file.
• output: Output raster file.
• variant: Optional variant value. Options include 3x3(1), 3x3(2), 3x3(3), 3x3(4), 5x5(1), and 5x5(2) (default is 3x3(1)).
• clip: Optional amount to clip the distribution tails by, in percent.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

laplacian_of_gaussian_filter(wbt_info::WhiteboxTools = wbt_info; i, output, sigma=0.75, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• sigma: Standard deviation in pixels.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

las_to_ascii(wbt_info::WhiteboxTools = wbt_info; inputs, callback::Union{Nothing,Function}=nothing)

Converts one or more LAS files into ASCII text files.

Arguments

• inputs: Input LiDAR files.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

las_to_multipoint_shapefile(wbt_info::WhiteboxTools = wbt_info; i=nothing, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

las_to_shapefile(wbt_info::WhiteboxTools = wbt_info; i=nothing, callback::Union{Nothing,Function}=nothing)

Converts one or more LAS files into a vector Shapefile of POINT ShapeType.

Arguments

• i: Input LiDAR file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

las_to_zlidar(wbt_info::WhiteboxTools = wbt_info; inputs=nothing, outdir=nothing, compress="brotli", level=5, callback::Union{Nothing,Function}=nothing)

Converts one or more LAS files into the zlidar compressed LiDAR data format.

Arguments

• inputs: Input LAS files.
• outdir: Output directory into which zlidar files are created. If unspecified, it is assumed to be the same as the inputs.
• compress: Compression method, including 'brotli' and 'deflate'.
• level: Compression level (1-9).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

layer_footprint(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Creates a vector polygon footprint of the area covered by a raster grid or vector layer.

Arguments

• i: Input raster or vector file.
• output: Output vector polygon file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lee_sigma_filter(wbt_info::WhiteboxTools = wbt_info; i, output, filterx=11, filtery=11, sigma=10.0, m=5.0, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input raster file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• sigma: Sigma value should be related to the standard deviation of the distribution of image speckle noise.
• m: M-threshold value the minimum allowable number of pixels within the intensity range.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

length_of_upstream_channels(wbt_info::WhiteboxTools = wbt_info; d8_pntr, streams, output, esri_pntr=false, zero_background=false, callback::Union{Nothing,Function}=nothing)

Calculates the total length of channels upstream.

Arguments

• d8_pntr: Input raster D8 pointer file.
• streams: Input raster streams file.
• output: Output raster file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• zero_background: Flag indicating whether a background value of zero should be used.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

less_than(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, incl_equals=false, callback::Union{Nothing,Function}=nothing)

Performs a less-than comparison operation on two rasters or a raster and a constant value.

Arguments

• input1: Input raster file or constant value.
• input2: Input raster file or constant value.
• output: Output raster file.
• incl_equals: Perform a less-than-or-equal-to operation.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

license(tool_name::Union{Nothing, String} = nothing, wbt_info::WhiteboxTools = wbt_info)

Retrieves the license information for WhiteboxTools.

lidar_block_maximum(wbt_info::WhiteboxTools = wbt_info; i=nothing, output=nothing, resolution=1.0, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file.
• output: Output file.
• resolution: Output raster's grid resolution.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_block_minimum(wbt_info::WhiteboxTools = wbt_info; i=nothing, output=nothing, resolution=1.0, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file.
• output: Output file.
• resolution: Output raster's grid resolution.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_classify_subset(wbt_info::WhiteboxTools = wbt_info; base, subset, output, subset_class, nonsubset_class=nothing, callback::Union{Nothing,Function}=nothing)

Classifies the values in one LiDAR point cloud that correspond with points in a subset cloud.

Arguments

• base: Input base LiDAR file.
• subset: Input subset LiDAR file.
• output: Output LiDAR file.
• subset_class: Subset point class value (must be 0-18; see LAS specifications).
• nonsubset_class: Non-subset point class value (must be 0-18; see LAS specifications).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_colourize(wbt_info::WhiteboxTools = wbt_info; in_lidar, in_image, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• in_lidar: Input LiDAR file.
• in_image: Input colour image file.
• output: Output LiDAR file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_digital_surface_model(wbt_info::WhiteboxTools = wbt_info; i=nothing, output=nothing, resolution=1.0, radius=0.5, minz=nothing, maxz=nothing, max_triangle_edge_length=nothing, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input LiDAR file (including extension).
• output: Output raster file (including extension).
• resolution: Output raster's grid resolution.
• radius: Search Radius.
• minz: Optional minimum elevation for inclusion in interpolation.
• maxz: Optional maximum elevation for inclusion in interpolation.
• max_triangle_edge_length: Optional maximum triangle edge length; triangles larger than this size will not be gridded.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_elevation_slice(wbt_info::WhiteboxTools = wbt_info; i, output, minz=nothing, maxz=nothing, cls=false, inclassval=2, outclassval=1, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• minz: Minimum elevation value (optional).
• maxz: Maximum elevation value (optional).
• cls: Optional boolean flag indicating whether points outside the range should be retained in output but reclassified.
• inclassval: Optional parameter specifying the class value assigned to points within the slice.
• outclassval: Optional parameter specifying the class value assigned to points within the slice.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_ground_point_filter(wbt_info::WhiteboxTools = wbt_info; i, output, radius=2.0, min_neighbours=0, slope_threshold=45.0, height_threshold=1.0, classify=true, slope_norm=true, height_above_ground=false, callback::Union{Nothing,Function}=nothing)

Identifies ground points within LiDAR dataset using a slope-based method.

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• radius: Search Radius.
• min_neighbours: The minimum number of neighbouring points within search areas. If fewer points than this threshold are identified during the fixed-radius search, a subsequent kNN search is performed to identify the k number of neighbours.
• slope_threshold: Maximum inter-point slope to be considered an off-terrain point.
• height_threshold: Inter-point height difference to be considered an off-terrain point.
• classify: Classify points as ground (2) or off-ground (1).
• slope_norm: Perform initial ground slope normalization?.
• height_above_ground: Transform output to height above average ground elevation?.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_hex_binning(wbt_info::WhiteboxTools = wbt_info; i, output, width, orientation="horizontal", callback::Union{Nothing,Function}=nothing)

Hex-bins a set of LiDAR points.

Arguments

• i: Input base file.
• output: Output vector polygon file.
• width: The grid cell width.
• orientation: Grid Orientation, 'horizontal' or 'vertical'.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_hillshade(wbt_info::WhiteboxTools = wbt_info; i, output, azimuth=315.0, altitude=30.0, radius=1.0, callback::Union{Nothing,Function}=nothing)

Calculates a hillshade value for points within a LAS file and stores these data in the RGB field.

Arguments

• i: Input LiDAR file.
• output: Output file.
• azimuth: Illumination source azimuth in degrees.
• altitude: Illumination source altitude in degrees.
• radius: Search Radius.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_histogram(wbt_info::WhiteboxTools = wbt_info; i, output, parameter="elevation", clip=1.0, callback::Union{Nothing,Function}=nothing)

Creates a histogram of LiDAR data.

Arguments

• i: Input LiDAR file.
• output: Output HTML file (default name will be based on input file if unspecified).
• parameter: Parameter; options are 'elevation' (default), 'intensity', 'scan angle', 'class', 'time'.
• clip: Amount to clip distribution tails (in percent).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_idw_interpolation(wbt_info::WhiteboxTools = wbt_info; i=nothing, output=nothing, parameter="elevation", returns="all", resolution=1.0, weight=1.0, radius=2.5, exclude_cls=nothing, minz=nothing, maxz=nothing, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file (including extension).
• output: Output raster file (including extension).
• parameter: Interpolation parameter; options are 'elevation' (default), 'intensity', 'class', 'returnnumber', 'numberof_returns', 'scan angle', 'rgb', 'user data'.
• returns: Point return types to include; options are 'all' (default), 'last', 'first'.
• resolution: Output raster's grid resolution.
• weight: IDW weight value.
• radius: Search Radius.
• exclude_cls: Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, –exclude_cls='3,4,5,6,7,18'.
• minz: Optional minimum elevation for inclusion in interpolation.
• maxz: Optional maximum elevation for inclusion in interpolation.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_info(wbt_info::WhiteboxTools = wbt_info; i, output=nothing, vlr=true, geokeys=true, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file.
• output: Output HTML file for summary report.
• vlr: Flag indicating whether or not to print the variable length records (VLRs).
• geokeys: Flag indicating whether or not to print the geokeys.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_join(wbt_info::WhiteboxTools = wbt_info; inputs, output, callback::Union{Nothing,Function}=nothing)

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

Arguments

• inputs: Input LiDAR files.
• output: Output LiDAR file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_kappa_index(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, class_accuracy, resolution=1.0, callback::Union{Nothing,Function}=nothing)

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

Arguments

• input1: Input LiDAR classification file.
• input2: Input LiDAR reference file.
• output: Output HTML file.
• class_accuracy: Output classification accuracy raster file.
• resolution: Output raster's grid resolution.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_nearest_neighbour_gridding(wbt_info::WhiteboxTools = wbt_info; i=nothing, output=nothing, parameter="elevation", returns="all", resolution=1.0, radius=2.5, exclude_cls=nothing, minz=nothing, maxz=nothing, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file (including extension).
• output: Output raster file (including extension).
• parameter: Interpolation parameter; options are 'elevation' (default), 'intensity', 'class', 'returnnumber', 'numberof_returns', 'scan angle', 'rgb', 'user data'.
• returns: Point return types to include; options are 'all' (default), 'last', 'first'.
• resolution: Output raster's grid resolution.
• radius: Search Radius.
• exclude_cls: Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, –exclude_cls='3,4,5,6,7,18'.
• minz: Optional minimum elevation for inclusion in interpolation.
• maxz: Optional maximum elevation for inclusion in interpolation.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_point_density(wbt_info::WhiteboxTools = wbt_info; i=nothing, output=nothing, returns="all", resolution=1.0, radius=2.5, exclude_cls=nothing, minz=nothing, maxz=nothing, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file (including extension).
• output: Output raster file (including extension).
• returns: Point return types to include; options are 'all' (default), 'last', 'first'.
• resolution: Output raster's grid resolution.
• radius: Search radius.
• exclude_cls: Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, –exclude_cls='3,4,5,6,7,18'.
• minz: Optional minimum elevation for inclusion in interpolation.
• maxz: Optional maximum elevation for inclusion in interpolation.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_point_stats(wbt_info::WhiteboxTools = wbt_info; i=nothing, resolution=1.0, num_points=true, num_pulses=false, avg_points_per_pulse=true, z_range=false, intensity_range=false, predom_class=false, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file.
• resolution: Output raster's grid resolution.
• num_points: Flag indicating whether or not to output the number of points (returns) raster.
• num_pulses: Flag indicating whether or not to output the number of pulses raster.
• avg_points_per_pulse: Flag indicating whether or not to output the average number of points (returns) per pulse raster.
• z_range: Flag indicating whether or not to output the elevation range raster.
• intensity_range: Flag indicating whether or not to output the intensity range raster.
• predom_class: Flag indicating whether or not to output the predominant classification raster.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_ransac_planes(wbt_info::WhiteboxTools = wbt_info; i, output, radius=2.0, num_iter=50, num_samples=5, threshold=0.35, model_size=8, max_slope=80.0, classify=false, last_returns=false, callback::Union{Nothing,Function}=nothing)

Performs a RANSAC analysis to identify points within a LiDAR point cloud that belong to linear planes.

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• radius: Search Radius.
• num_iter: Number of iterations.
• num_samples: Number of sample points on which to build the model.
• threshold: Threshold used to determine inlier points.
• model_size: Acceptable model size.
• max_slope: Maximum planar slope.
• classify: Classify points as ground (2) or off-ground (1).
• last_returns: Only include last- and only-return points.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_rbf_interpolation(wbt_info::WhiteboxTools = wbt_info; i=nothing, output=nothing, parameter="elevation", returns="all", resolution=1.0, num_points=20, exclude_cls=nothing, minz=nothing, maxz=nothing, func_type="ThinPlateSpline", poly_order="none", weight=5, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file (including extension).
• output: Output raster file (including extension).
• parameter: Interpolation parameter; options are 'elevation' (default), 'intensity', 'class', 'returnnumber', 'numberof_returns', 'scan angle', 'rgb', 'user data'.
• returns: Point return types to include; options are 'all' (default), 'last', 'first'.
• resolution: Output raster's grid resolution.
• num_points: Number of points.
• exclude_cls: Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, –exclude_cls='3,4,5,6,7,18'.
• minz: Optional minimum elevation for inclusion in interpolation.
• maxz: Optional maximum elevation for inclusion in interpolation.
• func_type: Radial basis function type; options are 'ThinPlateSpline' (default), 'PolyHarmonic', 'Gaussian', 'MultiQuadric', 'InverseMultiQuadric'.
• poly_order: Polynomial order; options are 'none' (default), 'constant', 'affine'.
• weight: Weight parameter used in basis function.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_remove_duplicates(wbt_info::WhiteboxTools = wbt_info; i, output, include_z=false, callback::Union{Nothing,Function}=nothing)

Removes duplicate points from a LiDAR data set.

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• include_z: Include z-values in point comparison?.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_remove_outliers(wbt_info::WhiteboxTools = wbt_info; i, output, radius=2.0, elev_diff=50.0, use_median=false, classify=true, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• radius: Search Radius.
• elev_diff: Max. elevation difference.
• use_median: Optional flag indicating whether to use the difference from median elevation rather than mean.
• classify: Classify points as ground (2) or off-ground (1).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_rooftop_analysis(wbt_info::WhiteboxTools = wbt_info; buildings, output, i=nothing, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=65.0, norm_diff=10.0, azimuth=180.0, altitude=30.0, callback::Union{Nothing,Function}=nothing)

Identifies roof segments in a LiDAR point cloud.

Arguments

• i: Input LiDAR file.
• buildings: Input vector build footprint polygons file.
• output: Output vector polygon file.
• radius: Search Radius.
• num_iter: Number of iterations.
• num_samples: Number of sample points on which to build the model.
• threshold: Threshold used to determine inlier points (in elevation units).
• model_size: Acceptable model size, in points.
• max_slope: Maximum planar slope, in degrees.
• norm_diff: Maximum difference in normal vectors, in degrees.
• azimuth: Illumination source azimuth, in degrees.
• altitude: Illumination source altitude in degrees.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_segmentation(wbt_info::WhiteboxTools = wbt_info; i, output, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=80.0, norm_diff=10.0, maxzdiff=1.0, classes=false, ground=false, callback::Union{Nothing,Function}=nothing)

Segments a LiDAR point cloud based on differences in the orientation of fitted planar surfaces and point proximity.

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• radius: Search Radius.
• num_iter: Number of iterations.
• num_samples: Number of sample points on which to build the model.
• threshold: Threshold used to determine inlier points.
• model_size: Acceptable model size.
• max_slope: Maximum planar slope.
• norm_diff: Maximum difference in normal vectors, in degrees.
• maxzdiff: Maximum difference in elevation (z units) between neighbouring points of the same segment.
• classes: Segments don't cross class boundaries.
• ground: Classify the largest segment as ground points?.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_segmentation_based_filter(wbt_info::WhiteboxTools = wbt_info; i, output, radius=5.0, norm_diff=2.0, maxzdiff=1.0, classify=false, callback::Union{Nothing,Function}=nothing)

Identifies ground points within LiDAR point clouds using a segmentation based approach.

Arguments

• i: Input LiDAR file.
• output: Output file.
• radius: Search Radius.
• norm_diff: Maximum difference in normal vectors, in degrees.
• maxzdiff: Maximum difference in elevation (z units) between neighbouring points of the same segment.
• classify: Classify points as ground (2) or off-ground (1).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_shift(wbt_info::WhiteboxTools = wbt_info; i, output, x_shift="", y_shift="", z_shift="", callback::Union{Nothing,Function}=nothing)

Shifts the x,y,z coordinates of a LiDAR file.

Arguments

• i: Name of the input LiDAR points.
• output: Name of the output LiDAR points.
• x_shift: x-shift value, blank for none.
• y_shift: y-shift value, blank for none.
• z_shift: z-shift value, blank for none.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_thin(wbt_info::WhiteboxTools = wbt_info; i, output, resolution=2.0, method="lowest", save_filtered=false, callback::Union{Nothing,Function}=nothing)

Thins a LiDAR point cloud, reducing point density.

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• resolution: The size of the square area used to evaluate nearby points in the LiDAR data.
• method: Point selection method; options are 'first', 'last', 'lowest' (default), 'highest', 'nearest'.
• save_filtered: Save filtered points to separate file?.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_thin_high_density(wbt_info::WhiteboxTools = wbt_info; i, output, density, resolution=1.0, save_filtered=false, callback::Union{Nothing,Function}=nothing)

Thins points from high density areas within a LiDAR point cloud.

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• resolution: Output raster's grid resolution.
• density: Max. point density (points / m^3).
• save_filtered: Save filtered points to separate file?.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_tile(wbt_info::WhiteboxTools = wbt_info; i, width=1000.0, height=1000.0, origin_x=0.0, origin_y=0.0, min_points=2, callback::Union{Nothing,Function}=nothing)

Tiles a LiDAR LAS file into multiple LAS files.

Arguments

• i: Input LiDAR file.
• width: Width of tiles in the X dimension; default 1000.0.
• height: Height of tiles in the Y dimension.
• origin_x: Origin point X coordinate for tile grid.
• origin_y: Origin point Y coordinate for tile grid.
• min_points: Minimum number of points contained in a tile for it to be saved.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_tile_footprint(wbt_info::WhiteboxTools = wbt_info; output, i=nothing, hull=false, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file.
• output: Output vector polygon file.
• hull: Identify the convex hull around points.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_tin_gridding(wbt_info::WhiteboxTools = wbt_info; i=nothing, output=nothing, parameter="elevation", returns="all", resolution=1.0, exclude_cls="7,18", minz=nothing, maxz=nothing, max_triangle_edge_length=nothing, callback::Union{Nothing,Function}=nothing)

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

Arguments

• i: Input LiDAR file (including extension).
• output: Output raster file (including extension).
• parameter: Interpolation parameter; options are 'elevation' (default), 'intensity', 'class', 'returnnumber', 'numberof_returns', 'scan angle', 'rgb', 'user data'.
• returns: Point return types to include; options are 'all' (default), 'last', 'first'.
• resolution: Output raster's grid resolution.
• exclude_cls: Optional exclude classes from interpolation; Valid class values range from 0 to 18, based on LAS specifications. Example, –exclude_cls='3,4,5,6,7,18'.
• minz: Optional minimum elevation for inclusion in interpolation.
• maxz: Optional maximum elevation for inclusion in interpolation.
• max_triangle_edge_length: Optional maximum triangle edge length; triangles larger than this size will not be gridded.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lidar_tophat_transform(wbt_info::WhiteboxTools = wbt_info; i, output, radius=1.0, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input LiDAR file.
• output: Output LiDAR file.
• radius: Search Radius.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

line_detection_filter(wbt_info::WhiteboxTools = wbt_info; i, output, variant="vertical", absvals=false, clip=0.0, callback::Union{Nothing,Function}=nothing)

Performs a line-detection filter on an image.

Arguments

• i: Input raster file.
• output: Output raster file.
• variant: Optional variant value. Options include 'v' (vertical), 'h' (horizontal), '45', and '135' (default is 'v').
• absvals: Optional flag indicating whether outputs should be absolute values.
• clip: Optional amount to clip the distribution tails by, in percent.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

line_intersections(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

Identifies points where the features of two vector line layers intersect.

Arguments

• input1: Input vector polyline file.
• input2: Input vector polyline file.
• output: Output vector point file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

line_thinning(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Performs line thinning a on Boolean raster image; intended to be used with the RemoveSpurs tool.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

linearity_index(wbt_info::WhiteboxTools = wbt_info; i, callback::Union{Nothing,Function}=nothing)

Calculates the linearity index for vector polygons.

Arguments

• i: Input vector polygon file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lines_to_polygons(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Converts vector polylines to polygons.

Arguments

• i: Input vector line file.
• output: Output vector polygon file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

list_tools(keywords::Vector{String}=[""], wbt_info::WhiteboxTools = wbt_info; return_obj::Bool = false)

Lists all available tools in WhiteboxTools.

list_unique_values(wbt_info::WhiteboxTools = wbt_info; i, field, output, callback::Union{Nothing,Function}=nothing)

Lists the unique values contained in a field within a vector's attribute table.

Arguments

• i: Input raster file.
• field: Input field name in attribute table.
• output: Output HTML file (default name will be based on input file if unspecified).
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

ln(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Returns the natural logarithm of values in a raster.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

local_quadratic_regression(wbt_info::WhiteboxTools = wbt_info; dem, output, filter=3, callback::Union{Nothing,Function}=nothing)

This tool is an implementation of the constrained quadratic regression algorithm using a flexible window size described in Wood (1996).

Arguments

• dem: Name of the input DEM raster file.
• output: Name of the output raster file.
• filter: Edge length of the filter kernel.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

log10(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Returns the base-10 logarithm of values in a raster.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

log2(wbt_info::WhiteboxTools = wbt_info; i, output, callback::Union{Nothing,Function}=nothing)

Returns the base-2 logarithm of values in a raster.

Arguments

• i: Input raster file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

long_profile(wbt_info::WhiteboxTools = wbt_info; d8_pntr, streams, dem, output, esri_pntr=false, callback::Union{Nothing,Function}=nothing)

Plots the stream longitudinal profiles for one or more rivers.

Arguments

• d8_pntr: Input raster D8 pointer file.
• streams: Input raster streams file.
• dem: Input raster DEM file.
• output: Output HTML file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

long_profile_from_points(wbt_info::WhiteboxTools = wbt_info; d8_pntr, points, dem, output, esri_pntr=false, callback::Union{Nothing,Function}=nothing)

Plots the longitudinal profiles from flow-paths initiating from a set of vector points.

Arguments

• d8_pntr: Input raster D8 pointer file.
• points: Input vector points file.
• dem: Input raster DEM file.
• output: Output HTML file.
• esri_pntr: D8 pointer uses the ESRI style scheme.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

longest_flowpath(wbt_info::WhiteboxTools = wbt_info; dem, basins, output, callback::Union{Nothing,Function}=nothing)

Delineates the longest flowpaths for a group of subbasins or watersheds.

Arguments

• dem: Input raster DEM file.
• basins: Input raster basins file.
• output: Output vector file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

lowest_position(wbt_info::WhiteboxTools = wbt_info; inputs, output, callback::Union{Nothing,Function}=nothing)

Identifies the stack position of the minimum value within a raster stack on a cell-by-cell basis.

Arguments

• inputs: Input raster files.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

majority_filter(wbt_info::WhiteboxTools = wbt_info; i, output, filterx=11, filtery=11, callback::Union{Nothing,Function}=nothing)

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.

Arguments

• i: Input raster file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

map_off_terrain_objects(wbt_info::WhiteboxTools = wbt_info; dem, output, max_slope=40.0, min_size=1, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• max_slope: Maximum inter-cell absolute slope.
• min_size: Minimum feature size, in grid cells.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max(wbt_info::WhiteboxTools = wbt_info; input1, input2, output, callback::Union{Nothing,Function}=nothing)

Performs a MAX operation on two rasters or a raster and a constant value.

Arguments

• input1: Input raster file or constant value.
• input2: Input raster file or constant value.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_absolute_overlay(wbt_info::WhiteboxTools = wbt_info; inputs, output, callback::Union{Nothing,Function}=nothing)

Evaluates the maximum absolute value for each grid cell from a stack of input rasters.

Arguments

• inputs: Input raster files.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_anisotropy_dev(wbt_info::WhiteboxTools = wbt_info; dem, out_mag, out_scale, max_scale, min_scale=3, step=2, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• out_mag: Output raster DEVmax magnitude file.
• out_scale: Output raster DEVmax scale file.
• min_scale: Minimum search neighbourhood radius in grid cells.
• max_scale: Maximum search neighbourhood radius in grid cells.
• step: Step size as any positive non-zero integer.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_anisotropy_dev_signature(wbt_info::WhiteboxTools = wbt_info; dem, points, output, max_scale, min_scale=1, step=1, callback::Union{Nothing,Function}=nothing)

Calculates the anisotropy in deviation from mean for points over a range of spatial scales.

Arguments

• dem: Input raster DEM file.
• points: Input vector points file.
• output: Output HTML file.
• min_scale: Minimum search neighbourhood radius in grid cells.
• max_scale: Maximum search neighbourhood radius in grid cells.
• step: Step size as any positive non-zero integer.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_branch_length(wbt_info::WhiteboxTools = wbt_info; dem, output, log=false, callback::Union{Nothing,Function}=nothing)

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

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• log: Optional flag to request the output be log-transformed.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_difference_from_mean(wbt_info::WhiteboxTools = wbt_info; dem, out_mag, out_scale, min_scale, max_scale, step=1, callback::Union{Nothing,Function}=nothing)

Calculates the maximum difference from mean elevation over a range of spatial scales.

Arguments

• dem: Input raster DEM file.
• out_mag: Output raster DIFFmax magnitude file.
• out_scale: Output raster DIFFmax scale file.
• min_scale: Minimum search neighbourhood radius in grid cells.
• max_scale: Maximum search neighbourhood radius in grid cells.
• step: Step size as any positive non-zero integer.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_downslope_elev_change(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Calculates the maximum downslope change in elevation between a grid cell and its eight downslope neighbors.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_elev_dev_signature(wbt_info::WhiteboxTools = wbt_info; dem, points, output, min_scale, max_scale, step=10, callback::Union{Nothing,Function}=nothing)

Calculates the maximum elevation deviation over a range of spatial scales and for a set of points.

Arguments

• dem: Input raster DEM file.
• points: Input vector points file.
• output: Output HTML file.
• min_scale: Minimum search neighbourhood radius in grid cells.
• max_scale: Maximum search neighbourhood radius in grid cells.
• step: Step size as any positive non-zero integer.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_elevation_deviation(wbt_info::WhiteboxTools = wbt_info; dem, out_mag, out_scale, min_scale, max_scale, step=1, callback::Union{Nothing,Function}=nothing)

Calculates the maximum elevation deviation over a range of spatial scales.

Arguments

• dem: Input raster DEM file.
• out_mag: Output raster DEVmax magnitude file.
• out_scale: Output raster DEVmax scale file.
• min_scale: Minimum search neighbourhood radius in grid cells.
• max_scale: Maximum search neighbourhood radius in grid cells.
• step: Step size as any positive non-zero integer.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_overlay(wbt_info::WhiteboxTools = wbt_info; inputs, output, callback::Union{Nothing,Function}=nothing)

Evaluates the maximum value for each grid cell from a stack of input rasters.

Arguments

• inputs: Input raster files.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_upslope_elev_change(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Calculates the maximum upslope change in elevation between a grid cell and its eight downslope neighbors.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

max_upslope_flowpath_length(wbt_info::WhiteboxTools = wbt_info; dem, output, callback::Union{Nothing,Function}=nothing)

Measures the maximum length of all upslope flowpaths draining each grid cell.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

maximal_curvature(wbt_info::WhiteboxTools = wbt_info; dem, output, log=false, zfactor=nothing, callback::Union{Nothing,Function}=nothing)

Calculates a mean curvature raster from an input DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• log: Display output values using a log-scale.
• zfactor: Optional multiplier for when the vertical and horizontal units are not the same.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

maximum_filter(wbt_info::WhiteboxTools = wbt_info; i, output, filterx=11, filtery=11, callback::Union{Nothing,Function}=nothing)

Assigns each cell in the output grid the maximum value in a moving window centred on each grid cell in the input raster.

Arguments

• i: Input raster file.
• output: Output raster file.
• filterx: Size of the filter kernel in the x-direction.
• filtery: Size of the filter kernel in the y-direction.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.

md_inf_flow_accumulation(wbt_info::WhiteboxTools = wbt_info; dem, output, out_type="specific contributing area", exponent=1.1, threshold=nothing, log=false, clip=false, callback::Union{Nothing,Function}=nothing)

Calculates an FD8 flow accumulation raster from an input DEM.

Arguments

• dem: Input raster DEM file.
• output: Output raster file.
• out_type: Output type; one of 'cells', 'specific contributing area' (default), and 'catchment area'.
• exponent: Optional exponent parameter; default is 1.1.
• threshold: Optional convergence threshold parameter, in grid cells; default is infinity.
• log: Optional flag to request the output be log-transformed.
• clip: Optional flag to request clipping the display max by 1%.
• callback::Union{Nothing,Function}: Custom function for handling tool text outputs.