diff --git a/articles/demo.html b/articles/demo.html index 9a61c52c..c1cd182a 100644 --- a/articles/demo.html +++ b/articles/demo.html @@ -205,7 +205,7 @@

Working with Raster Data
 # the SpatRaster retains a reference to the input file name
 terra::sources(outputras)
-#> [1] "/tmp/Rtmpy8s8At/slope.tif"
+#> [1] "/tmp/RtmpniWwxL/slope.tif"
@@ -397,7 +397,7 @@

Running tools# run breach_depressions tool wbt_breach_depressions(dem = input, output = output) -#> breach_depressions - Elapsed Time (excluding I/O): 0.7s

+#> breach_depressions - Elapsed Time (excluding I/O): 0.6s

For more info see: ?wbt_breach_depressions

These wbt_*_tool_name_*() functions are wrappers around the wbt_run_tool() function that does the @@ -540,7 +540,7 @@

output = file.path(wd, "toy_dem_breached_accum.tif"), out_type = "cells" ) -#> d8_flow_accumulation - Elapsed Time (excluding I/O): 0.5s +#> d8_flow_accumulation - Elapsed Time (excluding I/O): 0.6s
Additional Flow Direction and Accumulation Tools
@@ -581,10 +581,10 @@
Additional Flow Direct #> Rho8Pointer: Calculates a stochastic Rho8 flow pointer raster from an input DEM. #> SnapPourPoints: Moves outlet points used to specify points of interest in a watershedding operation to the cell with the highest flow accumulation in its neighbourhood. #> TraceDownslopeFlowpaths: Traces downslope flowpaths from one or more target sites (i.e. seed points). -#> Rho8FlowAccumulation: Calculates Fairfield and Leymarie (1991) flow accumulation. -#> MaxUpslopeValue: Calculates the maximum upslope value from an input values raster along flowpaths. #> QinFlowAccumulation: Calculates Qin et al. (2007) flow accumulation. +#> MaxUpslopeValue: Calculates the maximum upslope value from an input values raster along flowpaths. #> QuinnFlowAccumulation: Calculates Quinn et al. (1995) flow accumulation. +#> Rho8FlowAccumulation: Calculates Fairfield and Leymarie (1991) flow accumulation. #> ConvergenceIndex: Calculates Qin et al. (2007) flow accumulation.

This is just an example of the wealth of tool options made available by the WhiteboxTools platform.

@@ -626,7 +626,7 @@

streams = file.path(wd, "toy_dem_streams.tif"), output = file.path(wd, "toy_dem_tributaries.tif") ) -#> tributary_identifier - Elapsed Time (excluding I/O): 0.0s

+#> tributary_identifier - Elapsed Time (excluding I/O): 0.1s

Compare results @@ -745,9 +745,9 @@

#> FD8FlowAccumulation: Calculates an FD8 flow accumulation raster from an input DEM. #> FlowAccumulationFullWorkflow: Resolves all of the depressions in a DEM, outputting a breached DEM, an aspect-aligned non-divergent flow pointer, and a flow accumulation raster. #> MDInfFlowAccumulation: Calculates an FD8 flow accumulation raster from an input DEM. +#> Rho8FlowAccumulation: Calculates Fairfield and Leymarie (1991) flow accumulation. #> QinFlowAccumulation: Calculates Qin et al. (2007) flow accumulation. -#> QuinnFlowAccumulation: Calculates Quinn et al. (1995) flow accumulation. -#> Rho8FlowAccumulation: Calculates Fairfield and Leymarie (1991) flow accumulation.

+#> QuinnFlowAccumulation: Calculates Quinn et al. (1995) flow accumulation.

diff --git a/articles/wbt-method.html b/articles/wbt-method.html index 7b3ac15f..76853932 100644 --- a/articles/wbt-method.html +++ b/articles/wbt-method.html @@ -127,10 +127,10 @@

Result Objects#> <wbt_result> #> --- PARAMETERS (Slope) --- #> dem : '/home/runner/work/_temp/Library/whitebox/extdata/DEM.tif' -#> output : '/tmp/Rtmp3rOKmL/slope.tif' +#> output : '/tmp/RtmpTo4IsY/slope.tif' #> --- RESULT --- #> $output -#> File result: //tmp/Rtmp3rOKmL/slope.tif exists (Last modified: 2024-05-27 00:00:28.869362)

+#> File result: //tmp/RtmpTo4IsY/slope.tif exists (Last modified: 2024-05-27 13:49:06.160806)

Whether a system call succeeds or fails the parameters that were passed to the WhiteboxTools executable and references to any output file paths that were specified are returned. If output files reference @@ -149,7 +149,7 @@

Result Objects#> <wbt_result> #> --- PARAMETERS (Slope) --- #> goof : '/home/runner/work/_temp/Library/whitebox/extdata/DEM.tif' -#> output : '/tmp/Rtmp3rOKmL/slope.tif' +#> output : '/tmp/RtmpTo4IsY/slope.tif' #> #> Slope ERROR: 'goof' invalid; 'dem' required

When a call fails an informative error message issued, and the error @@ -168,7 +168,7 @@

str(wbt("slope", dem = dem, output = file.path(tempdir(), "slope.tif")), max.level = 1) #> List of 6 #> $ tool : chr "Slope" -#> $ args : chr "--dem=/home/runner/work/_temp/Library/whitebox/extdata/DEM.tif --output=/tmp/Rtmp3rOKmL/slope.tif" +#> $ args : chr "--dem=/home/runner/work/_temp/Library/whitebox/extdata/DEM.tif --output=/tmp/RtmpTo4IsY/slope.tif" #> $ stdout : chr "Slope - Elapsed Time (excluding I/O): 0.11s" #> $ crs : chr "" #> ..- attr(*, "package")= Named chr "" @@ -253,8 +253,8 @@

Compare ras t1 #> <wbt_result> #> --- PARAMETERS (Slope) --- -#> dem : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f5374a5d025.tif' -#> output : '/tmp/Rtmp3rOKmL/slope.tif' +#> dem : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e574d43b9f7.tif' +#> output : '/tmp/RtmpTo4IsY/slope.tif' #> --- RESULT --- #> $output #> class : SpatRaster @@ -334,7 +334,7 @@

# create a GeoPackage terra::writeVector(x2, filename = file.path(tempdir(), "lux.gpkg"), overwrite = TRUE) #> Warning in x@ptr$write(filename, layer, filetype, insert[1], overwrite[1], : -#> GDAL Message 6: dataset /tmp/Rtmp3rOKmL/lux.gpkg does not support layer +#> GDAL Message 6: dataset /tmp/RtmpTo4IsY/lux.gpkg does not support layer #> creation option ENCODING 
 
@@ -344,14 +344,14 @@ 

 wbt("polygon_area", input = x3)
 #> <wbt_result>
 #> --- PARAMETERS (PolygonArea) ---
-#> input    : '/tmp/Rtmp3rOKmL/lux.gpkg_file3f531cd4b079.shp' 
+#> input    : '/tmp/RtmpTo4IsY/lux.gpkg_file3e576b34a951.shp' 
 #> --- RESULT ---
 #> $output
 #>  class       : SpatVectorProxy
 #>  geometry    : polygons 
 #>  dimensions  : 12, 6  (geometries, attributes)
 #>  extent      : 5.74414, 6.528252, 49.44781, 50.18162  (xmin, xmax, ymin, ymax)
-#>  source      : lux.gpkg_file3f531cd4b079.shp
+#>  source      : lux.gpkg_file3e576b34a951.shp
 #>  coord. ref. : lon/lat WGS 84 (EPSG:4326) 
 #>  names       :  ID_1 NAME_1  ID_2 NAME_2   POP  AREA
 #>  type        : <num>  <chr> <num>  <chr> <int> <num>
@@ -394,11 +394,11 @@

Using pipesx2 #> <wbt_result> #> --- PARAMETERS (Slope) --- -#> dem : '//tmp/Rtmp3rOKmL/slope.tif' -#> output : '/tmp/Rtmp3rOKmL/curvature.tif' +#> dem : '//tmp/RtmpTo4IsY/slope.tif' +#> output : '/tmp/RtmpTo4IsY/curvature.tif' #> --- RESULT --- #> $output -#> File result: //tmp/Rtmp3rOKmL/curvature.tif exists (Last modified: 2024-05-27 00:00:31.281393) +#> File result: //tmp/RtmpTo4IsY/curvature.tif exists (Last modified: 2024-05-27 13:49:08.588789) #> --- HISTORY --- #> Prior results (n=1) for: Slope #> - Slope (output<character>) @@ -407,7 +407,7 @@

Using pipes
 str(wbt_result(x2), max.level = 1)
-#>  chr [1:2] "//tmp/Rtmp3rOKmL/slope.tif" "//tmp/Rtmp3rOKmL/curvature.tif"
+#> chr [1:2] "//tmp/RtmpTo4IsY/slope.tif" "//tmp/RtmpTo4IsY/curvature.tif"

The $history element is a list of the wbt_result from individual runs.

@@ -440,7 +440,7 @@ 
Using pipes#> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent'
 #> <wbt_result>
 #> --- PARAMETERS (Slope) ---
-#> output   : '/tmp/Rtmp3rOKmL/foo.tif' 
+#> output   : '/tmp/RtmpTo4IsY/foo.tif' 
 #> 
 #>  Slope ERROR: 'dem' required 
 #> --- HISTORY ---
@@ -494,8 +494,8 @@ 
Setting the CRSwbt("slope", dem = araster, output = file.path(tempdir(), "foo.tif"))
 #> <wbt_result>
 #> --- PARAMETERS (Slope) ---
-#> dem  : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f5340875334.tif'
-#> output   : '/tmp/Rtmp3rOKmL/foo.tif' 
+#> dem  : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e57550f98f.tif'
+#> output   : '/tmp/RtmpTo4IsY/foo.tif' 
 #> --- RESULT ---
 #> $output
 #> class       : SpatRaster 
@@ -513,8 +513,8 @@ 
Setting the CRSwbt("slope", dem = terra::rast(dem), crs = "EPSG:26918", output = file.path(tempdir(), "foo.tif"))
 #> <wbt_result>
 #> --- PARAMETERS (Slope) ---
-#> dem  : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f5317abf5f.tif'
-#> output   : '/tmp/Rtmp3rOKmL/foo.tif' 
+#> dem  : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e573510aabe.tif'
+#> output   : '/tmp/RtmpTo4IsY/foo.tif' 
 #> --- RESULT ---
 #> $output
 #> class       : SpatRaster 
@@ -543,9 +543,9 @@ 
Setting the CRS#> NOTE: Input CRS do not match.
 #> <wbt_result>
 #> --- PARAMETERS (Add) ---
-#> input1   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f53653e4d7.tif'
-#> input2   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f536e5c9aa4.tif'
-#> output   : '/tmp/Rtmp3rOKmL/foo.tif' 
+#> input1   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e57320ccaad.tif'
+#> input2   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e5720a6616b.tif'
+#> output   : '/tmp/RtmpTo4IsY/foo.tif' 
 #> --- RESULT ---
 #> $output
 #> class       : SpatRaster 
@@ -568,9 +568,9 @@ 
Setting the CRS   )
 #> <wbt_result>
 #> --- PARAMETERS (Add) ---
-#> input1   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f5369dfba6d.tif'
-#> input2   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f5336597977.tif'
-#> output   : '/tmp/Rtmp3rOKmL/foo.tif' 
+#> input1   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e572052046b.tif'
+#> input2   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e573c4e050b.tif'
+#> output   : '/tmp/RtmpTo4IsY/foo.tif' 
 #> --- RESULT ---
 #> $output
 #> class       : SpatRaster 
diff --git a/pkgdown.yml b/pkgdown.yml
index 8e954449..6a13d0d6 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -5,5 +5,5 @@ articles:
   datasets: datasets.html
   demo: demo.html
   wbt-method: wbt-method.html
-last_built: 2024-05-26T23:58Z
+last_built: 2024-05-27T13:47Z
 
diff --git a/search.json b/search.json
index b9cb2806..9d489d3b 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 whitebox authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"/articles/datasets.html","id":"whitebox-tool-metadata","dir":"Articles","previous_headings":"","what":"whitebox Tool Metadata","title":"whitebox Tool Metadata","text":"vignette provides introduction data sets included whitebox package. data sets contain names, arguments metadata tools available WhiteboxTools.","code":""},{"path":"/articles/datasets.html","id":"what-version-of-whiteboxtools-are-these-data-sets-generated-from","dir":"Articles","previous_headings":"whitebox Tool Metadata","what":"What version of WhiteboxTools are these data sets generated from?","title":"whitebox Tool Metadata","text":"Current version: 2.4.0 Internal data sets functions defined R package correspond tool names available recent version WhiteboxTools. Data sets dynamically generated WhiteboxTools installation. Relatively recent versions WhiteboxTools supported backward-compatibly, though newer functionality usable.","code":""},{"path":"/articles/datasets.html","id":"whiteboxtools-tool-names-and-r-function-names","dir":"Articles","previous_headings":"whitebox Tool Metadata","what":"WhiteboxTools Tool Names and R Function Names","title":"whitebox Tool Metadata","text":"first data set describes tool names WhiteboxTools corresponding exported function R package, along WhiteboxTools Toolbox name brief description. wbttools data set data.frame 537 tools 7 variables \"tool_name\" - WhiteboxTools tool name \"function_name\" - R function tool name \"toolbox_name\" - WhiteboxTools toolbox name \"label\" - WhiteboxTools tool label \"description\" - Brief description \"github\" - GitHub link \"book\" - Reference manual link \"is_extension\" - Tool part General Toolset Extension (GTE), opposed “open core” R function naming style differs tool names WhiteboxTools, core words . R function names derived WhiteboxTools name follows: PascalCase tool names change snake_case R function names get prefix wbt_ example, StreamSlopeContinuous WhiteboxTools becomes wbt_stream_slope_continuous() R.","code":"data(\"wbttools\", package = \"whitebox\")  str(wbttools) #> 'data.frame':    537 obs. of  8 variables: #>  $ tool_name    : chr  \"AbsoluteValue\" \"AccumulationCurvature\" \"AdaptiveFilter\" \"Add\" ... #>  $ function_name: chr  \"wbt_absolute_value\" \"wbt_accumulation_curvature\" \"wbt_adaptive_filter\" \"wbt_add\" ... #>  $ toolbox_name : chr  \"Math and Stats Tools\" \"Geomorphometric Analysis\" \"Image Processing Tools\" \"Math and Stats Tools\" ... #>  $ label        : chr  \"Absolute Value\" \"Accumulation Curvature\" \"Adaptive Filter\" \"Add\" ... #>  $ description  : chr  \"Calculates the absolute value of every cell in a raster.\" \"This tool calculates accumulation curvature from an input DEM.\" \"Performs an adaptive filter on an image.\" \"Performs an addition operation on two rasters or a raster and a constant value.\" ... #>  $ github       : chr  \"https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/math_stat_analysis/abs.rs\" \"Source code is unavailable due to proprietary license.\" \"https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/image_analysis/adaptive_filter.rs\" \"https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/math_stat_analysis/add.rs\" ... #>  $ book         : chr  \"https://www.whiteboxgeo.com/manual/wbt_book/available_tools/mathand_stats_tools.html#AbsoluteValue\" \"https://www.whiteboxgeo.com/manual/wbt_book/available_tools/geomorphometric_analysis.html#AccumulationCurvature\" \"https://www.whiteboxgeo.com/manual/wbt_book/available_tools/image_processing_tools.html#AdaptiveFilter\" \"https://www.whiteboxgeo.com/manual/wbt_book/available_tools/mathand_stats_tools.html#Add\" ... #>  $ is_extension : logi  FALSE TRUE FALSE FALSE FALSE FALSE ... #>  - attr(*, \"version\")= chr \"2.4.0\" head(wbttools) #>                    tool_name                      function_name #> 1              AbsoluteValue                 wbt_absolute_value #> 2      AccumulationCurvature         wbt_accumulation_curvature #> 3             AdaptiveFilter                wbt_adaptive_filter #> 4                        Add                            wbt_add #> 5 AddPointCoordinatesToTable wbt_add_point_coordinates_to_table #> 6            AggregateRaster               wbt_aggregate_raster #>               toolbox_name                          label #> 1     Math and Stats Tools                 Absolute Value #> 2 Geomorphometric Analysis         Accumulation Curvature #> 3   Image Processing Tools                Adaptive Filter #> 4     Math and Stats Tools                            Add #> 5               Data Tools Add Point Coordinates To Table #> 6             GIS Analysis               Aggregate Raster #>                                                                                                    description #> 1                                                     Calculates the absolute value of every cell in a raster. #> 2                                               This tool calculates accumulation curvature from an input DEM. #> 3                                                                     Performs an adaptive filter on an image. #> 4                              Performs an addition operation on two rasters or a raster and a constant value. #> 5 Modifies the attribute table of a point vector by adding fields containing each point's X and Y coordinates. #> 6                                                                   Aggregates a raster to a lower resolution. #>                                                                                                                              github #> 1                    https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/math_stat_analysis/abs.rs #> 2                                                                            Source code is unavailable due to proprietary license. #> 3            https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/image_analysis/adaptive_filter.rs #> 4                    https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/math_stat_analysis/add.rs #> 5 https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/data_tools/add_point_coordinates_to_table.rs #> 6             https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/gis_analysis/aggregate_raster.rs #>                                                                                                              book #> 1              https://www.whiteboxgeo.com/manual/wbt_book/available_tools/mathand_stats_tools.html#AbsoluteValue #> 2 https://www.whiteboxgeo.com/manual/wbt_book/available_tools/geomorphometric_analysis.html#AccumulationCurvature #> 3          https://www.whiteboxgeo.com/manual/wbt_book/available_tools/image_processing_tools.html#AdaptiveFilter #> 4                        https://www.whiteboxgeo.com/manual/wbt_book/available_tools/mathand_stats_tools.html#Add #> 5          https://www.whiteboxgeo.com/manual/wbt_book/available_tools/data_tools.html#AddPointCoordinatesToTable #> 6                   https://www.whiteboxgeo.com/manual/wbt_book/available_tools/gis_analysis.html#AggregateRaster #>   is_extension #> 1        FALSE #> 2         TRUE #> 3        FALSE #> 4        FALSE #> 5        FALSE #> 6        FALSE"},{"path":"/articles/datasets.html","id":"whiteboxtools-tool-and-parameter-names","dir":"Articles","previous_headings":"whitebox Tool Metadata","what":"WhiteboxTools Tool and Parameter Names","title":"whitebox Tool Metadata","text":"second data set provides details available function arguments tool name. wbttoolparameters data set data.frame 2198 parameters 13 variables: \"tool_name\" - WhiteboxTools tool name \"function_name\" - R function name \"toolbox_name\" - WhiteboxTools toolbox name \"name\" - WhiteboxTools tool parameter name \"flags\" - flags used specify parameter command line; comma-separated \"description\" - parameter description \"default_value\" - parameter default value, \"optional\" - parameter “optional” flag; note combination optional parameters may required certain conditions \"parameter_class\" - parameter type \"parameter_detail\" - parameter details; character: data type followed colon specifics, OptionList possible values, comma-separated (defined) \"is_input\" - logical. Classification ‘input’ parameters \"is_output\" - logical. Classification ‘output’ parameters \"argument_name\" - labels selected subset \"flags\" used R function argument names wbt_ functions Several fields table flags parameter_type “flattened” relative nested wbt_tool_parameters() output. nested parameter_type JSON result replaced two variables data set: parameter_class parameter_details parameter data.frame useful construct functions wbt_run_tool() inspecting types tools can run particular data types. find tool_name function_name present, can look whatever convenient. variable argument_name processed subset flags corresponds arguments R functions, denoted function_name.","code":"data(\"wbttoolparameters\", package = \"whitebox\") head(wbttoolparameters) #>               tool_name              function_name             toolbox_name #> 1         AbsoluteValue         wbt_absolute_value     Math and Stats Tools #> 2         AbsoluteValue         wbt_absolute_value     Math and Stats Tools #> 3 AccumulationCurvature wbt_accumulation_curvature Geomorphometric Analysis #> 4 AccumulationCurvature wbt_accumulation_curvature Geomorphometric Analysis #> 5 AccumulationCurvature wbt_accumulation_curvature Geomorphometric Analysis #> 6 AccumulationCurvature wbt_accumulation_curvature Geomorphometric Analysis #>                        name       flags #> 1                Input File  -i,--input #> 2               Output File -o,--output #> 3          Input Raster DEM    -i,--dem #> 4       Output Raster Image -o,--output #> 5 Log-transform the output?       --log #> 6                  Z-factor   --zfactor #>                                description default_value optional #> 1                       Input raster file.              FALSE #> 2                      Output raster file.              FALSE #> 3       Name of the input raster DEM file.              FALSE #> 4    Name of the output raster image file.              FALSE #> 5 Display output values using a log-scale.         false     TRUE #> 6                     Z conversion factor.           1.0     TRUE #>   parameter_class parameter_detail is_input is_output argument_name #> 1    ExistingFile           Raster     TRUE     FALSE         input #> 2         NewFile           Raster    FALSE      TRUE        output #> 3    ExistingFile           Raster     TRUE     FALSE           dem #> 4         NewFile           Raster    FALSE      TRUE        output #> 5         Boolean          Boolean    FALSE     FALSE           log #> 6           Float            Float    FALSE     FALSE       zfactor str(wbttoolparameters, max.level = 1) #> 'data.frame':    2198 obs. of  13 variables: #>  $ tool_name       : chr  \"AbsoluteValue\" \"AbsoluteValue\" \"AccumulationCurvature\" \"AccumulationCurvature\" ... #>  $ function_name   : chr  \"wbt_absolute_value\" \"wbt_absolute_value\" \"wbt_accumulation_curvature\" \"wbt_accumulation_curvature\" ... #>  $ toolbox_name    : chr  \"Math and Stats Tools\" \"Math and Stats Tools\" \"Geomorphometric Analysis\" \"Geomorphometric Analysis\" ... #>  $ name            : chr  \"Input File\" \"Output File\" \"Input Raster DEM\" \"Output Raster Image\" ... #>  $ flags           : chr  \"-i,--input\" \"-o,--output\" \"-i,--dem\" \"-o,--output\" ... #>  $ description     : chr  \"Input raster file.\" \"Output raster file.\" \"Name of the input raster DEM file.\" \"Name of the output raster image file.\" ... #>  $ default_value   : chr  NA NA NA NA ... #>  $ optional        : logi  FALSE FALSE FALSE FALSE TRUE TRUE ... #>  $ parameter_class : chr  \"ExistingFile\" \"NewFile\" \"ExistingFile\" \"NewFile\" ... #>  $ parameter_detail: chr  \"Raster\" \"Raster\" \"Raster\" \"Raster\" ... #>  $ is_input        : logi  TRUE FALSE TRUE FALSE FALSE FALSE ... #>  $ is_output       : logi  FALSE TRUE FALSE TRUE FALSE FALSE ... #>  $ argument_name   : chr  \"input\" \"output\" \"dem\" \"output\" ... #>  - attr(*, \"version\")= chr \"2.4.0\""},{"path":"/articles/datasets.html","id":"example-finding-tools-by-parameter-type","dir":"Articles","previous_headings":"whitebox Tool Metadata > WhiteboxTools Tool and Parameter Names","what":"Example: Finding Tools by Parameter Type","title":"whitebox Tool Metadata","text":"find tools “ExistingFile” argument file type “Raster” can use subset().","code":"head(subset(wbttoolparameters, grepl(\"ExistingFile\", parameter_class) & grepl(\"Raster\", parameter_detail))) #>                tool_name              function_name             toolbox_name #> 1          AbsoluteValue         wbt_absolute_value     Math and Stats Tools #> 3  AccumulationCurvature wbt_accumulation_curvature Geomorphometric Analysis #> 7         AdaptiveFilter        wbt_adaptive_filter   Image Processing Tools #> 12                   Add                    wbt_add     Math and Stats Tools #> 13                   Add                    wbt_add     Math and Stats Tools #> 16       AggregateRaster       wbt_aggregate_raster             GIS Analysis #>                            name      flags                          description #> 1                    Input File -i,--input                   Input raster file. #> 3              Input Raster DEM   -i,--dem   Name of the input raster DEM file. #> 7                    Input File -i,--input                   Input raster file. #> 12 Input File Or Constant Value   --input1 Input raster file or constant value. #> 13 Input File Or Constant Value   --input2 Input raster file or constant value. #> 16                   Input File -i,--input                   Input raster file. #>    default_value optional     parameter_class parameter_detail is_input #> 1               FALSE        ExistingFile           Raster     TRUE #> 3               FALSE        ExistingFile           Raster     TRUE #> 7               FALSE        ExistingFile           Raster     TRUE #> 12              FALSE ExistingFileOrFloat           Raster     TRUE #> 13              FALSE ExistingFileOrFloat           Raster     TRUE #> 16              FALSE        ExistingFile           Raster     TRUE #>    is_output argument_name #> 1      FALSE         input #> 3      FALSE           dem #> 7      FALSE         input #> 12     FALSE        input1 #> 13     FALSE        input2 #> 16     FALSE         input"},{"path":"/articles/datasets.html","id":"appendix-tables-of-function-names-by-toolbox","dir":"Articles","previous_headings":"whitebox Tool Metadata","what":"Appendix: Tables of Function Names by Toolbox","title":"whitebox Tool Metadata","text":"remainder vignette tables R function names tool descriptions wbttoolparameters, organized WhiteboxTools toolbox/extension name.","code":""},{"path":"/articles/datasets.html","id":"data-tools","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Data Tools","title":"whitebox Tool Metadata","text":"Toolbox: Data Tools","code":""},{"path":"/articles/datasets.html","id":"geomorphometric-analysis","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Geomorphometric Analysis","title":"whitebox Tool Metadata","text":"Toolbox: Geomorphometric Analysis","code":""},{"path":"/articles/datasets.html","id":"gis-analysis","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"GIS Analysis","title":"whitebox Tool Metadata","text":"Toolbox: GIS Analysis","code":""},{"path":"/articles/datasets.html","id":"hydrological-analysis","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Hydrological Analysis","title":"whitebox Tool Metadata","text":"Toolbox: Hydrological Analysis","code":""},{"path":"/articles/datasets.html","id":"image-processing-tools","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Image Processing Tools","title":"whitebox Tool Metadata","text":"Toolbox: Image Processing Tools","code":""},{"path":"/articles/datasets.html","id":"lidar-tools","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"LiDAR Tools","title":"whitebox Tool Metadata","text":"Toolbox: LiDAR Tools","code":""},{"path":"/articles/datasets.html","id":"machine-learning","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Machine Learning","title":"whitebox Tool Metadata","text":"Toolbox: Machine Learning","code":""},{"path":"/articles/datasets.html","id":"math-and-stats-tools","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Math and Stats Tools","title":"whitebox Tool Metadata","text":"Toolbox: Math Stats Tools","code":""},{"path":"/articles/datasets.html","id":"precision-agriculture","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Precision Agriculture","title":"whitebox Tool Metadata","text":"Toolbox: Precision Agriculture","code":""},{"path":"/articles/datasets.html","id":"stream-network-analysis","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Stream Network Analysis","title":"whitebox Tool Metadata","text":"Toolbox: Stream Network Analysis","code":""},{"path":"/articles/demo.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"whitebox Demo","text":"whitebox R frontend ‘WhiteboxTools’ library, advanced geospatial data analysis platform developed Prof. John Lindsay University Guelph’s Geomorphometry Hydrogeomatics Research Group. ‘WhiteboxTools’ can used perform common geographical information systems (GIS) analysis operations, cost-distance analysis, distance buffering, raster reclassification. Remote sensing image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), common image transformations. ‘WhiteboxTools’ also contains advanced tooling spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), LiDAR data processing. WhiteboxTools cartographic spatial data visualization package; instead meant serve analytical backend data visualization software, mainly GIS. vignette shows use whitebox R package run WhiteboxTools. Suggested citation: Lindsay, J. B. (2016). Whitebox GAT: case study geomorphometric analysis. Computers & Geosciences, 95, 75-84. doi: http://dx.doi.org/10.1016/j.cageo.2016.07.003","code":""},{"path":"/articles/demo.html","id":"setup","dir":"Articles","previous_headings":"","what":"Setup","title":"whitebox Demo","text":"Load whitebox library.","code":"library(whitebox)"},{"path":"/articles/demo.html","id":"how-whitebox-works","dir":"Articles","previous_headings":"Setup","what":"How whitebox works","title":"whitebox Demo","text":"whitebox generates system() calls local WhiteboxTools binary: whitebox_tools whitebox_tools.exe can find binary path package going use wbt_exe_path() command always returns “default” path, whether WhiteboxTools installed.","code":"wbt_exe_path(shell_quote = FALSE) #> [1] \"/home/runner/.local/share/R/whitebox/WBT/whitebox_tools\""},{"path":"/articles/demo.html","id":"interfacing-with-r-spatial-packages","dir":"Articles","previous_headings":"Setup","what":"Interfacing with R spatial packages","title":"whitebox Demo","text":"WhiteboxTools input output specified file paths rasters GeoTIFF format, shapefiles, HTML output, LiDAR-related files, . vignette use terra package visualization. Just easily used raster, stars options available R ecosystem handling GeoTIFF output. main way view output save “output” file paths variable can use processing load result R spatial object.","code":""},{"path":"/articles/demo.html","id":"working-with-raster-data","dir":"Articles","previous_headings":"Setup > Interfacing with R spatial packages","what":"Working with Raster Data","title":"whitebox Demo","text":"demonstration employing {terra} package follows: Run tool wbt_slope() \"Slope\". WhiteboxTools reads input writes output. case, can achieve similar slope map result using terra::terrain(), create plot SpatRaster output compare two.  SpatRaster, RasterLayer related classes terra raster packages perfect maintaining linkage file output R object data memory. Use terra::sources() get “source” file name(s). using raster RasterLayer objects equivalent method raster::filename().","code":"library(terra) #> terra 1.7.79 library(whitebox)  # DEMO: calculate slope with WhiteboxTools and raster  # Typically the input/output paths are stored as variables  # sample DEM input GeoTIFF input <- sample_dem_data()  # output file (to be created) output <- file.path(tempdir(), \"slope.tif\") wbt_slope(input, output, units = 'radians') if (file.exists(output)) {   # create a SpatRaster from file output path   outputras <- terra::rast(output) } if (file.exists(input) && file.exists(output) && !is.null(outputras)) {   # par(mfrow = c(2, 1), mar = c(1, 1, 1, 1))      # inspect the output graphically   plot(     outputras,     main = \"whitebox::wbt_slope() [radians]\",     axes = FALSE   )      # calculate equivalent using raster::terrain() on input   plot(     terra::terrain(terra::rast(input)),     main = \"terra::terrain() [radians]\",     axes = FALSE   ) } # the SpatRaster retains a reference to the input file name terra::sources(outputras) #> [1] \"/tmp/Rtmpy8s8At/slope.tif\""},{"path":[]},{"path":"/articles/demo.html","id":"installing-whiteboxtools","dir":"Articles","previous_headings":"Setup","what":"Installing WhiteboxTools","title":"whitebox Demo","text":"whitebox wbt_init() standard way set “exe_path” session. WhiteboxTools installed default location, whitebox_tools PATH, set package options, package able find WhiteboxTools installation load. Usually can use whitebox::install_whitebox() download latest binaries correspond available version R package. However, required. may download/compile WhiteboxTools install anywhere use whitebox R package. general information consult WhiteboxTools User Manual: https://www.whiteboxgeo.com/manual/wbt_book/install.html details building source see: https://github.com/jblindsay/whitebox-tools","code":""},{"path":"/articles/demo.html","id":"package-settings-with-wbt_init","dir":"Articles","previous_headings":"Setup","what":"Package Settings with wbt_init()","title":"whitebox Demo","text":"wbt_init() used set check path binary executable commands passed . executable path options stored package options, can overridden system environment variables. default value wbt_exe_path(shell_quote = FALSE) passed exe_path argument unspecified. section cover optional arguments wbt_init() (exe_path, wd verbose) corresponding options helper functions.","code":"# inspect where wbt_init() will be checking wbt_exe_path(shell_quote = FALSE) #> [1] \"/home/runner/.local/share/R/whitebox/WBT/whitebox_tools\" # TRUE when file is found at one of the user specified paths or package default # FALSE when whitebox_tools does not exist at path wbt_init()"},{"path":"/articles/demo.html","id":"exe_path-argument","dir":"Articles","previous_headings":"Setup > Package Settings with wbt_init()","what":"exe_path argument","title":"whitebox Demo","text":"exe_path argument wbt_init() sets whitebox.exe_path package option. exe_path path WhiteboxTools executable file. default value package installation directory, subdirectory \"WBT\", followed whitebox_tools.exe whitebox_tools depending operating system. package automatically find existing installation whitebox_tools directory PATH. Package options exe_path (detailed ?whitebox::whitebox ?wbt_init) can set wbt_init(exe_path, ...), ... additional named arguments corresponding * suffix whitebox.* package options names. Use wbt_options() specific methods like wbt_verbose(), wbt_wd() get values set specific values.","code":"# set path manually to whitebox_tools executable, for instance: wbt_init(exe_path = '/home/andrew/workspace/whitebox-tools/target/release/whitebox_tools')"},{"path":"/articles/demo.html","id":"wd-argument","dir":"Articles","previous_headings":"Setup > Package Settings with wbt_init()","what":"wd argument","title":"whitebox Demo","text":"wd argument can used set WhiteboxTools working directory. working directory specifies base folder path WhiteboxTools can find inputs create outputs. Setting whitebox.wd package option (via wd argument wbt_init() wbt_wd()) aids process setting file paths. value set option --wd directory flag added tools support . set working directory session default output current R working directory unless directory specified input/output arguments. can change working directory time setting wd argument wbt_wd() running tool. NOTE: set working directory session, directory needs set somewhere new “replace” old value; just dropping flag automatically change working directory back R working directory* output show whatever folder set initially. helper method setting whitebox.wd option wbt_wd(). “unset” option R package can use wbt_wd(\"\") equivalent wbt_wd(getwd()). next tool call change WhiteboxTools working directory setting new path. point flag need specified [wish change ].","code":"wbt_wd(\"\") # \"\" equivalent to getwd()"},{"path":"/articles/demo.html","id":"verbose-argument","dir":"Articles","previous_headings":"Setup > Package Settings with wbt_init()","what":"verbose argument","title":"whitebox Demo","text":"verbose argument used set package option related tool “verbosity”: whitebox.verbose. whitebox.verbose FALSE output cat() console running tools. helper method getting setting whitebox.verbose option wbt_verbose(). wbt_verbose() used throughout package check level verbosity used. default, result wbt_verbose() result interactive() tools print extra console output see . used variety wbt_* methods allow package option control output many functions consistent manner, hide output automated tests, markdown documents, vignettes etc. vignette use wbt_verbose(TRUE) package option whitebox.verbose set TRUE mainly print tool name elapsed time whenever run tool: package-level verbose option can also control verbose_mode values passed wbt_* tool functions. Turning “full” output requires third option set argument: \"\". Use wbt_verbose(\"\"). wbt_verbose() still return TRUE whitebox.verbose option \"\".","code":"# force output when run non-interactively (knitr) wbt_verbose(TRUE) #> wbt_breach_depressions - Elapsed Time (excluding I/O): 0.12s"},{"path":"/articles/demo.html","id":"long-term-package-option-settings","dir":"Articles","previous_headings":"Setup","what":"Long-term Package Option Settings","title":"whitebox Demo","text":"package detect added WhiteboxTools directory PATH environment variable. long-term package option settings can put whitebox_tools $PATH set R_WHITEBOX_EXE_PATH user .Rprofile .Renviron. Windows can add path whitebox_tools.exe new entry R_WHITEBOX_EXE_PATH User System Environment variable. Linux/Mac can set R_WHITEBOX_EXE_PATH directly export R_WHITEBOX_EXE_PATH=\"/path//whitebox_tools\". Note set $PATH regular shell profile (.profile/.bashrc/.zshrc) sourced RStudio R session default. requires Unix tool one analogues. can also set R_WHITEBOX_EXE_PATH manually R: Replace Sys.() call custom path string needed \"C:/path//whitebox_tools.exe\". package options can similarly set environment variables. prefixed R_WHITEBOX_*. See ?whitebox details.","code":"Sys.setenv(R_WHITEBOX_EXE_PATH = Sys.which(\"whitebox_tools\"))"},{"path":"/articles/demo.html","id":"running-tools","dir":"Articles","previous_headings":"","what":"Running tools","title":"whitebox Demo","text":"Specify input output paths, options, specified package reference: https://whiteboxR.gishub.org/reference/index.html instance, “BreachDepressions” used process Digital Elevation Model (DEM) identify flow pathways. tool uses uses Lindsay’s (2016) algorithm, preferred depression filling cases. info see: ?wbt_breach_depressions wbt_*_tool_name_*() functions wrappers around wbt_run_tool() function system() call given function-specific argument string. method creating wbt_breach_depressions(dem = ..., output = ...) handle wbt_run_tool(\"BreachDepressions\", args = ...) makes easy generate static methods parity latest WhiteboxTools interface.","code":"# sample DEM file path in package extdata folder input <- sample_dem_data()  # output file name output <- file.path(tempdir(), \"output.tif\")  # run breach_depressions tool wbt_breach_depressions(dem = input, output = output) #> breach_depressions - Elapsed Time (excluding I/O): 0.7s # sample DEM file path in package extdata folder input <- sample_dem_data()  # output file name output <- file.path(tempdir(), \"output.tif\")  # run breach_depressions tool wbt_run_tool(tool_name = \"BreachDepressions\", args = paste0(\"--dem=\", input, \" --output=\", output)) #> BreachDepressions - Elapsed Time (excluding I/O): 0.7s"},{"path":"/articles/demo.html","id":"example-compare-input-v-s--output-with-terra","dir":"Articles","previous_headings":"Running tools","what":"Example: Compare input v.s. output with terra","title":"whitebox Demo","text":"use {terra} package read GeoTIFF file output WhiteboxTools.","code":""},{"path":"/articles/demo.html","id":"setup-1","dir":"Articles","previous_headings":"Running tools > Example: Compare input v.s. output with terra","what":"Setup","title":"whitebox Demo","text":"","code":"library(terra)  # sample DEM file path in package extdata folder input <- sample_dem_data()  # output file name output <- file.path(tempdir(), \"output.tif\")"},{"path":"/articles/demo.html","id":"run-wbt_breach_depressions-breachdepressions-tool","dir":"Articles","previous_headings":"Running tools > Example: Compare input v.s. output with terra","what":"Run wbt_breach_depressions() (BreachDepressions tool)","title":"whitebox Demo","text":"","code":"# run breach_depressions tool wbt_breach_depressions(dem = input, output = output) #> breach_depressions - Elapsed Time (excluding I/O): 0.7s"},{"path":"/articles/demo.html","id":"visualize-results-with-terra","dir":"Articles","previous_headings":"Running tools > Example: Compare input v.s. output with terra","what":"Visualize results with terra","title":"whitebox Demo","text":"","code":"# create raster object from input file input <- rast(input)  if (file.exists(output)) {   # create raster object from output file   output <- rast(output)      # par(mar = c(2, 1, 2, 1))   # inspect input v.s. output   plot(input, axes = FALSE, main = \"DEM\")   plot(output, axes = FALSE, main = \"DEM (Breached Depressions)\")      # inspect numeric difference (output - input)    plot(output - input, axes = FALSE,  main = \"Difference ([Breached Depressions] - [DEM])\") }"},{"path":"/articles/demo.html","id":"example-identifying-tributaries","dir":"Articles","previous_headings":"Running tools","what":"Example: Identifying Tributaries","title":"whitebox Demo","text":"take processing DEMs bit performing several WhiteboxTools operations sequence. interested identifying ranking tributaries watercourses (streams rivers). R package makes use whitebox R package hydroweight. brief example beginning hydroweight README showing breached DEM can used spatial analysis stream networks.","code":""},{"path":"/articles/demo.html","id":"setup-2","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"Setup","title":"whitebox Demo","text":"","code":"library(whitebox) library(terra)  ## Sample DEM from whitebox package toy_file <- sample_dem_data() toy_dem <- rast(x = toy_file)  ## Generate wd as a temporary directory.  ## Replace with your own path, or \".\" for current directory wd <- tempdir()  ## Write toy_dem to working directory writeRaster(   x = toy_dem, filename = file.path(wd, \"toy_dem.tif\"),   overwrite = TRUE )"},{"path":"/articles/demo.html","id":"wbt_breach_depressions-breach-dem-depressions","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"wbt_breach_depressions() – Breach DEM Depressions","title":"whitebox Demo","text":"First pre-process breaching depressions DEM","code":"## Breach depressions to ensure continuous flow wbt_breach_depressions(   dem = file.path(wd, \"toy_dem.tif\"),   output = file.path(wd, \"toy_dem_breached.tif\") ) #> breach_depressions - Elapsed Time (excluding I/O): 0.7s"},{"path":"/articles/demo.html","id":"wbt_d8_pointer-calculate-flow-direction","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"wbt_d8_pointer() – Calculate Flow Direction","title":"whitebox Demo","text":"generate direction flow DEM surface using “D8” flow pointer method","code":"## Generate d8 flow pointer (note: other flow directions are available) wbt_d8_pointer(   dem = file.path(wd, \"toy_dem_breached.tif\"),   output = file.path(wd, \"toy_dem_breached_d8.tif\") ) #> d8_pointer - Elapsed Time (excluding I/O): 0.1s"},{"path":"/articles/demo.html","id":"wbt_d8_flow_accumulation-flow-accumulation","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"wbt_d8_flow_accumulation() – Flow Accumulation","title":"whitebox Demo","text":"calculate direction flow method, calculate cumulative flow example wbt_d8_flow_accumulation():","code":"## Generate d8 flow accumulation in units of cells (note: other flow directions are available) wbt_d8_flow_accumulation(   input = file.path(wd, \"toy_dem_breached.tif\"),   output = file.path(wd, \"toy_dem_breached_accum.tif\"),   out_type = \"cells\" ) #> d8_flow_accumulation - Elapsed Time (excluding I/O): 0.5s"},{"path":"/articles/demo.html","id":"additional-flow-direction-and-accumulation-tools","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries > wbt_d8_flow_accumulation() – Flow Accumulation","what":"Additional Flow Direction and Accumulation Tools","title":"whitebox Demo","text":"addition D8 flow pointers (flow direction), several options direction accumulation FD8, D-infinity, D-infinity. Keyword “Pointer” tools: \"D8Pointer\", \"DInfPointer\", \"FD8Pointer\", \"Rho8Pointer\" Keyword “FlowAccumulation” tools: \"D8FlowAccumulation\", \"DInfFlowAccumulation\", \"FD8FlowAccumulation\", \"Rho8FlowAccumulation\", \"MDInfFlowAccumulation\" Search tools involving \"flow pointer\" key word: wbt_list_tools(keyword = \"flow pointer\") just example wealth tool options made available WhiteboxTools platform.","code":"#> All 27 Tools containing keywords: #> AverageFlowpathSlope: Measures the average slope gradient from each grid cell to all upslope divide cells. #> AverageUpslopeFlowpathLength: Measures the average length of all upslope flowpaths draining each grid cell. #> D8FlowAccumulation: Calculates a D8 flow accumulation raster from an input DEM or flow pointer. #> D8Pointer: Calculates a D8 flow pointer raster from an input DEM. #> DInfFlowAccumulation: Calculates a D-infinity flow accumulation raster from an input DEM. #> DInfPointer: Calculates a D-infinity flow pointer (flow direction) raster from an input DEM. #> DownslopeFlowpathLength: Calculates the downslope flowpath length from each cell to basin outlet. #> ExtractStreams: Extracts stream grid cells from a flow accumulation raster. #> FD8FlowAccumulation: Calculates an FD8 flow accumulation raster from an input DEM. #> FD8Pointer: Calculates an FD8 flow pointer raster from an input DEM. #> FindNoFlowCells: Finds grid cells with no downslope neighbours. #> FindParallelFlow: Finds areas of parallel flow in D8 flow direction rasters. #> FlowAccumulationFullWorkflow: Resolves all of the depressions in a DEM, outputting a breached DEM, an aspect-aligned non-divergent flow pointer, and a flow accumulation raster. #> FlowLengthDiff: Calculates the local maximum absolute difference in downslope flowpath length, useful in mapping drainage divides and ridges. #> LongProfileFromPoints: Plots the longitudinal profiles from flow-paths initiating from a set of vector points. #> LongestFlowpath: Delineates the longest flowpaths for a group of subbasins or watersheds.  #> MDInfFlowAccumulation: Calculates an FD8 flow accumulation raster from an input DEM. #> MaxUpslopeFlowpathLength: Measures the maximum length of all upslope flowpaths draining each grid cell. #> NumInflowingNeighbours: Computes the number of inflowing neighbours to each cell in an input DEM based on the D8 algorithm. #> Rho8Pointer: Calculates a stochastic Rho8 flow pointer raster from an input DEM. #> SnapPourPoints: Moves outlet points used to specify points of interest in a watershedding operation to the cell with the highest flow accumulation in its neighbourhood. #> TraceDownslopeFlowpaths: Traces downslope flowpaths from one or more target sites (i.e. seed points). #> Rho8FlowAccumulation: Calculates Fairfield and Leymarie (1991) flow accumulation. #> MaxUpslopeValue: Calculates the maximum upslope value from an input values raster along flowpaths. #> QinFlowAccumulation: Calculates Qin et al. (2007) flow accumulation. #> QuinnFlowAccumulation: Calculates Quinn et al. (1995) flow accumulation. #> ConvergenceIndex: Calculates Qin et al. (2007) flow accumulation."},{"path":"/articles/demo.html","id":"wbt_extract_streams-extract-stream-network","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"wbt_extract_streams() – Extract Stream Network","title":"whitebox Demo","text":"flow accumulation raster hand, can extract stream network wbt_extract_streams() based threshold (e.g. 100) accumulated flow. threshold value choose depend analysis goals, choice flow accumulation algorithm used, local topography, well resolution extent DEM.","code":"## Generate streams with a stream initiation threshold of 100 cells wbt_extract_streams(   flow_accum = file.path(wd, \"toy_dem_breached_accum.tif\"),   output = file.path(wd, \"toy_dem_streams.tif\"),   threshold = 100 ) #> extract_streams - Elapsed Time (excluding I/O): 0.1s"},{"path":"/articles/demo.html","id":"wbt_tributary_identifier-identify-tributaries","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"wbt_tributary_identifier() – Identify Tributaries","title":"whitebox Demo","text":"Next, let’s identify tributaries. function wbt_tributary_identifier() little complicated takes takes two inputs: raster D8 pointer file. raster streams file.","code":"wbt_tributary_identifier(   d8_pntr = file.path(wd, \"toy_dem_breached_d8.tif\"),   streams = file.path(wd, \"toy_dem_streams.tif\"),   output = file.path(wd, \"toy_dem_tributaries.tif\") ) #> tributary_identifier - Elapsed Time (excluding I/O): 0.0s"},{"path":"/articles/demo.html","id":"compare-results","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"Compare results","title":"whitebox Demo","text":"Finally, compare results wbt_extract_streams() wbt_tributary_identifier()","code":"if (file.exists(file.path(wd, \"toy_dem_streams.tif\"))) {   par(mfrow = c(2, 1), mar = c(3, 1, 2, 1))      plot(     rast(file.path(wd, \"toy_dem_streams.tif\")),     main = \"Streams\",     col = \"black\"   )      plot(     rast(file.path(wd, \"toy_dem_tributaries.tif\")),     main = \"TributaryIdentifier\"   ) }"},{"path":"/articles/demo.html","id":"appendix-wbt_-utility-functions","dir":"Articles","previous_headings":"","what":"Appendix: wbt_* utility functions","title":"whitebox Demo","text":"methods provide access WhiteboxTools executable parameters metadata.","code":""},{"path":"/articles/demo.html","id":"wbt_help","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_help()","title":"whitebox Demo","text":"wbt_help() prints WhiteboxTools help: listing available commands executable","code":"wbt_help() #> WhiteboxTools Help #>  #> The following commands are recognized: #> --cd, --wd          Changes the working directory; used in conjunction with --run flag. #> --compress_rasters  Sets the compress_raster option in the settings.json file; determines if newly created rasters are compressed. e.g. --compress_rasters=true #> -h, --help          Prints help information. #> -l, --license       Prints the whitebox-tools license. Tool names may also be used, --license=\"Slope\" #> --listtools         Lists all available tools. Keywords may also be used, --listtools slope. #> --max_procs         Sets the maximum number of processors used. -1 = all available processors. e.g. --max_procs=2 #> -r, --run           Runs a tool; used in conjunction with --wd flag; -r=\"LidarInfo\". #> --toolbox           Prints the toolbox associated with a tool; --toolbox=Slope. #> --toolhelp          Prints the help associated with a tool; --toolhelp=\"LidarInfo\". #> --toolparameters    Prints the parameters (in json form) for a specific tool; --toolparameters=\"LidarInfo\". #> -v                  Verbose mode. Without this flag, tool outputs will not be printed. #> --viewcode          Opens the source code of a tool in a web browser; --viewcode=\"LidarInfo\". #> --version           Prints the version information. #>  #> Example Usage: #> >> ./whitebox_tools -r=lidar_info --cd=\"/path/to/data/\" -i=input.las --vlr --geokeys"},{"path":"/articles/demo.html","id":"wbt_license","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_license()","title":"whitebox Demo","text":"wbt_license() prints WhiteboxTools license","code":"wbt_license() #> WhiteboxTools License #> Copyright 2017-2023 John Lindsay #>  #> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and #> associated documentation files (the \"Software\"), to deal in the Software without restriction, #> including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, #> and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, #> subject to the following conditions: #>  #> The above copyright notice and this permission notice shall be included in all copies or substantial #> portions of the Software. #>  #> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT #> NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND #> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES #> OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN #> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."},{"path":"/articles/demo.html","id":"wbt_version","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_version()","title":"whitebox Demo","text":"Prints WhiteboxTools version","code":"wbt_version() #> WhiteboxTools v2.4.0 (c) Dr. John Lindsay 2017-2023 #>  #> WhiteboxTools is an advanced geospatial data analysis platform developed at #> the University of Guelph's Geomorphometry and Hydrogeomatics Research  #> Group (GHRG). See www.whiteboxgeo.com for more details."},{"path":"/articles/demo.html","id":"wbt_list_tools","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_list_tools()","title":"whitebox Demo","text":"Use wbt_list_tools() list available tools WhiteboxTools. version 2.4.0 484 tools! See available toolboxes extensions. full list can overwhelming amount output, pass keywords argument search filter. example list tools keyword ‘flowaccumulation’ tool name description.","code":"wbt_list_tools() wbt_list_tools(keywords = \"flowaccumulation\") #> All 8 Tools containing keywords: #> D8FlowAccumulation: Calculates a D8 flow accumulation raster from an input DEM or flow pointer. #> DInfFlowAccumulation: Calculates a D-infinity flow accumulation raster from an input DEM. #> FD8FlowAccumulation: Calculates an FD8 flow accumulation raster from an input DEM. #> FlowAccumulationFullWorkflow: Resolves all of the depressions in a DEM, outputting a breached DEM, an aspect-aligned non-divergent flow pointer, and a flow accumulation raster. #> MDInfFlowAccumulation: Calculates an FD8 flow accumulation raster from an input DEM. #> QinFlowAccumulation: Calculates Qin et al. (2007) flow accumulation. #> QuinnFlowAccumulation: Calculates Quinn et al. (1995) flow accumulation. #> Rho8FlowAccumulation: Calculates Fairfield and Leymarie (1991) flow accumulation."},{"path":"/articles/demo.html","id":"wbt_tool_help","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_tool_help()","title":"whitebox Demo","text":"find tool interested using, can investigate sort parameters takes. R methods generally take named parameters. R functions naming scheme wbt_tool_name _ used spaces, whereas tools spaces. wbt_tool_help(\"tributaryidentifier\") shows command line help tool name. ?wbt_tributary_identifier shows corresponding R function help, derived command line help page metadata.","code":"wbt_tool_help(\"tributaryidentifier\") #> TributaryIdentifier #> Description: #> Assigns a unique identifier to each tributary in a stream network. #> Toolbox: Stream Network Analysis #> Parameters: #>  #> Flag               Description #> -----------------  ----------- #> --d8_pntr          Input raster D8 pointer file. #> --streams          Input raster streams file. #> -o, --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. #>  #>  #> Example usage: #> >>./whitebox_tools -r=TributaryIdentifier -v --wd=\"/path/to/data/\" --d8_pntr=D8.tif --streams=streams.tif -o=output.tif #> >>./whitebox_tools -r=TributaryIdentifier -v --wd=\"/path/to/data/\" --d8_pntr=D8.tif --streams=streams.tif -o=output.tif --esri_pntr --zero_background"},{"path":"/articles/demo.html","id":"wbt_toolbox","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_toolbox()","title":"whitebox Demo","text":"Another way tools organized WhiteboxTools “toolbox.” wbt_toolbox() prints toolbox specific tool (tools none specified) Print full list specifying tool_name","code":"wbt_toolbox(tool_name = \"aspect\") #> Geomorphometric Analysis wbt_toolbox() #> AbsoluteValue: Math and Stats Tools #> AdaptiveFilter: Image Processing Tools/Filters #> Add: Math and Stats Tools #> AddPointCoordinatesToTable: Data Tools #> AggregateRaster: GIS Analysis #> And: Math and Stats Tools #> Anova: Math and Stats Tools #> ArcCos: Math and Stats Tools #> ArcSin: Math and Stats Tools #> ArcTan: Math and Stats Tools #> Arcosh: Math and Stats Tools #> Arsinh: Math and Stats Tools #> Artanh: Math and Stats Tools #> AsciiToLas: LiDAR Tools #> Aspect: Geomorphometric Analysis #> Atan2: Math and Stats Tools #> AttributeCorrelation: Math and Stats Tools #> AttributeCorrelationNeighbourhoodAnalysis: Math and Stats Tools #> AttributeHistogram: Math and Stats Tools #> AttributeScattergram: Math and Stats Tools #> AverageFlowpathSlope: Hydrological Analysis #> AverageNormalVectorAngularDeviation: Geomorphometric Analysis #> AverageOverlay: GIS Analysis/Overlay Tools #> AverageUpslopeFlowpathLength: Hydrological Analysis #> BalanceContrastEnhancement: Image Processing Tools/Image Enhancement #> Basins: Hydrological Analysis #> BilateralFilter: Image Processing Tools/Filters #> BlockMaximumGridding: GIS Analysis #> BlockMinimumGridding: GIS Analysis #> BoundaryShapeComplexity: GIS Analysis/Patch Shape Tools #> BreachDepressions: Hydrological Analysis #> BreachDepressionsLeastCost: Hydrological Analysis #> BreachSingleCellPits: Hydrological Analysis #> BufferRaster: GIS Analysis/Distance Tools #> BurnStreamsAtRoads: Hydrological Analysis #> Ceil: Math and Stats Tools #> Centroid: GIS Analysis #> CentroidVector: GIS Analysis #> ChangeVectorAnalysis: Image Processing Tools #> CircularVarianceOfAspect: Geomorphometric Analysis #> ClassifyBuildingsInLidar: LiDAR Tools #> ClassifyOverlapPoints: LiDAR Tools #> CleanVector: Data Tools #> Clip: GIS Analysis/Overlay Tools #> ClipLidarToPolygon: LiDAR Tools #> ClipRasterToPolygon: GIS Analysis/Overlay Tools #> Closing: Image Processing Tools #> Clump: GIS Analysis #> CompactnessRatio: GIS Analysis/Patch Shape Tools #> ConditionalEvaluation: Math and Stats Tools #> ConditionedLatinHypercube: Math and Stats Tools #> ConservativeSmoothingFilter: Image Processing Tools/Filters #> ConstructVectorTIN: GIS Analysis #> ContoursFromPoints: Geomorphometric Analysis #> ContoursFromRaster: Geomorphometric Analysis #> ConvergenceIndex: Geomorphometric Analysis #> ConvertNodataToZero: Data Tools #> ConvertRasterFormat: Data Tools #> CornerDetection: Image Processing Tools/Filters #> CorrectStreamVectorDirection: Stream Network Analysis #> CorrectVignetting: Image Processing Tools/Image Enhancement #> Cos: Math and Stats Tools #> Cosh: Math and Stats Tools #> CostAllocation: GIS Analysis/Distance Tools #> CostDistance: GIS Analysis/Distance Tools #> CostPathway: GIS Analysis/Distance Tools #> CountIf: GIS Analysis/Overlay Tools #> CreateColourComposite: Image Processing Tools #> CreateHexagonalVectorGrid: GIS Analysis #> CreatePlane: GIS Analysis #> CreateRectangularVectorGrid: GIS Analysis #> CrispnessIndex: Math and Stats Tools #> CrossTabulation: Math and Stats Tools #> CsvPointsToVector: Data Tools #> CumulativeDistribution: Math and Stats Tools #> D8FlowAccumulation: Hydrological Analysis #> D8MassFlux: Hydrological Analysis #> D8Pointer: Hydrological Analysis #> DInfFlowAccumulation: Hydrological Analysis #> DInfMassFlux: Hydrological Analysis #> DInfPointer: Hydrological Analysis #> Decrement: Math and Stats Tools #> DepthInSink: Hydrological Analysis #> DevFromMeanElev: Geomorphometric Analysis #> DeviationFromRegionalDirection: GIS Analysis/Patch Shape Tools #> DiffFromMeanElev: Geomorphometric Analysis #> DiffOfGaussianFilter: Image Processing Tools/Filters #> Difference: GIS Analysis/Overlay Tools #> DirectDecorrelationStretch: Image Processing Tools/Image Enhancement #> DirectionalRelief: Geomorphometric Analysis #> Dissolve: GIS Analysis #> DistanceToOutlet: Stream Network Analysis #> DiversityFilter: Image Processing Tools/Filters #> Divide: Math and Stats Tools #> DownslopeDistanceToStream: Hydrological Analysis #> DownslopeFlowpathLength: Hydrological Analysis #> DownslopeIndex: Geomorphometric Analysis #> EdgeContamination: Hydrological Analysis #> EdgeDensity: Geomorphometric Analysis #> EdgePreservingMeanFilter: Image Processing Tools/Filters #> EdgeProportion: GIS Analysis/Patch Shape Tools #> ElevAbovePit: Geomorphometric Analysis #> ElevPercentile: Geomorphometric Analysis #> ElevRelativeToMinMax: Geomorphometric Analysis #> ElevRelativeToWatershedMinMax: Geomorphometric Analysis #> ElevationAboveStream: Hydrological Analysis #> ElevationAboveStreamEuclidean: Hydrological Analysis #> EliminateCoincidentPoints: GIS Analysis #> ElongationRatio: GIS Analysis/Patch Shape Tools #> EmbankmentMapping: Geomorphometric Analysis #> EmbossFilter: Image Processing Tools/Filters #> EqualTo: Math and Stats Tools #> Erase: GIS Analysis/Overlay Tools #> ErasePolygonFromLidar: LiDAR Tools #> ErasePolygonFromRaster: GIS Analysis/Overlay Tools #> EuclideanAllocation: GIS Analysis/Distance Tools #> EuclideanDistance: GIS Analysis/Distance Tools #> Exp: Math and Stats Tools #> Exp2: Math and Stats Tools #> ExportTableToCsv: Data Tools #> ExposureTowardsWindFlux: Geomorphometric Analysis #> ExtendVectorLines: GIS Analysis #> ExtractByAttribute: GIS Analysis #> ExtractNodes: GIS Analysis #> ExtractRasterValuesAtPoints: GIS Analysis #> ExtractStreams: Stream Network Analysis #> ExtractValleys: Stream Network Analysis #> FD8FlowAccumulation: Hydrological Analysis #> FD8Pointer: Hydrological Analysis #> FarthestChannelHead: Stream Network Analysis #> FastAlmostGaussianFilter: Image Processing Tools/Filters #> FeaturePreservingSmoothing: Geomorphometric Analysis #> FetchAnalysis: Geomorphometric Analysis #> FillBurn: Hydrological Analysis #> FillDepressions: Hydrological Analysis #> FillDepressionsPlanchonAndDarboux: Hydrological Analysis #> FillDepressionsWangAndLiu: Hydrological Analysis #> FillMissingData: Geomorphometric Analysis #> FillSingleCellPits: Hydrological Analysis #> FilterLidarClasses: LiDAR Tools #> FilterLidarScanAngles: LiDAR Tools #> FilterRasterFeaturesByArea: GIS Analysis #> FindFlightlineEdgePoints: LiDAR Tools #> FindLowestOrHighestPoints: GIS Analysis #> FindMainStem: Stream Network Analysis #> FindNoFlowCells: Hydrological Analysis #> FindParallelFlow: Hydrological Analysis #> FindPatchOrClassEdgeCells: GIS Analysis/Patch Shape Tools #> FindRidges: Geomorphometric Analysis #> FlattenLakes: Hydrological Analysis #> FlightlineOverlap: LiDAR Tools #> FlipImage: Image Processing Tools #> FloodOrder: Hydrological Analysis #> Floor: Math and Stats Tools #> FlowAccumulationFullWorkflow: Hydrological Analysis #> FlowLengthDiff: Hydrological Analysis #> GammaCorrection: Image Processing Tools/Image Enhancement #> GaussianContrastStretch: Image Processing Tools/Image Enhancement #> GaussianCurvature: Geomorphometric Analysis #> GaussianFilter: Image Processing Tools/Filters #> GaussianScaleSpace: Geomorphometric Analysis #> Geomorphons: Geomorphometric Analysis #> GreaterThan: Math and Stats Tools #> HackStreamOrder: Stream Network Analysis #> HeatMap: GIS Analysis #> HeightAboveGround: LiDAR Tools #> HighPassBilateralFilter: Image Processing Tools/Filters #> HighPassFilter: Image Processing Tools/Filters #> HighPassMedianFilter: Image Processing Tools/Filters #> HighestPosition: GIS Analysis/Overlay Tools #> Hillshade: Geomorphometric Analysis #> Hillslopes: Hydrological Analysis #> HistogramEqualization: Image Processing Tools/Image Enhancement #> HistogramMatching: Image Processing Tools/Image Enhancement #> HistogramMatchingTwoImages: Image Processing Tools/Image Enhancement #> HoleProportion: GIS Analysis/Patch Shape Tools #> HorizonAngle: Geomorphometric Analysis #> HortonStreamOrder: Stream Network Analysis #> HypsometricAnalysis: Geomorphometric Analysis #> HypsometricallyTintedHillshade: Geomorphometric Analysis #> IdwInterpolation: GIS Analysis #> IhsToRgb: Image Processing Tools #> ImageAutocorrelation: Math and Stats Tools #> ImageCorrelation: Math and Stats Tools #> ImageCorrelationNeighbourhoodAnalysis: Math and Stats Tools #> ImageRegression: Math and Stats Tools #> ImageStackProfile: Image Processing Tools #> ImpoundmentSizeIndex: Hydrological Analysis #> InPlaceAdd: Math and Stats Tools #> InPlaceDivide: Math and Stats Tools #> InPlaceMultiply: Math and Stats Tools #> InPlaceSubtract: Math and Stats Tools #> Increment: Math and Stats Tools #> IndividualTreeDetection: LiDAR Tools #> InsertDams: Hydrological Analysis #> InstallWbExtension: Whitebox Utilities #> IntegerDivision: Math and Stats Tools #> IntegralImage: Image Processing Tools #> Intersect: GIS Analysis/Overlay Tools #> IsNoData: Math and Stats Tools #> Isobasins: Hydrological Analysis #> JensonSnapPourPoints: Hydrological Analysis #> JoinTables: Data Tools #> KMeansClustering: Machine Learning #> KNearestMeanFilter: Image Processing Tools/Filters #> KappaIndex: Math and Stats Tools #> KsTestForNormality: Math and Stats Tools #> LaplacianFilter: Image Processing Tools/Filters #> LaplacianOfGaussianFilter: Image Processing Tools/Filters #> LasToAscii: LiDAR Tools #> LasToMultipointShapefile: LiDAR Tools #> LasToShapefile: LiDAR Tools #> LasToZlidar: LiDAR Tools #> LaunchWbRunner: Whitebox Utilities #> LayerFootprint: GIS Analysis #> LeeSigmaFilter: Image Processing Tools/Filters #> LengthOfUpstreamChannels: Stream Network Analysis #> LessThan: Math and Stats Tools #> LidarBlockMaximum: LiDAR Tools #> LidarBlockMinimum: LiDAR Tools #> LidarClassifySubset: LiDAR Tools #> LidarColourize: LiDAR Tools #> LidarDigitalSurfaceModel: LiDAR Tools #> LidarElevationSlice: LiDAR Tools #> LidarGroundPointFilter: LiDAR Tools #> LidarHexBinning: LiDAR Tools #> LidarHillshade: LiDAR Tools #> LidarHistogram: LiDAR Tools #> LidarIdwInterpolation: LiDAR Tools #> LidarInfo: LiDAR Tools #> LidarJoin: LiDAR Tools #> LidarKappaIndex: LiDAR Tools #> LidarNearestNeighbourGridding: LiDAR Tools #> LidarPointDensity: LiDAR Tools #> LidarPointStats: LiDAR Tools #> LidarRansacPlanes: LiDAR Tools #> LidarRbfInterpolation: LiDAR Tools #> LidarRemoveDuplicates: LiDAR Tools #> LidarRemoveOutliers: LiDAR Tools #> LidarRooftopAnalysis: LiDAR Tools #> LidarSegmentation: LiDAR Tools #> LidarSegmentationBasedFilter: LiDAR Tools #> LidarShift: LiDAR Tools #> LidarTINGridding: LiDAR Tools #> LidarThin: LiDAR Tools #> LidarThinHighDensity: LiDAR Tools #> LidarTile: LiDAR Tools #> LidarTileFootprint: LiDAR Tools #> LidarTophatTransform: LiDAR Tools #> LineDetectionFilter: Image Processing Tools/Filters #> LineIntersections: GIS Analysis/Overlay Tools #> LineThinning: Image Processing Tools #> LinearityIndex: GIS Analysis/Patch Shape Tools #> LinesToPolygons: Data Tools #> ListUniqueValues: Math and Stats Tools #> ListUniqueValuesRaster: Math and Stats Tools #> Ln: Math and Stats Tools #> LocalQuadraticRegression: Geomorphometric Analysis #> Log10: Math and Stats Tools #> Log2: Math and Stats Tools #> LongProfile: Stream Network Analysis #> LongProfileFromPoints: Stream Network Analysis #> LongestFlowpath: Hydrological Analysis #> LowestPosition: GIS Analysis/Overlay Tools #> MDInfFlowAccumulation: Hydrological Analysis #> MajorityFilter: Image Processing Tools/Filters #> MapOffTerrainObjects: Geomorphometric Analysis #> Max: Math and Stats Tools #> MaxAbsoluteOverlay: GIS Analysis/Overlay Tools #> MaxAnisotropyDev: Geomorphometric Analysis #> MaxAnisotropyDevSignature: Geomorphometric Analysis #> MaxBranchLength: Geomorphometric Analysis #> MaxDifferenceFromMean: Geomorphometric Analysis #> MaxDownslopeElevChange: Geomorphometric Analysis #> MaxElevDevSignature: Geomorphometric Analysis #> MaxElevationDeviation: Geomorphometric Analysis #> MaxOverlay: GIS Analysis/Overlay Tools #> MaxUpslopeElevChange: Geomorphometric Analysis #> MaxUpslopeFlowpathLength: Hydrological Analysis #> MaxUpslopeValue: Hydrological Analysis #> MaximalCurvature: Geomorphometric Analysis #> MaximumFilter: Image Processing Tools/Filters #> MeanCurvature: Geomorphometric Analysis #> MeanFilter: Image Processing Tools/Filters #> MedianFilter: Image Processing Tools/Filters #> Medoid: GIS Analysis #> MergeLineSegments: GIS Analysis/Overlay Tools #> MergeTableWithCsv: Data Tools #> MergeVectors: Data Tools #> Min: Math and Stats Tools #> MinAbsoluteOverlay: GIS Analysis/Overlay Tools #> MinDownslopeElevChange: Geomorphometric Analysis #> MinMaxContrastStretch: Image Processing Tools/Image Enhancement #> MinOverlay: GIS Analysis/Overlay Tools #> MinimalCurvature: Geomorphometric Analysis #> MinimumBoundingBox: GIS Analysis #> MinimumBoundingCircle: GIS Analysis #> MinimumBoundingEnvelope: GIS Analysis #> MinimumConvexHull: GIS Analysis #> MinimumFilter: Image Processing Tools/Filters #> ModifiedKMeansClustering: Machine Learning #> ModifyNoDataValue: Data Tools #> Modulo: Math and Stats Tools #> Mosaic: Image Processing Tools #> MosaicWithFeathering: Image Processing Tools #> MultiPartToSinglePart: Data Tools #> MultidirectionalHillshade: Geomorphometric Analysis #> Multiply: Math and Stats Tools #> MultiplyOverlay: GIS Analysis/Overlay Tools #> MultiscaleElevationPercentile: Geomorphometric Analysis #> MultiscaleRoughness: Geomorphometric Analysis #> MultiscaleRoughnessSignature: Geomorphometric Analysis #> MultiscaleStdDevNormals: Geomorphometric Analysis #> MultiscaleStdDevNormalsSignature: Geomorphometric Analysis #> MultiscaleTopographicPositionImage: Geomorphometric Analysis #> NarrownessIndex: GIS Analysis/Patch Shape Tools #> NaturalNeighbourInterpolation: GIS Analysis #> NearestNeighbourGridding: GIS Analysis #> Negate: Math and Stats Tools #> NewRasterFromBase: Data Tools #> NormalVectors: LiDAR Tools #> NormalizeLidar: LiDAR Tools #> NormalizedDifferenceIndex: Image Processing Tools #> Not: Math and Stats Tools #> NotEqualTo: Math and Stats Tools #> NumDownslopeNeighbours: Geomorphometric Analysis #> NumInflowingNeighbours: Hydrological Analysis #> NumUpslopeNeighbours: Geomorphometric Analysis #> OlympicFilter: Image Processing Tools/Filters #> Opening: Image Processing Tools #> Or: Math and Stats Tools #> OtsuThresholding: Image Processing Tools #> PairedSampleTTest: Math and Stats Tools #> PanchromaticSharpening: Image Processing Tools/Image Enhancement #> PatchOrientation: GIS Analysis/Patch Shape Tools #> PennockLandformClass: Geomorphometric Analysis #> PercentElevRange: Geomorphometric Analysis #> PercentEqualTo: GIS Analysis/Overlay Tools #> PercentGreaterThan: GIS Analysis/Overlay Tools #> PercentLessThan: GIS Analysis/Overlay Tools #> PercentageContrastStretch: Image Processing Tools/Image Enhancement #> PercentileFilter: Image Processing Tools/Filters #> PerimeterAreaRatio: GIS Analysis/Patch Shape Tools #> PickFromList: GIS Analysis/Overlay Tools #> PlanCurvature: Geomorphometric Analysis #> PolygonArea: GIS Analysis #> PolygonLongAxis: GIS Analysis #> PolygonPerimeter: GIS Analysis #> PolygonShortAxis: GIS Analysis #> Polygonize: GIS Analysis/Overlay Tools #> PolygonsToLines: Data Tools #> Power: Math and Stats Tools #> PrewittFilter: Image Processing Tools/Filters #> PrincipalComponentAnalysis: Math and Stats Tools #> PrintGeoTiffTags: Data Tools #> Profile: Geomorphometric Analysis #> ProfileCurvature: Geomorphometric Analysis #> QinFlowAccumulation: Hydrological Analysis #> Quantiles: Math and Stats Tools #> QuinnFlowAccumulation: Hydrological Analysis #> RadialBasisFunctionInterpolation: GIS Analysis #> RadiusOfGyration: GIS Analysis/Patch Shape Tools #> RaiseWalls: Hydrological Analysis #> RandomField: Math and Stats Tools #> RandomSample: Math and Stats Tools #> RangeFilter: Image Processing Tools/Filters #> RasterArea: GIS Analysis #> RasterCalculator: Math and Stats Tools #> RasterCellAssignment: GIS Analysis #> RasterHistogram: Math and Stats Tools #> RasterPerimeter: GIS Analysis #> RasterStreamsToVector: Stream Network Analysis #> RasterSummaryStats: Math and Stats Tools #> RasterToVectorLines: Data Tools #> RasterToVectorPoints: Data Tools #> RasterToVectorPolygons: Data Tools #> RasterizeStreams: Stream Network Analysis #> Reciprocal: Math and Stats Tools #> Reclass: GIS Analysis #> ReclassEqualInterval: GIS Analysis #> ReclassFromFile: GIS Analysis #> ReinitializeAttributeTable: Data Tools #> RelatedCircumscribingCircle: GIS Analysis/Patch Shape Tools #> RelativeAspect: Geomorphometric Analysis #> RelativeTopographicPosition: Geomorphometric Analysis #> RemoveOffTerrainObjects: Geomorphometric Analysis #> RemovePolygonHoles: Data Tools #> RemoveShortStreams: Stream Network Analysis #> RemoveSpurs: Image Processing Tools #> RepairStreamVectorTopology: Stream Network Analysis #> Resample: Image Processing Tools #> RescaleValueRange: Math and Stats Tools #> RgbToIhs: Image Processing Tools #> Rho8FlowAccumulation: Hydrological Analysis #> Rho8Pointer: Hydrological Analysis #> RobertsCrossFilter: Image Processing Tools/Filters #> RootMeanSquareError: Math and Stats Tools #> Round: Math and Stats Tools #> RuggednessIndex: Geomorphometric Analysis #> ScharrFilter: Image Processing Tools/Filters #> SedimentTransportIndex: Geomorphometric Analysis #> SelectTilesByPolygon: LiDAR Tools #> SetNodataValue: Data Tools #> ShapeComplexityIndex: GIS Analysis/Patch Shape Tools #> ShapeComplexityIndexRaster: GIS Analysis/Patch Shape Tools #> ShreveStreamMagnitude: Stream Network Analysis #> SigmoidalContrastStretch: Image Processing Tools/Image Enhancement #> Sin: Math and Stats Tools #> SinglePartToMultiPart: Data Tools #> Sinh: Math and Stats Tools #> Sink: Hydrological Analysis #> Slope: Geomorphometric Analysis #> SlopeVsElevationPlot: Geomorphometric Analysis #> SmoothVectors: GIS Analysis #> SnapPourPoints: Hydrological Analysis #> SobelFilter: Image Processing Tools/Filters #> SphericalStdDevOfNormals: Geomorphometric Analysis #> SplitColourComposite: Image Processing Tools #> SplitVectorLines: GIS Analysis #> SplitWithLines: GIS Analysis/Overlay Tools #> Square: Math and Stats Tools #> SquareRoot: Math and Stats Tools #> StandardDeviationContrastStretch: Image Processing Tools/Image Enhancement #> StandardDeviationFilter: Image Processing Tools/Filters #> StandardDeviationOfSlope: Geomorphometric Analysis #> StochasticDepressionAnalysis: Hydrological Analysis #> StrahlerOrderBasins: Hydrological Analysis #> StrahlerStreamOrder: Stream Network Analysis #> StreamLinkClass: Stream Network Analysis #> StreamLinkIdentifier: Stream Network Analysis #> StreamLinkLength: Stream Network Analysis #> StreamLinkSlope: Stream Network Analysis #> StreamPowerIndex: Geomorphometric Analysis #> StreamSlopeContinuous: Stream Network Analysis #> Subbasins: Hydrological Analysis #> Subtract: Math and Stats Tools #> SumOverlay: GIS Analysis/Overlay Tools #> SurfaceAreaRatio: Geomorphometric Analysis #> SymmetricalDifference: GIS Analysis/Overlay Tools #> TINGridding: GIS Analysis #> Tan: Math and Stats Tools #> TangentialCurvature: Geomorphometric Analysis #> Tanh: Math and Stats Tools #> ThickenRasterLine: Image Processing Tools #> TimeInDaylight: Geomorphometric Analysis #> ToDegrees: Math and Stats Tools #> ToRadians: Math and Stats Tools #> TophatTransform: Image Processing Tools #> TopographicHachures: Geomorphometric Analysis #> TopologicalStreamOrder: Stream Network Analysis #> TotalCurvature: Geomorphometric Analysis #> TotalFilter: Image Processing Tools/Filters #> TraceDownslopeFlowpaths: Hydrological Analysis #> TravellingSalesmanProblem: GIS Analysis #> TrendSurface: Math and Stats Tools #> TrendSurfaceVectorPoints: Math and Stats Tools #> TributaryIdentifier: Stream Network Analysis #> Truncate: Math and Stats Tools #> TurningBandsSimulation: Math and Stats Tools #> TwoSampleKsTest: Math and Stats Tools #> Union: GIS Analysis/Overlay Tools #> UnnestBasins: Hydrological Analysis #> UnsharpMasking: Image Processing Tools/Filters #> UpdateNodataCells: GIS Analysis/Overlay Tools #> UpslopeDepressionStorage: Hydrological Analysis #> UserDefinedWeightsFilter: Image Processing Tools/Filters #> VectorHexBinning: GIS Analysis #> VectorLinesToRaster: Data Tools #> VectorPointsToRaster: Data Tools #> VectorPolygonsToRaster: Data Tools #> VectorStreamNetworkAnalysis: Stream Network Analysis #> Viewshed: Geomorphometric Analysis #> VisibilityIndex: Geomorphometric Analysis #> VoronoiDiagram: GIS Analysis #> Watershed: Hydrological Analysis #> WeightedOverlay: GIS Analysis/Overlay Tools #> WeightedSum: GIS Analysis/Overlay Tools #> WetnessIndex: Geomorphometric Analysis #> WilcoxonSignedRankTest: Math and Stats Tools #> WriteFunctionMemoryInsertion: Image Processing Tools #> Xor: Math and Stats Tools #> ZScores: Math and Stats Tools #> ZlidarToLas: LiDAR Tools #> ZonalStatistics: Math and Stats Tools"},{"path":"/articles/demo.html","id":"wbt_tool_parameters","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_tool_parameters()","title":"whitebox Demo","text":"wbt_tool_parameters() retrieves tool parameter descriptions specific tool JSON formatted string.","code":"wbt_tool_parameters(\"slope\") #> {\"parameters\": [{\"name\":\"Input DEM File\",\"flags\":[\"-i\",\"--dem\"],\"description\":\"Input raster DEM file.\",\"parameter_type\":{\"ExistingFile\":\"Raster\"},\"default_value\":null,\"optional\":false},{\"name\":\"Output File\",\"flags\":[\"-o\",\"--output\"],\"description\":\"Output raster file.\",\"parameter_type\":{\"NewFile\":\"Raster\"},\"default_value\":null,\"optional\":false},{\"name\":\"Z Conversion Factor\",\"flags\":[\"--zfactor\"],\"description\":\"Optional multiplier for when the vertical and horizontal units are not the same.\",\"parameter_type\":\"Float\",\"default_value\":null,\"optional\":true},{\"name\":\"Units\",\"flags\":[\"--units\"],\"description\":\"Units of output raster; options include 'degrees', 'radians', 'percent'\",\"parameter_type\":{\"OptionList\":[\"degrees\",\"radians\",\"percent\"]},\"default_value\":\"degrees\",\"optional\":true}]}"},{"path":"/articles/demo.html","id":"wbt_view_code","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_view_code()","title":"whitebox Demo","text":"WhiteboxTools written Rust open source. can view source code specific tool source code repository. Use argument viewer=TRUE use browseURL() open browser window corresponding GitHub page.","code":"wbt_view_code(\"breach_depressions\") #> https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/hydro_analysis/breach_depressions.rs"},{"path":"/articles/wbt-method.html","id":"wbt","dir":"Articles","previous_headings":"","what":"wbt()","title":"`wbt()` method: call 'Whitebox' tools by name","text":"wbt() method high-level wrapper function manage flow information R WhiteboxTools. wbt() one can run sequential analyses Whitebox R prepare inputs, generate commands, visualize results.","code":"library(whitebox)"},{"path":"/articles/wbt-method.html","id":"getting-started","dir":"Articles","previous_headings":"wbt()","what":"Getting Started","title":"`wbt()` method: call 'Whitebox' tools by name","text":"Know tool want run can’t remember required parameters? Just type wbt(\"toolname\") Output produced error invalid arguments helps guide use interactively prompting required optional arguments checklist.","code":"wbt(\"slope\") #> Required arguments: #> - [ ] dem -- Input raster DEM file. #> - [ ] output -- Output raster file. #>  #> Optional arguments: #> - [ ] zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. #> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent' #>  #> No parameters (Slope) #>  #>  Slope ERROR: 'dem', 'output' required"},{"path":"/articles/wbt-method.html","id":"result-objects","dir":"Articles","previous_headings":"wbt()","what":"Result Objects","title":"`wbt()` method: call 'Whitebox' tools by name","text":"calls wbt() return S3 object class wbt_result. Whether system call succeeds fails parameters passed WhiteboxTools executable references output file paths specified returned. output files reference spatial data (e.g. GeoTIFF file) may converted file-based R object providing information result. call fails informative error message issued, error cached inside result. Prior runs references stored well sequential tool runs; .","code":"# get file path of sample DEM dem <- sample_dem_data()  wbt(\"slope\", dem = dem, output = file.path(tempdir(), \"slope.tif\")) #>  #> --- PARAMETERS (Slope) --- #> dem  : '/home/runner/work/_temp/Library/whitebox/extdata/DEM.tif' #> output   : '/tmp/Rtmp3rOKmL/slope.tif'  #> --- RESULT --- #> $output #>   File result:  //tmp/Rtmp3rOKmL/slope.tif exists (Last modified: 2024-05-27 00:00:28.869362) wbt(\"slope\", goof = dem, output = file.path(tempdir(), \"slope.tif\")) #> Error: invalid parameter 'goof' #> Required arguments: #> - [ ] dem -- Input raster DEM file. #> - [*] output -- Output raster file. #>  #> Optional arguments: #> - [ ] zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. #> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent' #>  #> --- PARAMETERS (Slope) --- #> goof : '/home/runner/work/_temp/Library/whitebox/extdata/DEM.tif' #> output   : '/tmp/Rtmp3rOKmL/slope.tif'  #>  #>  Slope ERROR: 'goof' invalid; 'dem' required"},{"path":"/articles/wbt-method.html","id":"wbt_result-class","dir":"Articles","previous_headings":"wbt() > Result Objects","what":"wbt_result class","title":"`wbt()` method: call 'Whitebox' tools by name","text":"wbt_result class object base R list() standard element names (\"tool\", \"args\", \"stdout\", \"crs\", \"result\", \"history\") \"class\" attribute \"wbt_result\". output produced tool (usually file paths set user) included wbt_result$result list.","code":"str(wbt(\"slope\", dem = dem, output = file.path(tempdir(), \"slope.tif\")), max.level = 1) #> List of 6 #>  $ tool   : chr \"Slope\" #>  $ args   : chr \"--dem=/home/runner/work/_temp/Library/whitebox/extdata/DEM.tif --output=/tmp/Rtmp3rOKmL/slope.tif\" #>  $ stdout : chr \"Slope - Elapsed Time (excluding I/O): 0.11s\" #>  $ crs    : chr \"\" #>   ..- attr(*, \"package\")= Named chr \"\" #>   .. ..- attr(*, \"names\")= chr \"dem\" #>  $ result :List of 1 #>  $ history:List of 1 #>  - attr(*, \"class\")= chr \"wbt_result\""},{"path":"/articles/wbt-method.html","id":"wbt_result-on-error","dir":"Articles","previous_headings":"wbt() > Result Objects","what":"wbt_result on error","title":"`wbt()` method: call 'Whitebox' tools by name","text":"error try-error class object error message returned lieu list $result","code":"# on error there is a try-error object in $result x <- wbt(\"slope\") #> Required arguments: #> - [ ] dem -- Input raster DEM file. #> - [ ] output -- Output raster file. #>  #> Optional arguments: #> - [ ] zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. #> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent' inherits(x$result, 'try-error') #> [1] TRUE message(x$result[1]) #> ERROR: 'dem', 'output' required"},{"path":"/articles/wbt-method.html","id":"vignette-topics","dir":"Articles","previous_headings":"wbt()","what":"Vignette Topics","title":"`wbt()` method: call 'Whitebox' tools by name","text":"now cover wbt() method wbt_result class can used following: Input Output R spatial objects Running Sequences Tools (optionally: pipe |> %>%) Handling Coordinate Reference Systems","code":""},{"path":"/articles/wbt-method.html","id":"input-and-output-with-r-spatial-objects","dir":"Articles","previous_headings":"","what":"Input and Output with R spatial objects","title":"`wbt()` method: call 'Whitebox' tools by name","text":"feature wbt() handles input/output file name management using R objects input. can onerous task manage files workflows involving many tool runs. use terra object input, get SpatRaster. use raster object input object frontend, get RasterLayer object output tools produce raster. file paths associated R object.","code":""},{"path":"/articles/wbt-method.html","id":"compare-raster-and-terra-as-r-raster-object-frontends","dir":"Articles","previous_headings":"Input and Output with R spatial objects","what":"Compare raster and terra as R raster object frontends","title":"`wbt()` method: call 'Whitebox' tools by name","text":"user still needs specify paths wbt() eases process converting input objects paths reading output paths R objects tool run. principle R object references file type Whitebox supports can handled current (simple; proof concept) system. Using file-based representations may efficient, allows tangible trail steps workflow followed otherwise might hard track.","code":"if (requireNamespace(\"raster\")) {   rdem <- raster::raster(dem)    # raster input; raster output   r1 <- wbt(\"slope\", dem = rdem, output = file.path(tempdir(), \"slope.tif\"))   r1   class(r1$result$output) } #> Loading required namespace: raster #> [1] \"RasterLayer\" #> attr(,\"package\") #> [1] \"raster\" tdem <- terra::rast(dem)  ## terra input; terra output t1 <- wbt(\"slope\", dem = tdem, output =  file.path(tempdir(), \"slope.tif\")) t1 #>  #> --- PARAMETERS (Slope) --- #> dem  : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f5374a5d025.tif' #> output   : '/tmp/Rtmp3rOKmL/slope.tif'  #> --- RESULT --- #> $output #> class       : SpatRaster  #> dimensions  : 188, 237, 1  (nrow, ncol, nlyr) #> resolution  : 90, 90  (x, y) #> extent      : 664692, 686022, 4878904, 4895824  (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83 / UTM zone 18N (EPSG:26918)  #> source      : slope.tif  #> name        : slope class(t1$result$output) #> [1] \"SpatRaster\" #> attr(,\"package\") #> [1] \"terra\""},{"path":"/articles/wbt-method.html","id":"wbt_source-rasters-in-memory-and-vector-data","dir":"Articles","previous_headings":"","what":"wbt_source(): rasters in memory, and vector data","title":"`wbt()` method: call 'Whitebox' tools by name","text":"terra raster packages use pointers file/raster connection except grid entirely memory. Processing types rasters whitebox requires writing temporary GeoTIFF file tool input. general wbt() can handle . Vector data (point, line polygon geometries) commonly stored stored sf data.frames, sp objects, terra SpatVector objects. types read memory creation. Reading vector data R memory needed run Whitebox tools, wbt_source() provides means annotate objects information source file path (similar terra/raster handle raster sources) can processed wbt() minimal overhead. Objects like terra SpatVectorProxy use delayed read default. Passing file path wbt_source() create SpatVectorProxy necessary information use wbt(). instance, can create reference sample ESRI Shapefile via wbt_source(). result SpatVectorProxy. SpatVectorProxy provides light-weight means create R object reference large file; allowing “heavy” lifting file done primarily WhiteboxTools (GDAL via {terra}). time writing document, WhiteboxTools support vector data inputs Shapefile. , example, GeoPackage, wbt_source() convert input temporary shapefile return SpatVectorProxy references file. object can used input wbt().","code":"library(terra) #> terra 1.7.79 shp <- system.file(\"ex/lux.shp\", package = \"terra\") x <- wbt_source(shp) x #>  class       : SpatVectorProxy #>  geometry    : polygons  #>  dimensions  : 12, 6  (geometries, attributes) #>  extent      : 5.74414, 6.528252, 49.44781, 50.18162  (xmin, xmax, ymin, ymax) #>  source      : lux.shp #>  coord. ref. : lon/lat WGS 84 (EPSG:4326)  #>  names       :  ID_1 NAME_1  ID_2 NAME_2  AREA   POP #>  type        :         # load the data x2 <- query(x)  # remove area column x2$AREA <- NULL  # create a GeoPackage terra::writeVector(x2, filename = file.path(tempdir(), \"lux.gpkg\"), overwrite = TRUE) #> Warning in x@ptr$write(filename, layer, filetype, insert[1], overwrite[1], : #> GDAL Message 6: dataset /tmp/Rtmp3rOKmL/lux.gpkg does not support layer #> creation option ENCODING # now the source is a temporary .shp x3 <- wbt_source(file.path(tempdir(), \"lux.gpkg\"))  wbt(\"polygon_area\", input = x3) #>  #> --- PARAMETERS (PolygonArea) --- #> input    : '/tmp/Rtmp3rOKmL/lux.gpkg_file3f531cd4b079.shp'  #> --- RESULT --- #> $output #>  class       : SpatVectorProxy #>  geometry    : polygons  #>  dimensions  : 12, 6  (geometries, attributes) #>  extent      : 5.74414, 6.528252, 49.44781, 50.18162  (xmin, xmax, ymin, ymax) #>  source      : lux.gpkg_file3f531cd4b079.shp #>  coord. ref. : lon/lat WGS 84 (EPSG:4326)  #>  names       :  ID_1 NAME_1  ID_2 NAME_2   POP  AREA #>  type        :        "},{"path":"/articles/wbt-method.html","id":"running-sequences-of-tools","dir":"Articles","previous_headings":"","what":"Running Sequences of Tools","title":"`wbt()` method: call 'Whitebox' tools by name","text":"call wbt() first argument wbt_result output input wbt_result passed first input new tool run. general “pass output first input” works even first input parameter (\"-\" flag) something different dem input1. makes possible chain different operations together sequence. required parameters specified tool run. run “Slope” DEM, run “Slope” get second derivative “curvature”.","code":"x <- wbt(\"slope\", dem = dem, output = file.path(tempdir(), \"slope.tif\")) x2 <- wbt(x, tool_name = \"slope\", output = file.path(tempdir(), \"curvature.tif\"))"},{"path":"/articles/wbt-method.html","id":"using-pipes","dir":"Articles","previous_headings":"Running Sequences of Tools","what":"Using pipes","title":"`wbt()` method: call 'Whitebox' tools by name","text":"Nested chained operation syntax can transformed use pipe operators ({base} R 4.1+ |> {magrittr} %>%). can improve readability code (fewer nested parentheses) first argument transfer behavior allows results step transferred input next. wbt_result output prints console reflect input/output parameters recent tool run tool chain. wbt_result() method get $result single runs $result $history chained runs wbt_result object. $history element list wbt_result individual runs. pass invalid results one step next, get informative error message.","code":"wbt(\"slope\", dem = dem, output = file.path(tempdir(), \"slope.tif\")) |>   wbt(\"slope\", output = file.path(tempdir(), \"curvature.tif\")) x2 #>  #> --- PARAMETERS (Slope) --- #> dem  : '//tmp/Rtmp3rOKmL/slope.tif' #> output   : '/tmp/Rtmp3rOKmL/curvature.tif'  #> --- RESULT --- #> $output #>   File result:  //tmp/Rtmp3rOKmL/curvature.tif exists (Last modified: 2024-05-27 00:00:31.281393) #> --- HISTORY --- #> Prior results (n=1) for: Slope  #>  - Slope (output) str(wbt_result(x2), max.level = 1) #>  chr [1:2] \"//tmp/Rtmp3rOKmL/slope.tif\" \"//tmp/Rtmp3rOKmL/curvature.tif\" str(x2$history, max.level = 1) #> List of 2 #>  $ :List of 5 #>   ..- attr(*, \"class\")= chr \"wbt_result\" #>  $ :List of 5 #>   ..- attr(*, \"class\")= chr \"wbt_result\" x <- wbt(\"slope\") #> Required arguments: #> - [ ] dem -- Input raster DEM file. #> - [ ] output -- Output raster file. #>  #> Optional arguments: #> - [ ] zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. #> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent' wbt(x, \"slope\", output = file.path(tempdir(), \"foo.tif\")) #> NOTE: try-error result cannot be used as `dem` #> Required arguments: #> - [ ] dem -- Input raster DEM file. #> - [*] output -- Output raster file. #>  #> Optional arguments: #> - [ ] zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. #> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent' #>  #> --- PARAMETERS (Slope) --- #> output   : '/tmp/Rtmp3rOKmL/foo.tif'  #>  #>  Slope ERROR: 'dem' required  #> --- HISTORY --- #> Prior results (n=1) for: Slope  #>  - Slope ()"},{"path":"/articles/wbt-method.html","id":"coordinate-reference-systems-crs","dir":"Articles","previous_headings":"","what":"Coordinate Reference Systems (CRS)","title":"`wbt()` method: call 'Whitebox' tools by name","text":"top handling file paths necessary Geographic Information Systems handle Coordinate Reference System (CRS) information. Many R tools GDAL/PROJ sphere require valid CRS operate. WhiteboxTools read GeoKey information GeoTIFF files specified path propagate output file result. read files R, find original file’s CRS transferred. wbt() wbt_result help ensure consistent file CRS information across sequences operations within calls–especially involving R spatial objects. specified CRS R, made raster entirely R, might need hand setting file-based representation WhiteboxTools use. easy enough crs(), writeRaster() equivalent often requires boilerplate code just specifying argument, CRS propagate input. inputs file-based representation (e.g. RasterLayer SpatRaster objects) wbt() provides interface R objects can substituted file names vice versa. User workflow level attributes like CRS working directory handled time. process reading/writing files may contain CRS information, sample DEM, CRS can inspected, modified propagated file R objects.","code":"dem <- sample_dem_data()  ## equivalent to: # dem <- system.file(\"extdata/DEM.tif\", package = \"whitebox\")"},{"path":"/articles/wbt-method.html","id":"setting-the-crs","dir":"Articles","previous_headings":"Coordinate Reference Systems (CRS)","what":"Setting the CRS","title":"`wbt()` method: call 'Whitebox' tools by name","text":"CRS specified input SpatRaster object, wbt() makes sure propagated R object result. wbt() alter copy source output files may may CRS information. Alternately can specify crs argument wbt() instead rast(). directly set crs element wbt_result output. either case wherever specify crs argument crs stored wbt_result propagated relevant output. , source files unchanged CRS invalid CRS (write updated CRS file). two input R objects different () CRS wbt() method provide message user: message suppressed output CRS set accordingly crs argument specified. user set CRS SpatRaster object, necessarily match file used input returned output.","code":"araster <- terra::rast(dem) wbt(\"slope\", dem = araster, output = file.path(tempdir(), \"foo.tif\")) #>  #> --- PARAMETERS (Slope) --- #> dem  : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f5340875334.tif' #> output   : '/tmp/Rtmp3rOKmL/foo.tif'  #> --- RESULT --- #> $output #> class       : SpatRaster  #> dimensions  : 188, 237, 1  (nrow, ncol, nlyr) #> resolution  : 90, 90  (x, y) #> extent      : 664692, 686022, 4878904, 4895824  (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83 / UTM zone 18N (EPSG:26918)  #> source      : foo.tif  #> name        : foo wbt(\"slope\", dem = terra::rast(dem), crs = \"EPSG:26918\", output = file.path(tempdir(), \"foo.tif\")) #>  #> --- PARAMETERS (Slope) --- #> dem  : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f5317abf5f.tif' #> output   : '/tmp/Rtmp3rOKmL/foo.tif'  #> --- RESULT --- #> $output #> class       : SpatRaster  #> dimensions  : 188, 237, 1  (nrow, ncol, nlyr) #> resolution  : 90, 90  (x, y) #> extent      : 664692, 686022, 4878904, 4895824  (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83 / UTM zone 18N (EPSG:26918)  #> source      : foo.tif  #> name        : foo r1 <- terra::rast(dem) # default: EPSG:26918 r2 <- terra::deepcopy(r1) crs(r2) <- \"EPSG:26917\" # something else/wrong wbt(\"add\",      input1 = r1,      input2 = r2,      output = file.path(tempdir(), \"foo.tif\")    ) #> NOTE: Input CRS do not match. #>  #> --- PARAMETERS (Add) --- #> input1   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f53653e4d7.tif' #> input2   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f536e5c9aa4.tif' #> output   : '/tmp/Rtmp3rOKmL/foo.tif'  #> --- RESULT --- #> $output #> class       : SpatRaster  #> dimensions  : 188, 237, 1  (nrow, ncol, nlyr) #> resolution  : 90, 90  (x, y) #> extent      : 664692, 686022, 4878904, 4895824  (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83 / UTM zone 18N (EPSG:26918)  #> source      : foo.tif  #> name        : foo wbt(\"add\",      input1 = r1,     input2 = r2,      crs = \"EPSG:26918\",     output = file.path(tempdir(), \"foo.tif\")    ) #>  #> --- PARAMETERS (Add) --- #> input1   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f5369dfba6d.tif' #> input2   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3f5336597977.tif' #> output   : '/tmp/Rtmp3rOKmL/foo.tif'  #> --- RESULT --- #> $output #> class       : SpatRaster  #> dimensions  : 188, 237, 1  (nrow, ncol, nlyr) #> resolution  : 90, 90  (x, y) #> extent      : 664692, 686022, 4878904, 4895824  (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83 / UTM zone 18N (EPSG:26918)  #> source      : foo.tif  #> name        : foo"},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Qiusheng Wu. Author. Andrew Brown. Contributor, maintainer.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Wu, Q., Brown, . (2022). whitebox: 'WhiteboxTools' R Frontend. R package version 2.2.0.  Lindsay, J. B. (2016). Whitebox GAT: case study geomorphometric analysis. Computers & Geosciences, 95, 75-84. doi: http://dx.doi.org/10.1016/j.cageo.2016.07.003","code":"@Manual{,   title = {'whitebox': 'WhiteboxTools' R Frontend},   author = {Qiusheng Wu and Andrew Brown},   note = {R package version 2.2.0},   url = {https://CRAN.R-project.org/package=whitebox},   year = {2022}, } @Article{,   title = {Whitebox GAT: A case study in geomorphometric analysis.},   author = {J. B. Lindsay},   journal = {Computers & Geosciences},   year = {2016},   volume = {95},   pages = {75-84},   url = {http://dx.doi.org/10.1016/j.cageo.2016.07.003}, }"},{"path":"/index.html","id":"whitebox","dir":"","previous_headings":"","what":"WhiteboxTools R Frontend","title":"WhiteboxTools R Frontend","text":"WhiteboxTools R Frontend. repository related whitebox R package geospatial analysis, R frontend stand-alone executable command-line program called WhiteboxTools. Authors: John Lindsay (https://jblindsay.github.io/ghrg/index.html) Qiusheng Wu (https://wetlands.io) Andrew G. Brown (https://humus.rocks) GitHub repo: https://github.com/opengeos/whiteboxR CRAN link: https://cran.r-project.org/package=whitebox WhiteboxTools: https://github.com/jblindsay/whitebox-tools User Manual: https://jblindsay.github.io/wbt_book/ Free software: MIT license Contents Description Installation Usage Available Tools Contributing License Reporting Bugs","code":""},{"path":"/index.html","id":"description","dir":"","previous_headings":"","what":"Description","title":"WhiteboxTools R Frontend","text":"whitebox R package built WhiteboxTools, advanced geospatial data analysis platform developed Prof. John Lindsay (webpage; jblindsay) University Guelph’s Geomorphometry Hydrogeomatics Research Group. WhiteboxTools can used perform common geographical information systems (GIS) analysis operations, cost-distance analysis, distance buffering, raster reclassification. Remote sensing image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), common image transformations. WhiteboxTools also contains advanced tooling spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), LiDAR data processing. LiDAR point clouds can interrogated (LidarInfo, LidarHistogram), segmented, tiled joined, analyzed outliers, interpolated rasters (DEMs, intensity images), ground-points can classified filtered. WhiteboxTools cartographic spatial data visualization package; instead meant serve analytical backend data visualization software, mainly GIS. Suggested citation: Lindsay, J. B. (2016). Whitebox GAT: case study geomorphometric analysis. Computers & Geosciences, 95, 75-84. doi: http://dx.doi.org/10.1016/j.cageo.2016.07.003","code":""},{"path":"/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"WhiteboxTools R Frontend","text":"three ways install whitebox R package.","code":""},{"path":"/index.html","id":"id_1-cran","dir":"","previous_headings":"Installation","what":"1. CRAN","title":"WhiteboxTools R Frontend","text":"whitebox now available CRAN, can install :","code":"install.packages(\"whitebox\")"},{"path":"/index.html","id":"id_2-github","dir":"","previous_headings":"Installation","what":"2. GitHub","title":"WhiteboxTools R Frontend","text":"can alternatively install development version whitebox GitHub follows:","code":"if (!require(\"remotes\")) install.packages('remotes') remotes::install_github(\"opengeos/whiteboxR\", build = FALSE)"},{"path":"/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"WhiteboxTools R Frontend","text":"function wbt_init() checks path ‘WhiteboxTools’ binary. (invisibly) returns logical (TRUE/FALSE) value reflecting whether file found one default paths, including specified package options. See ?whitebox::whitebox. ‘WhiteboxTools’ installed already non-standard location run wbt_init(exe_path=...) set options current R session. Additional arguments wbt_init() can set package options, whether tools print standard console output cat(). want turn , set verbose = FALSE, instance:","code":"wbt_init() wbt_init(exe_path = 'C:/home/user/path/to/whitebox_tools.exe') wbt_init(exe_path = 'C:/home/user/path/to/whitebox_tools.exe', verbose = FALSE)"},{"path":"/index.html","id":"documentation","dir":"","previous_headings":"","what":"Documentation","title":"WhiteboxTools R Frontend","text":"whitebox package documentation R, ask help: list functions, try wbt_ prefix search: complete list functions available whitebox R package can found . Check demo examples.","code":"??whitebox ??wbt_"},{"path":"/index.html","id":"installing-whiteboxtools","dir":"","previous_headings":"","what":"Installing ‘WhiteboxTools’","title":"WhiteboxTools R Frontend","text":"quickest way get started 64-bit Windows, Linux MacOS architectures download install ‘WhiteboxTools’ binary. Linux binaries compiled ‘musl’ instead ‘glibc’ Ubuntu 22.04 available platform=\"linux_musl\". MacOS, Intel Apple ‘M’ series processors (‘arm64’) supported. method install_whitebox() provided download version binaries corresponds wrapper functions available package. default install ‘WhiteboxTools’ whitebox R package data directory (see wbt_data_dir()), subdirectory “WBT”.","code":"whitebox::install_whitebox()"},{"path":"/index.html","id":"whitebox-1","dir":"","previous_headings":"","what":"whitebox","title":"WhiteboxTools R Frontend","text":"run tools? Tool names whitebox R package can called corresponding function using wbt_snake_case() naming convention (e.g. wbt_lidar_info() R function \"LidarInfo\" ‘WhiteboxTools’ tool name). First load library perform necessary setup. Many ‘WhiteboxTools’ take GeoTIFF files input, ‘WhiteboxTools’ supports several grid input formats. sample Digital Elevation Model (DEM) included whitebox package. can get path follows demo: use DEM sequence ‘WhiteboxTools’ processing routines. Run tools passing file paths input output files. Apply feature-preserving smoothing (FeaturePreservingSmoothing) Breach depressions DEM (BreachDepressions) Calculate D-Infinity flow accumulation (DInfFlowAccumulation) filter argument wbt_feature_preserving_smoothing() sets size filter kernel.  ‘WhiteboxTools’","code":"library(whitebox)  # set up as needed wbt_init() # Set input raster DEM file dem <- sample_dem_data() ## 1. FeaturePreservingSmoothing wbt_feature_preserving_smoothing(   dem = dem,   output = \"./smoothed.tif\",   filter = 9 )  ## 2. BreachDepressions wbt_breach_depressions(dem = \"./smoothed.tif\", output = \"./breached.tif\")  ## 3. DInfFlowAccumulation wbt_d_inf_flow_accumulation(input = dem, output = \"./flow_accum.tif\")  if (requireNamespace('terra')) {   terra::plot(terra::rast(\"./flow_accum.tif\")) } #> Loading required namespace: terra library(whitebox)  # cat() output in non-interactive mode wbt_verbose(TRUE)  # Prints the whitebox-tools help...a listing of available commands wbt_help() #> WhiteboxTools Help #>  #> The following commands are recognized: #> --cd, --wd          Changes the working directory; used in conjunction with --run flag. #> --compress_rasters  Sets the compress_raster option in the settings.json file; determines if newly created rasters are compressed. e.g. --compress_rasters=true #> -h, --help          Prints help information. #> -l, --license       Prints the whitebox-tools license. Tool names may also be used, --license=\"Slope\" #> --listtools         Lists all available tools. Keywords may also be used, --listtools slope. #> --max_procs         Sets the maximum number of processors used. -1 = all available processors. e.g. --max_procs=2 #> -r, --run           Runs a tool; used in conjunction with --wd flag; -r=\"LidarInfo\". #> --toolbox           Prints the toolbox associated with a tool; --toolbox=Slope. #> --toolhelp          Prints the help associated with a tool; --toolhelp=\"LidarInfo\". #> --toolparameters    Prints the parameters (in json form) for a specific tool; --toolparameters=\"LidarInfo\". #> -v                  Verbose mode. Without this flag, tool outputs will not be printed. #> --viewcode          Opens the source code of a tool in a web browser; --viewcode=\"LidarInfo\". #> --version           Prints the version information. #>  #> Example Usage: #> >> ./whitebox_tools -r=lidar_info --cd=\"/path/to/data/\" -i=input.las --vlr --geokeys   # Prints the whitebox-tools license wbt_license() #> WhiteboxTools License #> Copyright 2017-2023 John Lindsay #>  #> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and #> associated documentation files (the \"Software\"), to deal in the Software without restriction, #> including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, #> and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, #> subject to the following conditions: #>  #> The above copyright notice and this permission notice shall be included in all copies or substantial #> portions of the Software. #>  #> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT #> NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND #> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES #> OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN #> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.   # Prints the whitebox-tools version wbt_version() #> WhiteboxTools v2.4.0 (c) Dr. John Lindsay 2017-2023 #>  #> WhiteboxTools is an advanced geospatial data analysis platform developed at #> the University of Guelph's Geomorphometry and Hydrogeomatics Research  #> Group (GHRG). See www.whiteboxgeo.com for more details.   # Prints the toolbox for a specific tool. wbt_toolbox(\"AsciiToLas\") #> LiDAR Tools   # Lists tools with 'lidar' in tool name or description. wbt_list_tools(\"lidar\") #> All 66 Tools containing keywords: #> AsciiToLas: Converts one or more ASCII files containing LiDAR points into LAS files. #> ClassifyBuildingsInLidar: Reclassifies a LiDAR points that lie within vector building footprints. #> ClassifyOverlapPoints: Classifies or filters LAS points in regions of overlapping flight lines. #> ClipLidarToPolygon: Clips a LiDAR point cloud to a vector polygon or polygons. #> ErasePolygonFromLidar: Erases (cuts out) a vector polygon or polygons from a LiDAR point cloud. #> FilterLidarClasses: Removes points in a LAS file with certain specified class values. #> FilterLidarScanAngles: Removes points in a LAS file with scan angles greater than a threshold. #> FindFlightlineEdgePoints: Identifies points along a flightline's edge in a LAS file. #> FlightlineOverlap: Reads a LiDAR (LAS) point file and outputs a raster containing the number of overlapping flight-lines in each grid cell. #> HeightAboveGround: Normalizes a LiDAR point cloud, providing the height above the nearest ground-classified point. #> LasToAscii: Converts one or more LAS files into ASCII text files. #> LasToMultipointShapefile: 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. #> LasToShapefile: Converts one or more LAS files into a vector Shapefile of POINT ShapeType. #> LasToZlidar: Converts one or more LAS files into the zlidar compressed LiDAR data format. #> LidarBlockMaximum: 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. #> LidarBlockMinimum: 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. #> LidarClassifySubset: Classifies the values in one LiDAR point cloud that correspond with points in a subset cloud. #> LidarColourize: Adds the red-green-blue colour fields of a LiDAR (LAS) file based on an input image. #> LidarDigitalSurfaceModel: Creates a top-surface digital surface model (DSM) from a LiDAR point cloud. #> LidarElevationSlice: Outputs all of the points within a LiDAR (LAS) point file that lie between a specified elevation range. #> LidarGroundPointFilter: Identifies ground points within LiDAR dataset using a slope-based method. #> LidarHexBinning: Hex-bins a set of LiDAR points. #> LidarHillshade: Calculates a hillshade value for points within a LAS file and stores these data in the RGB field. #> LidarHistogram: Creates a histogram of LiDAR data. #> LidarIdwInterpolation: 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. #> LidarInfo: 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. #> LidarJoin: Joins multiple LiDAR (LAS) files into a single LAS file. #> LidarKappaIndex: Performs a kappa index of agreement (KIA) analysis on the classifications of two LAS files. #> LidarNearestNeighbourGridding: 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. #> LidarPointDensity: 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. #> LidarPointStats: 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. #> LidarRansacPlanes: Performs a RANSAC analysis to identify points within a LiDAR point cloud that belong to linear planes. #> LidarRbfInterpolation: 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. #> LidarRemoveDuplicates: Removes duplicate points from a LiDAR data set. #> LidarRemoveOutliers: Removes outliers (high and low points) in a LiDAR point cloud. #> LidarRooftopAnalysis: Identifies roof segments in a LiDAR point cloud. #> LidarSegmentation: Segments a LiDAR point cloud based on differences in the orientation of fitted planar surfaces and point proximity. #> LidarSegmentationBasedFilter: Identifies ground points within LiDAR point clouds using a segmentation based approach. #> LidarTINGridding: Creates a raster grid based on a Delaunay triangular irregular network (TIN) fitted to LiDAR points. #> LidarThin: Thins a LiDAR point cloud, reducing point density. #> LidarThinHighDensity: Thins points from high density areas within a LiDAR point cloud. #> LidarTile: Tiles a LiDAR LAS file into multiple LAS files. #> LidarTileFootprint: 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. #> LidarTophatTransform: 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. #> NormalVectors: Calculates normal vectors for points within a LAS file and stores these data (XYZ vector components) in the RGB field. #> SelectTilesByPolygon: Copies LiDAR tiles overlapping with a polygon into an output directory. #> ZlidarToLas: Converts one or more zlidar files into the LAS data format. #> ModifyLidar: Modify points within a LiDAR point cloud based on point properties. #> ColourizeBasedOnPointReturns: Sets the RGB values of a LiDAR point cloud based on the point returns. #> FilterLidarByReferenceSurface: Filters points within a LiDAR point cloud based on a reference surface. #> SmoothVegetationResidual: This tool can smooth the residual roughness due to vegetation cover in LiDAR DEMs. #> SortLidar: Sorts LiDAR points based on their properties. #> IndividualTreeDetection: Identifies points in a LiDAR point cloud that are associated with the tops of individual trees. #> SplitLidar: Splits LiDAR points up into a series of new files based on their properties. #> RecoverFlightlineInfo: Associates LiDAR points by their flightlines. #> ColourizeBasedOnClass: Sets the RGB values of a LiDAR point cloud based on the point classification values. #> LidarPointReturnAnalysis: This tool performs a quality control check on the return values of points in a LiDAR file. #> LidarShift: Shifts the x,y,z coordinates of a LiDAR file. #> FilterLidarByPercentile: Filters points within a LiDAR point cloud based on local elevation percentile. #> LidarContour: This tool creates a vector contour coverage from an input LiDAR point file. #> ImprovedGroundPointFilter: Filters points within a LiDAR point cloud based on a reference surface. #> LidarSibsonInterpolation: This tool interpolates one or more LiDAR tiles using Sibson's natural neighbour method. #> ClassifyLidar: Classify points within a LiDAR point cloud based on point properties. #> LidarEigenvalueFeatures: Calculate eigenvalue-based metrics from a LiDAR point cloud. #> FilterLidar: Filters points within a LiDAR point cloud based on point properties. #> NormalizeLidar: Normalizes a LiDAR point cloud.   # Prints the help for a specific tool. wbt_tool_help(\"lidar_info\") #> LidarInfo #> Description: #> 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. #> Toolbox: LiDAR Tools #> Parameters: #>  #> Flag               Description #> -----------------  ----------- #> -i, --input        Input LiDAR file. #> -o, --output       Output HTML file for summary report. #> --density          Flag indicating whether or not to calculate the average point density and nominal point spacing. #> --vlr              Flag indicating whether or not to print the variable length records (VLRs). #> --geokeys          Flag indicating whether or not to print the geokeys. #>  #>  #> Example usage: #> >>./whitebox_tools -r=LidarInfo -v --wd=\"/path/to/data/\" -i=file.las --vlr --geokeys\" #> ./whitebox_tools -r=LidarInfo --wd=\"/path/to/data/\" -i=file.las   # Retrieves the tool parameter descriptions for a specific tool. wbt_tool_parameters(\"slope\") #> {\"parameters\": [{\"name\":\"Input DEM File\",\"flags\":[\"-i\",\"--dem\"],\"description\":\"Input raster DEM file.\",\"parameter_type\":{\"ExistingFile\":\"Raster\"},\"default_value\":null,\"optional\":false},{\"name\":\"Output File\",\"flags\":[\"-o\",\"--output\"],\"description\":\"Output raster file.\",\"parameter_type\":{\"NewFile\":\"Raster\"},\"default_value\":null,\"optional\":false},{\"name\":\"Z Conversion Factor\",\"flags\":[\"--zfactor\"],\"description\":\"Optional multiplier for when the vertical and horizontal units are not the same.\",\"parameter_type\":\"Float\",\"default_value\":null,\"optional\":true},{\"name\":\"Units\",\"flags\":[\"--units\"],\"description\":\"Units of output raster; options include 'degrees', 'radians', 'percent'\",\"parameter_type\":{\"OptionList\":[\"degrees\",\"radians\",\"percent\"]},\"default_value\":\"degrees\",\"optional\":true}]}   # View the source code for a specific tool on the source code repository. wbt_view_code(\"breach_depressions\") #> https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/hydro_analysis/breach_depressions.rs"},{"path":"/index.html","id":"available-tools","dir":"","previous_headings":"","what":"Available Tools","title":"WhiteboxTools R Frontend","text":"WhiteboxTools library currently contains 537 tools, grouped based main function one following categories: Data Tools, GIS Analysis, Hydrological Analysis, Image Analysis, LiDAR Analysis, Mathematical Statistical Analysis, Stream Network Analysis, Terrain Analysis. listing available tools, complete documentation usage details, please see ‘WhiteboxTools’ User Manual. interested using ‘WhiteboxTools’ command-line program, check ‘WhiteboxTools’ Usage","code":""},{"path":"/index.html","id":"contributing","dir":"","previous_headings":"","what":"Contributing","title":"WhiteboxTools R Frontend","text":"like contribute project developer, follow instructions get started: Fork whiteboxR repository (https://github.com/opengeos/whiteboxR) Create feature branch (git checkout -b -new-feature) Commit changes (git commit -‘Add feature’) Push branch (git push origin -new-feature) Create new Pull Request Unless explicitly stated otherwise, contribution intentionally submitted inclusion work shall licensed MIT license without additional terms conditions.","code":""},{"path":"/index.html","id":"license","dir":"","previous_headings":"","what":"License","title":"WhiteboxTools R Frontend","text":"whitebox R package distributed MIT license, permissive open-source (free software) license.","code":""},{"path":"/index.html","id":"reporting-bugs","dir":"","previous_headings":"","what":"Reporting Bugs","title":"WhiteboxTools R Frontend","text":"whitebox distributed without warranty suitability application. encounter flaws software (.e. bugs) please report issue. Providing detailed description conditions bug occurred help identify bug. Use Issues tracker GitHub report issues software request feature enchancements. Please email Dr. Lindsay directly bugs.","code":""},{"path":"/reference/check_whitebox_binary.html","id":null,"dir":"Reference","previous_headings":"","what":"Check for 'WhiteboxTools' executable path — check_whitebox_binary","title":"Check for 'WhiteboxTools' executable path — check_whitebox_binary","text":"Check 'WhiteboxTools' executable path","code":""},{"path":"/reference/check_whitebox_binary.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check for 'WhiteboxTools' executable path — check_whitebox_binary","text":"","code":"check_whitebox_binary(silent = TRUE)"},{"path":"/reference/check_whitebox_binary.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check for 'WhiteboxTools' executable path — check_whitebox_binary","text":"silent logical. Print help installation/setting path. Default TRUE.","code":""},{"path":"/reference/check_whitebox_binary.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check for 'WhiteboxTools' executable path — check_whitebox_binary","text":"logical 'WhiteboxTools' executable file exists.","code":""},{"path":[]},{"path":"/reference/install_whitebox.html","id":null,"dir":"Reference","previous_headings":"","what":"Download and Install 'WhiteboxTools' — wbt_install","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"function downloads 'WhiteboxTools' binary needed. Pre-compiled binaries available download 64-bit Linux (default compiled glibc Ubuntu 22.04; use platform=\"linux_musl\" musl/earlier versions glibc), Windows Mac OS (ARM Intel) platforms. need WhiteboxTools another platform follow instructions build source: https://github.com/jblindsay/whitebox-tools","code":""},{"path":"/reference/install_whitebox.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"","code":"wbt_install(   pkg_dir = wbt_data_dir(),   platform = NULL,   force = FALSE,   remove = FALSE )  install_whitebox(   pkg_dir = wbt_data_dir(),   platform = NULL,   force = FALSE,   remove = FALSE )  wbt_install_extension(   extension = c(\"GeneralToolsetExtension\", \"AgricultureToolset\",     \"DemAndSpatialHydrologyToolset\", \"LidarAndRemoteSensingToolset\"),   platform = NULL,   destdir = dirname(wbt_exe_path(shell_quote = FALSE)) )"},{"path":"/reference/install_whitebox.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"pkg_dir default install path whitebox package \"WBT\" folder platform character. Optional: suffix used alternate platform names. Linux, can choose \"linux_amd64\" (default; Linux) \"linux_musl\" older glibc versions. macOS Darwin can choose \"darwin_amd64\" (default; macOS) \"darwin_m_series\" Apple M series hardware. Note wbt_install_extension() Apple M series use \"MacOS_ARM\". one Windows binary available: \"win_amd64\" (default; Windows). force logical. Force install? Default FALSE. remove=TRUE passed unlink() change permissions allow removal files/directories. remove logical. Remove contents \"WBT\" folder pkg_dir? Default: FALSE extension Extension name destdir Directory create /plugins/ directory extracting extensions","code":""},{"path":"/reference/install_whitebox.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"Prints location WhiteboxTools binary, found. NULL otherwise.","code":""},{"path":"/reference/install_whitebox.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"'WhiteboxTools' extensions can uninstalled passing remove=TRUE argument.","code":""},{"path":"/reference/install_whitebox.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"","code":"if (FALSE) { install_whitebox() }"},{"path":"/reference/sample_dem_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Convenience method for path to sample DEM — sample_dem_data","title":"Convenience method for path to sample DEM — sample_dem_data","text":"Get file path DEM.tif stored extdata subfolder whitebox package installation directory. needed, download TIFF file GitHub.","code":""},{"path":"/reference/sample_dem_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convenience method for path to sample DEM — sample_dem_data","text":"","code":"sample_dem_data(   destfile = file.path(system.file(\"extdata\", package = \"whitebox\"), \"DEM.tif\"),   ... )"},{"path":"/reference/sample_dem_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convenience method for path to sample DEM — sample_dem_data","text":"destfile Path target location sample data. downloaded exist. Defaults file path extdata subfolder whitebox package installation directory. ... additional arguments download.file()","code":""},{"path":"/reference/sample_dem_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convenience method for path to sample DEM — sample_dem_data","text":"character.","code":""},{"path":"/reference/sample_dem_data.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convenience method for path to sample DEM — sample_dem_data","text":"","code":"if (check_whitebox_binary()) {   wbt_slope(sample_dem_data(), output = \"slope.tif\") } unlink(c('slope.tif', 'settings.json'))"},{"path":"/reference/wbt.html","id":null,"dir":"Reference","previous_headings":"","what":"Run WhiteboxTools by Tool Name — wbt","title":"Run WhiteboxTools by Tool Name — wbt","text":"required specify required arguments either paths files, R object types can associated file. wbt_result(): return combined list results either history wbt_result (present history=TRUE), result wbt_result","code":""},{"path":"/reference/wbt.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run WhiteboxTools by Tool Name — wbt","text":"","code":"wbt(   result,   tool_name,   ...,   crs = NULL,   verbose_mode = FALSE,   command_only = FALSE )  # S3 method for wbt_result wbt(   result,   tool_name,   ...,   crs = NULL,   verbose_mode = FALSE,   command_only = FALSE )  wbt_result(result, i = NULL, history = TRUE, attribute = \"output\")  # S3 method for character wbt(   result,   tool_name,   ...,   crs = NULL,   verbose_mode = FALSE,   command_only = FALSE )  # S3 method for `function` wbt(   result,   tool_name,   ...,   crs = NULL,   verbose_mode = FALSE,   command_only = FALSE )  # S3 method for missing wbt(   result,   tool_name,   ...,   crs = NULL,   verbose_mode = FALSE,   command_only = FALSE )"},{"path":"/reference/wbt.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run WhiteboxTools by Tool Name — wbt","text":"result object class wbt_result tool_name character. name tool run. tool/function name (.e. symbol) non-standard evaluated character. ... arguments tool crs character Optional: WKT Coordinate Reference System string, identifier EPSG code PROJ string verbose_mode passed wbt_run_tool() command_only Return command run system()? Default: FALSE Optional index result list element return result. Default whole list. history Default: TRUE returns list history results attribute Default: \"output\"","code":""},{"path":"/reference/wbt.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run WhiteboxTools by Tool Name — wbt","text":"list class \"wbt_result\" containing elements: tool - tool name args - arguments passed executable stdout - console output (result wbt_run_tool()) crs - Coordinate Reference System string (WKT PROJ) result - 'result' parameters (--output) can converted R objects run. list RasterLayer character. May try-error arguments specified incorrectly. history - history 'result' wbt_result passed input, recent output end list result attribute \"history\" present, otherwise result attribute. specified, just ith element list.","code":""},{"path":"/reference/wbt.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Run WhiteboxTools by Tool Name — wbt","text":"Supports SpatRaster / RasterLayer input / output. Arguments transformed source class passed WhiteboxTools executable standard character string arguments involving file paths. print help tool, see wbt_tool_help() tool_name may specified without quotes wbt_ prefix. e.g. \"wbt_slope\", wbt_slope, slope, \"slope\" identical.","code":""},{"path":[]},{"path":"/reference/wbt_absolute_value.html","id":null,"dir":"Reference","previous_headings":"","what":"Absolute value — wbt_absolute_value","title":"Absolute value — wbt_absolute_value","text":"Calculates absolute value every cell raster.","code":""},{"path":"/reference/wbt_absolute_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Absolute value — wbt_absolute_value","text":"","code":"wbt_absolute_value(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_absolute_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Absolute value — wbt_absolute_value","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_absolute_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Absolute value — wbt_absolute_value","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_accumulation_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Accumulation curvature — wbt_accumulation_curvature","title":"Accumulation curvature — wbt_accumulation_curvature","text":"tool calculates accumulation curvature input DEM.","code":""},{"path":"/reference/wbt_accumulation_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Accumulation curvature — wbt_accumulation_curvature","text":"","code":"wbt_accumulation_curvature(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_accumulation_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Accumulation curvature — wbt_accumulation_curvature","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_accumulation_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Accumulation curvature — wbt_accumulation_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_activate.html","id":null,"dir":"Reference","previous_headings":"","what":"Activate 'WhiteboxTools' Extensions — wbt_activate","title":"Activate 'WhiteboxTools' Extensions — wbt_activate","text":"Activate 'WhiteboxTools' Extensions","code":""},{"path":"/reference/wbt_activate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Activate 'WhiteboxTools' Extensions — wbt_activate","text":"","code":"wbt_activate(   email,   activation_key,   seat = 1,   destdir = dirname(wbt_exe_path(shell_quote = FALSE)) )"},{"path":"/reference/wbt_activate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Activate 'WhiteboxTools' Extensions — wbt_activate","text":"email Email Address activation_key Activation Key seat Seat Number (Default 1) destdir Directory containing whitebox_tools /plugins/ folder.","code":""},{"path":"/reference/wbt_activate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Activate 'WhiteboxTools' Extensions — wbt_activate","text":"0 success (invisibly). Try-error error.","code":""},{"path":"/reference/wbt_adaptive_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Adaptive filter — wbt_adaptive_filter","title":"Adaptive filter — wbt_adaptive_filter","text":"Performs adaptive filter image.","code":""},{"path":"/reference/wbt_adaptive_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Adaptive filter — wbt_adaptive_filter","text":"","code":"wbt_adaptive_filter(   input,   output,   filterx = 11,   filtery = 11,   threshold = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_adaptive_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Adaptive filter — wbt_adaptive_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. threshold Difference mean threshold, standard deviations. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_adaptive_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Adaptive filter — wbt_adaptive_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_add.html","id":null,"dir":"Reference","previous_headings":"","what":"Add — wbt_add","title":"Add — wbt_add","text":"Performs addition operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_add.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add — wbt_add","text":"","code":"wbt_add(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_add.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add — wbt_add","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_add.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add — wbt_add","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_add_point_coordinates_to_table.html","id":null,"dir":"Reference","previous_headings":"","what":"Add point coordinates to table — wbt_add_point_coordinates_to_table","title":"Add point coordinates to table — wbt_add_point_coordinates_to_table","text":"Modifies attribute table point vector adding fields containing point's X Y coordinates.","code":""},{"path":"/reference/wbt_add_point_coordinates_to_table.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add point coordinates to table — wbt_add_point_coordinates_to_table","text":"","code":"wbt_add_point_coordinates_to_table(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_add_point_coordinates_to_table.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add point coordinates to table — wbt_add_point_coordinates_to_table","text":"input Input vector Points file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_add_point_coordinates_to_table.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add point coordinates to table — wbt_add_point_coordinates_to_table","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_aggregate_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Aggregate raster — wbt_aggregate_raster","title":"Aggregate raster — wbt_aggregate_raster","text":"Aggregates raster lower resolution.","code":""},{"path":"/reference/wbt_aggregate_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Aggregate raster — wbt_aggregate_raster","text":"","code":"wbt_aggregate_raster(   input,   output,   agg_factor = 2,   type = \"mean\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_aggregate_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Aggregate raster — wbt_aggregate_raster","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. agg_factor Aggregation factor, pixels. type Statistic used fill output pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_aggregate_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Aggregate raster — wbt_aggregate_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_and.html","id":null,"dir":"Reference","previous_headings":"","what":"And — wbt_and","title":"And — wbt_and","text":"Performs logical operator two Boolean raster images.","code":""},{"path":"/reference/wbt_and.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"And — wbt_and","text":"","code":"wbt_and(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_and.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"And — wbt_and","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_and.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"And — wbt_and","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_anova.html","id":null,"dir":"Reference","previous_headings":"","what":"Anova — wbt_anova","title":"Anova — wbt_anova","text":"Performs analysis variance (ANOVA) test raster dataset.","code":""},{"path":"/reference/wbt_anova.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Anova — wbt_anova","text":"","code":"wbt_anova(   input,   features,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_anova.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Anova — wbt_anova","text":"input Input raster file path. See wbt_file_path() details. features Feature definition (class) raster. output Output HTML file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_anova.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Anova — wbt_anova","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_arc_cos.html","id":null,"dir":"Reference","previous_headings":"","what":"Arc cos — wbt_arc_cos","title":"Arc cos — wbt_arc_cos","text":"Returns inverse cosine (arccos) values raster.","code":""},{"path":"/reference/wbt_arc_cos.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Arc cos — wbt_arc_cos","text":"","code":"wbt_arc_cos(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_arc_cos.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Arc cos — wbt_arc_cos","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_arc_cos.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Arc cos — wbt_arc_cos","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_arc_sin.html","id":null,"dir":"Reference","previous_headings":"","what":"Arc sin — wbt_arc_sin","title":"Arc sin — wbt_arc_sin","text":"Returns inverse sine (arcsin) values raster.","code":""},{"path":"/reference/wbt_arc_sin.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Arc sin — wbt_arc_sin","text":"","code":"wbt_arc_sin(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_arc_sin.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Arc sin — wbt_arc_sin","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_arc_sin.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Arc sin — wbt_arc_sin","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_arc_tan.html","id":null,"dir":"Reference","previous_headings":"","what":"Arc tan — wbt_arc_tan","title":"Arc tan — wbt_arc_tan","text":"Returns inverse tangent (arctan) values raster.","code":""},{"path":"/reference/wbt_arc_tan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Arc tan — wbt_arc_tan","text":"","code":"wbt_arc_tan(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_arc_tan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Arc tan — wbt_arc_tan","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_arc_tan.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Arc tan — wbt_arc_tan","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_arcosh.html","id":null,"dir":"Reference","previous_headings":"","what":"Arcosh — wbt_arcosh","title":"Arcosh — wbt_arcosh","text":"Returns inverse hyperbolic cosine (arcosh) values raster.","code":""},{"path":"/reference/wbt_arcosh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Arcosh — wbt_arcosh","text":"","code":"wbt_arcosh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_arcosh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Arcosh — wbt_arcosh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_arcosh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Arcosh — wbt_arcosh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_arsinh.html","id":null,"dir":"Reference","previous_headings":"","what":"Arsinh — wbt_arsinh","title":"Arsinh — wbt_arsinh","text":"Returns inverse hyperbolic sine (arsinh) values raster.","code":""},{"path":"/reference/wbt_arsinh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Arsinh — wbt_arsinh","text":"","code":"wbt_arsinh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_arsinh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Arsinh — wbt_arsinh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_arsinh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Arsinh — wbt_arsinh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_artanh.html","id":null,"dir":"Reference","previous_headings":"","what":"Artanh — wbt_artanh","title":"Artanh — wbt_artanh","text":"Returns inverse hyperbolic tangent (arctanh) values raster.","code":""},{"path":"/reference/wbt_artanh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Artanh — wbt_artanh","text":"","code":"wbt_artanh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_artanh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Artanh — wbt_artanh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_artanh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Artanh — wbt_artanh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ascii_to_las.html","id":null,"dir":"Reference","previous_headings":"","what":"Ascii to las — wbt_ascii_to_las","title":"Ascii to las — wbt_ascii_to_las","text":"Converts one ASCII files containing LiDAR points LAS files.","code":""},{"path":"/reference/wbt_ascii_to_las.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ascii to las — wbt_ascii_to_las","text":"","code":"wbt_ascii_to_las(   inputs,   pattern,   proj = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ascii_to_las.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ascii to las — wbt_ascii_to_las","text":"inputs Input LiDAR  ASCII files (.csv). pattern Input field pattern. proj Well-known-text string EPSG code describing projection. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ascii_to_las.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ascii to las — wbt_ascii_to_las","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_aspect.html","id":null,"dir":"Reference","previous_headings":"","what":"Aspect — wbt_aspect","title":"Aspect — wbt_aspect","text":"Calculates aspect raster input DEM.","code":""},{"path":"/reference/wbt_aspect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Aspect — wbt_aspect","text":"","code":"wbt_aspect(   dem,   output,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_aspect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Aspect — wbt_aspect","text":"dem Input raster DEM file. output Output raster file. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_aspect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Aspect — wbt_aspect","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_assess_route.html","id":null,"dir":"Reference","previous_headings":"","what":"Assess route — wbt_assess_route","title":"Assess route — wbt_assess_route","text":"tool assesses route slope, elevation, visibility variation.","code":""},{"path":"/reference/wbt_assess_route.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Assess route — wbt_assess_route","text":"","code":"wbt_assess_route(   routes,   dem,   output,   length = \"\",   dist = 20,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_assess_route.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Assess route — wbt_assess_route","text":"routes Name input routes vector file. dem Name input DEM raster file. output Name output lines shapefile. length Maximum segment length (m). dist Search distance, grid cells, used visibility analysis. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_assess_route.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Assess route — wbt_assess_route","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_atan2.html","id":null,"dir":"Reference","previous_headings":"","what":"Atan2 — wbt_atan2","title":"Atan2 — wbt_atan2","text":"Returns 2-argument inverse tangent (atan2).","code":""},{"path":"/reference/wbt_atan2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Atan2 — wbt_atan2","text":"","code":"wbt_atan2(   input_y,   input_x,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_atan2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Atan2 — wbt_atan2","text":"input_y Input y raster file constant value (rise). input_x Input x raster file constant value (run). output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_atan2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Atan2 — wbt_atan2","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_attribute_correlation.html","id":null,"dir":"Reference","previous_headings":"","what":"Attribute correlation — wbt_attribute_correlation","title":"Attribute correlation — wbt_attribute_correlation","text":"Performs correlation analysis attribute fields vector database.","code":""},{"path":"/reference/wbt_attribute_correlation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attribute correlation — wbt_attribute_correlation","text":"","code":"wbt_attribute_correlation(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_attribute_correlation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attribute correlation — wbt_attribute_correlation","text":"input Input vector file path. See wbt_file_path() details. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_attribute_correlation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attribute correlation — wbt_attribute_correlation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_attribute_correlation_neighbourhood_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Attribute correlation neighbourhood analysis — wbt_attribute_correlation_neighbourhood_analysis","title":"Attribute correlation neighbourhood analysis — wbt_attribute_correlation_neighbourhood_analysis","text":"Performs correlation two input vector attributes within neighbourhood search windows.","code":""},{"path":"/reference/wbt_attribute_correlation_neighbourhood_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attribute correlation neighbourhood analysis — wbt_attribute_correlation_neighbourhood_analysis","text":"","code":"wbt_attribute_correlation_neighbourhood_analysis(   input,   field1,   field2,   radius = NULL,   min_points = NULL,   stat = \"pearson\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_attribute_correlation_neighbourhood_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attribute correlation neighbourhood analysis — wbt_attribute_correlation_neighbourhood_analysis","text":"input Input vector file path. See wbt_file_path() details. field1 First input field name (dependent variable) attribute table. field2 Second input field name (independent variable) attribute table. radius Search Radius (map units). min_points Minimum number points. stat Correlation type; one 'pearson' (default) 'spearman'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_attribute_correlation_neighbourhood_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attribute correlation neighbourhood analysis — wbt_attribute_correlation_neighbourhood_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_attribute_histogram.html","id":null,"dir":"Reference","previous_headings":"","what":"Attribute histogram — wbt_attribute_histogram","title":"Attribute histogram — wbt_attribute_histogram","text":"Creates histogram field values vector's attribute table.","code":""},{"path":"/reference/wbt_attribute_histogram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attribute histogram — wbt_attribute_histogram","text":"","code":"wbt_attribute_histogram(   input,   field,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_attribute_histogram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attribute histogram — wbt_attribute_histogram","text":"input Input vector file path. See wbt_file_path() details. field Input field name attribute table. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_attribute_histogram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attribute histogram — wbt_attribute_histogram","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_attribute_scattergram.html","id":null,"dir":"Reference","previous_headings":"","what":"Attribute scattergram — wbt_attribute_scattergram","title":"Attribute scattergram — wbt_attribute_scattergram","text":"Creates scattergram two field values vector's attribute table.","code":""},{"path":"/reference/wbt_attribute_scattergram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attribute scattergram — wbt_attribute_scattergram","text":"","code":"wbt_attribute_scattergram(   input,   fieldx,   fieldy,   output,   trendline = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_attribute_scattergram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attribute scattergram — wbt_attribute_scattergram","text":"input Input raster file path. See wbt_file_path() details. fieldx Input field name attribute table x-axis. fieldy Input field name attribute table y-axis. output Output HTML file (default name based input file unspecified). trendline Draw trendline. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_attribute_scattergram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attribute scattergram — wbt_attribute_scattergram","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_average_flowpath_slope.html","id":null,"dir":"Reference","previous_headings":"","what":"Average flowpath slope — wbt_average_flowpath_slope","title":"Average flowpath slope — wbt_average_flowpath_slope","text":"Measures average slope gradient grid cell upslope divide cells.","code":""},{"path":"/reference/wbt_average_flowpath_slope.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Average flowpath slope — wbt_average_flowpath_slope","text":"","code":"wbt_average_flowpath_slope(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_average_flowpath_slope.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Average flowpath slope — wbt_average_flowpath_slope","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_average_flowpath_slope.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Average flowpath slope — wbt_average_flowpath_slope","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_average_normal_vector_angular_deviation.html","id":null,"dir":"Reference","previous_headings":"","what":"Average normal vector angular deviation — wbt_average_normal_vector_angular_deviation","title":"Average normal vector angular deviation — wbt_average_normal_vector_angular_deviation","text":"Calculates circular variance aspect scale DEM.","code":""},{"path":"/reference/wbt_average_normal_vector_angular_deviation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Average normal vector angular deviation — wbt_average_normal_vector_angular_deviation","text":"","code":"wbt_average_normal_vector_angular_deviation(   dem,   output,   filter = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_average_normal_vector_angular_deviation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Average normal vector angular deviation — wbt_average_normal_vector_angular_deviation","text":"dem Input raster DEM file. output Output raster file. filter Size filter kernel. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_average_normal_vector_angular_deviation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Average normal vector angular deviation — wbt_average_normal_vector_angular_deviation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_average_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Average overlay — wbt_average_overlay","title":"Average overlay — wbt_average_overlay","text":"Calculates average grid cell group raster images.","code":""},{"path":"/reference/wbt_average_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Average overlay — wbt_average_overlay","text":"","code":"wbt_average_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_average_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Average overlay — wbt_average_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_average_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Average overlay — wbt_average_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_average_upslope_flowpath_length.html","id":null,"dir":"Reference","previous_headings":"","what":"Average upslope flowpath length — wbt_average_upslope_flowpath_length","title":"Average upslope flowpath length — wbt_average_upslope_flowpath_length","text":"Measures average length upslope flowpaths draining grid cell.","code":""},{"path":"/reference/wbt_average_upslope_flowpath_length.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Average upslope flowpath length — wbt_average_upslope_flowpath_length","text":"","code":"wbt_average_upslope_flowpath_length(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_average_upslope_flowpath_length.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Average upslope flowpath length — wbt_average_upslope_flowpath_length","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_average_upslope_flowpath_length.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Average upslope flowpath length — wbt_average_upslope_flowpath_length","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_balance_contrast_enhancement.html","id":null,"dir":"Reference","previous_headings":"","what":"Balance contrast enhancement — wbt_balance_contrast_enhancement","title":"Balance contrast enhancement — wbt_balance_contrast_enhancement","text":"Performs balance contrast enhancement colour-composite image multispectral data.","code":""},{"path":"/reference/wbt_balance_contrast_enhancement.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Balance contrast enhancement — wbt_balance_contrast_enhancement","text":"","code":"wbt_balance_contrast_enhancement(   input,   output,   band_mean = 100,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_balance_contrast_enhancement.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Balance contrast enhancement — wbt_balance_contrast_enhancement","text":"input Input colour composite image file. output Output raster file. band_mean Band mean value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_balance_contrast_enhancement.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Balance contrast enhancement — wbt_balance_contrast_enhancement","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_basins.html","id":null,"dir":"Reference","previous_headings":"","what":"Basins — wbt_basins","title":"Basins — wbt_basins","text":"Identifies drainage basins drain DEM edge.","code":""},{"path":"/reference/wbt_basins.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Basins — wbt_basins","text":"","code":"wbt_basins(   d8_pntr,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_basins.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Basins — wbt_basins","text":"d8_pntr Input raster D8 pointer file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_basins.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Basins — wbt_basins","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_bilateral_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Bilateral filter — wbt_bilateral_filter","title":"Bilateral filter — wbt_bilateral_filter","text":"bilateral filter edge-preserving smoothing filter introduced Tomasi Manduchi (1998).","code":""},{"path":"/reference/wbt_bilateral_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bilateral filter — wbt_bilateral_filter","text":"","code":"wbt_bilateral_filter(   input,   output,   sigma_dist = 0.75,   sigma_int = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_bilateral_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bilateral filter — wbt_bilateral_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma_dist Standard deviation distance pixels. sigma_int Standard deviation intensity pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_bilateral_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Bilateral filter — wbt_bilateral_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_block_maximum_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Block maximum gridding — wbt_block_maximum_gridding","title":"Block maximum gridding — wbt_block_maximum_gridding","text":"Creates raster grid based set vector points assigns grid values using block maximum scheme.","code":""},{"path":"/reference/wbt_block_maximum_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Block maximum gridding — wbt_block_maximum_gridding","text":"","code":"wbt_block_maximum_gridding(   input,   field,   output,   use_z = FALSE,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_block_maximum_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Block maximum gridding — wbt_block_maximum_gridding","text":"input Input vector Points file. field Input field name attribute table. output Output raster file. use_z Use z-coordinate instead field?. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_block_maximum_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Block maximum gridding — wbt_block_maximum_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_block_minimum_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Block minimum gridding — wbt_block_minimum_gridding","title":"Block minimum gridding — wbt_block_minimum_gridding","text":"Creates raster grid based set vector points assigns grid values using block minimum scheme.","code":""},{"path":"/reference/wbt_block_minimum_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Block minimum gridding — wbt_block_minimum_gridding","text":"","code":"wbt_block_minimum_gridding(   input,   field,   output,   use_z = FALSE,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_block_minimum_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Block minimum gridding — wbt_block_minimum_gridding","text":"input Input vector Points file. field Input field name attribute table. output Output raster file. use_z Use z-coordinate instead field?. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_block_minimum_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Block minimum gridding — wbt_block_minimum_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_boundary_shape_complexity.html","id":null,"dir":"Reference","previous_headings":"","what":"Boundary shape complexity — wbt_boundary_shape_complexity","title":"Boundary shape complexity — wbt_boundary_shape_complexity","text":"Calculates complexity boundaries raster polygons.","code":""},{"path":"/reference/wbt_boundary_shape_complexity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Boundary shape complexity — wbt_boundary_shape_complexity","text":"","code":"wbt_boundary_shape_complexity(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_boundary_shape_complexity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Boundary shape complexity — wbt_boundary_shape_complexity","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_boundary_shape_complexity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Boundary shape complexity — wbt_boundary_shape_complexity","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_breach_depressions.html","id":null,"dir":"Reference","previous_headings":"","what":"Breach depressions — wbt_breach_depressions","title":"Breach depressions — wbt_breach_depressions","text":"Breaches depressions DEM using Lindsay's (2016) algorithm. preferred depression filling cases.","code":""},{"path":"/reference/wbt_breach_depressions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Breach depressions — wbt_breach_depressions","text":"","code":"wbt_breach_depressions(   dem,   output,   max_depth = NULL,   max_length = NULL,   flat_increment = NULL,   fill_pits = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_breach_depressions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Breach depressions — wbt_breach_depressions","text":"dem Input raster DEM file. output Output raster file. max_depth Optional maximum breach depth (default Inf). max_length Optional maximum breach channel length (grid cells; default Inf). flat_increment Optional elevation increment applied flat areas. fill_pits Optional flag indicating whether fill single-cell pits. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_breach_depressions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Breach depressions — wbt_breach_depressions","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_breach_depressions_least_cost.html","id":null,"dir":"Reference","previous_headings":"","what":"Breach depressions least cost — wbt_breach_depressions_least_cost","title":"Breach depressions least cost — wbt_breach_depressions_least_cost","text":"Breaches depressions DEM using least-cost pathway method.","code":""},{"path":"/reference/wbt_breach_depressions_least_cost.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Breach depressions least cost — wbt_breach_depressions_least_cost","text":"","code":"wbt_breach_depressions_least_cost(   dem,   output,   dist,   max_cost = NULL,   min_dist = TRUE,   flat_increment = NULL,   fill = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_breach_depressions_least_cost.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Breach depressions least cost — wbt_breach_depressions_least_cost","text":"dem Input raster DEM file. output Output raster file. dist Maximum search distance breach paths cells. max_cost Optional maximum breach cost (default Inf). min_dist Optional flag indicating whether minimize breach distances. flat_increment Optional elevation increment applied flat areas. fill Optional flag indicating whether fill remaining unbreached depressions. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_breach_depressions_least_cost.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Breach depressions least cost — wbt_breach_depressions_least_cost","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_breach_single_cell_pits.html","id":null,"dir":"Reference","previous_headings":"","what":"Breach single cell pits — wbt_breach_single_cell_pits","title":"Breach single cell pits — wbt_breach_single_cell_pits","text":"Removes single-cell pits input DEM breaching.","code":""},{"path":"/reference/wbt_breach_single_cell_pits.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Breach single cell pits — wbt_breach_single_cell_pits","text":"","code":"wbt_breach_single_cell_pits(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_breach_single_cell_pits.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Breach single cell pits — wbt_breach_single_cell_pits","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_breach_single_cell_pits.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Breach single cell pits — wbt_breach_single_cell_pits","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_breakline_mapping.html","id":null,"dir":"Reference","previous_headings":"","what":"Breakline mapping — wbt_breakline_mapping","title":"Breakline mapping — wbt_breakline_mapping","text":"tool maps breaklines input DEM.","code":""},{"path":"/reference/wbt_breakline_mapping.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Breakline mapping — wbt_breakline_mapping","text":"","code":"wbt_breakline_mapping(   dem,   output,   threshold = 2,   min_length = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_breakline_mapping.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Breakline mapping — wbt_breakline_mapping","text":"dem Name input raster image file. output Name output vector lines file. threshold Threshold value (0 - infinity typically 1 5 works well). min_length Minimum line length, grid cells. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_breakline_mapping.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Breakline mapping — wbt_breakline_mapping","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_buffer_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Buffer raster — wbt_buffer_raster","title":"Buffer raster — wbt_buffer_raster","text":"Maps distance-based buffer around non-background (non-zero/non-nodata) grid cell input image.","code":""},{"path":"/reference/wbt_buffer_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Buffer raster — wbt_buffer_raster","text":"","code":"wbt_buffer_raster(   input,   output,   size,   gridcells = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_buffer_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Buffer raster — wbt_buffer_raster","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. size Buffer size. gridcells Optional flag indicate 'size' threshold measured grid cells instead default map units. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_buffer_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Buffer raster — wbt_buffer_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_burn_streams_at_roads.html","id":null,"dir":"Reference","previous_headings":"","what":"Burn streams at roads — wbt_burn_streams_at_roads","title":"Burn streams at roads — wbt_burn_streams_at_roads","text":"Burns-streams sites road embankments.","code":""},{"path":"/reference/wbt_burn_streams_at_roads.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Burn streams at roads — wbt_burn_streams_at_roads","text":"","code":"wbt_burn_streams_at_roads(   dem,   streams,   roads,   output,   width = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_burn_streams_at_roads.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Burn streams at roads — wbt_burn_streams_at_roads","text":"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, map units. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_burn_streams_at_roads.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Burn streams at roads — wbt_burn_streams_at_roads","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_canny_edge_detection.html","id":null,"dir":"Reference","previous_headings":"","what":"Canny edge detection — wbt_canny_edge_detection","title":"Canny edge detection — wbt_canny_edge_detection","text":"tool performs Canny edge-detection filter input image.","code":""},{"path":"/reference/wbt_canny_edge_detection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Canny edge detection — wbt_canny_edge_detection","text":"","code":"wbt_canny_edge_detection(   input,   output,   sigma = 0.5,   low = 0.05,   high = 0.15,   add_back = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_canny_edge_detection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Canny edge detection — wbt_canny_edge_detection","text":"input Name input raster image file. output Name output raster image file. sigma Sigma value used Gaussian filtering, default = 0.5. low Low threshold, default = 0.05. high High threshold, default = 0.15. add_back Add edge cells back input image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_canny_edge_detection.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Canny edge detection — wbt_canny_edge_detection","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ceil.html","id":null,"dir":"Reference","previous_headings":"","what":"Ceil — wbt_ceil","title":"Ceil — wbt_ceil","text":"Returns smallest (closest negative infinity) value greater equal values raster.","code":""},{"path":"/reference/wbt_ceil.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ceil — wbt_ceil","text":"","code":"wbt_ceil(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ceil.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ceil — wbt_ceil","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ceil.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ceil — wbt_ceil","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_centroid.html","id":null,"dir":"Reference","previous_headings":"","what":"Centroid — wbt_centroid","title":"Centroid — wbt_centroid","text":"Calculates centroid, average location, raster polygon objects.","code":""},{"path":"/reference/wbt_centroid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Centroid — wbt_centroid","text":"","code":"wbt_centroid(   input,   output,   text_output = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_centroid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Centroid — wbt_centroid","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. text_output Optional text output. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_centroid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Centroid — wbt_centroid","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_centroid_vector.html","id":null,"dir":"Reference","previous_headings":"","what":"Centroid vector — wbt_centroid_vector","title":"Centroid vector — wbt_centroid_vector","text":"Identifies centroid point vector polyline polygon feature group vector points.","code":""},{"path":"/reference/wbt_centroid_vector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Centroid vector — wbt_centroid_vector","text":"","code":"wbt_centroid_vector(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_centroid_vector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Centroid vector — wbt_centroid_vector","text":"input Input vector file path. See wbt_file_path() details. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_centroid_vector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Centroid vector — wbt_centroid_vector","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_change_vector_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Change vector analysis — wbt_change_vector_analysis","title":"Change vector analysis — wbt_change_vector_analysis","text":"Performs change vector analysis two-date multi-spectral dataset.","code":""},{"path":"/reference/wbt_change_vector_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Change vector analysis — wbt_change_vector_analysis","text":"","code":"wbt_change_vector_analysis(   date1,   date2,   magnitude,   direction,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_change_vector_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Change vector analysis — wbt_change_vector_analysis","text":"date1 Input raster files earlier date. date2 Input raster files later date. magnitude Output vector magnitude raster file. direction Output vector Direction raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_change_vector_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Change vector analysis — wbt_change_vector_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_circular_variance_of_aspect.html","id":null,"dir":"Reference","previous_headings":"","what":"Circular variance of aspect — wbt_circular_variance_of_aspect","title":"Circular variance of aspect — wbt_circular_variance_of_aspect","text":"Calculates circular variance aspect scale DEM.","code":""},{"path":"/reference/wbt_circular_variance_of_aspect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Circular variance of aspect — wbt_circular_variance_of_aspect","text":"","code":"wbt_circular_variance_of_aspect(   dem,   output,   filter = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_circular_variance_of_aspect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Circular variance of aspect — wbt_circular_variance_of_aspect","text":"dem Input raster DEM file. output Output raster file. filter Size filter kernel. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_circular_variance_of_aspect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Circular variance of aspect — wbt_circular_variance_of_aspect","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_classify_buildings_in_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Classify buildings in lidar — wbt_classify_buildings_in_lidar","title":"Classify buildings in lidar — wbt_classify_buildings_in_lidar","text":"Reclassifies LiDAR points lie within vector building footprints.","code":""},{"path":"/reference/wbt_classify_buildings_in_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Classify buildings in lidar — wbt_classify_buildings_in_lidar","text":"","code":"wbt_classify_buildings_in_lidar(   input,   buildings,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_classify_buildings_in_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Classify buildings in lidar — wbt_classify_buildings_in_lidar","text":"input Input LiDAR file. buildings Input vector polygons file. output Output LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_classify_buildings_in_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Classify buildings in lidar — wbt_classify_buildings_in_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_classify_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Classify lidar — wbt_classify_lidar","title":"Classify lidar — wbt_classify_lidar","text":"Classify points within LiDAR point cloud based point properties.","code":""},{"path":"/reference/wbt_classify_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Classify lidar — wbt_classify_lidar","text":"","code":"wbt_classify_lidar(   input,   output = NULL,   radius = 1.5,   grd_threshold = 0.1,   oto_threshold = 2,   planarity_threshold = 0.85,   linearity_threshold = 0.7,   iterations = 30,   facade_threshold = 0.5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_classify_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Classify lidar — wbt_classify_lidar","text":"input Name input LiDAR points. output Name output LiDAR points. radius Search distance used neighbourhood search (metres). grd_threshold Ground threshold (metres). oto_threshold -terrain object threshold (metres). planarity_threshold Planarity threshold (0-1). linearity_threshold Linearity threshold (0-1). iterations Number iterations. facade_threshold Facade threshold (metres). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_classify_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Classify lidar — wbt_classify_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_classify_overlap_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Classify overlap points — wbt_classify_overlap_points","title":"Classify overlap points — wbt_classify_overlap_points","text":"Classifies filters LAS points regions overlapping flight lines.","code":""},{"path":"/reference/wbt_classify_overlap_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Classify overlap points — wbt_classify_overlap_points","text":"","code":"wbt_classify_overlap_points(   input,   output,   resolution = 2,   criterion = \"max scan angle\",   filter = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_classify_overlap_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Classify overlap points — wbt_classify_overlap_points","text":"input Input LiDAR file. output Output LiDAR file. resolution size square area used evaluate nearby points LiDAR data. criterion Criterion used identify overlapping points; options 'max scan angle', 'min point source ID', 'min time', 'multiple point source IDs'. filter Filter points overlapping flightlines? false, overlaps simply classified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_classify_overlap_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Classify overlap points — wbt_classify_overlap_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_clean_vector.html","id":null,"dir":"Reference","previous_headings":"","what":"Clean vector — wbt_clean_vector","title":"Clean vector — wbt_clean_vector","text":"Removes null features lines/polygons fewer required number vertices.","code":""},{"path":"/reference/wbt_clean_vector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clean vector — wbt_clean_vector","text":"","code":"wbt_clean_vector(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_clean_vector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clean vector — wbt_clean_vector","text":"input Input vector file path. See wbt_file_path() details. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_clean_vector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clean vector — wbt_clean_vector","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_clip.html","id":null,"dir":"Reference","previous_headings":"","what":"Clip — wbt_clip","title":"Clip — wbt_clip","text":"Extract features, parts features, overlap features clip vector.","code":""},{"path":"/reference/wbt_clip.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clip — wbt_clip","text":"","code":"wbt_clip(   input,   clip,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_clip.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clip — wbt_clip","text":"input Input vector file path. See wbt_file_path() details. clip Input clip polygon vector file. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_clip.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clip — wbt_clip","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_clip_lidar_to_polygon.html","id":null,"dir":"Reference","previous_headings":"","what":"Clip lidar to polygon — wbt_clip_lidar_to_polygon","title":"Clip lidar to polygon — wbt_clip_lidar_to_polygon","text":"Clips LiDAR point cloud vector polygon polygons.","code":""},{"path":"/reference/wbt_clip_lidar_to_polygon.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clip lidar to polygon — wbt_clip_lidar_to_polygon","text":"","code":"wbt_clip_lidar_to_polygon(   input,   polygons,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_clip_lidar_to_polygon.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clip lidar to polygon — wbt_clip_lidar_to_polygon","text":"input Input LiDAR file. polygons Input vector polygons file. output Output LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_clip_lidar_to_polygon.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clip lidar to polygon — wbt_clip_lidar_to_polygon","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_clip_raster_to_polygon.html","id":null,"dir":"Reference","previous_headings":"","what":"Clip raster to polygon — wbt_clip_raster_to_polygon","title":"Clip raster to polygon — wbt_clip_raster_to_polygon","text":"Clips raster vector polygon.","code":""},{"path":"/reference/wbt_clip_raster_to_polygon.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clip raster to polygon — wbt_clip_raster_to_polygon","text":"","code":"wbt_clip_raster_to_polygon(   input,   polygons,   output,   maintain_dimensions = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_clip_raster_to_polygon.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clip raster to polygon — wbt_clip_raster_to_polygon","text":"input Input raster file path. See wbt_file_path() details. polygons Input vector polygons file. output Output raster file. maintain_dimensions Maintain input raster dimensions?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_clip_raster_to_polygon.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clip raster to polygon — wbt_clip_raster_to_polygon","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_closing.html","id":null,"dir":"Reference","previous_headings":"","what":"Closing — wbt_closing","title":"Closing — wbt_closing","text":"closing mathematical morphology operation involving erosion (min filter) dilation (max filter) set.","code":""},{"path":"/reference/wbt_closing.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Closing — wbt_closing","text":"","code":"wbt_closing(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_closing.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Closing — wbt_closing","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_closing.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Closing — wbt_closing","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_clump.html","id":null,"dir":"Reference","previous_headings":"","what":"Clump — wbt_clump","title":"Clump — wbt_clump","text":"Groups cells form discrete areas, assigning unique identifiers.","code":""},{"path":"/reference/wbt_clump.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clump — wbt_clump","text":"","code":"wbt_clump(   input,   output,   diag = TRUE,   zero_back = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_clump.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clump — wbt_clump","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. diag Flag indicating whether diagonal connections considered. zero_back Flag indicating whether zero values treated background. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_clump.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clump — wbt_clump","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_colourize_based_on_class.html","id":null,"dir":"Reference","previous_headings":"","what":"Colourize based on class — wbt_colourize_based_on_class","title":"Colourize based on class — wbt_colourize_based_on_class","text":"Sets RGB values LiDAR point cloud based point classification values.","code":""},{"path":"/reference/wbt_colourize_based_on_class.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Colourize based on class — wbt_colourize_based_on_class","text":"","code":"wbt_colourize_based_on_class(   input,   output = NULL,   intensity_blending = 50,   clr_str = \"\",   use_unique_clrs_for_buildings = FALSE,   radius = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_colourize_based_on_class.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Colourize based on class — wbt_colourize_based_on_class","text":"input Name input LiDAR points. output Name output LiDAR points. intensity_blending Intensity blending amount (0-100 percent). clr_str Colour values, e.g. 2: (184, 167, 108); 5: #9ab86c. use_unique_clrs_for_buildings Use unique colours building?. radius Search distance used neighbourhood search. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_colourize_based_on_class.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Colourize based on class — wbt_colourize_based_on_class","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_colourize_based_on_point_returns.html","id":null,"dir":"Reference","previous_headings":"","what":"Colourize based on point returns — wbt_colourize_based_on_point_returns","title":"Colourize based on point returns — wbt_colourize_based_on_point_returns","text":"Sets RGB values LiDAR point cloud based point returns.","code":""},{"path":"/reference/wbt_colourize_based_on_point_returns.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Colourize based on point returns — wbt_colourize_based_on_point_returns","text":"","code":"wbt_colourize_based_on_point_returns(   input,   output = NULL,   intensity_blending = 50,   only = \"(230,214,170)\",   first = \"(0,140,0)\",   intermediate = \"(255,0,255)\",   last = \"(0,0,255)\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_colourize_based_on_point_returns.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Colourize based on point returns — wbt_colourize_based_on_point_returns","text":"input Name input LiDAR points. output Name output LiDAR points. intensity_blending Intensity blending amount (0-100 percent). return colour, e.g. (230,214,170), #e6d6aa, 0xe6d6aa. first First return colour, e.g. (230,214,170), #e6d6aa, 0xe6d6aa. intermediate Intermediate return colour, e.g. (230,214,170), #e6d6aa, 0xe6d6aa. last Last return colour, e.g. (230,214,170), #e6d6aa, 0xe6d6aa. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_colourize_based_on_point_returns.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Colourize based on point returns — wbt_colourize_based_on_point_returns","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_compactness_ratio.html","id":null,"dir":"Reference","previous_headings":"","what":"Compactness ratio — wbt_compactness_ratio","title":"Compactness ratio — wbt_compactness_ratio","text":"Calculates compactness ratio (/P), measure shape complexity, vector polygons.","code":""},{"path":"/reference/wbt_compactness_ratio.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compactness ratio — wbt_compactness_ratio","text":"","code":"wbt_compactness_ratio(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_compactness_ratio.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compactness ratio — wbt_compactness_ratio","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_compactness_ratio.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compactness ratio — wbt_compactness_ratio","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_conditional_evaluation.html","id":null,"dir":"Reference","previous_headings":"","what":"Conditional evaluation — wbt_conditional_evaluation","title":"Conditional evaluation — wbt_conditional_evaluation","text":"Performs conditional evaluation (--else) operation raster.","code":""},{"path":"/reference/wbt_conditional_evaluation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Conditional evaluation — wbt_conditional_evaluation","text":"","code":"wbt_conditional_evaluation(   input,   output,   statement = \"\",   true = NULL,   false = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_conditional_evaluation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Conditional evaluation — wbt_conditional_evaluation","text":"input Name input raster file. output Name output raster file. statement Conditional statement e.g. value > 35.0. statement must valid Rust statement. true Value condition evaluates TRUE (input raster constant value). false Value condition evaluates FALSE (input raster constant value). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_conditional_evaluation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Conditional evaluation — wbt_conditional_evaluation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_conditioned_latin_hypercube.html","id":null,"dir":"Reference","previous_headings":"","what":"Conditioned latin hypercube — wbt_conditioned_latin_hypercube","title":"Conditioned latin hypercube — wbt_conditioned_latin_hypercube","text":"Implements conditioned Latin Hypercube sampling.","code":""},{"path":"/reference/wbt_conditioned_latin_hypercube.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Conditioned latin hypercube — wbt_conditioned_latin_hypercube","text":"","code":"wbt_conditioned_latin_hypercube(   inputs,   output,   samples = 500,   iterations = 25000,   seed = NULL,   prob = 0.5,   threshold = NULL,   temp = 1,   temp_decay = 0.05,   cycle = 10,   average = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_conditioned_latin_hypercube.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Conditioned latin hypercube — wbt_conditioned_latin_hypercube","text":"inputs Name input raster file. output Output shapefile. samples Number sample sites returned. iterations Maximum iterations (stopping criteria reached). seed Seed RNG consistency. prob Probability random resample resampling worst strata [0,1]. threshold Objective function values threshold stop resampling iterations. temp Initial annealing temperature [0,1]. temp_decay Annealing temperature decay proportion [0,1]. Reduce temperature proportion annealing cycle. cycle Number iterations decaying annealing temperature. average Weight continuous objective function 1/N contributing strata. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_conditioned_latin_hypercube.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Conditioned latin hypercube — wbt_conditioned_latin_hypercube","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_conservative_smoothing_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Conservative smoothing filter — wbt_conservative_smoothing_filter","title":"Conservative smoothing filter — wbt_conservative_smoothing_filter","text":"Performs conservative-smoothing filter image.","code":""},{"path":"/reference/wbt_conservative_smoothing_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Conservative smoothing filter — wbt_conservative_smoothing_filter","text":"","code":"wbt_conservative_smoothing_filter(   input,   output,   filterx = 3,   filtery = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_conservative_smoothing_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Conservative smoothing filter — wbt_conservative_smoothing_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_conservative_smoothing_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Conservative smoothing filter — wbt_conservative_smoothing_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_construct_vector_tin.html","id":null,"dir":"Reference","previous_headings":"","what":"Construct vector tin — wbt_construct_vector_tin","title":"Construct vector tin — wbt_construct_vector_tin","text":"Creates vector triangular irregular network (TIN) set vector points.","code":""},{"path":"/reference/wbt_construct_vector_tin.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Construct vector tin — wbt_construct_vector_tin","text":"","code":"wbt_construct_vector_tin(   input,   output,   field = NULL,   use_z = FALSE,   max_triangle_edge_length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_construct_vector_tin.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Construct vector tin — wbt_construct_vector_tin","text":"input Input vector points file. output Output vector polygon file. field Input field name attribute table. use_z Use 'z' dimension Shapefile's geometry instead attribute field?. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_construct_vector_tin.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Construct vector tin — wbt_construct_vector_tin","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_contours_from_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Contours from points — wbt_contours_from_points","title":"Contours from points — wbt_contours_from_points","text":"Creates contour coverage set input points.","code":""},{"path":"/reference/wbt_contours_from_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Contours from points — wbt_contours_from_points","text":"","code":"wbt_contours_from_points(   input,   output,   field = NULL,   use_z = FALSE,   max_triangle_edge_length = NULL,   interval = 10,   base = 0,   smooth = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_contours_from_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Contours from points — wbt_contours_from_points","text":"input Input vector points file. output Output vector lines file. field Input field name attribute table. use_z Use 'z' dimension Shapefile's geometry instead attribute field?. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. interval Contour interval. base Base contour height. smooth Smoothing filter size (num. points), e.g. 3, 5, 7, 9, 11. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_contours_from_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Contours from points — wbt_contours_from_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_contours_from_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Contours from raster — wbt_contours_from_raster","title":"Contours from raster — wbt_contours_from_raster","text":"Derives vector contour coverage raster surface.","code":""},{"path":"/reference/wbt_contours_from_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Contours from raster — wbt_contours_from_raster","text":"","code":"wbt_contours_from_raster(   input,   output,   interval = 10,   base = 0,   smooth = 9,   tolerance = 10,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_contours_from_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Contours from raster — wbt_contours_from_raster","text":"input Input surface raster file. output Output vector contour file. interval Contour interval. base Base contour height. smooth Smoothing filter size (num. points), e.g. 3, 5, 7, 9, 11. tolerance Tolerance factor, degrees (0-45); determines generalization level. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_contours_from_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Contours from raster — wbt_contours_from_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_convert_nodata_to_zero.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert nodata to zero — wbt_convert_nodata_to_zero","title":"Convert nodata to zero — wbt_convert_nodata_to_zero","text":"Converts nodata values raster zero.","code":""},{"path":"/reference/wbt_convert_nodata_to_zero.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert nodata to zero — wbt_convert_nodata_to_zero","text":"","code":"wbt_convert_nodata_to_zero(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_convert_nodata_to_zero.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert nodata to zero — wbt_convert_nodata_to_zero","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_convert_nodata_to_zero.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert nodata to zero — wbt_convert_nodata_to_zero","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_convert_raster_format.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert raster format — wbt_convert_raster_format","title":"Convert raster format — wbt_convert_raster_format","text":"Converts raster data one format another.","code":""},{"path":"/reference/wbt_convert_raster_format.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert raster format — wbt_convert_raster_format","text":"","code":"wbt_convert_raster_format(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_convert_raster_format.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert raster format — wbt_convert_raster_format","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_convert_raster_format.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert raster format — wbt_convert_raster_format","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_corner_detection.html","id":null,"dir":"Reference","previous_headings":"","what":"Corner detection — wbt_corner_detection","title":"Corner detection — wbt_corner_detection","text":"Identifies corner patterns boolean images using hit--miss pattern matching.","code":""},{"path":"/reference/wbt_corner_detection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Corner detection — wbt_corner_detection","text":"","code":"wbt_corner_detection(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_corner_detection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Corner detection — wbt_corner_detection","text":"input Input boolean image. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_corner_detection.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Corner detection — wbt_corner_detection","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_correct_vignetting.html","id":null,"dir":"Reference","previous_headings":"","what":"Correct vignetting — wbt_correct_vignetting","title":"Correct vignetting — wbt_correct_vignetting","text":"Corrects darkening images towards corners.","code":""},{"path":"/reference/wbt_correct_vignetting.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Correct vignetting — wbt_correct_vignetting","text":"","code":"wbt_correct_vignetting(   input,   pp,   output,   focal_length = 304.8,   image_width = 228.6,   n = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_correct_vignetting.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Correct vignetting — wbt_correct_vignetting","text":"input Input raster file path. See wbt_file_path() details. pp Input principal point file. output Output raster file. focal_length Camera focal length, millimeters. image_width Distance photograph edges, millimeters. n 'n' parameter. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_correct_vignetting.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Correct vignetting — wbt_correct_vignetting","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cos.html","id":null,"dir":"Reference","previous_headings":"","what":"Cos — wbt_cos","title":"Cos — wbt_cos","text":"Returns cosine (cos) values raster.","code":""},{"path":"/reference/wbt_cos.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cos — wbt_cos","text":"","code":"wbt_cos(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cos.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cos — wbt_cos","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cos.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cos — wbt_cos","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cosh.html","id":null,"dir":"Reference","previous_headings":"","what":"Cosh — wbt_cosh","title":"Cosh — wbt_cosh","text":"Returns hyperbolic cosine (cosh) values raster.","code":""},{"path":"/reference/wbt_cosh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cosh — wbt_cosh","text":"","code":"wbt_cosh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cosh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cosh — wbt_cosh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cosh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cosh — wbt_cosh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cost_allocation.html","id":null,"dir":"Reference","previous_headings":"","what":"Cost allocation — wbt_cost_allocation","title":"Cost allocation — wbt_cost_allocation","text":"Identifies source cell grid cell connected least-cost pathway cost-distance analysis.","code":""},{"path":"/reference/wbt_cost_allocation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cost allocation — wbt_cost_allocation","text":"","code":"wbt_cost_allocation(   source,   backlink,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cost_allocation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cost allocation — wbt_cost_allocation","text":"source Input source raster file. backlink Input backlink raster file generated cost-distance tool. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cost_allocation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cost allocation — wbt_cost_allocation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cost_distance.html","id":null,"dir":"Reference","previous_headings":"","what":"Cost distance — wbt_cost_distance","title":"Cost distance — wbt_cost_distance","text":"Performs cost-distance accumulation cost surface group source cells.","code":""},{"path":"/reference/wbt_cost_distance.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cost distance — wbt_cost_distance","text":"","code":"wbt_cost_distance(   source,   cost,   out_accum,   out_backlink,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cost_distance.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cost distance — wbt_cost_distance","text":"source Input source raster file. cost Input cost (friction) raster file. out_accum Output cost accumulation raster file. out_backlink Output backlink raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cost_distance.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cost distance — wbt_cost_distance","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cost_pathway.html","id":null,"dir":"Reference","previous_headings":"","what":"Cost pathway — wbt_cost_pathway","title":"Cost pathway — wbt_cost_pathway","text":"Performs cost-distance pathway analysis using series destination grid cells.","code":""},{"path":"/reference/wbt_cost_pathway.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cost pathway — wbt_cost_pathway","text":"","code":"wbt_cost_pathway(   destination,   backlink,   output,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cost_pathway.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cost pathway — wbt_cost_pathway","text":"destination Input destination raster file. backlink Input backlink raster file generated cost-distance tool. output Output cost pathway raster file. zero_background Flag indicating whether zero values treated background. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cost_pathway.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cost pathway — wbt_cost_pathway","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_count_if.html","id":null,"dir":"Reference","previous_headings":"","what":"Count if — wbt_count_if","title":"Count if — wbt_count_if","text":"Counts number occurrences specified value cell-stack rasters.","code":""},{"path":"/reference/wbt_count_if.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Count if — wbt_count_if","text":"","code":"wbt_count_if(   inputs,   output,   value,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_count_if.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Count if — wbt_count_if","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. value Search value (e.g. countif value = 5.0). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_count_if.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Count if — wbt_count_if","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_create_colour_composite.html","id":null,"dir":"Reference","previous_headings":"","what":"Create colour composite — wbt_create_colour_composite","title":"Create colour composite — wbt_create_colour_composite","text":"Creates colour-composite image three bands multispectral imagery.","code":""},{"path":"/reference/wbt_create_colour_composite.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create colour composite — wbt_create_colour_composite","text":"","code":"wbt_create_colour_composite(   red,   green,   blue,   output,   opacity = NULL,   enhance = TRUE,   zeros = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_create_colour_composite.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create colour composite — wbt_create_colour_composite","text":"red Input red band image file. green Input green band image file. blue Input blue band image file. output Output colour composite file. opacity Input opacity band image file (optional). enhance Optional flag indicating whether balance contrast enhancement performed. zeros Optional flag indicate zeros nodata values. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_create_colour_composite.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create colour composite — wbt_create_colour_composite","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_create_hexagonal_vector_grid.html","id":null,"dir":"Reference","previous_headings":"","what":"Create hexagonal vector grid — wbt_create_hexagonal_vector_grid","title":"Create hexagonal vector grid — wbt_create_hexagonal_vector_grid","text":"Creates hexagonal vector grid.","code":""},{"path":"/reference/wbt_create_hexagonal_vector_grid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create hexagonal vector grid — wbt_create_hexagonal_vector_grid","text":"","code":"wbt_create_hexagonal_vector_grid(   input,   output,   width,   orientation = \"horizontal\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_create_hexagonal_vector_grid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create hexagonal vector grid — wbt_create_hexagonal_vector_grid","text":"input Input base file. output Output vector polygon file. width grid cell width. orientation Grid Orientation, 'horizontal' 'vertical'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_create_hexagonal_vector_grid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create hexagonal vector grid — wbt_create_hexagonal_vector_grid","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_create_plane.html","id":null,"dir":"Reference","previous_headings":"","what":"Create plane — wbt_create_plane","title":"Create plane — wbt_create_plane","text":"Creates raster image based equation simple plane.","code":""},{"path":"/reference/wbt_create_plane.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create plane — wbt_create_plane","text":"","code":"wbt_create_plane(   base,   output,   gradient = 15,   aspect = 90,   constant = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_create_plane.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create plane — wbt_create_plane","text":"base Input base raster file. output Output raster file. gradient Slope gradient degrees (-85.0 85.0). aspect Aspect (direction) degrees clockwise north (0.0-360.0). constant Constant value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_create_plane.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create plane — wbt_create_plane","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_create_rectangular_vector_grid.html","id":null,"dir":"Reference","previous_headings":"","what":"Create rectangular vector grid — wbt_create_rectangular_vector_grid","title":"Create rectangular vector grid — wbt_create_rectangular_vector_grid","text":"Creates rectangular vector grid.","code":""},{"path":"/reference/wbt_create_rectangular_vector_grid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create rectangular vector grid — wbt_create_rectangular_vector_grid","text":"","code":"wbt_create_rectangular_vector_grid(   input,   output,   width,   height,   xorig = 0,   yorig = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_create_rectangular_vector_grid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create rectangular vector grid — wbt_create_rectangular_vector_grid","text":"input Input base file. output Output vector polygon file. width grid cell width. height grid cell height. xorig grid origin x-coordinate. yorig grid origin y-coordinate. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_create_rectangular_vector_grid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create rectangular vector grid — wbt_create_rectangular_vector_grid","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_crispness_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Crispness index — wbt_crispness_index","title":"Crispness index — wbt_crispness_index","text":"Calculates Crispness Index, used quantify crisp (conversely fuzzy) probability image .","code":""},{"path":"/reference/wbt_crispness_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Crispness index — wbt_crispness_index","text":"","code":"wbt_crispness_index(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_crispness_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Crispness index — wbt_crispness_index","text":"input Input raster file path. See wbt_file_path() details. output Optional output html file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_crispness_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Crispness index — wbt_crispness_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cross_tabulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Cross tabulation — wbt_cross_tabulation","title":"Cross tabulation — wbt_cross_tabulation","text":"Performs cross-tabulation two categorical images.","code":""},{"path":"/reference/wbt_cross_tabulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cross tabulation — wbt_cross_tabulation","text":"","code":"wbt_cross_tabulation(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cross_tabulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cross tabulation — wbt_cross_tabulation","text":"input1 Input raster file 1. input2 Input raster file 1. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cross_tabulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cross tabulation — wbt_cross_tabulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_csv_points_to_vector.html","id":null,"dir":"Reference","previous_headings":"","what":"Csv points to vector — wbt_csv_points_to_vector","title":"Csv points to vector — wbt_csv_points_to_vector","text":"Converts CSV text file vector points.","code":""},{"path":"/reference/wbt_csv_points_to_vector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Csv points to vector — wbt_csv_points_to_vector","text":"","code":"wbt_csv_points_to_vector(   input,   output,   xfield = 0,   yfield = 1,   epsg = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_csv_points_to_vector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Csv points to vector — wbt_csv_points_to_vector","text":"input Input CSV file (.e. source data imported). output Output vector file. xfield X field number (e.g. 0 first field). yfield Y field number (e.g. 1 second field). epsg EPSG projection (e.g. 2958). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_csv_points_to_vector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Csv points to vector — wbt_csv_points_to_vector","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cumulative_distribution.html","id":null,"dir":"Reference","previous_headings":"","what":"Cumulative distribution — wbt_cumulative_distribution","title":"Cumulative distribution — wbt_cumulative_distribution","text":"Converts raster image cumulative distribution function.","code":""},{"path":"/reference/wbt_cumulative_distribution.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cumulative distribution — wbt_cumulative_distribution","text":"","code":"wbt_cumulative_distribution(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cumulative_distribution.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cumulative distribution — wbt_cumulative_distribution","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cumulative_distribution.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cumulative distribution — wbt_cumulative_distribution","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_curvedness.html","id":null,"dir":"Reference","previous_headings":"","what":"Curvedness — wbt_curvedness","title":"Curvedness — wbt_curvedness","text":"tool calculates curvedness input DEM.","code":""},{"path":"/reference/wbt_curvedness.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Curvedness — wbt_curvedness","text":"","code":"wbt_curvedness(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_curvedness.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Curvedness — wbt_curvedness","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_curvedness.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Curvedness — wbt_curvedness","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d8_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"D8 flow accumulation — wbt_d8_flow_accumulation","title":"D8 flow accumulation — wbt_d8_flow_accumulation","text":"Calculates D8 flow accumulation raster input DEM flow pointer.","code":""},{"path":"/reference/wbt_d8_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D8 flow accumulation — wbt_d8_flow_accumulation","text":"","code":"wbt_d8_flow_accumulation(   input,   output,   out_type = \"cells\",   log = FALSE,   clip = FALSE,   pntr = FALSE,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d8_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D8 flow accumulation — wbt_d8_flow_accumulation","text":"input Input raster DEM D8 pointer file. output Output raster file. out_type Output type; one 'cells' (default), 'catchment area', 'specific contributing area'. log Optional flag request output log-transformed. clip Optional flag request clipping display max 1 percent. pntr input raster D8 flow pointer rather DEM?. esri_pntr Input D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d8_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D8 flow accumulation — wbt_d8_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d8_mass_flux.html","id":null,"dir":"Reference","previous_headings":"","what":"D8 mass flux — wbt_d8_mass_flux","title":"D8 mass flux — wbt_d8_mass_flux","text":"Performs D8 mass flux calculation.","code":""},{"path":"/reference/wbt_d8_mass_flux.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D8 mass flux — wbt_d8_mass_flux","text":"","code":"wbt_d8_mass_flux(   dem,   loading,   efficiency,   absorption,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d8_mass_flux.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D8 mass flux — wbt_d8_mass_flux","text":"dem Input raster DEM file. loading Input loading raster file. efficiency Input efficiency raster file. absorption Input absorption raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d8_mass_flux.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D8 mass flux — wbt_d8_mass_flux","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d8_pointer.html","id":null,"dir":"Reference","previous_headings":"","what":"D8 pointer — wbt_d8_pointer","title":"D8 pointer — wbt_d8_pointer","text":"Calculates D8 flow pointer raster input DEM.","code":""},{"path":"/reference/wbt_d8_pointer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D8 pointer — wbt_d8_pointer","text":"","code":"wbt_d8_pointer(   dem,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d8_pointer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D8 pointer — wbt_d8_pointer","text":"dem Input raster DEM file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d8_pointer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D8 pointer — wbt_d8_pointer","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d_inf_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"D inf flow accumulation — wbt_d_inf_flow_accumulation","title":"D inf flow accumulation — wbt_d_inf_flow_accumulation","text":"Calculates D-infinity flow accumulation raster input DEM.","code":""},{"path":"/reference/wbt_d_inf_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D inf flow accumulation — wbt_d_inf_flow_accumulation","text":"","code":"wbt_d_inf_flow_accumulation(   input,   output,   out_type = \"Specific Contributing Area\",   threshold = NULL,   log = FALSE,   clip = FALSE,   pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d_inf_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D inf flow accumulation — wbt_d_inf_flow_accumulation","text":"input Input raster DEM D-infinity pointer file. output Output raster file. out_type Output type; one 'cells', 'sca' (default), 'ca'. threshold Optional convergence threshold parameter, grid cells; default infinity. log Optional flag request output log-transformed. clip Optional flag request clipping display max 1 percent. pntr input raster D-infinity flow pointer rather DEM?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d_inf_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D inf flow accumulation — wbt_d_inf_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d_inf_mass_flux.html","id":null,"dir":"Reference","previous_headings":"","what":"D inf mass flux — wbt_d_inf_mass_flux","title":"D inf mass flux — wbt_d_inf_mass_flux","text":"Performs D-infinity mass flux calculation.","code":""},{"path":"/reference/wbt_d_inf_mass_flux.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D inf mass flux — wbt_d_inf_mass_flux","text":"","code":"wbt_d_inf_mass_flux(   dem,   loading,   efficiency,   absorption,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d_inf_mass_flux.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D inf mass flux — wbt_d_inf_mass_flux","text":"dem Input raster DEM file. loading Input loading raster file. efficiency Input efficiency raster file. absorption Input absorption raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d_inf_mass_flux.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D inf mass flux — wbt_d_inf_mass_flux","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d_inf_pointer.html","id":null,"dir":"Reference","previous_headings":"","what":"D inf pointer — wbt_d_inf_pointer","title":"D inf pointer — wbt_d_inf_pointer","text":"Calculates D-infinity flow pointer (flow direction) raster input DEM.","code":""},{"path":"/reference/wbt_d_inf_pointer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D inf pointer — wbt_d_inf_pointer","text":"","code":"wbt_d_inf_pointer(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d_inf_pointer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D inf pointer — wbt_d_inf_pointer","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d_inf_pointer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D inf pointer — wbt_d_inf_pointer","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_dbscan.html","id":null,"dir":"Reference","previous_headings":"","what":"Dbscan — wbt_dbscan","title":"Dbscan — wbt_dbscan","text":"Performs DBSCAN-based unsupervised clustering operation.","code":""},{"path":"/reference/wbt_dbscan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dbscan — wbt_dbscan","text":"","code":"wbt_dbscan(   inputs,   output,   scaling = \"Normalize\",   search_dist = 0.01,   min_points = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_dbscan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Dbscan — wbt_dbscan","text":"inputs Names input rasters. output Name output raster file. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. search_dist Search-distance parameter. min_points Minimum point density needed define 'core' point cluster. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_dbscan.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Dbscan — wbt_dbscan","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_decrement.html","id":null,"dir":"Reference","previous_headings":"","what":"Decrement — wbt_decrement","title":"Decrement — wbt_decrement","text":"Decreases values grid cell input raster 1.0 (see also InPlaceSubtract).","code":""},{"path":"/reference/wbt_decrement.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Decrement — wbt_decrement","text":"","code":"wbt_decrement(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_decrement.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Decrement — wbt_decrement","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_decrement.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Decrement — wbt_decrement","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_dem_void_filling.html","id":null,"dir":"Reference","previous_headings":"","what":"Dem void filling — wbt_dem_void_filling","title":"Dem void filling — wbt_dem_void_filling","text":"tool can used fill void areas DEM using another fill DEM data set.","code":""},{"path":"/reference/wbt_dem_void_filling.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dem void filling — wbt_dem_void_filling","text":"","code":"wbt_dem_void_filling(   dem,   fill,   output,   mean_plane_dist = 20,   edge_treatment = \"use DEM\",   weight_value = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_dem_void_filling.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Dem void filling — wbt_dem_void_filling","text":"dem Name input raster DEM file, containing void areas. fill Name input fill DEM file, containing values used fill void areas DEM. output Name output void-filled DEM file. mean_plane_dist Distance void edge mean-plane value used offset, measured grid cells. edge_treatment void-edge cells treated? Options include 'use DEM' (default), 'use Fill', 'average'. weight_value Weight value used IDW interpolation (default 2.0). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_dem_void_filling.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Dem void filling — wbt_dem_void_filling","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_depth_in_sink.html","id":null,"dir":"Reference","previous_headings":"","what":"Depth in sink — wbt_depth_in_sink","title":"Depth in sink — wbt_depth_in_sink","text":"Measures depth sinks (depressions) DEM.","code":""},{"path":"/reference/wbt_depth_in_sink.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Depth in sink — wbt_depth_in_sink","text":"","code":"wbt_depth_in_sink(   dem,   output,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_depth_in_sink.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Depth in sink — wbt_depth_in_sink","text":"dem Input raster DEM file. output Output raster file. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_depth_in_sink.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Depth in sink — wbt_depth_in_sink","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_depth_to_water.html","id":null,"dir":"Reference","previous_headings":"","what":"Depth to water — wbt_depth_to_water","title":"Depth to water — wbt_depth_to_water","text":"tool calculates cartographic depth--water (DTW) index.","code":""},{"path":"/reference/wbt_depth_to_water.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Depth to water — wbt_depth_to_water","text":"","code":"wbt_depth_to_water(   dem,   output,   streams = NULL,   lakes = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_depth_to_water.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Depth to water — wbt_depth_to_water","text":"dem Name input raster DEM file. output Name output raster image file. streams Name input streams vector (optional). lakes Name input lakes vector (optional). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_depth_to_water.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Depth to water — wbt_depth_to_water","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_dev_from_mean_elev.html","id":null,"dir":"Reference","previous_headings":"","what":"Dev from mean elev — wbt_dev_from_mean_elev","title":"Dev from mean elev — wbt_dev_from_mean_elev","text":"Calculates deviation mean elevation.","code":""},{"path":"/reference/wbt_dev_from_mean_elev.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dev from mean elev — wbt_dev_from_mean_elev","text":"","code":"wbt_dev_from_mean_elev(   dem,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_dev_from_mean_elev.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Dev from mean elev — wbt_dev_from_mean_elev","text":"dem Input raster DEM file. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_dev_from_mean_elev.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Dev from mean elev — wbt_dev_from_mean_elev","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_diff_from_mean_elev.html","id":null,"dir":"Reference","previous_headings":"","what":"Diff from mean elev — wbt_diff_from_mean_elev","title":"Diff from mean elev — wbt_diff_from_mean_elev","text":"Calculates difference mean elevation (equivalent high-pass filter).","code":""},{"path":"/reference/wbt_diff_from_mean_elev.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Diff from mean elev — wbt_diff_from_mean_elev","text":"","code":"wbt_diff_from_mean_elev(   dem,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_diff_from_mean_elev.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Diff from mean elev — wbt_diff_from_mean_elev","text":"dem Input raster DEM file. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_diff_from_mean_elev.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Diff from mean elev — wbt_diff_from_mean_elev","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_diff_of_gaussian_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Diff of gaussian filter — wbt_diff_of_gaussian_filter","title":"Diff of gaussian filter — wbt_diff_of_gaussian_filter","text":"Performs Difference Gaussian (DoG) filter image.","code":""},{"path":"/reference/wbt_diff_of_gaussian_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Diff of gaussian filter — wbt_diff_of_gaussian_filter","text":"","code":"wbt_diff_of_gaussian_filter(   input,   output,   sigma1 = 2,   sigma2 = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_diff_of_gaussian_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Diff of gaussian filter — wbt_diff_of_gaussian_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma1 Standard deviation distance pixels. sigma2 Standard deviation distance pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_diff_of_gaussian_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Diff of gaussian filter — wbt_diff_of_gaussian_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_difference.html","id":null,"dir":"Reference","previous_headings":"","what":"Difference — wbt_difference","title":"Difference — wbt_difference","text":"Outputs features occur one two vector inputs , .e. overlapping features.","code":""},{"path":"/reference/wbt_difference.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Difference — wbt_difference","text":"","code":"wbt_difference(   input,   overlay,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_difference.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Difference — wbt_difference","text":"input Input vector file path. See wbt_file_path() details. overlay Input overlay vector file. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_difference.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Difference — wbt_difference","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_difference_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Difference curvature — wbt_difference_curvature","title":"Difference curvature — wbt_difference_curvature","text":"tool calculates difference curvature input DEM.","code":""},{"path":"/reference/wbt_difference_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Difference curvature — wbt_difference_curvature","text":"","code":"wbt_difference_curvature(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_difference_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Difference curvature — wbt_difference_curvature","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_difference_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Difference curvature — wbt_difference_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_direct_decorrelation_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Direct decorrelation stretch — wbt_direct_decorrelation_stretch","title":"Direct decorrelation stretch — wbt_direct_decorrelation_stretch","text":"Performs direct decorrelation stretch enhancement colour-composite image multispectral data.","code":""},{"path":"/reference/wbt_direct_decorrelation_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Direct decorrelation stretch — wbt_direct_decorrelation_stretch","text":"","code":"wbt_direct_decorrelation_stretch(   input,   output,   k = 0.5,   clip = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_direct_decorrelation_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Direct decorrelation stretch — wbt_direct_decorrelation_stretch","text":"input Input colour composite image file. output Output raster file. k Achromatic factor (k) ranges 0 (effect) 1 (full saturation stretch), although typical values range 0.3 0.7. clip Optional percent clip upper tail stretch. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_direct_decorrelation_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Direct decorrelation stretch — wbt_direct_decorrelation_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_directional_relief.html","id":null,"dir":"Reference","previous_headings":"","what":"Directional relief — wbt_directional_relief","title":"Directional relief — wbt_directional_relief","text":"Calculates relief cells input DEM specified direction.","code":""},{"path":"/reference/wbt_directional_relief.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Directional relief — wbt_directional_relief","text":"","code":"wbt_directional_relief(   dem,   output,   azimuth = 0,   max_dist = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_directional_relief.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Directional relief — wbt_directional_relief","text":"dem Input raster DEM file. output Output raster file. azimuth Wind azimuth degrees. max_dist Optional maximum search distance (unspecified none; xy units). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_directional_relief.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Directional relief — wbt_directional_relief","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_dissolve.html","id":null,"dir":"Reference","previous_headings":"","what":"Dissolve — wbt_dissolve","title":"Dissolve — wbt_dissolve","text":"Removes interior, shared, boundaries within vector polygon coverage.","code":""},{"path":"/reference/wbt_dissolve.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dissolve — wbt_dissolve","text":"","code":"wbt_dissolve(   input,   output,   field = NULL,   snap = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_dissolve.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Dissolve — wbt_dissolve","text":"input Input vector file path. See wbt_file_path() details. output Output vector file. field Dissolve field attribute (optional). snap Snap tolerance. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_dissolve.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Dissolve — wbt_dissolve","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_distance_to_outlet.html","id":null,"dir":"Reference","previous_headings":"","what":"Distance to outlet — wbt_distance_to_outlet","title":"Distance to outlet — wbt_distance_to_outlet","text":"Calculates distance stream grid cells channel network outlet cell.","code":""},{"path":"/reference/wbt_distance_to_outlet.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Distance to outlet — wbt_distance_to_outlet","text":"","code":"wbt_distance_to_outlet(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_distance_to_outlet.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Distance to outlet — wbt_distance_to_outlet","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_distance_to_outlet.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Distance to outlet — wbt_distance_to_outlet","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_diversity_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Diversity filter — wbt_diversity_filter","title":"Diversity filter — wbt_diversity_filter","text":"Assigns cell output grid number different values moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_diversity_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Diversity filter — wbt_diversity_filter","text":"","code":"wbt_diversity_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_diversity_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Diversity filter — wbt_diversity_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_diversity_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Diversity filter — wbt_diversity_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_divide.html","id":null,"dir":"Reference","previous_headings":"","what":"Divide — wbt_divide","title":"Divide — wbt_divide","text":"Performs division operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_divide.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Divide — wbt_divide","text":"","code":"wbt_divide(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_divide.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Divide — wbt_divide","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_divide.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Divide — wbt_divide","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_downslope_distance_to_stream.html","id":null,"dir":"Reference","previous_headings":"","what":"Downslope distance to stream — wbt_downslope_distance_to_stream","title":"Downslope distance to stream — wbt_downslope_distance_to_stream","text":"Measures distance nearest downslope stream cell.","code":""},{"path":"/reference/wbt_downslope_distance_to_stream.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Downslope distance to stream — wbt_downslope_distance_to_stream","text":"","code":"wbt_downslope_distance_to_stream(   dem,   streams,   output,   dinf = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_downslope_distance_to_stream.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Downslope distance to stream — wbt_downslope_distance_to_stream","text":"dem Input raster DEM file. streams Input raster streams file. output Output raster file. dinf Use D-infinity flow algorithm instead D8?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_downslope_distance_to_stream.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Downslope distance to stream — wbt_downslope_distance_to_stream","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_downslope_flowpath_length.html","id":null,"dir":"Reference","previous_headings":"","what":"Downslope flowpath length — wbt_downslope_flowpath_length","title":"Downslope flowpath length — wbt_downslope_flowpath_length","text":"Calculates downslope flowpath length cell basin outlet.","code":""},{"path":"/reference/wbt_downslope_flowpath_length.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Downslope flowpath length — wbt_downslope_flowpath_length","text":"","code":"wbt_downslope_flowpath_length(   d8_pntr,   output,   watersheds = NULL,   weights = NULL,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_downslope_flowpath_length.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Downslope flowpath length — wbt_downslope_flowpath_length","text":"d8_pntr Input D8 pointer raster file. output Output raster file. watersheds Optional input watershed raster file. weights Optional input weights raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_downslope_flowpath_length.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Downslope flowpath length — wbt_downslope_flowpath_length","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_downslope_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Downslope index — wbt_downslope_index","title":"Downslope index — wbt_downslope_index","text":"Calculates Hjerdt et al. (2004) downslope index.","code":""},{"path":"/reference/wbt_downslope_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Downslope index — wbt_downslope_index","text":"","code":"wbt_downslope_index(   dem,   output,   drop = 2,   out_type = \"tangent\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_downslope_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Downslope index — wbt_downslope_index","text":"dem Input raster DEM file. output Output raster file. drop Vertical drop value (default 2.0). out_type Output type, options include 'tangent', 'degrees', 'radians', 'distance' (default 'tangent'). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_downslope_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Downslope index — wbt_downslope_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_edge_contamination.html","id":null,"dir":"Reference","previous_headings":"","what":"Edge contamination — wbt_edge_contamination","title":"Edge contamination — wbt_edge_contamination","text":"Identifies grid cells within input DEM may impacted edge contamination hydrological applications.","code":""},{"path":"/reference/wbt_edge_contamination.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Edge contamination — wbt_edge_contamination","text":"","code":"wbt_edge_contamination(   dem,   output,   flow_type = \"mfd\",   zfactor = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_edge_contamination.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Edge contamination — wbt_edge_contamination","text":"dem Name input DEM raster file; must depressionless. output Name output raster file. flow_type Flow algorithm type, one 'd8', 'mfd', 'dinf'. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_edge_contamination.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Edge contamination — wbt_edge_contamination","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_edge_density.html","id":null,"dir":"Reference","previous_headings":"","what":"Edge density — wbt_edge_density","title":"Edge density — wbt_edge_density","text":"Calculates density edges, breaks--slope within DEMs.","code":""},{"path":"/reference/wbt_edge_density.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Edge density — wbt_edge_density","text":"","code":"wbt_edge_density(   dem,   output,   filter = 11,   norm_diff = 5,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_edge_density.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Edge density — wbt_edge_density","text":"dem Input raster DEM file. output Output raster file. filter Size filter kernel. norm_diff Maximum difference normal vectors, degrees. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_edge_density.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Edge density — wbt_edge_density","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_edge_preserving_mean_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Edge preserving mean filter — wbt_edge_preserving_mean_filter","title":"Edge preserving mean filter — wbt_edge_preserving_mean_filter","text":"Performs simple edge-preserving mean filter input image.","code":""},{"path":"/reference/wbt_edge_preserving_mean_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Edge preserving mean filter — wbt_edge_preserving_mean_filter","text":"","code":"wbt_edge_preserving_mean_filter(   input,   output,   threshold,   filter = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_edge_preserving_mean_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Edge preserving mean filter — wbt_edge_preserving_mean_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. threshold Maximum difference values. filter Size filter kernel. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_edge_preserving_mean_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Edge preserving mean filter — wbt_edge_preserving_mean_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_edge_proportion.html","id":null,"dir":"Reference","previous_headings":"","what":"Edge proportion — wbt_edge_proportion","title":"Edge proportion — wbt_edge_proportion","text":"Calculate proportion cells raster polygon edge cells.","code":""},{"path":"/reference/wbt_edge_proportion.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Edge proportion — wbt_edge_proportion","text":"","code":"wbt_edge_proportion(   input,   output,   output_text = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_edge_proportion.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Edge proportion — wbt_edge_proportion","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. output_text flag indicating whether text report also output. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_edge_proportion.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Edge proportion — wbt_edge_proportion","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elev_above_pit.html","id":null,"dir":"Reference","previous_headings":"","what":"Elev above pit — wbt_elev_above_pit","title":"Elev above pit — wbt_elev_above_pit","text":"Calculate elevation grid cell nearest downstream pit cell grid edge cell.","code":""},{"path":"/reference/wbt_elev_above_pit.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elev above pit — wbt_elev_above_pit","text":"","code":"wbt_elev_above_pit(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elev_above_pit.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elev above pit — wbt_elev_above_pit","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elev_above_pit.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elev above pit — wbt_elev_above_pit","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elev_percentile.html","id":null,"dir":"Reference","previous_headings":"","what":"Elev percentile — wbt_elev_percentile","title":"Elev percentile — wbt_elev_percentile","text":"Calculates elevation percentile raster DEM.","code":""},{"path":"/reference/wbt_elev_percentile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elev percentile — wbt_elev_percentile","text":"","code":"wbt_elev_percentile(   dem,   output,   filterx = 11,   filtery = 11,   sig_digits = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elev_percentile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elev percentile — wbt_elev_percentile","text":"dem Input raster DEM file. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. sig_digits Number significant digits. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elev_percentile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elev percentile — wbt_elev_percentile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elev_relative_to_min_max.html","id":null,"dir":"Reference","previous_headings":"","what":"Elev relative to min max — wbt_elev_relative_to_min_max","title":"Elev relative to min max — wbt_elev_relative_to_min_max","text":"Calculates elevation location relative minimum maximum elevations DEM.","code":""},{"path":"/reference/wbt_elev_relative_to_min_max.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elev relative to min max — wbt_elev_relative_to_min_max","text":"","code":"wbt_elev_relative_to_min_max(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elev_relative_to_min_max.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elev relative to min max — wbt_elev_relative_to_min_max","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elev_relative_to_min_max.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elev relative to min max — wbt_elev_relative_to_min_max","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elev_relative_to_watershed_min_max.html","id":null,"dir":"Reference","previous_headings":"","what":"Elev relative to watershed min max — wbt_elev_relative_to_watershed_min_max","title":"Elev relative to watershed min max — wbt_elev_relative_to_watershed_min_max","text":"Calculates elevation location relative minimum maximum elevations watershed.","code":""},{"path":"/reference/wbt_elev_relative_to_watershed_min_max.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elev relative to watershed min max — wbt_elev_relative_to_watershed_min_max","text":"","code":"wbt_elev_relative_to_watershed_min_max(   dem,   watersheds,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elev_relative_to_watershed_min_max.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elev relative to watershed min max — wbt_elev_relative_to_watershed_min_max","text":"dem Input raster DEM file. watersheds Input raster watersheds file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elev_relative_to_watershed_min_max.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elev relative to watershed min max — wbt_elev_relative_to_watershed_min_max","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elevation_above_stream.html","id":null,"dir":"Reference","previous_headings":"","what":"Elevation above stream — wbt_elevation_above_stream","title":"Elevation above stream — wbt_elevation_above_stream","text":"Calculates elevation cells nearest downslope stream cell.","code":""},{"path":"/reference/wbt_elevation_above_stream.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elevation above stream — wbt_elevation_above_stream","text":"","code":"wbt_elevation_above_stream(   dem,   streams,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elevation_above_stream.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elevation above stream — wbt_elevation_above_stream","text":"dem Input raster DEM file. streams Input raster streams file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elevation_above_stream.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elevation above stream — wbt_elevation_above_stream","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elevation_above_stream_euclidean.html","id":null,"dir":"Reference","previous_headings":"","what":"Elevation above stream euclidean — wbt_elevation_above_stream_euclidean","title":"Elevation above stream euclidean — wbt_elevation_above_stream_euclidean","text":"Calculates elevation cells nearest (Euclidean distance) stream cell.","code":""},{"path":"/reference/wbt_elevation_above_stream_euclidean.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elevation above stream euclidean — wbt_elevation_above_stream_euclidean","text":"","code":"wbt_elevation_above_stream_euclidean(   dem,   streams,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elevation_above_stream_euclidean.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elevation above stream euclidean — wbt_elevation_above_stream_euclidean","text":"dem Input raster DEM file. streams Input raster streams file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elevation_above_stream_euclidean.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elevation above stream euclidean — wbt_elevation_above_stream_euclidean","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_eliminate_coincident_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Eliminate coincident points — wbt_eliminate_coincident_points","title":"Eliminate coincident points — wbt_eliminate_coincident_points","text":"Removes coincident, nearly coincident, points vector points file.","code":""},{"path":"/reference/wbt_eliminate_coincident_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Eliminate coincident points — wbt_eliminate_coincident_points","text":"","code":"wbt_eliminate_coincident_points(   input,   output,   tolerance,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_eliminate_coincident_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Eliminate coincident points — wbt_eliminate_coincident_points","text":"input Input vector file path. See wbt_file_path() details. output Output vector points file. tolerance distance tolerance points. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_eliminate_coincident_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Eliminate coincident points — wbt_eliminate_coincident_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elongation_ratio.html","id":null,"dir":"Reference","previous_headings":"","what":"Elongation ratio — wbt_elongation_ratio","title":"Elongation ratio — wbt_elongation_ratio","text":"Calculates elongation ratio vector polygons.","code":""},{"path":"/reference/wbt_elongation_ratio.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elongation ratio — wbt_elongation_ratio","text":"","code":"wbt_elongation_ratio(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elongation_ratio.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elongation ratio — wbt_elongation_ratio","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elongation_ratio.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elongation ratio — wbt_elongation_ratio","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_embankment_mapping.html","id":null,"dir":"Reference","previous_headings":"","what":"Embankment mapping — wbt_embankment_mapping","title":"Embankment mapping — wbt_embankment_mapping","text":"Maps /removes road embankments input fine-resolution DEM.","code":""},{"path":"/reference/wbt_embankment_mapping.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Embankment mapping — wbt_embankment_mapping","text":"","code":"wbt_embankment_mapping(   dem,   road_vec,   output,   search_dist = 2.5,   min_road_width = 6,   typical_width = 30,   max_height = 2,   max_width = 60,   max_increment = 0.05,   spillout_slope = 4,   remove_embankments = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_embankment_mapping.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Embankment mapping — wbt_embankment_mapping","text":"dem Input raster DEM file. road_vec Input vector polygons file. output Output raster file. search_dist Search distance used reposition transportation vectors onto road embankments (map units). min_road_width Minimum road width; width paved road surface (map units). typical_width Typical embankment width; maximum width embankment roadside ditches (map units). max_height Typical embankment maximum height; height typical embankment roadside ditches (map units). max_width Maximum embankment width, typically embankments traverse steep-sided valleys (map units). max_increment Maximum upwards increment neighbouring cells embankment (elevation units). spillout_slope Spillout slope (degrees). remove_embankments Optional flag indicating whether output DEM embankments removed (true) embankment raster map (false). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_embankment_mapping.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Embankment mapping — wbt_embankment_mapping","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_emboss_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Emboss filter — wbt_emboss_filter","title":"Emboss filter — wbt_emboss_filter","text":"Performs emboss filter image, similar hillshade operation.","code":""},{"path":"/reference/wbt_emboss_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Emboss filter — wbt_emboss_filter","text":"","code":"wbt_emboss_filter(   input,   output,   direction = \"n\",   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_emboss_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Emboss filter — wbt_emboss_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. direction Direction reflection; options include 'n', 's', 'e', 'w', 'ne', 'se', 'nw', 'sw'. clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_emboss_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Emboss filter — wbt_emboss_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_equal_to.html","id":null,"dir":"Reference","previous_headings":"","what":"Equal to — wbt_equal_to","title":"Equal to — wbt_equal_to","text":"Performs equal-comparison operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_equal_to.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Equal to — wbt_equal_to","text":"","code":"wbt_equal_to(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_equal_to.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Equal to — wbt_equal_to","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_equal_to.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Equal to — wbt_equal_to","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_erase.html","id":null,"dir":"Reference","previous_headings":"","what":"Erase — wbt_erase","title":"Erase — wbt_erase","text":"Removes features, parts features, overlap features erase vector polygon.","code":""},{"path":"/reference/wbt_erase.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Erase — wbt_erase","text":"","code":"wbt_erase(   input,   erase,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_erase.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Erase — wbt_erase","text":"input Input vector file path. See wbt_file_path() details. erase Input erase polygon vector file. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_erase.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Erase — wbt_erase","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_erase_polygon_from_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Erase polygon from lidar — wbt_erase_polygon_from_lidar","title":"Erase polygon from lidar — wbt_erase_polygon_from_lidar","text":"Erases (cuts ) vector polygon polygons LiDAR point cloud.","code":""},{"path":"/reference/wbt_erase_polygon_from_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Erase polygon from lidar — wbt_erase_polygon_from_lidar","text":"","code":"wbt_erase_polygon_from_lidar(   input,   polygons,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_erase_polygon_from_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Erase polygon from lidar — wbt_erase_polygon_from_lidar","text":"input Input LiDAR file. polygons Input vector polygons file. output Output LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_erase_polygon_from_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Erase polygon from lidar — wbt_erase_polygon_from_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_erase_polygon_from_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Erase polygon from raster — wbt_erase_polygon_from_raster","title":"Erase polygon from raster — wbt_erase_polygon_from_raster","text":"Erases (cuts ) vector polygon raster.","code":""},{"path":"/reference/wbt_erase_polygon_from_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Erase polygon from raster — wbt_erase_polygon_from_raster","text":"","code":"wbt_erase_polygon_from_raster(   input,   polygons,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_erase_polygon_from_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Erase polygon from raster — wbt_erase_polygon_from_raster","text":"input Input raster file path. See wbt_file_path() details. polygons Input vector polygons file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_erase_polygon_from_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Erase polygon from raster — wbt_erase_polygon_from_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_euclidean_allocation.html","id":null,"dir":"Reference","previous_headings":"","what":"Euclidean allocation — wbt_euclidean_allocation","title":"Euclidean allocation — wbt_euclidean_allocation","text":"Assigns grid cells output raster value nearest target cell input image, measured Shih Wu (2004) Euclidean distance transform.","code":""},{"path":"/reference/wbt_euclidean_allocation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Euclidean allocation — wbt_euclidean_allocation","text":"","code":"wbt_euclidean_allocation(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_euclidean_allocation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Euclidean allocation — wbt_euclidean_allocation","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_euclidean_allocation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Euclidean allocation — wbt_euclidean_allocation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_euclidean_distance.html","id":null,"dir":"Reference","previous_headings":"","what":"Euclidean distance — wbt_euclidean_distance","title":"Euclidean distance — wbt_euclidean_distance","text":"Calculates Shih Wu (2004) Euclidean distance transform.","code":""},{"path":"/reference/wbt_euclidean_distance.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Euclidean distance — wbt_euclidean_distance","text":"","code":"wbt_euclidean_distance(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_euclidean_distance.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Euclidean distance — wbt_euclidean_distance","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_euclidean_distance.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Euclidean distance — wbt_euclidean_distance","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_evaluate_training_sites.html","id":null,"dir":"Reference","previous_headings":"","what":"Evaluate training sites — wbt_evaluate_training_sites","title":"Evaluate training sites — wbt_evaluate_training_sites","text":"tool can used inspect overlap spectral signatures training sites various classes.","code":""},{"path":"/reference/wbt_evaluate_training_sites.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Evaluate training sites — wbt_evaluate_training_sites","text":"","code":"wbt_evaluate_training_sites(   inputs,   polys,   field,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_evaluate_training_sites.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Evaluate training sites — wbt_evaluate_training_sites","text":"inputs Name input band images. polys Name input training site polygons shapefile. field Name attribute containing class name data. output Name output report file (*.html). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_evaluate_training_sites.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Evaluate training sites — wbt_evaluate_training_sites","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_exp.html","id":null,"dir":"Reference","previous_headings":"","what":"Exp — wbt_exp","title":"Exp — wbt_exp","text":"Returns exponential (base e) values raster.","code":""},{"path":"/reference/wbt_exp.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Exp — wbt_exp","text":"","code":"wbt_exp(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_exp.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Exp — wbt_exp","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_exp.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Exp — wbt_exp","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_exp2.html","id":null,"dir":"Reference","previous_headings":"","what":"Exp2 — wbt_exp2","title":"Exp2 — wbt_exp2","text":"Returns exponential (base 2) values raster.","code":""},{"path":"/reference/wbt_exp2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Exp2 — wbt_exp2","text":"","code":"wbt_exp2(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_exp2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Exp2 — wbt_exp2","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_exp2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Exp2 — wbt_exp2","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_export_table_to_csv.html","id":null,"dir":"Reference","previous_headings":"","what":"Export table to csv — wbt_export_table_to_csv","title":"Export table to csv — wbt_export_table_to_csv","text":"Exports attribute table CSV text file.","code":""},{"path":"/reference/wbt_export_table_to_csv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Export table to csv — wbt_export_table_to_csv","text":"","code":"wbt_export_table_to_csv(   input,   output,   headers = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_export_table_to_csv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Export table to csv — wbt_export_table_to_csv","text":"input Input vector file path. See wbt_file_path() details. output Output csv file. headers Export field names file header?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_export_table_to_csv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Export table to csv — wbt_export_table_to_csv","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_exposure_towards_wind_flux.html","id":null,"dir":"Reference","previous_headings":"","what":"Exposure towards wind flux — wbt_exposure_towards_wind_flux","title":"Exposure towards wind flux — wbt_exposure_towards_wind_flux","text":"Evaluates hydrologic connectivity within DEM.","code":""},{"path":"/reference/wbt_exposure_towards_wind_flux.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Exposure towards wind flux — wbt_exposure_towards_wind_flux","text":"","code":"wbt_exposure_towards_wind_flux(   dem,   output,   azimuth = \"\",   max_dist = \"\",   zfactor = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_exposure_towards_wind_flux.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Exposure towards wind flux — wbt_exposure_towards_wind_flux","text":"dem Name input DEM raster file. output Name output raster file. azimuth Wind azimuth, degrees. max_dist Optional maximum search distance. Minimum value 5 x cell size. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_exposure_towards_wind_flux.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Exposure towards wind flux — wbt_exposure_towards_wind_flux","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_extend_vector_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Extend vector lines — wbt_extend_vector_lines","title":"Extend vector lines — wbt_extend_vector_lines","text":"Extends vector lines specified distance.","code":""},{"path":"/reference/wbt_extend_vector_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extend vector lines — wbt_extend_vector_lines","text":"","code":"wbt_extend_vector_lines(   input,   output,   dist,   extend = \"both ends\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_extend_vector_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extend vector lines — wbt_extend_vector_lines","text":"input Input vector polyline file. output Output vector polyline file. dist distance extend. extend Extend direction, 'ends' (default), 'line start', 'line end'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_extend_vector_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extend vector lines — wbt_extend_vector_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_extract_nodes.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract nodes — wbt_extract_nodes","title":"Extract nodes — wbt_extract_nodes","text":"Converts vector lines polygons vertex points.","code":""},{"path":"/reference/wbt_extract_nodes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract nodes — wbt_extract_nodes","text":"","code":"wbt_extract_nodes(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_extract_nodes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract nodes — wbt_extract_nodes","text":"input Input vector lines polygon file. output Output vector points file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_extract_nodes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extract nodes — wbt_extract_nodes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_extract_raster_values_at_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract raster values at points — wbt_extract_raster_values_at_points","title":"Extract raster values at points — wbt_extract_raster_values_at_points","text":"Extracts values raster(s) vector point locations.","code":""},{"path":"/reference/wbt_extract_raster_values_at_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract raster values at points — wbt_extract_raster_values_at_points","text":"","code":"wbt_extract_raster_values_at_points(   inputs,   points,   out_text = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_extract_raster_values_at_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract raster values at points — wbt_extract_raster_values_at_points","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. points Input vector points file. out_text Output point values text? Otherwise, output points file's attribute table. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_extract_raster_values_at_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extract raster values at points — wbt_extract_raster_values_at_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_extract_streams.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract streams — wbt_extract_streams","title":"Extract streams — wbt_extract_streams","text":"Extracts stream grid cells flow accumulation raster.","code":""},{"path":"/reference/wbt_extract_streams.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract streams — wbt_extract_streams","text":"","code":"wbt_extract_streams(   flow_accum,   output,   threshold,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_extract_streams.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract streams — wbt_extract_streams","text":"flow_accum Input raster D8 flow accumulation file. output Output raster file. threshold Threshold flow accumulation values channelization. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_extract_streams.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extract streams — wbt_extract_streams","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_extract_valleys.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract valleys — wbt_extract_valleys","title":"Extract valleys — wbt_extract_valleys","text":"Identifies potential valley bottom grid cells based local topolography alone.","code":""},{"path":"/reference/wbt_extract_valleys.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract valleys — wbt_extract_valleys","text":"","code":"wbt_extract_valleys(   dem,   output,   variant = \"LQ\",   line_thin = TRUE,   filter = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_extract_valleys.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract valleys — wbt_extract_valleys","text":"dem Input raster DEM file. output Output raster file. variant Options include 'LQ' (lower quartile), 'JandR' (Johnston Rosenfeld), 'PandD' (Peucker Douglas); default 'LQ'. line_thin Optional flag indicating whether post-processing line-thinning performed. filter Optional argument (used variant='lq') providing filter size, grid cells, used lq-filtering (default 5). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_extract_valleys.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extract valleys — wbt_extract_valleys","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_farthest_channel_head.html","id":null,"dir":"Reference","previous_headings":"","what":"Farthest channel head — wbt_farthest_channel_head","title":"Farthest channel head — wbt_farthest_channel_head","text":"Calculates distance furthest upstream channel head stream cell.","code":""},{"path":"/reference/wbt_farthest_channel_head.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Farthest channel head — wbt_farthest_channel_head","text":"","code":"wbt_farthest_channel_head(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_farthest_channel_head.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Farthest channel head — wbt_farthest_channel_head","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_farthest_channel_head.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Farthest channel head — wbt_farthest_channel_head","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fast_almost_gaussian_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Fast almost gaussian filter — wbt_fast_almost_gaussian_filter","title":"Fast almost gaussian filter — wbt_fast_almost_gaussian_filter","text":"Performs fast approximate Gaussian filter image.","code":""},{"path":"/reference/wbt_fast_almost_gaussian_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fast almost gaussian filter — wbt_fast_almost_gaussian_filter","text":"","code":"wbt_fast_almost_gaussian_filter(   input,   output,   sigma = 1.8,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fast_almost_gaussian_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fast almost gaussian filter — wbt_fast_almost_gaussian_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma Standard deviation distance pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fast_almost_gaussian_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fast almost gaussian filter — wbt_fast_almost_gaussian_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fd8_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Fd8 flow accumulation — wbt_fd8_flow_accumulation","title":"Fd8 flow accumulation — wbt_fd8_flow_accumulation","text":"Calculates FD8 flow accumulation raster input DEM.","code":""},{"path":"/reference/wbt_fd8_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fd8 flow accumulation — wbt_fd8_flow_accumulation","text":"","code":"wbt_fd8_flow_accumulation(   dem,   output,   out_type = \"specific contributing area\",   exponent = 1.1,   threshold = NULL,   log = FALSE,   clip = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fd8_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fd8 flow accumulation — wbt_fd8_flow_accumulation","text":"dem Input raster DEM file. output Output raster file. out_type Output type; one 'cells', 'specific contributing area' (default), 'catchment area'. exponent Optional exponent parameter; default 1.1. threshold Optional convergence threshold parameter, grid cells; default infinity. log Optional flag request output log-transformed. clip Optional flag request clipping display max 1 percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fd8_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fd8 flow accumulation — wbt_fd8_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fd8_pointer.html","id":null,"dir":"Reference","previous_headings":"","what":"Fd8 pointer — wbt_fd8_pointer","title":"Fd8 pointer — wbt_fd8_pointer","text":"Calculates FD8 flow pointer raster input DEM.","code":""},{"path":"/reference/wbt_fd8_pointer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fd8 pointer — wbt_fd8_pointer","text":"","code":"wbt_fd8_pointer(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fd8_pointer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fd8 pointer — wbt_fd8_pointer","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fd8_pointer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fd8 pointer — wbt_fd8_pointer","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_feature_preserving_smoothing.html","id":null,"dir":"Reference","previous_headings":"","what":"Feature preserving smoothing — wbt_feature_preserving_smoothing","title":"Feature preserving smoothing — wbt_feature_preserving_smoothing","text":"Reduces short-scale variation input DEM using modified Sun et al. (2007) algorithm.","code":""},{"path":"/reference/wbt_feature_preserving_smoothing.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Feature preserving smoothing — wbt_feature_preserving_smoothing","text":"","code":"wbt_feature_preserving_smoothing(   dem,   output,   filter = 11,   norm_diff = 15,   num_iter = 3,   max_diff = 0.5,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_feature_preserving_smoothing.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Feature preserving smoothing — wbt_feature_preserving_smoothing","text":"dem Input raster DEM file. output Output raster file. filter Size filter kernel. norm_diff Maximum difference normal vectors, degrees. num_iter Number iterations. max_diff Maximum allowable absolute elevation change (optional). zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_feature_preserving_smoothing.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Feature preserving smoothing — wbt_feature_preserving_smoothing","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fetch_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch analysis — wbt_fetch_analysis","title":"Fetch analysis — wbt_fetch_analysis","text":"Performs analysis fetch upwind distance obstacle.","code":""},{"path":"/reference/wbt_fetch_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch analysis — wbt_fetch_analysis","text":"","code":"wbt_fetch_analysis(   dem,   output,   azimuth = 0,   hgt_inc = 0.05,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fetch_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch analysis — wbt_fetch_analysis","text":"dem Input raster DEM file. output Output raster file. azimuth Wind azimuth degrees degrees. hgt_inc Height increment value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fetch_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch analysis — wbt_fetch_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_file_path.html","id":null,"dir":"Reference","previous_headings":"","what":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"Performs path expansion path.expand() shell quotes shQuote() input paths.","code":""},{"path":"/reference/wbt_file_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"","code":"wbt_file_path(x, shell_quote = TRUE, delimiter = \",\", check_exists = FALSE)"},{"path":"/reference/wbt_file_path.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"x character terra object. Vector file paths strings file paths passing arguments WhiteboxTools. object class SpatRaster, SpatRasterCollection, SpatVector SpatVectorProxy sources extracted terra::sources() shell_quote logical. Shell quotes around result? Default: TRUE delimiter character. Either \",\" (default) \";\" allowed WhiteboxTools. check_exists logical. Check file(s) x exist? Useful input values. Default: FALSE","code":""},{"path":"/reference/wbt_file_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"character. Length 1. safe input string use WhiteboxTools commands, paths expanded concatenated, necessary, optionally shell quoted.","code":""},{"path":"/reference/wbt_file_path.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"input vector contains \";\" \",\" considered, path expansion performed substrings. input vector length greater 1, vector concatenated \",\" \";\" create single output string.","code":""},{"path":"/reference/wbt_file_path.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"","code":"wbt_file_path(\"./abc.tif\") #> [1] \"'./abc.tif'\"  wbt_file_path(\"./abc.tif;./def.tif\") #> [1] \"'./abc.tif,./def.tif'\"  wbt_file_path(\"./abc.tif,./def.tif\") #> [1] \"'./abc.tif,./def.tif'\"  wbt_file_path(c(\"./abc.tif\", \"./def.tif\")) #> [1] \"'./abc.tif,./def.tif'\"  wbt_file_path(\"~/abc.tif\", shell_quote = FALSE) #> [1] \"/home/runner/abc.tif\"  wbt_file_path(c(\"~/abc.tif\", \"~/def.tif\")) #> [1] \"'/home/runner/abc.tif,/home/runner/def.tif'\""},{"path":"/reference/wbt_fill_burn.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill burn — wbt_fill_burn","title":"Fill burn — wbt_fill_burn","text":"Burns streams DEM using FillBurn (Saunders, 1999) method.","code":""},{"path":"/reference/wbt_fill_burn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill burn — wbt_fill_burn","text":"","code":"wbt_fill_burn(   dem,   streams,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_burn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill burn — wbt_fill_burn","text":"dem Input raster DEM file. streams Input vector streams file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_burn.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill burn — wbt_fill_burn","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fill_depressions.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill depressions — wbt_fill_depressions","title":"Fill depressions — wbt_fill_depressions","text":"Fills depressions DEM. Depression breaching preferred cases.","code":""},{"path":"/reference/wbt_fill_depressions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill depressions — wbt_fill_depressions","text":"","code":"wbt_fill_depressions(   dem,   output,   fix_flats = TRUE,   flat_increment = NULL,   max_depth = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_depressions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill depressions — wbt_fill_depressions","text":"dem Input raster DEM file. output Output raster file. fix_flats Optional flag indicating whether flat areas small gradient applied. flat_increment Optional elevation increment applied flat areas. max_depth Optional maximum depression depth fill. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_depressions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill depressions — wbt_fill_depressions","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fill_depressions_planchon_and_darboux.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill depressions planchon and darboux — wbt_fill_depressions_planchon_and_darboux","title":"Fill depressions planchon and darboux — wbt_fill_depressions_planchon_and_darboux","text":"Fills depressions DEM using Planchon Darboux (2002) method.","code":""},{"path":"/reference/wbt_fill_depressions_planchon_and_darboux.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill depressions planchon and darboux — wbt_fill_depressions_planchon_and_darboux","text":"","code":"wbt_fill_depressions_planchon_and_darboux(   dem,   output,   fix_flats = TRUE,   flat_increment = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_depressions_planchon_and_darboux.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill depressions planchon and darboux — wbt_fill_depressions_planchon_and_darboux","text":"dem Input raster DEM file. output Output raster file. fix_flats Optional flag indicating whether flat areas small gradient applied. flat_increment Optional elevation increment applied flat areas. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_depressions_planchon_and_darboux.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill depressions planchon and darboux — wbt_fill_depressions_planchon_and_darboux","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fill_depressions_wang_and_liu.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill depressions wang and liu — wbt_fill_depressions_wang_and_liu","title":"Fill depressions wang and liu — wbt_fill_depressions_wang_and_liu","text":"Fills depressions DEM using Wang Liu (2006) method. Depression breaching preferred cases.","code":""},{"path":"/reference/wbt_fill_depressions_wang_and_liu.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill depressions wang and liu — wbt_fill_depressions_wang_and_liu","text":"","code":"wbt_fill_depressions_wang_and_liu(   dem,   output,   fix_flats = TRUE,   flat_increment = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_depressions_wang_and_liu.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill depressions wang and liu — wbt_fill_depressions_wang_and_liu","text":"dem Input raster DEM file. output Output raster file. fix_flats Optional flag indicating whether flat areas small gradient applied. flat_increment Optional elevation increment applied flat areas. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_depressions_wang_and_liu.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill depressions wang and liu — wbt_fill_depressions_wang_and_liu","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fill_missing_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill missing data — wbt_fill_missing_data","title":"Fill missing data — wbt_fill_missing_data","text":"Fills NoData holes DEM.","code":""},{"path":"/reference/wbt_fill_missing_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill missing data — wbt_fill_missing_data","text":"","code":"wbt_fill_missing_data(   input,   output,   filter = 11,   weight = 2,   no_edges = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_missing_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill missing data — wbt_fill_missing_data","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filter Filter size (cells). weight IDW weight value. no_edges Optional flag indicating whether exclude NoData cells edge regions. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_missing_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill missing data — wbt_fill_missing_data","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fill_single_cell_pits.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill single cell pits — wbt_fill_single_cell_pits","title":"Fill single cell pits — wbt_fill_single_cell_pits","text":"Raises pit cells elevation lowest neighbour.","code":""},{"path":"/reference/wbt_fill_single_cell_pits.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill single cell pits — wbt_fill_single_cell_pits","text":"","code":"wbt_fill_single_cell_pits(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_single_cell_pits.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill single cell pits — wbt_fill_single_cell_pits","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_single_cell_pits.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill single cell pits — wbt_fill_single_cell_pits","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_filter_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter lidar — wbt_filter_lidar","title":"Filter lidar — wbt_filter_lidar","text":"Filters points within LiDAR point cloud based point properties.","code":""},{"path":"/reference/wbt_filter_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter lidar — wbt_filter_lidar","text":"","code":"wbt_filter_lidar(   input,   output = NULL,   statement = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_filter_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter lidar — wbt_filter_lidar","text":"input Name input LiDAR points. output Name output LiDAR points. statement Filter statement e.g. x < 5000.0 && y > 100.0 && is_late && !is_noise. statement must valid Rust statement. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_filter_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter lidar — wbt_filter_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_filter_lidar_classes.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter lidar classes — wbt_filter_lidar_classes","title":"Filter lidar classes — wbt_filter_lidar_classes","text":"Removes points LAS file certain specified class values.","code":""},{"path":"/reference/wbt_filter_lidar_classes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter lidar classes — wbt_filter_lidar_classes","text":"","code":"wbt_filter_lidar_classes(   input,   output,   exclude_cls = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_filter_lidar_classes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter lidar classes — wbt_filter_lidar_classes","text":"input Input LiDAR file. output Output LiDAR file. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_filter_lidar_classes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter lidar classes — wbt_filter_lidar_classes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_filter_lidar_scan_angles.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter lidar scan angles — wbt_filter_lidar_scan_angles","title":"Filter lidar scan angles — wbt_filter_lidar_scan_angles","text":"Removes points LAS file scan angles greater threshold.","code":""},{"path":"/reference/wbt_filter_lidar_scan_angles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter lidar scan angles — wbt_filter_lidar_scan_angles","text":"","code":"wbt_filter_lidar_scan_angles(   input,   output,   threshold,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_filter_lidar_scan_angles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter lidar scan angles — wbt_filter_lidar_scan_angles","text":"input Input LiDAR file. output Output LiDAR file. threshold Scan angle threshold. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_filter_lidar_scan_angles.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter lidar scan angles — wbt_filter_lidar_scan_angles","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_filter_raster_features_by_area.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter raster features by area — wbt_filter_raster_features_by_area","title":"Filter raster features by area — wbt_filter_raster_features_by_area","text":"Removes small-area features raster.","code":""},{"path":"/reference/wbt_filter_raster_features_by_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter raster features by area — wbt_filter_raster_features_by_area","text":"","code":"wbt_filter_raster_features_by_area(   input,   output,   threshold,   background = \"zero\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_filter_raster_features_by_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter raster features by area — wbt_filter_raster_features_by_area","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. threshold Remove features fewer grid cells threshold value. background Background value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_filter_raster_features_by_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter raster features by area — wbt_filter_raster_features_by_area","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_flightline_edge_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Find flightline edge points — wbt_find_flightline_edge_points","title":"Find flightline edge points — wbt_find_flightline_edge_points","text":"Identifies points along flightline's edge LAS file.","code":""},{"path":"/reference/wbt_find_flightline_edge_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find flightline edge points — wbt_find_flightline_edge_points","text":"","code":"wbt_find_flightline_edge_points(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_flightline_edge_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find flightline edge points — wbt_find_flightline_edge_points","text":"input Input LiDAR file. output Output file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_flightline_edge_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find flightline edge points — wbt_find_flightline_edge_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_lowest_or_highest_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Find lowest or highest points — wbt_find_lowest_or_highest_points","title":"Find lowest or highest points — wbt_find_lowest_or_highest_points","text":"Locates lowest /highest valued cells raster.","code":""},{"path":"/reference/wbt_find_lowest_or_highest_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find lowest or highest points — wbt_find_lowest_or_highest_points","text":"","code":"wbt_find_lowest_or_highest_points(   input,   output,   out_type = \"lowest\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_lowest_or_highest_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find lowest or highest points — wbt_find_lowest_or_highest_points","text":"input Input raster file path. See wbt_file_path() details. output Output vector points file. out_type Output type; one 'area' (default) 'volume'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_lowest_or_highest_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find lowest or highest points — wbt_find_lowest_or_highest_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_main_stem.html","id":null,"dir":"Reference","previous_headings":"","what":"Find main stem — wbt_find_main_stem","title":"Find main stem — wbt_find_main_stem","text":"Finds main stem, based stream lengths, stream network.","code":""},{"path":"/reference/wbt_find_main_stem.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find main stem — wbt_find_main_stem","text":"","code":"wbt_find_main_stem(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_main_stem.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find main stem — wbt_find_main_stem","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_main_stem.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find main stem — wbt_find_main_stem","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_no_flow_cells.html","id":null,"dir":"Reference","previous_headings":"","what":"Find no flow cells — wbt_find_no_flow_cells","title":"Find no flow cells — wbt_find_no_flow_cells","text":"Finds grid cells downslope neighbours.","code":""},{"path":"/reference/wbt_find_no_flow_cells.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find no flow cells — wbt_find_no_flow_cells","text":"","code":"wbt_find_no_flow_cells(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_no_flow_cells.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find no flow cells — wbt_find_no_flow_cells","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_no_flow_cells.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find no flow cells — wbt_find_no_flow_cells","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_parallel_flow.html","id":null,"dir":"Reference","previous_headings":"","what":"Find parallel flow — wbt_find_parallel_flow","title":"Find parallel flow — wbt_find_parallel_flow","text":"Finds areas parallel flow D8 flow direction rasters.","code":""},{"path":"/reference/wbt_find_parallel_flow.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find parallel flow — wbt_find_parallel_flow","text":"","code":"wbt_find_parallel_flow(   d8_pntr,   streams,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_parallel_flow.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find parallel flow — wbt_find_parallel_flow","text":"d8_pntr Input D8 pointer raster file. streams Input raster streams file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_parallel_flow.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find parallel flow — wbt_find_parallel_flow","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_patch_or_class_edge_cells.html","id":null,"dir":"Reference","previous_headings":"","what":"Find patch or class edge cells — wbt_find_patch_or_class_edge_cells","title":"Find patch or class edge cells — wbt_find_patch_or_class_edge_cells","text":"Finds cells located edge patch class features.","code":""},{"path":"/reference/wbt_find_patch_or_class_edge_cells.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find patch or class edge cells — wbt_find_patch_or_class_edge_cells","text":"","code":"wbt_find_patch_or_class_edge_cells(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_patch_or_class_edge_cells.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find patch or class edge cells — wbt_find_patch_or_class_edge_cells","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_patch_or_class_edge_cells.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find patch or class edge cells — wbt_find_patch_or_class_edge_cells","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_ridges.html","id":null,"dir":"Reference","previous_headings":"","what":"Find ridges — wbt_find_ridges","title":"Find ridges — wbt_find_ridges","text":"Identifies potential ridge peak grid cells.","code":""},{"path":"/reference/wbt_find_ridges.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find ridges — wbt_find_ridges","text":"","code":"wbt_find_ridges(   dem,   output,   line_thin = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_ridges.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find ridges — wbt_find_ridges","text":"dem Input raster DEM file. output Output raster file. line_thin Optional flag indicating whether post-processing line-thinning performed. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_ridges.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find ridges — wbt_find_ridges","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fix_dangling_arcs.html","id":null,"dir":"Reference","previous_headings":"","what":"Fix dangling arcs — wbt_fix_dangling_arcs","title":"Fix dangling arcs — wbt_fix_dangling_arcs","text":"tool fixes undershot overshot arcs, two common topological errors, input vector lines file.","code":""},{"path":"/reference/wbt_fix_dangling_arcs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fix dangling arcs — wbt_fix_dangling_arcs","text":"","code":"wbt_fix_dangling_arcs(   input,   output,   dist = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fix_dangling_arcs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fix dangling arcs — wbt_fix_dangling_arcs","text":"input Name input lines vector file. output Name output lines vector file. dist Snap distance, xy units (metres). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fix_dangling_arcs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fix dangling arcs — wbt_fix_dangling_arcs","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flatten_lakes.html","id":null,"dir":"Reference","previous_headings":"","what":"Flatten lakes — wbt_flatten_lakes","title":"Flatten lakes — wbt_flatten_lakes","text":"Flattens lake polygons raster DEM.","code":""},{"path":"/reference/wbt_flatten_lakes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flatten lakes — wbt_flatten_lakes","text":"","code":"wbt_flatten_lakes(   dem,   lakes,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flatten_lakes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flatten lakes — wbt_flatten_lakes","text":"dem Input raster DEM file. lakes Input lakes vector polygons file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flatten_lakes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flatten lakes — wbt_flatten_lakes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flightline_overlap.html","id":null,"dir":"Reference","previous_headings":"","what":"Flightline overlap — wbt_flightline_overlap","title":"Flightline overlap — wbt_flightline_overlap","text":"Reads LiDAR (LAS) point file outputs raster containing number overlapping flight-lines grid cell.","code":""},{"path":"/reference/wbt_flightline_overlap.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flightline overlap — wbt_flightline_overlap","text":"","code":"wbt_flightline_overlap(   input,   output = NULL,   resolution = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flightline_overlap.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flightline overlap — wbt_flightline_overlap","text":"input Input LiDAR file. output Output file. resolution Output raster's grid resolution. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flightline_overlap.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flightline overlap — wbt_flightline_overlap","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flip_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Flip image — wbt_flip_image","title":"Flip image — wbt_flip_image","text":"Reflects image vertical horizontal axis.","code":""},{"path":"/reference/wbt_flip_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flip image — wbt_flip_image","text":"","code":"wbt_flip_image(   input,   output,   direction = \"vertical\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flip_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flip image — wbt_flip_image","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. direction Direction reflection; options include 'v' (vertical), 'h' (horizontal), 'b' (). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flip_image.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flip image — wbt_flip_image","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flood_order.html","id":null,"dir":"Reference","previous_headings":"","what":"Flood order — wbt_flood_order","title":"Flood order — wbt_flood_order","text":"Assigns DEM grid cell order sequence inundations encountered search starting edges, moving inward increasing elevations.","code":""},{"path":"/reference/wbt_flood_order.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flood order — wbt_flood_order","text":"","code":"wbt_flood_order(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flood_order.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flood order — wbt_flood_order","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flood_order.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flood order — wbt_flood_order","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_floor.html","id":null,"dir":"Reference","previous_headings":"","what":"Floor — wbt_floor","title":"Floor — wbt_floor","text":"Returns largest (closest positive infinity) value less equal values raster.","code":""},{"path":"/reference/wbt_floor.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Floor — wbt_floor","text":"","code":"wbt_floor(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_floor.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Floor — wbt_floor","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_floor.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Floor — wbt_floor","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flow_accumulation_full_workflow.html","id":null,"dir":"Reference","previous_headings":"","what":"Flow accumulation full workflow — wbt_flow_accumulation_full_workflow","title":"Flow accumulation full workflow — wbt_flow_accumulation_full_workflow","text":"Resolves depressions DEM, outputting breached DEM, aspect-aligned non-divergent flow pointer, flow accumulation raster.","code":""},{"path":"/reference/wbt_flow_accumulation_full_workflow.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flow accumulation full workflow — wbt_flow_accumulation_full_workflow","text":"","code":"wbt_flow_accumulation_full_workflow(   dem,   out_dem,   out_pntr,   out_accum,   out_type = \"Specific Contributing Area\",   log = FALSE,   clip = FALSE,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flow_accumulation_full_workflow.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flow accumulation full workflow — wbt_flow_accumulation_full_workflow","text":"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 'cells', 'sca' (default), 'ca'. log Optional flag request output log-transformed. clip Optional flag request clipping display max 1 percent. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flow_accumulation_full_workflow.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flow accumulation full workflow — wbt_flow_accumulation_full_workflow","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flow_length_diff.html","id":null,"dir":"Reference","previous_headings":"","what":"Flow length diff — wbt_flow_length_diff","title":"Flow length diff — wbt_flow_length_diff","text":"Calculates local maximum absolute difference downslope flowpath length, useful mapping drainage divides ridges.","code":""},{"path":"/reference/wbt_flow_length_diff.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flow length diff — wbt_flow_length_diff","text":"","code":"wbt_flow_length_diff(   d8_pntr,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flow_length_diff.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flow length diff — wbt_flow_length_diff","text":"d8_pntr Input D8 pointer raster file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flow_length_diff.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flow length diff — wbt_flow_length_diff","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_gamma_correction.html","id":null,"dir":"Reference","previous_headings":"","what":"Gamma correction — wbt_gamma_correction","title":"Gamma correction — wbt_gamma_correction","text":"Performs gamma correction input images.","code":""},{"path":"/reference/wbt_gamma_correction.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Gamma correction — wbt_gamma_correction","text":"","code":"wbt_gamma_correction(   input,   output,   gamma = 0.5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_gamma_correction.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Gamma correction — wbt_gamma_correction","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. gamma Gamma value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_gamma_correction.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Gamma correction — wbt_gamma_correction","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_gaussian_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Gaussian contrast stretch — wbt_gaussian_contrast_stretch","title":"Gaussian contrast stretch — wbt_gaussian_contrast_stretch","text":"Performs Gaussian contrast stretch input images.","code":""},{"path":"/reference/wbt_gaussian_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Gaussian contrast stretch — wbt_gaussian_contrast_stretch","text":"","code":"wbt_gaussian_contrast_stretch(   input,   output,   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_gaussian_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Gaussian contrast stretch — wbt_gaussian_contrast_stretch","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_gaussian_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Gaussian contrast stretch — wbt_gaussian_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_gaussian_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Gaussian curvature — wbt_gaussian_curvature","title":"Gaussian curvature — wbt_gaussian_curvature","text":"Calculates mean curvature raster input DEM.","code":""},{"path":"/reference/wbt_gaussian_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Gaussian curvature — wbt_gaussian_curvature","text":"","code":"wbt_gaussian_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_gaussian_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Gaussian curvature — wbt_gaussian_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_gaussian_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Gaussian curvature — wbt_gaussian_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_gaussian_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Gaussian filter — wbt_gaussian_filter","title":"Gaussian filter — wbt_gaussian_filter","text":"Performs Gaussian filter image.","code":""},{"path":"/reference/wbt_gaussian_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Gaussian filter — wbt_gaussian_filter","text":"","code":"wbt_gaussian_filter(   input,   output,   sigma = 0.75,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_gaussian_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Gaussian filter — wbt_gaussian_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma Standard deviation distance pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_gaussian_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Gaussian filter — wbt_gaussian_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_gaussian_scale_space.html","id":null,"dir":"Reference","previous_headings":"","what":"Gaussian scale space — wbt_gaussian_scale_space","title":"Gaussian scale space — wbt_gaussian_scale_space","text":"Uses fast Gaussian approximation algorithm produce scaled land-surface parameter measurements input DEM.","code":""},{"path":"/reference/wbt_gaussian_scale_space.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Gaussian scale space — wbt_gaussian_scale_space","text":"","code":"wbt_gaussian_scale_space(   dem,   output,   output_zscore,   output_scale,   points = NULL,   sigma = 0.5,   step = 0.5,   num_steps = 10,   lsp = \"Slope\",   z_factor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_gaussian_scale_space.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Gaussian scale space — wbt_gaussian_scale_space","text":"dem Name input DEM raster file. output Name output land-surface parameter raster file. output_zscore Name output z-score raster file. output_scale Name output scale raster file. points Name input vector points shapefile. sigma Initial sigma value (cells). step Step size positive non-zero integer. num_steps Number steps. lsp Output land-surface parameter; one 'AnisotropyLTP', 'Aspect', 'DiffMeanElev', 'Eastness', 'Elevation', 'Hillshade', 'MeanCurvature', 'Northness', 'PlanCurvature', 'ProfileCurvature', 'Ruggedness', 'Slope', 'TanCurvature', 'TotalCurvature'. z_factor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_gaussian_scale_space.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Gaussian scale space — wbt_gaussian_scale_space","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_generalize_classified_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Generalize classified raster — wbt_generalize_classified_raster","title":"Generalize classified raster — wbt_generalize_classified_raster","text":"Generalizes raster containing class object features removing small features.","code":""},{"path":"/reference/wbt_generalize_classified_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generalize classified raster — wbt_generalize_classified_raster","text":"","code":"wbt_generalize_classified_raster(   input,   output,   min_size = 4,   method = \"longest\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_generalize_classified_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generalize classified raster — wbt_generalize_classified_raster","text":"input Name input raster image file. output Name output raster file. min_size Minimum feature size, grid cells. method Grouping method; one 'longest' (default), 'largest', 'nearest'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_generalize_classified_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generalize classified raster — wbt_generalize_classified_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_generalize_with_similarity.html","id":null,"dir":"Reference","previous_headings":"","what":"Generalize with similarity — wbt_generalize_with_similarity","title":"Generalize with similarity — wbt_generalize_with_similarity","text":"Generalizes raster containing class object features removing small features using similarity criteria neighbouring features.","code":""},{"path":"/reference/wbt_generalize_with_similarity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generalize with similarity — wbt_generalize_with_similarity","text":"","code":"wbt_generalize_with_similarity(   input,   similarity,   output,   min_size = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_generalize_with_similarity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generalize with similarity — wbt_generalize_with_similarity","text":"input Name input raster image file. similarity Names input similarity images. output Name output raster file. min_size Minimum feature size, grid cells. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_generalize_with_similarity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generalize with similarity — wbt_generalize_with_similarity","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_generating_function.html","id":null,"dir":"Reference","previous_headings":"","what":"Generating function — wbt_generating_function","title":"Generating function — wbt_generating_function","text":"tool calculates generating function input DEM.","code":""},{"path":"/reference/wbt_generating_function.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generating function — wbt_generating_function","text":"","code":"wbt_generating_function(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_generating_function.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generating function — wbt_generating_function","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_generating_function.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generating function — wbt_generating_function","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_geomorphons.html","id":null,"dir":"Reference","previous_headings":"","what":"Geomorphons — wbt_geomorphons","title":"Geomorphons — wbt_geomorphons","text":"Computes geomorphon patterns.","code":""},{"path":"/reference/wbt_geomorphons.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Geomorphons — wbt_geomorphons","text":"","code":"wbt_geomorphons(   dem,   output,   search = 50,   threshold = 0,   fdist = 0,   skip = 0,   forms = TRUE,   residuals = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_geomorphons.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Geomorphons — wbt_geomorphons","text":"dem Input raster DEM file. output Output raster file. search Look distance (cells). threshold Flatness threshold classification function (degrees). fdist Distance (cells) begin reducing flatness threshold avoid problems pseudo-flat lines--sight. skip Distance (cells) begin calculating lines--sight. forms Classify geomorphons 10 common land morphologies, else output ternary pattern. residuals Convert elevation residuals linear model. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_geomorphons.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Geomorphons — wbt_geomorphons","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_greater_than.html","id":null,"dir":"Reference","previous_headings":"","what":"Greater than — wbt_greater_than","title":"Greater than — wbt_greater_than","text":"Performs greater-comparison operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_greater_than.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Greater than — wbt_greater_than","text":"","code":"wbt_greater_than(   input1,   input2,   output,   incl_equals = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_greater_than.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Greater than — wbt_greater_than","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. incl_equals Perform greater---equal-operation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_greater_than.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Greater than — wbt_greater_than","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hack_stream_order.html","id":null,"dir":"Reference","previous_headings":"","what":"Hack stream order — wbt_hack_stream_order","title":"Hack stream order — wbt_hack_stream_order","text":"Assigns Hack stream order tributary stream network.","code":""},{"path":"/reference/wbt_hack_stream_order.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hack stream order — wbt_hack_stream_order","text":"","code":"wbt_hack_stream_order(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hack_stream_order.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hack stream order — wbt_hack_stream_order","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hack_stream_order.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hack stream order — wbt_hack_stream_order","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_heat_map.html","id":null,"dir":"Reference","previous_headings":"","what":"Heat map — wbt_heat_map","title":"Heat map — wbt_heat_map","text":"Calculates heat map, kernel density estimation (KDE), input point set.","code":""},{"path":"/reference/wbt_heat_map.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Heat map — wbt_heat_map","text":"","code":"wbt_heat_map(   input,   output,   weight_field = NULL,   bandwidth = \"\",   kernel = \"quartic\",   cell_size = \"\",   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_heat_map.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Heat map — wbt_heat_map","text":"input Name input points shapefile. output Name output raster image file. weight_field Optional name attribute containing point weight. bandwidth Bandwidth (metres). kernel Kernel type; one 'uniform', 'triangular', 'epanechnikov', 'quartic', 'triweight', 'tricube', 'gaussian', 'cosine', 'logistic', 'sigmoid', 'silverman'. cell_size Optionally specified cell size output raster, metres. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_heat_map.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Heat map — wbt_heat_map","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_height_above_ground.html","id":null,"dir":"Reference","previous_headings":"","what":"Height above ground — wbt_height_above_ground","title":"Height above ground — wbt_height_above_ground","text":"Normalizes LiDAR point cloud, providing height nearest ground-classified point.","code":""},{"path":"/reference/wbt_height_above_ground.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Height above ground — wbt_height_above_ground","text":"","code":"wbt_height_above_ground(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_height_above_ground.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Height above ground — wbt_height_above_ground","text":"input Input LiDAR file (including extension). output Output lidar file (including extension). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_height_above_ground.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Height above ground — wbt_height_above_ground","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_help.html","id":null,"dir":"Reference","previous_headings":"","what":"Help description for 'WhiteboxTools' — wbt_help","title":"Help description for 'WhiteboxTools' — wbt_help","text":"Help description 'WhiteboxTools'","code":""},{"path":"/reference/wbt_help.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Help description for 'WhiteboxTools' — wbt_help","text":"","code":"wbt_help()"},{"path":"/reference/wbt_help.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Help description for 'WhiteboxTools' — wbt_help","text":"Returns help description 'WhiteboxTools' R character vector.","code":""},{"path":"/reference/wbt_help.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Help description for 'WhiteboxTools' — wbt_help","text":"","code":"if (FALSE) { wbt_help() }"},{"path":"/reference/wbt_high_pass_bilateral_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"High pass bilateral filter — wbt_high_pass_bilateral_filter","title":"High pass bilateral filter — wbt_high_pass_bilateral_filter","text":"Performs high-pass bilateral filter, differencing input image bilateral filter Tomasi Manduchi (1998).","code":""},{"path":"/reference/wbt_high_pass_bilateral_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"High pass bilateral filter — wbt_high_pass_bilateral_filter","text":"","code":"wbt_high_pass_bilateral_filter(   input,   output,   sigma_dist = 0.75,   sigma_int = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_high_pass_bilateral_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"High pass bilateral filter — wbt_high_pass_bilateral_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma_dist Standard deviation distance pixels. sigma_int Standard deviation intensity pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_high_pass_bilateral_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"High pass bilateral filter — wbt_high_pass_bilateral_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_high_pass_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"High pass filter — wbt_high_pass_filter","title":"High pass filter — wbt_high_pass_filter","text":"Performs high-pass filter input image.","code":""},{"path":"/reference/wbt_high_pass_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"High pass filter — wbt_high_pass_filter","text":"","code":"wbt_high_pass_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_high_pass_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"High pass filter — wbt_high_pass_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_high_pass_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"High pass filter — wbt_high_pass_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_high_pass_median_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"High pass median filter — wbt_high_pass_median_filter","title":"High pass median filter — wbt_high_pass_median_filter","text":"Performs high pass median filter input image.","code":""},{"path":"/reference/wbt_high_pass_median_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"High pass median filter — wbt_high_pass_median_filter","text":"","code":"wbt_high_pass_median_filter(   input,   output,   filterx = 11,   filtery = 11,   sig_digits = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_high_pass_median_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"High pass median filter — wbt_high_pass_median_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. sig_digits Number significant digits. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_high_pass_median_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"High pass median filter — wbt_high_pass_median_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_highest_position.html","id":null,"dir":"Reference","previous_headings":"","what":"Highest position — wbt_highest_position","title":"Highest position — wbt_highest_position","text":"Identifies stack position maximum value within raster stack cell--cell basis.","code":""},{"path":"/reference/wbt_highest_position.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Highest position — wbt_highest_position","text":"","code":"wbt_highest_position(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_highest_position.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Highest position — wbt_highest_position","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_highest_position.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Highest position — wbt_highest_position","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hillshade.html","id":null,"dir":"Reference","previous_headings":"","what":"Hillshade — wbt_hillshade","title":"Hillshade — wbt_hillshade","text":"Calculates hillshade raster input DEM.","code":""},{"path":"/reference/wbt_hillshade.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hillshade — wbt_hillshade","text":"","code":"wbt_hillshade(   dem,   output,   azimuth = 315,   altitude = 30,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hillshade.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hillshade — wbt_hillshade","text":"dem Input raster DEM file. output Output raster file. azimuth Illumination source azimuth degrees. altitude Illumination source altitude degrees. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hillshade.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hillshade — wbt_hillshade","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hillslopes.html","id":null,"dir":"Reference","previous_headings":"","what":"Hillslopes — wbt_hillslopes","title":"Hillslopes — wbt_hillslopes","text":"Identifies individual hillslopes draining link stream network.","code":""},{"path":"/reference/wbt_hillslopes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hillslopes — wbt_hillslopes","text":"","code":"wbt_hillslopes(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hillslopes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hillslopes — wbt_hillslopes","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hillslopes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hillslopes — wbt_hillslopes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_histogram_equalization.html","id":null,"dir":"Reference","previous_headings":"","what":"Histogram equalization — wbt_histogram_equalization","title":"Histogram equalization — wbt_histogram_equalization","text":"Performs histogram equalization contrast enhancement image.","code":""},{"path":"/reference/wbt_histogram_equalization.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Histogram equalization — wbt_histogram_equalization","text":"","code":"wbt_histogram_equalization(   input,   output,   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_histogram_equalization.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Histogram equalization — wbt_histogram_equalization","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_histogram_equalization.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Histogram equalization — wbt_histogram_equalization","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_histogram_matching.html","id":null,"dir":"Reference","previous_headings":"","what":"Histogram matching — wbt_histogram_matching","title":"Histogram matching — wbt_histogram_matching","text":"Alters statistical distribution raster image matching specified PDF.","code":""},{"path":"/reference/wbt_histogram_matching.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Histogram matching — wbt_histogram_matching","text":"","code":"wbt_histogram_matching(   input,   histo_file,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_histogram_matching.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Histogram matching — wbt_histogram_matching","text":"input Input raster file path. See wbt_file_path() details. histo_file Input reference probability distribution function (pdf) text file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_histogram_matching.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Histogram matching — wbt_histogram_matching","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_histogram_matching_two_images.html","id":null,"dir":"Reference","previous_headings":"","what":"Histogram matching two images — wbt_histogram_matching_two_images","title":"Histogram matching two images — wbt_histogram_matching_two_images","text":"Alters cumulative distribution function raster image another image.","code":""},{"path":"/reference/wbt_histogram_matching_two_images.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Histogram matching two images — wbt_histogram_matching_two_images","text":"","code":"wbt_histogram_matching_two_images(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_histogram_matching_two_images.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Histogram matching two images — wbt_histogram_matching_two_images","text":"input1 Input raster file modify. input2 Input reference raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_histogram_matching_two_images.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Histogram matching two images — wbt_histogram_matching_two_images","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hole_proportion.html","id":null,"dir":"Reference","previous_headings":"","what":"Hole proportion — wbt_hole_proportion","title":"Hole proportion — wbt_hole_proportion","text":"Calculates proportion total area polygon's holes relative area polygon's hull.","code":""},{"path":"/reference/wbt_hole_proportion.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hole proportion — wbt_hole_proportion","text":"","code":"wbt_hole_proportion(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hole_proportion.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hole proportion — wbt_hole_proportion","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hole_proportion.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hole proportion — wbt_hole_proportion","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_horizon_angle.html","id":null,"dir":"Reference","previous_headings":"","what":"Horizon angle — wbt_horizon_angle","title":"Horizon angle — wbt_horizon_angle","text":"Calculates horizon angle (maximum upwind slope) grid cell input DEM.","code":""},{"path":"/reference/wbt_horizon_angle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Horizon angle — wbt_horizon_angle","text":"","code":"wbt_horizon_angle(   dem,   output,   azimuth = 0,   max_dist = 100,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_horizon_angle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Horizon angle — wbt_horizon_angle","text":"dem Input raster DEM file. output Output raster file. azimuth Azimuth, degrees. max_dist Optional maximum search distance (unspecified none; xy units). Minimum value 5 x cell size. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_horizon_angle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Horizon angle — wbt_horizon_angle","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_horizontal_excess_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Horizontal excess curvature — wbt_horizontal_excess_curvature","title":"Horizontal excess curvature — wbt_horizontal_excess_curvature","text":"tool calculates horizontal excess curvature input DEM.","code":""},{"path":"/reference/wbt_horizontal_excess_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Horizontal excess curvature — wbt_horizontal_excess_curvature","text":"","code":"wbt_horizontal_excess_curvature(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_horizontal_excess_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Horizontal excess curvature — wbt_horizontal_excess_curvature","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_horizontal_excess_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Horizontal excess curvature — wbt_horizontal_excess_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_horton_stream_order.html","id":null,"dir":"Reference","previous_headings":"","what":"Horton stream order — wbt_horton_stream_order","title":"Horton stream order — wbt_horton_stream_order","text":"Assigns Horton stream order tributary stream network.","code":""},{"path":"/reference/wbt_horton_stream_order.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Horton stream order — wbt_horton_stream_order","text":"","code":"wbt_horton_stream_order(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_horton_stream_order.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Horton stream order — wbt_horton_stream_order","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_horton_stream_order.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Horton stream order — wbt_horton_stream_order","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hydrologic_connectivity.html","id":null,"dir":"Reference","previous_headings":"","what":"Hydrologic connectivity — wbt_hydrologic_connectivity","title":"Hydrologic connectivity — wbt_hydrologic_connectivity","text":"tool evaluates hydrologic connectivity within DEM.","code":""},{"path":"/reference/wbt_hydrologic_connectivity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hydrologic connectivity — wbt_hydrologic_connectivity","text":"","code":"wbt_hydrologic_connectivity(   dem,   output1,   output2,   exponent = 1,   threshold = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hydrologic_connectivity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hydrologic connectivity — wbt_hydrologic_connectivity","text":"dem Name input DEM raster file; must depressionless. output1 Name output downslope unsaturated length (DUL) file. output2 Name output upslope disconnected saturated area (UDSA) file. exponent Optional exponent parameter; default 1.0. threshold Optional convergence threshold parameter, grid cells; default infinity. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hydrologic_connectivity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hydrologic connectivity — wbt_hydrologic_connectivity","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hypsometric_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Hypsometric analysis — wbt_hypsometric_analysis","title":"Hypsometric analysis — wbt_hypsometric_analysis","text":"Calculates hypsometric curve one DEMs.","code":""},{"path":"/reference/wbt_hypsometric_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hypsometric analysis — wbt_hypsometric_analysis","text":"","code":"wbt_hypsometric_analysis(   inputs,   output,   watershed = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hypsometric_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hypsometric analysis — wbt_hypsometric_analysis","text":"inputs Input DEM files. output Output HTML file (default name based input file unspecified). watershed Input watershed files (optional). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hypsometric_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hypsometric analysis — wbt_hypsometric_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hypsometrically_tinted_hillshade.html","id":null,"dir":"Reference","previous_headings":"","what":"Hypsometrically tinted hillshade — wbt_hypsometrically_tinted_hillshade","title":"Hypsometrically tinted hillshade — wbt_hypsometrically_tinted_hillshade","text":"Creates colour shaded relief image input DEM.","code":""},{"path":"/reference/wbt_hypsometrically_tinted_hillshade.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hypsometrically tinted hillshade — wbt_hypsometrically_tinted_hillshade","text":"","code":"wbt_hypsometrically_tinted_hillshade(   dem,   output,   altitude = 45,   hs_weight = 0.5,   brightness = 0.5,   atmospheric = 0,   palette = \"atlas\",   reverse = FALSE,   zfactor = NULL,   full_mode = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hypsometrically_tinted_hillshade.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hypsometrically tinted hillshade — wbt_hypsometrically_tinted_hillshade","text":"dem Input raster DEM file. output Output raster file. altitude Illumination source altitude degrees. hs_weight Weight given hillshade relative relief (0.0-1.0). brightness Brightness factor (0.0-1.0). atmospheric Atmospheric effects weight (0.0-1.0). palette Options include 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'purple', 'viridis', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep'. reverse Optional flag indicating whether use reverse palette. zfactor Optional multiplier vertical horizontal units . full_mode Optional flag indicating whether use full 360-degrees illumination sources. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hypsometrically_tinted_hillshade.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hypsometrically tinted hillshade — wbt_hypsometrically_tinted_hillshade","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_idw_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Idw interpolation — wbt_idw_interpolation","title":"Idw interpolation — wbt_idw_interpolation","text":"Interpolates vector points raster surface using inverse-distance weighted scheme.","code":""},{"path":"/reference/wbt_idw_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Idw interpolation — wbt_idw_interpolation","text":"","code":"wbt_idw_interpolation(   input,   field,   output,   use_z = FALSE,   weight = 2,   radius = NULL,   min_points = NULL,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_idw_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Idw interpolation — wbt_idw_interpolation","text":"input Input vector Points file. field Input field name attribute table. output Output raster file. use_z Use z-coordinate instead field?. weight IDW weight value. radius Search Radius map units. min_points Minimum number points. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_idw_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Idw interpolation — wbt_idw_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ihs_to_rgb.html","id":null,"dir":"Reference","previous_headings":"","what":"Ihs to rgb — wbt_ihs_to_rgb","title":"Ihs to rgb — wbt_ihs_to_rgb","text":"Converts intensity, hue, saturation (IHS) images red, green, blue (RGB) images.","code":""},{"path":"/reference/wbt_ihs_to_rgb.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ihs to rgb — wbt_ihs_to_rgb","text":"","code":"wbt_ihs_to_rgb(   intensity,   hue,   saturation,   red = NULL,   green = NULL,   blue = NULL,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ihs_to_rgb.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ihs to rgb — wbt_ihs_to_rgb","text":"intensity Input intensity file. hue Input hue file. saturation Input saturation file. red Output red band file. Optionally specified colour-composite specified. green Output green band file. Optionally specified colour-composite specified. blue Output blue band file. Optionally specified colour-composite specified. output Output colour-composite file. used individual bands specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ihs_to_rgb.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ihs to rgb — wbt_ihs_to_rgb","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_autocorrelation.html","id":null,"dir":"Reference","previous_headings":"","what":"Image autocorrelation — wbt_image_autocorrelation","title":"Image autocorrelation — wbt_image_autocorrelation","text":"Performs Moran's analysis two input images.","code":""},{"path":"/reference/wbt_image_autocorrelation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image autocorrelation — wbt_image_autocorrelation","text":"","code":"wbt_image_autocorrelation(   inputs,   output,   contiguity = \"Rook\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_autocorrelation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image autocorrelation — wbt_image_autocorrelation","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output HTML file (default name based input file unspecified). contiguity Contiguity type. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_autocorrelation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image autocorrelation — wbt_image_autocorrelation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_correlation.html","id":null,"dir":"Reference","previous_headings":"","what":"Image correlation — wbt_image_correlation","title":"Image correlation — wbt_image_correlation","text":"Performs image correlation two input images.","code":""},{"path":"/reference/wbt_image_correlation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image correlation — wbt_image_correlation","text":"","code":"wbt_image_correlation(   inputs,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_correlation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image correlation — wbt_image_correlation","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_correlation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image correlation — wbt_image_correlation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_correlation_neighbourhood_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Image correlation neighbourhood analysis — wbt_image_correlation_neighbourhood_analysis","title":"Image correlation neighbourhood analysis — wbt_image_correlation_neighbourhood_analysis","text":"Performs image correlation two input images neighbourhood search windows.","code":""},{"path":"/reference/wbt_image_correlation_neighbourhood_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image correlation neighbourhood analysis — wbt_image_correlation_neighbourhood_analysis","text":"","code":"wbt_image_correlation_neighbourhood_analysis(   input1,   input2,   output1,   output2,   filter = 11,   stat = \"pearson\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_correlation_neighbourhood_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image correlation neighbourhood analysis — wbt_image_correlation_neighbourhood_analysis","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file path. See wbt_file_path() details. output1 Output correlation (r-value rho) raster file. output2 Output significance (p-value) raster file. filter Size filter kernel. stat Correlation type; one 'pearson' (default) 'spearman'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_correlation_neighbourhood_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image correlation neighbourhood analysis — wbt_image_correlation_neighbourhood_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Image regression — wbt_image_regression","title":"Image regression — wbt_image_regression","text":"Performs image regression analysis two input images.","code":""},{"path":"/reference/wbt_image_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image regression — wbt_image_regression","text":"","code":"wbt_image_regression(   input1,   input2,   output,   out_residuals = NULL,   standardize = FALSE,   scattergram = FALSE,   num_samples = 1000,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image regression — wbt_image_regression","text":"input1 Input raster file (independent variable, X). input2 Input raster file (dependent variable, Y). output Output HTML file regression summary report. out_residuals Output raster regression residual file. standardize Optional flag indicating whether standardize residuals map. scattergram Optional flag indicating whether output scattergram. num_samples Number samples used create scattergram. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image regression — wbt_image_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_segmentation.html","id":null,"dir":"Reference","previous_headings":"","what":"Image segmentation — wbt_image_segmentation","title":"Image segmentation — wbt_image_segmentation","text":"Performs region-growing based segmentation set multi-spectral images.","code":""},{"path":"/reference/wbt_image_segmentation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image segmentation — wbt_image_segmentation","text":"","code":"wbt_image_segmentation(   inputs,   output,   threshold = 0.5,   steps = 10,   min_area = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_segmentation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image segmentation — wbt_image_segmentation","text":"inputs Names input band images. output Name output raster file. threshold Distance threshold, z-scores. steps Number steps. min_area Minimum object area, grid cells (1-8). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_segmentation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image segmentation — wbt_image_segmentation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_slider.html","id":null,"dir":"Reference","previous_headings":"","what":"Image slider — wbt_image_slider","title":"Image slider — wbt_image_slider","text":"tool creates image slider two input images.","code":""},{"path":"/reference/wbt_image_slider.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image slider — wbt_image_slider","text":"","code":"wbt_image_slider(   input1,   input2,   output,   palette1 = \"grey\",   reverse1 = FALSE,   label1 = \"\",   palette2 = \"grey\",   reverse2 = FALSE,   label2 = \"\",   height = 600,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_slider.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image slider — wbt_image_slider","text":"input1 Name left input image file. input2 Name right input image file. output Name output HTML file (*.html). palette1 Left image palette; options 'grey', 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', 'rgb'. reverse1 Reverse left image palette?. label1 Left image label (leave blank none). palette2 Right image palette; options 'grey', 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', 'rgb'. reverse2 Reverse right image palette?. label2 Right image label (leave blank none). height Image height, pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_slider.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image slider — wbt_image_slider","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_stack_profile.html","id":null,"dir":"Reference","previous_headings":"","what":"Image stack profile — wbt_image_stack_profile","title":"Image stack profile — wbt_image_stack_profile","text":"Plots image stack profile (.e. signature) set points multispectral images.","code":""},{"path":"/reference/wbt_image_stack_profile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image stack profile — wbt_image_stack_profile","text":"","code":"wbt_image_stack_profile(   inputs,   points,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_stack_profile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image stack profile — wbt_image_stack_profile","text":"inputs Input multispectral image files. points Input vector points file. output Output HTML file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_stack_profile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image stack profile — wbt_image_stack_profile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_impoundment_size_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Impoundment size index — wbt_impoundment_size_index","title":"Impoundment size index — wbt_impoundment_size_index","text":"Calculates impoundment size resulting damming DEM.","code":""},{"path":"/reference/wbt_impoundment_size_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Impoundment size index — wbt_impoundment_size_index","text":"","code":"wbt_impoundment_size_index(   dem,   damlength,   out_mean = NULL,   out_max = NULL,   out_volume = NULL,   out_area = NULL,   out_dam_height = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_impoundment_size_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Impoundment size index — wbt_impoundment_size_index","text":"dem Input raster DEM file. damlength Maximum length dam. 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. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_impoundment_size_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Impoundment size index — wbt_impoundment_size_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_in_place_add.html","id":null,"dir":"Reference","previous_headings":"","what":"In place add — wbt_in_place_add","title":"In place add — wbt_in_place_add","text":"Performs -place addition operation (input1 += input2).","code":""},{"path":"/reference/wbt_in_place_add.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"In place add — wbt_in_place_add","text":"","code":"wbt_in_place_add(   input1,   input2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_in_place_add.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"In place add — wbt_in_place_add","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file constant value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_in_place_add.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"In place add — wbt_in_place_add","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_in_place_divide.html","id":null,"dir":"Reference","previous_headings":"","what":"In place divide — wbt_in_place_divide","title":"In place divide — wbt_in_place_divide","text":"Performs -place division operation (input1 /= input2).","code":""},{"path":"/reference/wbt_in_place_divide.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"In place divide — wbt_in_place_divide","text":"","code":"wbt_in_place_divide(   input1,   input2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_in_place_divide.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"In place divide — wbt_in_place_divide","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file constant value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_in_place_divide.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"In place divide — wbt_in_place_divide","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_in_place_multiply.html","id":null,"dir":"Reference","previous_headings":"","what":"In place multiply — wbt_in_place_multiply","title":"In place multiply — wbt_in_place_multiply","text":"Performs -place multiplication operation (input1 *= input2).","code":""},{"path":"/reference/wbt_in_place_multiply.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"In place multiply — wbt_in_place_multiply","text":"","code":"wbt_in_place_multiply(   input1,   input2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_in_place_multiply.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"In place multiply — wbt_in_place_multiply","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file constant value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_in_place_multiply.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"In place multiply — wbt_in_place_multiply","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_in_place_subtract.html","id":null,"dir":"Reference","previous_headings":"","what":"In place subtract — wbt_in_place_subtract","title":"In place subtract — wbt_in_place_subtract","text":"Performs -place subtraction operation (input1 -= input2).","code":""},{"path":"/reference/wbt_in_place_subtract.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"In place subtract — wbt_in_place_subtract","text":"","code":"wbt_in_place_subtract(   input1,   input2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_in_place_subtract.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"In place subtract — wbt_in_place_subtract","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file constant value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_in_place_subtract.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"In place subtract — wbt_in_place_subtract","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_increment.html","id":null,"dir":"Reference","previous_headings":"","what":"Increment — wbt_increment","title":"Increment — wbt_increment","text":"Increases values grid cell input raster 1.0. (see also InPlaceAdd).","code":""},{"path":"/reference/wbt_increment.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Increment — wbt_increment","text":"","code":"wbt_increment(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_increment.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Increment — wbt_increment","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_increment.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Increment — wbt_increment","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_individual_tree_detection.html","id":null,"dir":"Reference","previous_headings":"","what":"Individual tree detection — wbt_individual_tree_detection","title":"Individual tree detection — wbt_individual_tree_detection","text":"Identifies points LiDAR point cloud associated tops individual trees.","code":""},{"path":"/reference/wbt_individual_tree_detection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Individual tree detection — wbt_individual_tree_detection","text":"","code":"wbt_individual_tree_detection(   input,   output = NULL,   min_search_radius = 1,   min_height = 0,   max_search_radius = \"\",   max_height = \"\",   only_use_veg = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_individual_tree_detection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Individual tree detection — wbt_individual_tree_detection","text":"input Name input LiDAR file. output Name output vector points file. min_search_radius Minimum search radius (m). min_height Minimum height (m). max_search_radius Maximum search radius (m). max_height Maximum height (m). only_use_veg use veg. class points?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_individual_tree_detection.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Individual tree detection — wbt_individual_tree_detection","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_init.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize 'WhiteboxTools' — wbt_init","title":"Initialize 'WhiteboxTools' — wbt_init","text":"wbt_init(): Check suitable 'WhiteboxTools' executable present. Search default path package directory set manually exe_path. wbt_options(): Get/set package options whitebox.exe_path - character. Path executable file. default value package installation directory, subdirectory \"WBT\", followed whitebox_tools.exe whitebox_tools. Set whitebox.exe_path option using wbt_init() exe_path argument whitebox.wd - character. Path WhiteboxTools working directory. Used --wd argument tools support wd specified elsewhere. whitebox.verbose - logical. standard output calls executable cat() readability? whitebox.verbose=FALSE output produced. Set value whitebox.verbose wbt_verbose() verbose argument. Default result interactive() R package options unset. whitebox.compress_rasters - logical. raster output WhiteboxTools compressed? Default: NULL uses existing WhiteboxTools settings. Set value whitebox.compress_rasters wbt_compress_rasters() compress_rasters argument. whitebox.max_procs - integer. Maximum number processes tools run parallel partially parallelize. Default: -1 uses available cores. wbt_exe_path(): Get file path 'WhiteboxTools' executable. wbt_runner_path(): Get file path 'WhiteboxTools Runner' executable. wbt_default_path(): Get default file path 'WhiteboxTools' executable. wbt_data_dir(): Get directory 'WhiteboxTools' data stored. wbt_wd(): Get set 'WhiteboxTools' working directory. Default: \"\" (unset) R working directory options set. wbt_verbose(): Check verbose options 'WhiteboxTools' wbt_compress_rasters(): Check raster compression option 'WhiteboxTools'. Default behavior based WhiteboxTools settings.json, package options (set). Raster compression settings can overridden wbt_*() function call passing compress_rasters argument directly. wbt_max_procs(): Check maximum number processes  tools run parallel partially parallelize. Default: -1 uses available cores.","code":""},{"path":"/reference/wbt_init.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize 'WhiteboxTools' — wbt_init","text":"","code":"wbt_init(   exe_path = wbt_exe_path(shell_quote = FALSE),   ...,   check_version = TRUE )  wbt_options(   exe_path = NULL,   wd = NULL,   verbose = NULL,   compress_rasters = NULL,   max_procs = NULL )  wbt_exe_path(exe_path = NULL, shell_quote = TRUE)  wbt_runner_path(shell_quote = TRUE)  wbt_default_path()  wbt_data_dir()  wbt_wd(wd = NULL)  wbt_verbose(verbose = NULL)  wbt_compress_rasters(compress_rasters = NULL)  wbt_max_procs(max_procs = NULL)"},{"path":"/reference/wbt_init.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize 'WhiteboxTools' — wbt_init","text":"exe_path Optional: User-supplied path 'WhiteboxTools' executable. Default: NULL ... additional arguments wbt_options() check_version Check version 'WhiteboxTools' installed version R package built ? Default: TRUE wd character; Default: NULL; set package option whitebox.wd set specified path (directory exists) verbose logical. Default: NULL; TRUE FALSE, set package option whitebox.verbose specified value. Tool verbosity settings can overridden wbt_*() function call passing verbose_mode argument directly. compress_rasters logical. Default: NULL; TRUE FALSE, set package option whitebox.compress_rasters specified value. max_procs Default: NULL; integer, set package option whitebox.max_procs specified value shell_quote Return shQuote() result?","code":""},{"path":"/reference/wbt_init.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize 'WhiteboxTools' — wbt_init","text":"wbt_init(): logical; TRUE binary file found exe_path wbt_options(): invisible list containing current whitebox.exe_path, whitebox.verbose, whitebox.compress_rasters, whitebox.max_procs options Returns file path 'WhiteboxTools' executable. wbt_wd(): character; working directory unset, add --wd= arguments calls using getwd(). See Details. wbt_verbose(): logical; returns result option \"whitebox.verbose_mode\", unset defaults result interactive(). wbt_compress_rasters(): logical; returns result option \"whitebox.compress_rasters\", unset defaults NA. wbt_max_procs(): integer; defaults NA_integer_","code":""},{"path":"/reference/wbt_init.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Initialize 'WhiteboxTools' — wbt_init","text":"wbt_exe_path(): Checks system environment variable R_WHITEBOX_EXE_PATH package option whitebox.exe_path. Set desired path either Sys.setenv(R_WHITEBOX_EXE_PATH = \"C:/path//whitebox_tools.exe\") options(whitebox.exe_path = \"C:/path//whitebox_tools.exe\"). default, backwards-compatible path returned wbt_default_path() wbt_runner_path(): Returns path 'WhiteboxTools Runner' including platform-specific executable (without .exe extension) wbt_default_path(): Returns path 'WhiteboxTools' executable including platform-specific executable (without .exe extension) wbt_data_dir(): Uses platform-specific user data directory tools::R_user_dir(package = \"whitebox\", = \"data\") R 4.0+. R<4 returns original default find.package(\"whitebox\"). wbt_wd(): set working directory session default output current R working directory unless otherwise specified. can change working directory time setting wd argument wbt_wd() running tool. Note set working directory, directory needs set somewhere \"replace\" old value; just dropping flag change working directory back R working directory. \"unset\" option R package can use wbt_wd(\"\") removes --wd flag commands sets working_directory value WhiteboxTools settings.json \"\".","code":""},{"path":[]},{"path":"/reference/wbt_init.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize 'WhiteboxTools' — wbt_init","text":"","code":"if (FALSE) { ## wbt_init():  # set path to binary as an argument # wbt_init(exe_path = \"not/a/valid/path/whitebox_tools.exe\") } if (FALSE) {  ## wbt_options():  # set multiple options (e.g. exe_path and verbose) with wbt_options() wbt_options(exe_path = \"not/a/valid/path/whitebox_tools.exe\", verbose = TRUE)  } if (FALSE) { wbt_exe_path() } if (FALSE) {  ## wbt_wd():  # no working directory set wbt_wd(wd = \"\")  # set WBT working directory to R working directory wbt_wd(wd = getwd()) } if (FALSE) {  ## wbt_verbose():  wbt_verbose(verbose = TRUE) } if (FALSE) {  ## wbt_compress_rasters():  wbt_compress_rasters(compress_rasters = TRUE) } if (FALSE) {  ## wbt_max_procs():  wbt_max_procs(max_procs = 2) }"},{"path":"/reference/wbt_insert_dams.html","id":null,"dir":"Reference","previous_headings":"","what":"Insert dams — wbt_insert_dams","title":"Insert dams — wbt_insert_dams","text":"Calculates impoundment size resulting damming DEM.","code":""},{"path":"/reference/wbt_insert_dams.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Insert dams — wbt_insert_dams","text":"","code":"wbt_insert_dams(   dem,   dam_pts,   output,   damlength,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_insert_dams.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Insert dams — wbt_insert_dams","text":"dem Input raster DEM file. dam_pts Input vector dam points file. output Output file. damlength Maximum length dam. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_insert_dams.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Insert dams — wbt_insert_dams","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_install_wb_extension.html","id":null,"dir":"Reference","previous_headings":"","what":"Install wb extension — wbt_install_wb_extension","title":"Install wb extension — wbt_install_wb_extension","text":"Use install Whitebox extension product.","code":""},{"path":"/reference/wbt_install_wb_extension.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install wb extension — wbt_install_wb_extension","text":"","code":"wbt_install_wb_extension(   install_extension = \"General Toolset Extension\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_install_wb_extension.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install wb extension — wbt_install_wb_extension","text":"install_extension Name extension product install. Options include: 'General Toolset Extension', 'DEM & Spatial Hydrology Extension', 'Lidar & Remote Sensing Extension', 'Agriculture Extension'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_install_wb_extension.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Install wb extension — wbt_install_wb_extension","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_integer_division.html","id":null,"dir":"Reference","previous_headings":"","what":"Integer division — wbt_integer_division","title":"Integer division — wbt_integer_division","text":"Performs integer division operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_integer_division.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Integer division — wbt_integer_division","text":"","code":"wbt_integer_division(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_integer_division.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Integer division — wbt_integer_division","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_integer_division.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Integer division — wbt_integer_division","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_integral_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Integral image — wbt_integral_image","title":"Integral image — wbt_integral_image","text":"Transforms input image (summed area table) integral image equivalent.","code":""},{"path":"/reference/wbt_integral_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Integral image — wbt_integral_image","text":"","code":"wbt_integral_image(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_integral_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Integral image — wbt_integral_image","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_integral_image.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Integral image — wbt_integral_image","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_intersect.html","id":null,"dir":"Reference","previous_headings":"","what":"Intersect — wbt_intersect","title":"Intersect — wbt_intersect","text":"Identifies parts features common two input vector layers.","code":""},{"path":"/reference/wbt_intersect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Intersect — wbt_intersect","text":"","code":"wbt_intersect(   input,   overlay,   output,   snap = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_intersect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Intersect — wbt_intersect","text":"input Input vector file path. See wbt_file_path() details. overlay Input overlay vector file. output Output vector file. snap Snap tolerance. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_intersect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Intersect — wbt_intersect","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_inverse_principal_component_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Inverse principal component analysis — wbt_inverse_principal_component_analysis","title":"Inverse principal component analysis — wbt_inverse_principal_component_analysis","text":"tool performs inverse principal component analysis series input component images.","code":""},{"path":"/reference/wbt_inverse_principal_component_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Inverse principal component analysis — wbt_inverse_principal_component_analysis","text":"","code":"wbt_inverse_principal_component_analysis(   inputs,   report,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_inverse_principal_component_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Inverse principal component analysis — wbt_inverse_principal_component_analysis","text":"inputs Name input PCA component images. report Name PCA report file (*.html). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_inverse_principal_component_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Inverse principal component analysis — wbt_inverse_principal_component_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_is_no_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Is no data — wbt_is_no_data","title":"Is no data — wbt_is_no_data","text":"Identifies NoData valued pixels image.","code":""},{"path":"/reference/wbt_is_no_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is no data — wbt_is_no_data","text":"","code":"wbt_is_no_data(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_is_no_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is no data — wbt_is_no_data","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_is_no_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Is no data — wbt_is_no_data","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_isobasins.html","id":null,"dir":"Reference","previous_headings":"","what":"Isobasins — wbt_isobasins","title":"Isobasins — wbt_isobasins","text":"Divides landscape nearly equal sized drainage basins (.e. watersheds).","code":""},{"path":"/reference/wbt_isobasins.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Isobasins — wbt_isobasins","text":"","code":"wbt_isobasins(   dem,   output,   size,   connections = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_isobasins.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Isobasins — wbt_isobasins","text":"dem Input raster DEM file. output Output raster file. size Target basin size, grid cells. connections Output upstream-downstream flow connections among basins?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_isobasins.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Isobasins — wbt_isobasins","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_jenson_snap_pour_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Jenson snap pour points — wbt_jenson_snap_pour_points","title":"Jenson snap pour points — wbt_jenson_snap_pour_points","text":"Moves outlet points used specify points interest watershedding operation nearest stream cell.","code":""},{"path":"/reference/wbt_jenson_snap_pour_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Jenson snap pour points — wbt_jenson_snap_pour_points","text":"","code":"wbt_jenson_snap_pour_points(   pour_pts,   streams,   output,   snap_dist,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_jenson_snap_pour_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Jenson snap pour points — wbt_jenson_snap_pour_points","text":"pour_pts Input vector pour points (outlet) file. streams Input raster streams file. output Output vector file. snap_dist Maximum snap distance map units. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_jenson_snap_pour_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Jenson snap pour points — wbt_jenson_snap_pour_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_join_tables.html","id":null,"dir":"Reference","previous_headings":"","what":"Join tables — wbt_join_tables","title":"Join tables — wbt_join_tables","text":"Merge vector's attribute table another table based common field.","code":""},{"path":"/reference/wbt_join_tables.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Join tables — wbt_join_tables","text":"","code":"wbt_join_tables(   input1,   pkey,   input2,   fkey,   import_field = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_join_tables.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Join tables — wbt_join_tables","text":"input1 Input primary vector file (.e. table modified). pkey Primary key field. input2 Input foreign vector file (.e. source data imported). fkey Foreign key field. import_field Imported field (fields imported specified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_join_tables.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Join tables — wbt_join_tables","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_k_means_clustering.html","id":null,"dir":"Reference","previous_headings":"","what":"K means clustering — wbt_k_means_clustering","title":"K means clustering — wbt_k_means_clustering","text":"Performs k-means clustering operation multi-spectral dataset.","code":""},{"path":"/reference/wbt_k_means_clustering.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"K means clustering — wbt_k_means_clustering","text":"","code":"wbt_k_means_clustering(   inputs,   output,   classes,   out_html = NULL,   max_iterations = 10,   class_change = 2,   initialize = \"diagonal\",   min_class_size = 10,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_k_means_clustering.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"K means clustering — wbt_k_means_clustering","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. classes Number classes. out_html Output HTML report file. max_iterations Maximum number iterations. class_change Minimum percent cells changed iterations completion. initialize initialize cluster centres?. min_class_size Minimum class size, pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_k_means_clustering.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"K means clustering — wbt_k_means_clustering","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_k_nearest_mean_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"K nearest mean filter — wbt_k_nearest_mean_filter","title":"K nearest mean filter — wbt_k_nearest_mean_filter","text":"k-nearest mean filter type edge-preserving smoothing filter.","code":""},{"path":"/reference/wbt_k_nearest_mean_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"K nearest mean filter — wbt_k_nearest_mean_filter","text":"","code":"wbt_k_nearest_mean_filter(   input,   output,   filterx = 11,   filtery = 11,   k = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_k_nearest_mean_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"K nearest mean filter — wbt_k_nearest_mean_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. k k-value pixels; number nearest-valued neighbours use. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_k_nearest_mean_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"K nearest mean filter — wbt_k_nearest_mean_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_kappa_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Kappa index — wbt_kappa_index","title":"Kappa index — wbt_kappa_index","text":"Performs kappa index agreement (KIA) analysis two categorical raster files.","code":""},{"path":"/reference/wbt_kappa_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Kappa index — wbt_kappa_index","text":"","code":"wbt_kappa_index(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_kappa_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Kappa index — wbt_kappa_index","text":"input1 Input classification raster file. input2 Input reference raster file. output Output HTML file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_kappa_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Kappa index — wbt_kappa_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_knn_classification.html","id":null,"dir":"Reference","previous_headings":"","what":"Knn classification — wbt_knn_classification","title":"Knn classification — wbt_knn_classification","text":"Performs supervised k-nearest neighbour classification using training site polygons/points predictor rasters.","code":""},{"path":"/reference/wbt_knn_classification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Knn classification — wbt_knn_classification","text":"","code":"wbt_knn_classification(   inputs,   training,   field,   scaling = \"Normalize\",   output = NULL,   k = 5,   clip = TRUE,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_knn_classification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Knn classification — wbt_knn_classification","text":"inputs Names input predictor rasters. training Name input training site polygons/points shapefile. field Name attribute containing class name data. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. output Name output raster file. k k-parameter, determines number nearest neighbours used. clip Perform training data clipping remove outlier pixels?. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_knn_classification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Knn classification — wbt_knn_classification","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_knn_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Knn regression — wbt_knn_regression","title":"Knn regression — wbt_knn_regression","text":"Performs supervised k-nearest neighbour regression using training site points predictor rasters.","code":""},{"path":"/reference/wbt_knn_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Knn regression — wbt_knn_regression","text":"","code":"wbt_knn_regression(   inputs,   training,   field,   scaling = \"Normalize\",   output = NULL,   k = 5,   weight = TRUE,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_knn_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Knn regression — wbt_knn_regression","text":"inputs Names input predictor rasters. training Name input training site points Shapefile. field Name attribute containing response variable name data. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. output Name output raster file. k k-parameter, determines number nearest neighbours used. weight Use distance weighting?. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_knn_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Knn regression — wbt_knn_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ks_test_for_normality.html","id":null,"dir":"Reference","previous_headings":"","what":"Ks test for normality — wbt_ks_test_for_normality","title":"Ks test for normality — wbt_ks_test_for_normality","text":"Evaluates whether values raster normally distributed.","code":""},{"path":"/reference/wbt_ks_test_for_normality.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ks test for normality — wbt_ks_test_for_normality","text":"","code":"wbt_ks_test_for_normality(   input,   output,   num_samples = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ks_test_for_normality.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ks test for normality — wbt_ks_test_for_normality","text":"input Input raster file path. See wbt_file_path() details. output Output HTML file. num_samples Number samples. Leave blank use whole image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ks_test_for_normality.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ks test for normality — wbt_ks_test_for_normality","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_laplacian_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Laplacian filter — wbt_laplacian_filter","title":"Laplacian filter — wbt_laplacian_filter","text":"Performs Laplacian filter image.","code":""},{"path":"/reference/wbt_laplacian_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Laplacian filter — wbt_laplacian_filter","text":"","code":"wbt_laplacian_filter(   input,   output,   variant = \"3x3(1)\",   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_laplacian_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Laplacian filter — wbt_laplacian_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. variant Optional variant value. Options include 3x3(1), 3x3(2), 3x3(3), 3x3(4), 5x5(1), 5x5(2) (default 3x3(1)). clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_laplacian_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Laplacian filter — wbt_laplacian_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_laplacian_of_gaussian_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Laplacian of gaussian filter — wbt_laplacian_of_gaussian_filter","title":"Laplacian of gaussian filter — wbt_laplacian_of_gaussian_filter","text":"Performs Laplacian--Gaussian (LoG) filter image.","code":""},{"path":"/reference/wbt_laplacian_of_gaussian_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Laplacian of gaussian filter — wbt_laplacian_of_gaussian_filter","text":"","code":"wbt_laplacian_of_gaussian_filter(   input,   output,   sigma = 0.75,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_laplacian_of_gaussian_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Laplacian of gaussian filter — wbt_laplacian_of_gaussian_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma Standard deviation pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_laplacian_of_gaussian_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Laplacian of gaussian filter — wbt_laplacian_of_gaussian_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_las_to_ascii.html","id":null,"dir":"Reference","previous_headings":"","what":"Las to ascii — wbt_las_to_ascii","title":"Las to ascii — wbt_las_to_ascii","text":"Converts one LAS files ASCII text files.","code":""},{"path":"/reference/wbt_las_to_ascii.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Las to ascii — wbt_las_to_ascii","text":"","code":"wbt_las_to_ascii(   inputs,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_las_to_ascii.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Las to ascii — wbt_las_to_ascii","text":"inputs Input LiDAR files. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_las_to_ascii.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Las to ascii — wbt_las_to_ascii","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_las_to_laz.html","id":null,"dir":"Reference","previous_headings":"","what":"Las to laz — wbt_las_to_laz","title":"Las to laz — wbt_las_to_laz","text":"tool converts one LAS files LAZ format.","code":""},{"path":"/reference/wbt_las_to_laz.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Las to laz — wbt_las_to_laz","text":"","code":"wbt_las_to_laz(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_las_to_laz.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Las to laz — wbt_las_to_laz","text":"input Name input LAS files (leave blank use LAS files WorkingDirectory. output Output LAZ file (including extension). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_las_to_laz.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Las to laz — wbt_las_to_laz","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_las_to_multipoint_shapefile.html","id":null,"dir":"Reference","previous_headings":"","what":"Las to multipoint shapefile — wbt_las_to_multipoint_shapefile","title":"Las to multipoint shapefile — wbt_las_to_multipoint_shapefile","text":"Converts one LAS files MultipointZ vector Shapefiles. input parameter specified, tool grids LAS files contained within working directory.","code":""},{"path":"/reference/wbt_las_to_multipoint_shapefile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Las to multipoint shapefile — wbt_las_to_multipoint_shapefile","text":"","code":"wbt_las_to_multipoint_shapefile(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_las_to_multipoint_shapefile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Las to multipoint shapefile — wbt_las_to_multipoint_shapefile","text":"input Input LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_las_to_multipoint_shapefile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Las to multipoint shapefile — wbt_las_to_multipoint_shapefile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_las_to_shapefile.html","id":null,"dir":"Reference","previous_headings":"","what":"Las to shapefile — wbt_las_to_shapefile","title":"Las to shapefile — wbt_las_to_shapefile","text":"Converts one LAS files vector Shapefile POINT ShapeType.","code":""},{"path":"/reference/wbt_las_to_shapefile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Las to shapefile — wbt_las_to_shapefile","text":"","code":"wbt_las_to_shapefile(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_las_to_shapefile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Las to shapefile — wbt_las_to_shapefile","text":"input Input LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_las_to_shapefile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Las to shapefile — wbt_las_to_shapefile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_las_to_zlidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Las to zlidar — wbt_las_to_zlidar","title":"Las to zlidar — wbt_las_to_zlidar","text":"Converts one LAS files zlidar compressed LiDAR data format.","code":""},{"path":"/reference/wbt_las_to_zlidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Las to zlidar — wbt_las_to_zlidar","text":"","code":"wbt_las_to_zlidar(   inputs = NULL,   outdir = NULL,   compress = \"brotli\",   level = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_las_to_zlidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Las to zlidar — wbt_las_to_zlidar","text":"inputs Input LAS files. outdir Output directory zlidar files created. unspecified, assumed inputs. compress Compression method, including 'brotli' 'deflate'. level Compression level (1-9). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_las_to_zlidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Las to zlidar — wbt_las_to_zlidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_launch_runner.html","id":null,"dir":"Reference","previous_headings":"","what":"Launch 'WhiteboxTools Runner' GUI — wbt_launch_runner","title":"Launch 'WhiteboxTools Runner' GUI — wbt_launch_runner","text":"wbt_launch_runner(): Launch 'WhiteboxTools Runner' GUI wbt_runner_path()","code":""},{"path":"/reference/wbt_launch_runner.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Launch 'WhiteboxTools Runner' GUI — wbt_launch_runner","text":"","code":"wbt_launch_runner(clear_app_state = FALSE)"},{"path":"/reference/wbt_launch_runner.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Launch 'WhiteboxTools Runner' GUI — wbt_launch_runner","text":"clear_app_state Clear application state memory? Default: FALSE","code":""},{"path":"/reference/wbt_launch_runner.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Launch 'WhiteboxTools Runner' GUI — wbt_launch_runner","text":"Opens 'WhiteboxTools Runner' GUI included WhiteboxTools Open Core v2.3.0 higher.","code":""},{"path":[]},{"path":"/reference/wbt_launch_wb_runner.html","id":null,"dir":"Reference","previous_headings":"","what":"Launch wb runner — wbt_launch_wb_runner","title":"Launch wb runner — wbt_launch_wb_runner","text":"Opens Whitebox Runner application.","code":""},{"path":"/reference/wbt_launch_wb_runner.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Launch wb runner — wbt_launch_wb_runner","text":"","code":"wbt_launch_wb_runner(   clear_app_state = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_launch_wb_runner.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Launch wb runner — wbt_launch_wb_runner","text":"clear_app_state Clear application state memory?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_launch_wb_runner.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Launch wb runner — wbt_launch_wb_runner","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_layer_footprint.html","id":null,"dir":"Reference","previous_headings":"","what":"Layer footprint — wbt_layer_footprint","title":"Layer footprint — wbt_layer_footprint","text":"Creates vector polygon footprint area covered raster grid vector layer.","code":""},{"path":"/reference/wbt_layer_footprint.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Layer footprint — wbt_layer_footprint","text":"","code":"wbt_layer_footprint(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_layer_footprint.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Layer footprint — wbt_layer_footprint","text":"input Input raster vector file. output Output vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_layer_footprint.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Layer footprint — wbt_layer_footprint","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_laz_to_las.html","id":null,"dir":"Reference","previous_headings":"","what":"Laz to las — wbt_laz_to_las","title":"Laz to las — wbt_laz_to_las","text":"tool converts one LAZ files LAS format.","code":""},{"path":"/reference/wbt_laz_to_las.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Laz to las — wbt_laz_to_las","text":"","code":"wbt_laz_to_las(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_laz_to_las.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Laz to las — wbt_laz_to_las","text":"input Name input LAZ files (leave blank use LAZ files WorkingDirectory. output Output LAS file (including extension). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_laz_to_las.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Laz to las — wbt_laz_to_las","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lee_sigma_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Lee sigma filter — wbt_lee_sigma_filter","title":"Lee sigma filter — wbt_lee_sigma_filter","text":"Performs Lee (Sigma) smoothing filter image.","code":""},{"path":"/reference/wbt_lee_sigma_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lee sigma filter — wbt_lee_sigma_filter","text":"","code":"wbt_lee_sigma_filter(   input,   output,   filterx = 11,   filtery = 11,   sigma = 10,   m = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lee_sigma_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lee sigma filter — wbt_lee_sigma_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. sigma Sigma value related standard deviation distribution image speckle noise. m M-threshold value minimum allowable number pixels within intensity range. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lee_sigma_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lee sigma filter — wbt_lee_sigma_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_length_of_upstream_channels.html","id":null,"dir":"Reference","previous_headings":"","what":"Length of upstream channels — wbt_length_of_upstream_channels","title":"Length of upstream channels — wbt_length_of_upstream_channels","text":"Calculates total length channels upstream.","code":""},{"path":"/reference/wbt_length_of_upstream_channels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Length of upstream channels — wbt_length_of_upstream_channels","text":"","code":"wbt_length_of_upstream_channels(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_length_of_upstream_channels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Length of upstream channels — wbt_length_of_upstream_channels","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_length_of_upstream_channels.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Length of upstream channels — wbt_length_of_upstream_channels","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_less_than.html","id":null,"dir":"Reference","previous_headings":"","what":"Less than — wbt_less_than","title":"Less than — wbt_less_than","text":"Performs less-comparison operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_less_than.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Less than — wbt_less_than","text":"","code":"wbt_less_than(   input1,   input2,   output,   incl_equals = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_less_than.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Less than — wbt_less_than","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. incl_equals Perform less---equal-operation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_less_than.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Less than — wbt_less_than","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_license.html","id":null,"dir":"Reference","previous_headings":"","what":"License information for 'WhiteboxTools' — wbt_license","title":"License information for 'WhiteboxTools' — wbt_license","text":"License information 'WhiteboxTools'","code":""},{"path":"/reference/wbt_license.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"License information for 'WhiteboxTools' — wbt_license","text":"","code":"wbt_license()"},{"path":"/reference/wbt_license.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"License information for 'WhiteboxTools' — wbt_license","text":"Returns license information WhiteboxTools R character vector.","code":""},{"path":"/reference/wbt_license.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"License information for 'WhiteboxTools' — wbt_license","text":"","code":"if (FALSE) { wbt_license() }"},{"path":"/reference/wbt_lidar_block_maximum.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar block maximum — wbt_lidar_block_maximum","title":"Lidar block maximum — wbt_lidar_block_maximum","text":"Creates block-maximum raster input LAS file. input/output parameters specified, tool grids LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_block_maximum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar block maximum — wbt_lidar_block_maximum","text":"","code":"wbt_lidar_block_maximum(   input,   output = NULL,   resolution = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_block_maximum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar block maximum — wbt_lidar_block_maximum","text":"input Input LiDAR file. output Output file. resolution Output raster's grid resolution. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_block_maximum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar block maximum — wbt_lidar_block_maximum","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_block_minimum.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar block minimum — wbt_lidar_block_minimum","title":"Lidar block minimum — wbt_lidar_block_minimum","text":"Creates block-minimum raster input LAS file. input/output parameters specified, tool grids LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_block_minimum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar block minimum — wbt_lidar_block_minimum","text":"","code":"wbt_lidar_block_minimum(   input,   output = NULL,   resolution = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_block_minimum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar block minimum — wbt_lidar_block_minimum","text":"input Input LiDAR file. output Output file. resolution Output raster's grid resolution. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_block_minimum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar block minimum — wbt_lidar_block_minimum","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_classify_subset.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar classify subset — wbt_lidar_classify_subset","title":"Lidar classify subset — wbt_lidar_classify_subset","text":"Classifies values one LiDAR point cloud correspond points subset cloud.","code":""},{"path":"/reference/wbt_lidar_classify_subset.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar classify subset — wbt_lidar_classify_subset","text":"","code":"wbt_lidar_classify_subset(   base,   subset,   output,   subset_class,   nonsubset_class = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_classify_subset.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar classify subset — wbt_lidar_classify_subset","text":"base Input base LiDAR file. subset Input subset LiDAR file. output Output LiDAR file. subset_class Subset point class value (must 0-18; see LAS specifications). nonsubset_class Non-subset point class value (must 0-18; see LAS specifications). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_classify_subset.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar classify subset — wbt_lidar_classify_subset","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_colourize.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar colourize — wbt_lidar_colourize","title":"Lidar colourize — wbt_lidar_colourize","text":"Adds red-green-blue colour fields LiDAR (LAS) file based input image.","code":""},{"path":"/reference/wbt_lidar_colourize.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar colourize — wbt_lidar_colourize","text":"","code":"wbt_lidar_colourize(   in_lidar,   in_image,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_colourize.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar colourize — wbt_lidar_colourize","text":"in_lidar Input LiDAR file. in_image Input colour image file. output Output LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_colourize.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar colourize — wbt_lidar_colourize","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_contour.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar contour — wbt_lidar_contour","title":"Lidar contour — wbt_lidar_contour","text":"tool creates vector contour coverage input LiDAR point file.","code":""},{"path":"/reference/wbt_lidar_contour.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar contour — wbt_lidar_contour","text":"","code":"wbt_lidar_contour(   input,   output = NULL,   interval = 10,   base = 0,   smooth = 5,   parameter = \"elevation\",   returns = \"all\",   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   max_triangle_edge_length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_contour.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar contour — wbt_lidar_contour","text":"input Name input LiDAR points. output Name output vector lines file. interval Contour interval. base Base contour. smooth Smoothing filter size (num. points), e.g. 3, 5, 7, 9, 11. parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'user_data'. returns Point return types include; options '' (default), 'last', 'first'. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_contour.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar contour — wbt_lidar_contour","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_digital_surface_model.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar digital surface model — wbt_lidar_digital_surface_model","title":"Lidar digital surface model — wbt_lidar_digital_surface_model","text":"Creates top-surface digital surface model (DSM) LiDAR point cloud.","code":""},{"path":"/reference/wbt_lidar_digital_surface_model.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar digital surface model — wbt_lidar_digital_surface_model","text":"","code":"wbt_lidar_digital_surface_model(   input,   output = NULL,   resolution = 1,   radius = 0.5,   minz = NULL,   maxz = NULL,   max_triangle_edge_length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_digital_surface_model.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar digital surface model — wbt_lidar_digital_surface_model","text":"input Input LiDAR file (including extension). output Output raster file (including extension). resolution Output raster's grid resolution. radius Search Radius. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_digital_surface_model.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar digital surface model — wbt_lidar_digital_surface_model","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_eigenvalue_features.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar eigenvalue features — wbt_lidar_eigenvalue_features","title":"Lidar eigenvalue features — wbt_lidar_eigenvalue_features","text":"Calculate eigenvalue-based metrics LiDAR point cloud.","code":""},{"path":"/reference/wbt_lidar_eigenvalue_features.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar eigenvalue features — wbt_lidar_eigenvalue_features","text":"","code":"wbt_lidar_eigenvalue_features(   input,   num_neighbours = NULL,   radius = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_eigenvalue_features.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar eigenvalue features — wbt_lidar_eigenvalue_features","text":"input Name input LiDAR points. num_neighbours Number neighbours used search. radius Search distance used neighbourhood search. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_eigenvalue_features.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar eigenvalue features — wbt_lidar_eigenvalue_features","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_elevation_slice.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar elevation slice — wbt_lidar_elevation_slice","title":"Lidar elevation slice — wbt_lidar_elevation_slice","text":"Outputs points within LiDAR (LAS) point file lie specified elevation range.","code":""},{"path":"/reference/wbt_lidar_elevation_slice.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar elevation slice — wbt_lidar_elevation_slice","text":"","code":"wbt_lidar_elevation_slice(   input,   output,   minz = NULL,   maxz = NULL,   cls = FALSE,   inclassval = 2,   outclassval = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_elevation_slice.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar elevation slice — wbt_lidar_elevation_slice","text":"input 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 range retained output reclassified. inclassval Optional parameter specifying class value assigned points within slice. outclassval Optional parameter specifying class value assigned points within slice. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_elevation_slice.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar elevation slice — wbt_lidar_elevation_slice","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_ground_point_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar ground point filter — wbt_lidar_ground_point_filter","title":"Lidar ground point filter — wbt_lidar_ground_point_filter","text":"Identifies ground points within LiDAR dataset using slope-based method.","code":""},{"path":"/reference/wbt_lidar_ground_point_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar ground point filter — wbt_lidar_ground_point_filter","text":"","code":"wbt_lidar_ground_point_filter(   input,   output,   radius = 2,   min_neighbours = 0,   slope_threshold = 45,   height_threshold = 1,   classify = TRUE,   slope_norm = TRUE,   height_above_ground = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_ground_point_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar ground point filter — wbt_lidar_ground_point_filter","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. min_neighbours minimum number neighbouring points within search areas. fewer points threshold identified fixed-radius search, subsequent kNN search performed identify k number neighbours. slope_threshold Maximum inter-point slope considered -terrain point. height_threshold Inter-point height difference considered -terrain point. classify Classify points ground (2) -ground (1). slope_norm Perform initial ground slope normalization?. height_above_ground Transform output height average ground elevation?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_ground_point_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar ground point filter — wbt_lidar_ground_point_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_hex_binning.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar hex binning — wbt_lidar_hex_binning","title":"Lidar hex binning — wbt_lidar_hex_binning","text":"Hex-bins set LiDAR points.","code":""},{"path":"/reference/wbt_lidar_hex_binning.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar hex binning — wbt_lidar_hex_binning","text":"","code":"wbt_lidar_hex_binning(   input,   output,   width,   orientation = \"horizontal\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_hex_binning.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar hex binning — wbt_lidar_hex_binning","text":"input Input base file. output Output vector polygon file. width grid cell width. orientation Grid Orientation, 'horizontal' 'vertical'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_hex_binning.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar hex binning — wbt_lidar_hex_binning","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_hillshade.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar hillshade — wbt_lidar_hillshade","title":"Lidar hillshade — wbt_lidar_hillshade","text":"Calculates hillshade value points within LAS file stores data RGB field.","code":""},{"path":"/reference/wbt_lidar_hillshade.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar hillshade — wbt_lidar_hillshade","text":"","code":"wbt_lidar_hillshade(   input,   output,   azimuth = 315,   altitude = 30,   radius = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_hillshade.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar hillshade — wbt_lidar_hillshade","text":"input Input LiDAR file. output Output file. azimuth Illumination source azimuth degrees. altitude Illumination source altitude degrees. radius Search Radius. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_hillshade.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar hillshade — wbt_lidar_hillshade","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_histogram.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar histogram — wbt_lidar_histogram","title":"Lidar histogram — wbt_lidar_histogram","text":"Creates histogram LiDAR data.","code":""},{"path":"/reference/wbt_lidar_histogram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar histogram — wbt_lidar_histogram","text":"","code":"wbt_lidar_histogram(   input,   output,   parameter = \"elevation\",   clip = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_histogram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar histogram — wbt_lidar_histogram","text":"input Input LiDAR file. output Output HTML file (default name based input file unspecified). parameter Parameter; options 'elevation' (default), 'intensity', 'scan angle', 'class', 'time'. clip Amount clip distribution tails (percent). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_histogram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar histogram — wbt_lidar_histogram","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_idw_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar idw interpolation — wbt_lidar_idw_interpolation","title":"Lidar idw interpolation — wbt_lidar_idw_interpolation","text":"Interpolates LAS files using inverse-distance weighted (IDW) scheme. input/output parameters specified, tool interpolates LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_idw_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar idw interpolation — wbt_lidar_idw_interpolation","text":"","code":"wbt_lidar_idw_interpolation(   input,   output = NULL,   parameter = \"elevation\",   returns = \"all\",   resolution = 1,   weight = 1,   radius = 2.5,   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_idw_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar idw interpolation — wbt_lidar_idw_interpolation","text":"input Input LiDAR file (including extension). output Output raster file (including extension). parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'class', 'return_number', 'number_of_returns', 'scan angle', 'rgb', 'user data'. returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. weight IDW weight value. radius Search Radius. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_idw_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar idw interpolation — wbt_lidar_idw_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar info — wbt_lidar_info","title":"Lidar info — wbt_lidar_info","text":"Prints information LiDAR (LAS) dataset, including header, point return frequency, classification data information variable length records (VLRs) geokeys.","code":""},{"path":"/reference/wbt_lidar_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar info — wbt_lidar_info","text":"","code":"wbt_lidar_info(   input,   output,   density = TRUE,   vlr = TRUE,   geokeys = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar info — wbt_lidar_info","text":"input Input LiDAR file. output Output HTML file summary report. density Flag indicating whether calculate average point density nominal point spacing. vlr Flag indicating whether print variable length records (VLRs). geokeys Flag indicating whether print geokeys. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar info — wbt_lidar_info","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_join.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar join — wbt_lidar_join","title":"Lidar join — wbt_lidar_join","text":"Joins multiple LiDAR (LAS) files single LAS file.","code":""},{"path":"/reference/wbt_lidar_join.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar join — wbt_lidar_join","text":"","code":"wbt_lidar_join(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_join.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar join — wbt_lidar_join","text":"inputs Input LiDAR files. output Output LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_join.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar join — wbt_lidar_join","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_kappa_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar kappa index — wbt_lidar_kappa_index","title":"Lidar kappa index — wbt_lidar_kappa_index","text":"Performs kappa index agreement (KIA) analysis classifications two LAS files.","code":""},{"path":"/reference/wbt_lidar_kappa_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar kappa index — wbt_lidar_kappa_index","text":"","code":"wbt_lidar_kappa_index(   input1,   input2,   output,   class_accuracy,   resolution = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_kappa_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar kappa index — wbt_lidar_kappa_index","text":"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. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_kappa_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar kappa index — wbt_lidar_kappa_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_nearest_neighbour_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar nearest neighbour gridding — wbt_lidar_nearest_neighbour_gridding","title":"Lidar nearest neighbour gridding — wbt_lidar_nearest_neighbour_gridding","text":"Grids LiDAR files using nearest-neighbour scheme. input/output parameters specified, tool grids LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_nearest_neighbour_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar nearest neighbour gridding — wbt_lidar_nearest_neighbour_gridding","text":"","code":"wbt_lidar_nearest_neighbour_gridding(   input,   output = NULL,   parameter = \"elevation\",   returns = \"all\",   resolution = 1,   radius = 2.5,   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_nearest_neighbour_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar nearest neighbour gridding — wbt_lidar_nearest_neighbour_gridding","text":"input Input LiDAR file (including extension). output Output raster file (including extension). parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'class', 'return_number', 'number_of_returns', 'scan angle', 'rgb', 'user data', 'time'. returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. radius Search Radius. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_nearest_neighbour_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar nearest neighbour gridding — wbt_lidar_nearest_neighbour_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_point_density.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar point density — wbt_lidar_point_density","title":"Lidar point density — wbt_lidar_point_density","text":"Calculates spatial pattern point density LiDAR data set. input/output parameters specified, tool grids LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_point_density.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar point density — wbt_lidar_point_density","text":"","code":"wbt_lidar_point_density(   input,   output = NULL,   returns = \"all\",   resolution = 1,   radius = 2.5,   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_point_density.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar point density — wbt_lidar_point_density","text":"input Input LiDAR file (including extension). output Output raster file (including extension). returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. radius Search radius. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_point_density.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar point density — wbt_lidar_point_density","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_point_return_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar point return analysis — wbt_lidar_point_return_analysis","title":"Lidar point return analysis — wbt_lidar_point_return_analysis","text":"tool performs quality control check return values points LiDAR file.","code":""},{"path":"/reference/wbt_lidar_point_return_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar point return analysis — wbt_lidar_point_return_analysis","text":"","code":"wbt_lidar_point_return_analysis(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_point_return_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar point return analysis — wbt_lidar_point_return_analysis","text":"input Name input LiDAR points. output Name output LiDAR points. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_point_return_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar point return analysis — wbt_lidar_point_return_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_point_stats.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar point stats — wbt_lidar_point_stats","title":"Lidar point stats — wbt_lidar_point_stats","text":"Creates several rasters summarizing distribution LAS point data. input/output parameters specified, tool works LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_point_stats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar point stats — wbt_lidar_point_stats","text":"","code":"wbt_lidar_point_stats(   input,   resolution = 1,   num_points = TRUE,   num_pulses = FALSE,   avg_points_per_pulse = TRUE,   z_range = FALSE,   intensity_range = FALSE,   predom_class = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_point_stats.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar point stats — wbt_lidar_point_stats","text":"input Input LiDAR file. resolution Output raster's grid resolution. num_points Flag indicating whether output number points (returns) raster. num_pulses Flag indicating whether output number pulses raster. avg_points_per_pulse Flag indicating whether output average number points (returns) per pulse raster. z_range Flag indicating whether output elevation range raster. intensity_range Flag indicating whether output intensity range raster. predom_class Flag indicating whether output predominant classification raster. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_point_stats.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar point stats — wbt_lidar_point_stats","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_ransac_planes.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar ransac planes — wbt_lidar_ransac_planes","title":"Lidar ransac planes — wbt_lidar_ransac_planes","text":"Performs RANSAC analysis identify points within LiDAR point cloud belong linear planes.","code":""},{"path":"/reference/wbt_lidar_ransac_planes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar ransac planes — wbt_lidar_ransac_planes","text":"","code":"wbt_lidar_ransac_planes(   input,   output,   radius = 2,   num_iter = 50,   num_samples = 5,   threshold = 0.35,   model_size = 8,   max_slope = 80,   classify = FALSE,   last_returns = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_ransac_planes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar ransac planes — wbt_lidar_ransac_planes","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. num_iter Number iterations. num_samples Number sample points build model. threshold Threshold used determine inlier points. model_size Acceptable model size. max_slope Maximum planar slope. classify Classify points ground (2) -ground (1). last_returns include last- -return points. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_ransac_planes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar ransac planes — wbt_lidar_ransac_planes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_rbf_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar rbf interpolation — wbt_lidar_rbf_interpolation","title":"Lidar rbf interpolation — wbt_lidar_rbf_interpolation","text":"Interpolates LAS files using radial basis function (RBF) scheme. input/output parameters specified, tool interpolates LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_rbf_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar rbf interpolation — wbt_lidar_rbf_interpolation","text":"","code":"wbt_lidar_rbf_interpolation(   input,   output = NULL,   parameter = \"elevation\",   returns = \"all\",   resolution = 1,   num_points = 20,   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   func_type = \"ThinPlateSpline\",   poly_order = \"none\",   weight = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_rbf_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar rbf interpolation — wbt_lidar_rbf_interpolation","text":"input Input LiDAR file (including extension). output Output raster file (including extension). parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'class', 'return_number', 'number_of_returns', 'scan angle', 'rgb', 'user data'. returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. num_points Number points. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. func_type Radial basis function type; options 'ThinPlateSpline' (default), 'PolyHarmonic', 'Gaussian', 'MultiQuadric', 'InverseMultiQuadric'. poly_order Polynomial order; options 'none' (default), 'constant', 'affine'. weight Weight parameter used basis function. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_rbf_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar rbf interpolation — wbt_lidar_rbf_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_remove_duplicates.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar remove duplicates — wbt_lidar_remove_duplicates","title":"Lidar remove duplicates — wbt_lidar_remove_duplicates","text":"Removes duplicate points LiDAR data set.","code":""},{"path":"/reference/wbt_lidar_remove_duplicates.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar remove duplicates — wbt_lidar_remove_duplicates","text":"","code":"wbt_lidar_remove_duplicates(   input,   output,   include_z = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_remove_duplicates.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar remove duplicates — wbt_lidar_remove_duplicates","text":"input Input LiDAR file. output Output LiDAR file. include_z Include z-values point comparison?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_remove_duplicates.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar remove duplicates — wbt_lidar_remove_duplicates","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_remove_outliers.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar remove outliers — wbt_lidar_remove_outliers","title":"Lidar remove outliers — wbt_lidar_remove_outliers","text":"Removes outliers (high low points) LiDAR point cloud.","code":""},{"path":"/reference/wbt_lidar_remove_outliers.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar remove outliers — wbt_lidar_remove_outliers","text":"","code":"wbt_lidar_remove_outliers(   input,   output,   radius = 2,   elev_diff = 50,   use_median = FALSE,   classify = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_remove_outliers.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar remove outliers — wbt_lidar_remove_outliers","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. elev_diff Max. elevation difference. use_median Optional flag indicating whether use difference median elevation rather mean. classify Classify points ground (2) -ground (1). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_remove_outliers.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar remove outliers — wbt_lidar_remove_outliers","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_rooftop_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar rooftop analysis — wbt_lidar_rooftop_analysis","title":"Lidar rooftop analysis — wbt_lidar_rooftop_analysis","text":"Identifies roof segments LiDAR point cloud.","code":""},{"path":"/reference/wbt_lidar_rooftop_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar rooftop analysis — wbt_lidar_rooftop_analysis","text":"","code":"wbt_lidar_rooftop_analysis(   buildings,   output,   input = NULL,   radius = 2,   num_iter = 50,   num_samples = 10,   threshold = 0.15,   model_size = 15,   max_slope = 65,   norm_diff = 10,   azimuth = 180,   altitude = 30,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_rooftop_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar rooftop analysis — wbt_lidar_rooftop_analysis","text":"buildings Input vector build footprint polygons file. output Output vector polygon file. input Input LiDAR file. radius Search Radius. num_iter Number iterations. num_samples Number sample points build model. threshold Threshold used determine inlier points (elevation units). model_size Acceptable model size, points. max_slope Maximum planar slope, degrees. norm_diff Maximum difference normal vectors, degrees. azimuth Illumination source azimuth, degrees. altitude Illumination source altitude degrees. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_rooftop_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar rooftop analysis — wbt_lidar_rooftop_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_segmentation.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar segmentation — wbt_lidar_segmentation","title":"Lidar segmentation — wbt_lidar_segmentation","text":"Segments LiDAR point cloud based differences orientation fitted planar surfaces point proximity.","code":""},{"path":"/reference/wbt_lidar_segmentation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar segmentation — wbt_lidar_segmentation","text":"","code":"wbt_lidar_segmentation(   input,   output,   radius = 2,   num_iter = 50,   num_samples = 10,   threshold = 0.15,   model_size = 15,   max_slope = 80,   norm_diff = 10,   maxzdiff = 1,   classes = FALSE,   ground = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_segmentation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar segmentation — wbt_lidar_segmentation","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. num_iter Number iterations. num_samples Number sample points build model. threshold Threshold used determine inlier points. model_size Acceptable model size. max_slope Maximum planar slope. norm_diff Maximum difference normal vectors, degrees. maxzdiff Maximum difference elevation (z units) neighbouring points segment. classes Segments cross class boundaries. ground Classify largest segment ground points?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_segmentation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar segmentation — wbt_lidar_segmentation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_segmentation_based_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar segmentation based filter — wbt_lidar_segmentation_based_filter","title":"Lidar segmentation based filter — wbt_lidar_segmentation_based_filter","text":"Identifies ground points within LiDAR point clouds using segmentation based approach.","code":""},{"path":"/reference/wbt_lidar_segmentation_based_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar segmentation based filter — wbt_lidar_segmentation_based_filter","text":"","code":"wbt_lidar_segmentation_based_filter(   input,   output,   radius = 5,   norm_diff = 2,   maxzdiff = 1,   classify = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_segmentation_based_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar segmentation based filter — wbt_lidar_segmentation_based_filter","text":"input Input LiDAR file. output Output file. radius Search Radius. norm_diff Maximum difference normal vectors, degrees. maxzdiff Maximum difference elevation (z units) neighbouring points segment. classify Classify points ground (2) -ground (1). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_segmentation_based_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar segmentation based filter — wbt_lidar_segmentation_based_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_shift.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar shift — wbt_lidar_shift","title":"Lidar shift — wbt_lidar_shift","text":"Shifts x,y,z coordinates LiDAR file.","code":""},{"path":"/reference/wbt_lidar_shift.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar shift — wbt_lidar_shift","text":"","code":"wbt_lidar_shift(   input,   output,   x_shift = \"\",   y_shift = \"\",   z_shift = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_shift.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar shift — wbt_lidar_shift","text":"input Name input LiDAR points. output Name output LiDAR points. x_shift x-shift value, blank none. y_shift y-shift value, blank none. z_shift z-shift value, blank none. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_shift.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar shift — wbt_lidar_shift","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_sibson_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar sibson interpolation — wbt_lidar_sibson_interpolation","title":"Lidar sibson interpolation — wbt_lidar_sibson_interpolation","text":"tool interpolates one LiDAR tiles using Sibson's natural neighbour method.","code":""},{"path":"/reference/wbt_lidar_sibson_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar sibson interpolation — wbt_lidar_sibson_interpolation","text":"","code":"wbt_lidar_sibson_interpolation(   input,   output = NULL,   parameter = \"elevation\",   returns = \"all\",   resolution = 1,   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_sibson_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar sibson interpolation — wbt_lidar_sibson_interpolation","text":"input Name input LiDAR points (leave blank use files WorkingDirectory. output Output raster file (including extension). parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'class', 'return_number', 'number_of_returns', 'scan angle', 'user_data'. returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_sibson_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar sibson interpolation — wbt_lidar_sibson_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_sort_by_time.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar sort by time — wbt_lidar_sort_by_time","title":"Lidar sort by time — wbt_lidar_sort_by_time","text":"tool sorts points LiDAR file GPS time.","code":""},{"path":"/reference/wbt_lidar_sort_by_time.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar sort by time — wbt_lidar_sort_by_time","text":"","code":"wbt_lidar_sort_by_time(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_sort_by_time.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar sort by time — wbt_lidar_sort_by_time","text":"input Name input LiDAR points. output Name output LiDAR points. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_sort_by_time.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar sort by time — wbt_lidar_sort_by_time","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_thin.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar thin — wbt_lidar_thin","title":"Lidar thin — wbt_lidar_thin","text":"Thins LiDAR point cloud, reducing point density.","code":""},{"path":"/reference/wbt_lidar_thin.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar thin — wbt_lidar_thin","text":"","code":"wbt_lidar_thin(   input,   output,   resolution = 2,   method = \"lowest\",   save_filtered = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_thin.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar thin — wbt_lidar_thin","text":"input Input LiDAR file. output Output LiDAR file. resolution size square area used evaluate nearby points LiDAR data. method Point selection method; options 'first', 'last', 'lowest' (default), 'highest', 'nearest'. save_filtered Save filtered points separate file?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_thin.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar thin — wbt_lidar_thin","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_thin_high_density.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar thin high density — wbt_lidar_thin_high_density","title":"Lidar thin high density — wbt_lidar_thin_high_density","text":"Thins points high density areas within LiDAR point cloud.","code":""},{"path":"/reference/wbt_lidar_thin_high_density.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar thin high density — wbt_lidar_thin_high_density","text":"","code":"wbt_lidar_thin_high_density(   input,   output,   density,   resolution = 1,   save_filtered = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_thin_high_density.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar thin high density — wbt_lidar_thin_high_density","text":"input Input LiDAR file. output Output LiDAR file. density Max. point density (points / m^3). resolution Output raster's grid resolution. save_filtered Save filtered points separate file?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_thin_high_density.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar thin high density — wbt_lidar_thin_high_density","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_tile.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar tile — wbt_lidar_tile","title":"Lidar tile — wbt_lidar_tile","text":"Tiles LiDAR LAS file multiple LAS files.","code":""},{"path":"/reference/wbt_lidar_tile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar tile — wbt_lidar_tile","text":"","code":"wbt_lidar_tile(   input,   width = 1000,   height = 1000,   origin_x = 0,   origin_y = 0,   min_points = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_tile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar tile — wbt_lidar_tile","text":"input Input LiDAR file. width Width tiles X dimension; default 1000.0. height Height tiles Y dimension. origin_x Origin point X coordinate tile grid. origin_y Origin point Y coordinate tile grid. min_points Minimum number points contained tile saved. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_tile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar tile — wbt_lidar_tile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_tile_footprint.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar tile footprint — wbt_lidar_tile_footprint","title":"Lidar tile footprint — wbt_lidar_tile_footprint","text":"Creates vector polygon convex hull LiDAR point cloud. input/output parameters specified, tool works LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_tile_footprint.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar tile footprint — wbt_lidar_tile_footprint","text":"","code":"wbt_lidar_tile_footprint(   input,   output,   hull = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_tile_footprint.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar tile footprint — wbt_lidar_tile_footprint","text":"input Input LiDAR file. output Output vector polygon file. hull Identify convex hull around points. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_tile_footprint.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar tile footprint — wbt_lidar_tile_footprint","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_tin_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar tin gridding — wbt_lidar_tin_gridding","title":"Lidar tin gridding — wbt_lidar_tin_gridding","text":"Creates raster grid based Delaunay triangular irregular network (TIN) fitted LiDAR points.","code":""},{"path":"/reference/wbt_lidar_tin_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar tin gridding — wbt_lidar_tin_gridding","text":"","code":"wbt_lidar_tin_gridding(   input,   output = NULL,   parameter = \"elevation\",   returns = \"all\",   resolution = 1,   exclude_cls = \"7,18\",   minz = NULL,   maxz = NULL,   max_triangle_edge_length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_tin_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar tin gridding — wbt_lidar_tin_gridding","text":"input Input LiDAR file (including extension). output Output raster file (including extension). parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'class', 'return_number', 'number_of_returns', 'scan angle', 'rgb', 'user data'. returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_tin_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar tin gridding — wbt_lidar_tin_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_tophat_transform.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar tophat transform — wbt_lidar_tophat_transform","title":"Lidar tophat transform — wbt_lidar_tophat_transform","text":"Performs white top-hat transform Lidar dataset; estimate height ground, useful modelling vegetation canopy.","code":""},{"path":"/reference/wbt_lidar_tophat_transform.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar tophat transform — wbt_lidar_tophat_transform","text":"","code":"wbt_lidar_tophat_transform(   input,   output,   radius = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_tophat_transform.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar tophat transform — wbt_lidar_tophat_transform","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_tophat_transform.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar tophat transform — wbt_lidar_tophat_transform","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_line_detection_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Line detection filter — wbt_line_detection_filter","title":"Line detection filter — wbt_line_detection_filter","text":"Performs line-detection filter image.","code":""},{"path":"/reference/wbt_line_detection_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Line detection filter — wbt_line_detection_filter","text":"","code":"wbt_line_detection_filter(   input,   output,   variant = \"vertical\",   absvals = FALSE,   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_line_detection_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Line detection filter — wbt_line_detection_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. variant Optional variant value. Options include 'v' (vertical), 'h' (horizontal), '45', '135' (default 'v'). absvals Optional flag indicating whether outputs absolute values. clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_line_detection_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Line detection filter — wbt_line_detection_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_line_intersections.html","id":null,"dir":"Reference","previous_headings":"","what":"Line intersections — wbt_line_intersections","title":"Line intersections — wbt_line_intersections","text":"Identifies points features two vector line layers intersect.","code":""},{"path":"/reference/wbt_line_intersections.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Line intersections — wbt_line_intersections","text":"","code":"wbt_line_intersections(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_line_intersections.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Line intersections — wbt_line_intersections","text":"input1 Input vector polyline file. input2 Input vector polyline file. output Output vector point file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_line_intersections.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Line intersections — wbt_line_intersections","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_line_thinning.html","id":null,"dir":"Reference","previous_headings":"","what":"Line thinning — wbt_line_thinning","title":"Line thinning — wbt_line_thinning","text":"Performs line thinning Boolean raster image; intended used RemoveSpurs tool.","code":""},{"path":"/reference/wbt_line_thinning.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Line thinning — wbt_line_thinning","text":"","code":"wbt_line_thinning(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_line_thinning.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Line thinning — wbt_line_thinning","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_line_thinning.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Line thinning — wbt_line_thinning","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_linearity_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Linearity index — wbt_linearity_index","title":"Linearity index — wbt_linearity_index","text":"Calculates linearity index vector polygons.","code":""},{"path":"/reference/wbt_linearity_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Linearity index — wbt_linearity_index","text":"","code":"wbt_linearity_index(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_linearity_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Linearity index — wbt_linearity_index","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_linearity_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Linearity index — wbt_linearity_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lines_to_polygons.html","id":null,"dir":"Reference","previous_headings":"","what":"Lines to polygons — wbt_lines_to_polygons","title":"Lines to polygons — wbt_lines_to_polygons","text":"Converts vector polylines polygons.","code":""},{"path":"/reference/wbt_lines_to_polygons.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lines to polygons — wbt_lines_to_polygons","text":"","code":"wbt_lines_to_polygons(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lines_to_polygons.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lines to polygons — wbt_lines_to_polygons","text":"input Input vector line file. output Output vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lines_to_polygons.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lines to polygons — wbt_lines_to_polygons","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_list_tools.html","id":null,"dir":"Reference","previous_headings":"","what":"All available tools in 'WhiteboxTools' — wbt_list_tools","title":"All available tools in 'WhiteboxTools' — wbt_list_tools","text":"available tools 'WhiteboxTools'","code":""},{"path":"/reference/wbt_list_tools.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"All available tools in 'WhiteboxTools' — wbt_list_tools","text":"","code":"wbt_list_tools(keywords = \"''\")"},{"path":"/reference/wbt_list_tools.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"All available tools in 'WhiteboxTools' — wbt_list_tools","text":"keywords Keywords may used search available tools. Default \"''\" returns available tools.","code":""},{"path":"/reference/wbt_list_tools.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"All available tools in 'WhiteboxTools' — wbt_list_tools","text":"Return available tools WhiteboxTools contain keywords.","code":""},{"path":"/reference/wbt_list_tools.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"All available tools in 'WhiteboxTools' — wbt_list_tools","text":"","code":"if (FALSE) { wbt_list_tools(\"lidar\") }"},{"path":"/reference/wbt_list_unique_values.html","id":null,"dir":"Reference","previous_headings":"","what":"List unique values — wbt_list_unique_values","title":"List unique values — wbt_list_unique_values","text":"Lists unique values contained field within vector's attribute table.","code":""},{"path":"/reference/wbt_list_unique_values.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List unique values — wbt_list_unique_values","text":"","code":"wbt_list_unique_values(   input,   field,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_list_unique_values.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List unique values — wbt_list_unique_values","text":"input Input vector file path. See wbt_file_path() details. field Input field name attribute table. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_list_unique_values.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List unique values — wbt_list_unique_values","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_list_unique_values_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"List unique values raster — wbt_list_unique_values_raster","title":"List unique values raster — wbt_list_unique_values_raster","text":"Lists unique values contained field within vector's attribute table.","code":""},{"path":"/reference/wbt_list_unique_values_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List unique values raster — wbt_list_unique_values_raster","text":"","code":"wbt_list_unique_values_raster(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_list_unique_values_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List unique values raster — wbt_list_unique_values_raster","text":"input Input vector file path. See wbt_file_path() details. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_list_unique_values_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List unique values raster — wbt_list_unique_values_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ln.html","id":null,"dir":"Reference","previous_headings":"","what":"Ln — wbt_ln","title":"Ln — wbt_ln","text":"Returns natural logarithm values raster.","code":""},{"path":"/reference/wbt_ln.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ln — wbt_ln","text":"","code":"wbt_ln(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ln.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ln — wbt_ln","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ln.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ln — wbt_ln","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_local_hypsometric_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Local hypsometric analysis — wbt_local_hypsometric_analysis","title":"Local hypsometric analysis — wbt_local_hypsometric_analysis","text":"tool calculates local, neighbourhood-based hypsometric integral raster.","code":""},{"path":"/reference/wbt_local_hypsometric_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Local hypsometric analysis — wbt_local_hypsometric_analysis","text":"","code":"wbt_local_hypsometric_analysis(   input,   out_mag,   out_scale,   min_scale = 4,   step = 1,   num_steps = 10,   step_nonlinearity = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_local_hypsometric_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Local hypsometric analysis — wbt_local_hypsometric_analysis","text":"input Name input raster DEM file. out_mag Name openness output raster file. out_scale Name openness output raster file. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_local_hypsometric_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Local hypsometric analysis — wbt_local_hypsometric_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_local_quadratic_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Local quadratic regression — wbt_local_quadratic_regression","title":"Local quadratic regression — wbt_local_quadratic_regression","text":"implementation constrained quadratic regression algorithm using flexible window size described Wood (1996).","code":""},{"path":"/reference/wbt_local_quadratic_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Local quadratic regression — wbt_local_quadratic_regression","text":"","code":"wbt_local_quadratic_regression(   dem,   output,   filter = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_local_quadratic_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Local quadratic regression — wbt_local_quadratic_regression","text":"dem Name input DEM raster file. output Name output raster file. filter Edge length filter kernel. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_local_quadratic_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Local quadratic regression — wbt_local_quadratic_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_log10.html","id":null,"dir":"Reference","previous_headings":"","what":"Log10 — wbt_log10","title":"Log10 — wbt_log10","text":"Returns base-10 logarithm values raster.","code":""},{"path":"/reference/wbt_log10.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Log10 — wbt_log10","text":"","code":"wbt_log10(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_log10.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Log10 — wbt_log10","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_log10.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Log10 — wbt_log10","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_log2.html","id":null,"dir":"Reference","previous_headings":"","what":"Log2 — wbt_log2","title":"Log2 — wbt_log2","text":"Returns base-2 logarithm values raster.","code":""},{"path":"/reference/wbt_log2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Log2 — wbt_log2","text":"","code":"wbt_log2(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_log2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Log2 — wbt_log2","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_log2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Log2 — wbt_log2","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_logistic_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Logistic regression — wbt_logistic_regression","title":"Logistic regression — wbt_logistic_regression","text":"Performs logistic regression analysis using training site polygons/points predictor rasters.","code":""},{"path":"/reference/wbt_logistic_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Logistic regression — wbt_logistic_regression","text":"","code":"wbt_logistic_regression(   inputs,   training,   field,   scaling = \"Normalize\",   output = NULL,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_logistic_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Logistic regression — wbt_logistic_regression","text":"inputs Names input predictor rasters. training Name input training site polygons/points shapefile. field Name attribute containing class data. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. output Name output raster file. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_logistic_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Logistic regression — wbt_logistic_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_long_profile.html","id":null,"dir":"Reference","previous_headings":"","what":"Long profile — wbt_long_profile","title":"Long profile — wbt_long_profile","text":"Plots stream longitudinal profiles one rivers.","code":""},{"path":"/reference/wbt_long_profile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Long profile — wbt_long_profile","text":"","code":"wbt_long_profile(   d8_pntr,   streams,   dem,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_long_profile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Long profile — wbt_long_profile","text":"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 ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_long_profile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Long profile — wbt_long_profile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_long_profile_from_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Long profile from points — wbt_long_profile_from_points","title":"Long profile from points — wbt_long_profile_from_points","text":"Plots longitudinal profiles flow-paths initiating set vector points.","code":""},{"path":"/reference/wbt_long_profile_from_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Long profile from points — wbt_long_profile_from_points","text":"","code":"wbt_long_profile_from_points(   d8_pntr,   points,   dem,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_long_profile_from_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Long profile from points — wbt_long_profile_from_points","text":"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 ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_long_profile_from_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Long profile from points — wbt_long_profile_from_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_longest_flowpath.html","id":null,"dir":"Reference","previous_headings":"","what":"Longest flowpath — wbt_longest_flowpath","title":"Longest flowpath — wbt_longest_flowpath","text":"Delineates longest flowpaths group subbasins watersheds.","code":""},{"path":"/reference/wbt_longest_flowpath.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Longest flowpath — wbt_longest_flowpath","text":"","code":"wbt_longest_flowpath(   dem,   basins,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_longest_flowpath.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Longest flowpath — wbt_longest_flowpath","text":"dem Input raster DEM file. basins Input raster basins file. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_longest_flowpath.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Longest flowpath — wbt_longest_flowpath","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_low_points_on_headwater_divides.html","id":null,"dir":"Reference","previous_headings":"","what":"Low points on headwater divides — wbt_low_points_on_headwater_divides","title":"Low points on headwater divides — wbt_low_points_on_headwater_divides","text":"tool locates saddle points along ridges within digital elevation model (DEM).","code":""},{"path":"/reference/wbt_low_points_on_headwater_divides.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Low points on headwater divides — wbt_low_points_on_headwater_divides","text":"","code":"wbt_low_points_on_headwater_divides(   dem,   streams,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_low_points_on_headwater_divides.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Low points on headwater divides — wbt_low_points_on_headwater_divides","text":"dem Name input DEM raster file. streams Name input stream channel raster file. output Name output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_low_points_on_headwater_divides.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Low points on headwater divides — wbt_low_points_on_headwater_divides","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lowest_position.html","id":null,"dir":"Reference","previous_headings":"","what":"Lowest position — wbt_lowest_position","title":"Lowest position — wbt_lowest_position","text":"Identifies stack position minimum value within raster stack cell--cell basis.","code":""},{"path":"/reference/wbt_lowest_position.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lowest position — wbt_lowest_position","text":"","code":"wbt_lowest_position(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lowest_position.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lowest position — wbt_lowest_position","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lowest_position.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lowest position — wbt_lowest_position","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_majority_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Majority filter — wbt_majority_filter","title":"Majority filter — wbt_majority_filter","text":"Assigns cell output grid frequently occurring value (mode) moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_majority_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Majority filter — wbt_majority_filter","text":"","code":"wbt_majority_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_majority_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Majority filter — wbt_majority_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_majority_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Majority filter — wbt_majority_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_map_off_terrain_objects.html","id":null,"dir":"Reference","previous_headings":"","what":"Map off terrain objects — wbt_map_off_terrain_objects","title":"Map off terrain objects — wbt_map_off_terrain_objects","text":"Maps -terrain objects digital elevation model (DEM).","code":""},{"path":"/reference/wbt_map_off_terrain_objects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Map off terrain objects — wbt_map_off_terrain_objects","text":"","code":"wbt_map_off_terrain_objects(   dem,   output,   max_slope = 40,   min_size = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_map_off_terrain_objects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Map off terrain objects — wbt_map_off_terrain_objects","text":"dem Input raster DEM file. output Output raster file. max_slope Maximum inter-cell absolute slope. min_size Minimum feature size, grid cells. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_map_off_terrain_objects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Map off terrain objects — wbt_map_off_terrain_objects","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max.html","id":null,"dir":"Reference","previous_headings":"","what":"Max — wbt_max","title":"Max — wbt_max","text":"Performs MAX operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_max.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max — wbt_max","text":"","code":"wbt_max(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max — wbt_max","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max — wbt_max","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_absolute_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Max absolute overlay — wbt_max_absolute_overlay","title":"Max absolute overlay — wbt_max_absolute_overlay","text":"Evaluates maximum absolute value grid cell stack input rasters.","code":""},{"path":"/reference/wbt_max_absolute_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max absolute overlay — wbt_max_absolute_overlay","text":"","code":"wbt_max_absolute_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_absolute_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max absolute overlay — wbt_max_absolute_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_absolute_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max absolute overlay — wbt_max_absolute_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_anisotropy_dev.html","id":null,"dir":"Reference","previous_headings":"","what":"Max anisotropy dev — wbt_max_anisotropy_dev","title":"Max anisotropy dev — wbt_max_anisotropy_dev","text":"Calculates maximum anisotropy (directionality) elevation deviation range spatial scales.","code":""},{"path":"/reference/wbt_max_anisotropy_dev.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max anisotropy dev — wbt_max_anisotropy_dev","text":"","code":"wbt_max_anisotropy_dev(   dem,   out_mag,   out_scale,   max_scale,   min_scale = 3,   step = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_anisotropy_dev.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max anisotropy dev — wbt_max_anisotropy_dev","text":"dem Input raster DEM file. out_mag Output raster DEVmax magnitude file. out_scale Output raster DEVmax scale file. max_scale Maximum search neighbourhood radius grid cells. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_anisotropy_dev.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max anisotropy dev — wbt_max_anisotropy_dev","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_anisotropy_dev_signature.html","id":null,"dir":"Reference","previous_headings":"","what":"Max anisotropy dev signature — wbt_max_anisotropy_dev_signature","title":"Max anisotropy dev signature — wbt_max_anisotropy_dev_signature","text":"Calculates anisotropy deviation mean points range spatial scales.","code":""},{"path":"/reference/wbt_max_anisotropy_dev_signature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max anisotropy dev signature — wbt_max_anisotropy_dev_signature","text":"","code":"wbt_max_anisotropy_dev_signature(   dem,   points,   output,   max_scale,   min_scale = 1,   step = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_anisotropy_dev_signature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max anisotropy dev signature — wbt_max_anisotropy_dev_signature","text":"dem Input raster DEM file. points Input vector points file. output Output HTML file. max_scale Maximum search neighbourhood radius grid cells. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_anisotropy_dev_signature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max anisotropy dev signature — wbt_max_anisotropy_dev_signature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_branch_length.html","id":null,"dir":"Reference","previous_headings":"","what":"Max branch length — wbt_max_branch_length","title":"Max branch length — wbt_max_branch_length","text":"Lindsay Seibert's (2013) branch length index used map drainage divides ridge lines.","code":""},{"path":"/reference/wbt_max_branch_length.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max branch length — wbt_max_branch_length","text":"","code":"wbt_max_branch_length(   dem,   output,   log = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_branch_length.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max branch length — wbt_max_branch_length","text":"dem Input raster DEM file. output Output raster file. log Optional flag request output log-transformed. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_branch_length.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max branch length — wbt_max_branch_length","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_difference_from_mean.html","id":null,"dir":"Reference","previous_headings":"","what":"Max difference from mean — wbt_max_difference_from_mean","title":"Max difference from mean — wbt_max_difference_from_mean","text":"Calculates maximum difference mean elevation range spatial scales.","code":""},{"path":"/reference/wbt_max_difference_from_mean.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max difference from mean — wbt_max_difference_from_mean","text":"","code":"wbt_max_difference_from_mean(   dem,   out_mag,   out_scale,   min_scale,   max_scale,   step = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_difference_from_mean.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max difference from mean — wbt_max_difference_from_mean","text":"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 grid cells. max_scale Maximum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_difference_from_mean.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max difference from mean — wbt_max_difference_from_mean","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_downslope_elev_change.html","id":null,"dir":"Reference","previous_headings":"","what":"Max downslope elev change — wbt_max_downslope_elev_change","title":"Max downslope elev change — wbt_max_downslope_elev_change","text":"Calculates maximum downslope change elevation grid cell eight downslope neighbors.","code":""},{"path":"/reference/wbt_max_downslope_elev_change.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max downslope elev change — wbt_max_downslope_elev_change","text":"","code":"wbt_max_downslope_elev_change(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_downslope_elev_change.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max downslope elev change — wbt_max_downslope_elev_change","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_downslope_elev_change.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max downslope elev change — wbt_max_downslope_elev_change","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_elev_dev_signature.html","id":null,"dir":"Reference","previous_headings":"","what":"Max elev dev signature — wbt_max_elev_dev_signature","title":"Max elev dev signature — wbt_max_elev_dev_signature","text":"Calculates maximum elevation deviation range spatial scales set points.","code":""},{"path":"/reference/wbt_max_elev_dev_signature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max elev dev signature — wbt_max_elev_dev_signature","text":"","code":"wbt_max_elev_dev_signature(   dem,   points,   output,   min_scale,   max_scale,   step = 10,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_elev_dev_signature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max elev dev signature — wbt_max_elev_dev_signature","text":"dem Input raster DEM file. points Input vector points file. output Output HTML file. min_scale Minimum search neighbourhood radius grid cells. max_scale Maximum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_elev_dev_signature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max elev dev signature — wbt_max_elev_dev_signature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_elevation_deviation.html","id":null,"dir":"Reference","previous_headings":"","what":"Max elevation deviation — wbt_max_elevation_deviation","title":"Max elevation deviation — wbt_max_elevation_deviation","text":"Calculates maximum elevation deviation range spatial scales.","code":""},{"path":"/reference/wbt_max_elevation_deviation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max elevation deviation — wbt_max_elevation_deviation","text":"","code":"wbt_max_elevation_deviation(   dem,   out_mag,   out_scale,   min_scale,   max_scale,   step = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_elevation_deviation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max elevation deviation — wbt_max_elevation_deviation","text":"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 grid cells. max_scale Maximum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_elevation_deviation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max elevation deviation — wbt_max_elevation_deviation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Max overlay — wbt_max_overlay","title":"Max overlay — wbt_max_overlay","text":"Evaluates maximum value grid cell stack input rasters.","code":""},{"path":"/reference/wbt_max_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max overlay — wbt_max_overlay","text":"","code":"wbt_max_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max overlay — wbt_max_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max overlay — wbt_max_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_upslope_elev_change.html","id":null,"dir":"Reference","previous_headings":"","what":"Max upslope elev change — wbt_max_upslope_elev_change","title":"Max upslope elev change — wbt_max_upslope_elev_change","text":"Calculates maximum upslope change elevation grid cell eight downslope neighbors.","code":""},{"path":"/reference/wbt_max_upslope_elev_change.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max upslope elev change — wbt_max_upslope_elev_change","text":"","code":"wbt_max_upslope_elev_change(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_upslope_elev_change.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max upslope elev change — wbt_max_upslope_elev_change","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_upslope_elev_change.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max upslope elev change — wbt_max_upslope_elev_change","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_upslope_flowpath_length.html","id":null,"dir":"Reference","previous_headings":"","what":"Max upslope flowpath length — wbt_max_upslope_flowpath_length","title":"Max upslope flowpath length — wbt_max_upslope_flowpath_length","text":"Measures maximum length upslope flowpaths draining grid cell.","code":""},{"path":"/reference/wbt_max_upslope_flowpath_length.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max upslope flowpath length — wbt_max_upslope_flowpath_length","text":"","code":"wbt_max_upslope_flowpath_length(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_upslope_flowpath_length.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max upslope flowpath length — wbt_max_upslope_flowpath_length","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_upslope_flowpath_length.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max upslope flowpath length — wbt_max_upslope_flowpath_length","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_upslope_value.html","id":null,"dir":"Reference","previous_headings":"","what":"Max upslope value — wbt_max_upslope_value","title":"Max upslope value — wbt_max_upslope_value","text":"Calculates maximum upslope value input values raster along flowpaths.","code":""},{"path":"/reference/wbt_max_upslope_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max upslope value — wbt_max_upslope_value","text":"","code":"wbt_max_upslope_value(   dem,   values,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_upslope_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max upslope value — wbt_max_upslope_value","text":"dem Input DEM; must depressionless. values Name input values raster file. output Name output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_upslope_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max upslope value — wbt_max_upslope_value","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_maximal_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Maximal curvature — wbt_maximal_curvature","title":"Maximal curvature — wbt_maximal_curvature","text":"Calculates mean curvature raster input DEM.","code":""},{"path":"/reference/wbt_maximal_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Maximal curvature — wbt_maximal_curvature","text":"","code":"wbt_maximal_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_maximal_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Maximal curvature — wbt_maximal_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_maximal_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Maximal curvature — wbt_maximal_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_maximum_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Maximum filter — wbt_maximum_filter","title":"Maximum filter — wbt_maximum_filter","text":"Assigns cell output grid maximum value moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_maximum_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Maximum filter — wbt_maximum_filter","text":"","code":"wbt_maximum_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_maximum_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Maximum filter — wbt_maximum_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_maximum_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Maximum filter — wbt_maximum_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_md_inf_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Md inf flow accumulation — wbt_md_inf_flow_accumulation","title":"Md inf flow accumulation — wbt_md_inf_flow_accumulation","text":"Calculates FD8 flow accumulation raster input DEM.","code":""},{"path":"/reference/wbt_md_inf_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Md inf flow accumulation — wbt_md_inf_flow_accumulation","text":"","code":"wbt_md_inf_flow_accumulation(   dem,   output,   out_type = \"specific contributing area\",   exponent = 1.1,   threshold = NULL,   log = FALSE,   clip = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_md_inf_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Md inf flow accumulation — wbt_md_inf_flow_accumulation","text":"dem Input raster DEM file. output Output raster file. out_type Output type; one 'cells', 'specific contributing area' (default), 'catchment area'. exponent Optional exponent parameter; default 1.1. threshold Optional convergence threshold parameter, grid cells; default infinity. log Optional flag request output log-transformed. clip Optional flag request clipping display max 1 percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_md_inf_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Md inf flow accumulation — wbt_md_inf_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_mean_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Mean curvature — wbt_mean_curvature","title":"Mean curvature — wbt_mean_curvature","text":"Calculates mean curvature raster input DEM.","code":""},{"path":"/reference/wbt_mean_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Mean curvature — wbt_mean_curvature","text":"","code":"wbt_mean_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_mean_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Mean curvature — wbt_mean_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_mean_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Mean curvature — wbt_mean_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_mean_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Mean filter — wbt_mean_filter","title":"Mean filter — wbt_mean_filter","text":"Performs mean filter (low-pass filter) input image.","code":""},{"path":"/reference/wbt_mean_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Mean filter — wbt_mean_filter","text":"","code":"wbt_mean_filter(   input,   output,   filterx = 3,   filtery = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_mean_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Mean filter — wbt_mean_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_mean_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Mean filter — wbt_mean_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_median_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Median filter — wbt_median_filter","title":"Median filter — wbt_median_filter","text":"Performs median filter input image.","code":""},{"path":"/reference/wbt_median_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Median filter — wbt_median_filter","text":"","code":"wbt_median_filter(   input,   output,   filterx = 11,   filtery = 11,   sig_digits = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_median_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Median filter — wbt_median_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. sig_digits Number significant digits. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_median_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Median filter — wbt_median_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_medoid.html","id":null,"dir":"Reference","previous_headings":"","what":"Medoid — wbt_medoid","title":"Medoid — wbt_medoid","text":"Calculates medoid series vector features contained shapefile.","code":""},{"path":"/reference/wbt_medoid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Medoid — wbt_medoid","text":"","code":"wbt_medoid(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_medoid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Medoid — wbt_medoid","text":"input Input vector file path. See wbt_file_path() details. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_medoid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Medoid — wbt_medoid","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_merge_line_segments.html","id":null,"dir":"Reference","previous_headings":"","what":"Merge line segments — wbt_merge_line_segments","title":"Merge line segments — wbt_merge_line_segments","text":"Merges vector line segments larger features.","code":""},{"path":"/reference/wbt_merge_line_segments.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Merge line segments — wbt_merge_line_segments","text":"","code":"wbt_merge_line_segments(   input,   output,   snap = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_merge_line_segments.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Merge line segments — wbt_merge_line_segments","text":"input Input vector file path. See wbt_file_path() details. output Output vector file. snap Snap tolerance. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_merge_line_segments.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Merge line segments — wbt_merge_line_segments","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_merge_table_with_csv.html","id":null,"dir":"Reference","previous_headings":"","what":"Merge table with csv — wbt_merge_table_with_csv","title":"Merge table with csv — wbt_merge_table_with_csv","text":"Merge vector's attribute table table contained within CSV text file.","code":""},{"path":"/reference/wbt_merge_table_with_csv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Merge table with csv — wbt_merge_table_with_csv","text":"","code":"wbt_merge_table_with_csv(   input,   pkey,   csv,   fkey,   import_field = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_merge_table_with_csv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Merge table with csv — wbt_merge_table_with_csv","text":"input Input primary vector file (.e. table modified). pkey Primary key field. csv Input CSV file (.e. source data imported). fkey Foreign key field. import_field Imported field (fields imported specified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_merge_table_with_csv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Merge table with csv — wbt_merge_table_with_csv","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_merge_vectors.html","id":null,"dir":"Reference","previous_headings":"","what":"Merge vectors — wbt_merge_vectors","title":"Merge vectors — wbt_merge_vectors","text":"Combines two input vectors ShapeType creating single, new output vector.","code":""},{"path":"/reference/wbt_merge_vectors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Merge vectors — wbt_merge_vectors","text":"","code":"wbt_merge_vectors(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_merge_vectors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Merge vectors — wbt_merge_vectors","text":"inputs Input vector file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_merge_vectors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Merge vectors — wbt_merge_vectors","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min.html","id":null,"dir":"Reference","previous_headings":"","what":"Min — wbt_min","title":"Min — wbt_min","text":"Performs MIN operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_min.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min — wbt_min","text":"","code":"wbt_min(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min — wbt_min","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min — wbt_min","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min_absolute_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Min absolute overlay — wbt_min_absolute_overlay","title":"Min absolute overlay — wbt_min_absolute_overlay","text":"Evaluates minimum absolute value grid cell stack input rasters.","code":""},{"path":"/reference/wbt_min_absolute_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min absolute overlay — wbt_min_absolute_overlay","text":"","code":"wbt_min_absolute_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min_absolute_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min absolute overlay — wbt_min_absolute_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min_absolute_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min absolute overlay — wbt_min_absolute_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min_dist_classification.html","id":null,"dir":"Reference","previous_headings":"","what":"Min dist classification — wbt_min_dist_classification","title":"Min dist classification — wbt_min_dist_classification","text":"Performs supervised minimum-distance classification using training site polygons multi-spectral images.","code":""},{"path":"/reference/wbt_min_dist_classification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min dist classification — wbt_min_dist_classification","text":"","code":"wbt_min_dist_classification(   inputs,   polys,   field,   output,   threshold = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min_dist_classification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min dist classification — wbt_min_dist_classification","text":"inputs Names input band images. polys Name input training site polygons shapefile. field Name attribute containing class name data. output Name output raster file. threshold Distance threshold, z-scores; blank none. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min_dist_classification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min dist classification — wbt_min_dist_classification","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min_downslope_elev_change.html","id":null,"dir":"Reference","previous_headings":"","what":"Min downslope elev change — wbt_min_downslope_elev_change","title":"Min downslope elev change — wbt_min_downslope_elev_change","text":"Calculates minimum downslope change elevation grid cell eight downslope neighbors.","code":""},{"path":"/reference/wbt_min_downslope_elev_change.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min downslope elev change — wbt_min_downslope_elev_change","text":"","code":"wbt_min_downslope_elev_change(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min_downslope_elev_change.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min downslope elev change — wbt_min_downslope_elev_change","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min_downslope_elev_change.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min downslope elev change — wbt_min_downslope_elev_change","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min_max_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Min max contrast stretch — wbt_min_max_contrast_stretch","title":"Min max contrast stretch — wbt_min_max_contrast_stretch","text":"Performs min-max contrast stretch input greytone image.","code":""},{"path":"/reference/wbt_min_max_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min max contrast stretch — wbt_min_max_contrast_stretch","text":"","code":"wbt_min_max_contrast_stretch(   input,   output,   min_val,   max_val,   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min_max_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min max contrast stretch — wbt_min_max_contrast_stretch","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. min_val Lower tail clip value. max_val Upper tail clip value. num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min_max_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min max contrast stretch — wbt_min_max_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Min overlay — wbt_min_overlay","title":"Min overlay — wbt_min_overlay","text":"Evaluates minimum value grid cell stack input rasters.","code":""},{"path":"/reference/wbt_min_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min overlay — wbt_min_overlay","text":"","code":"wbt_min_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min overlay — wbt_min_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min overlay — wbt_min_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimal_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimal curvature — wbt_minimal_curvature","title":"Minimal curvature — wbt_minimal_curvature","text":"Calculates mean curvature raster input DEM.","code":""},{"path":"/reference/wbt_minimal_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimal curvature — wbt_minimal_curvature","text":"","code":"wbt_minimal_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimal_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimal curvature — wbt_minimal_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimal_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimal curvature — wbt_minimal_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimum_bounding_box.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimum bounding box — wbt_minimum_bounding_box","title":"Minimum bounding box — wbt_minimum_bounding_box","text":"Creates vector minimum bounding rectangle around vector features.","code":""},{"path":"/reference/wbt_minimum_bounding_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimum bounding box — wbt_minimum_bounding_box","text":"","code":"wbt_minimum_bounding_box(   input,   output,   criterion = \"area\",   features = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimum_bounding_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimum bounding box — wbt_minimum_bounding_box","text":"input Input vector file path. See wbt_file_path() details. output Output vector polygon file. criterion Minimization criterion; options include 'area' (default), 'length', 'width', 'perimeter'. features Find minimum bounding rectangles around individual vector feature. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimum_bounding_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimum bounding box — wbt_minimum_bounding_box","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimum_bounding_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimum bounding circle — wbt_minimum_bounding_circle","title":"Minimum bounding circle — wbt_minimum_bounding_circle","text":"Delineates minimum bounding circle (.e. smallest enclosing circle) group vectors.","code":""},{"path":"/reference/wbt_minimum_bounding_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimum bounding circle — wbt_minimum_bounding_circle","text":"","code":"wbt_minimum_bounding_circle(   input,   output,   features = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimum_bounding_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimum bounding circle — wbt_minimum_bounding_circle","text":"input Input vector file path. See wbt_file_path() details. output Output vector polygon file. features Find minimum bounding circle around individual vector feature. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimum_bounding_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimum bounding circle — wbt_minimum_bounding_circle","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimum_bounding_envelope.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimum bounding envelope — wbt_minimum_bounding_envelope","title":"Minimum bounding envelope — wbt_minimum_bounding_envelope","text":"Creates vector axis-aligned minimum bounding rectangle (envelope) around vector features.","code":""},{"path":"/reference/wbt_minimum_bounding_envelope.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimum bounding envelope — wbt_minimum_bounding_envelope","text":"","code":"wbt_minimum_bounding_envelope(   input,   output,   features = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimum_bounding_envelope.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimum bounding envelope — wbt_minimum_bounding_envelope","text":"input Input vector file path. See wbt_file_path() details. output Output vector polygon file. features Find minimum bounding envelop around individual vector feature. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimum_bounding_envelope.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimum bounding envelope — wbt_minimum_bounding_envelope","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimum_convex_hull.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimum convex hull — wbt_minimum_convex_hull","title":"Minimum convex hull — wbt_minimum_convex_hull","text":"Creates vector convex polygon around vector features.","code":""},{"path":"/reference/wbt_minimum_convex_hull.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimum convex hull — wbt_minimum_convex_hull","text":"","code":"wbt_minimum_convex_hull(   input,   output,   features = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimum_convex_hull.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimum convex hull — wbt_minimum_convex_hull","text":"input Input vector file path. See wbt_file_path() details. output Output vector polygon file. features Find hulls around vector feature. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimum_convex_hull.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimum convex hull — wbt_minimum_convex_hull","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimum_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimum filter — wbt_minimum_filter","title":"Minimum filter — wbt_minimum_filter","text":"Assigns cell output grid minimum value moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_minimum_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimum filter — wbt_minimum_filter","text":"","code":"wbt_minimum_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimum_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimum filter — wbt_minimum_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimum_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimum filter — wbt_minimum_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_modified_k_means_clustering.html","id":null,"dir":"Reference","previous_headings":"","what":"Modified k means clustering — wbt_modified_k_means_clustering","title":"Modified k means clustering — wbt_modified_k_means_clustering","text":"Performs modified k-means clustering operation multi-spectral dataset.","code":""},{"path":"/reference/wbt_modified_k_means_clustering.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modified k means clustering — wbt_modified_k_means_clustering","text":"","code":"wbt_modified_k_means_clustering(   inputs,   output,   out_html = NULL,   start_clusters = 1000,   merge_dist = NULL,   max_iterations = 10,   class_change = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_modified_k_means_clustering.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modified k means clustering — wbt_modified_k_means_clustering","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. out_html Output HTML report file. start_clusters Initial number clusters. merge_dist Cluster merger distance. max_iterations Maximum number iterations. class_change Minimum percent cells changed iterations completion. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_modified_k_means_clustering.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Modified k means clustering — wbt_modified_k_means_clustering","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_modify_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Modify lidar — wbt_modify_lidar","title":"Modify lidar — wbt_modify_lidar","text":"Modify points within LiDAR point cloud based point properties.","code":""},{"path":"/reference/wbt_modify_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modify lidar — wbt_modify_lidar","text":"","code":"wbt_modify_lidar(   input,   output = NULL,   statement = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_modify_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modify lidar — wbt_modify_lidar","text":"input Name input LiDAR points. output Name output LiDAR points. statement Modify statement e.g. x += 5000.0. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_modify_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Modify lidar — wbt_modify_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_modify_no_data_value.html","id":null,"dir":"Reference","previous_headings":"","what":"Modify no data value — wbt_modify_no_data_value","title":"Modify no data value — wbt_modify_no_data_value","text":"Modifies nodata values raster.","code":""},{"path":"/reference/wbt_modify_no_data_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modify no data value — wbt_modify_no_data_value","text":"","code":"wbt_modify_no_data_value(   input,   new_value = \"-32768.0\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_modify_no_data_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modify no data value — wbt_modify_no_data_value","text":"input Input raster file path. See wbt_file_path() details. new_value New NoData value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_modify_no_data_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Modify no data value — wbt_modify_no_data_value","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_modulo.html","id":null,"dir":"Reference","previous_headings":"","what":"Modulo — wbt_modulo","title":"Modulo — wbt_modulo","text":"Performs modulo operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_modulo.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modulo — wbt_modulo","text":"","code":"wbt_modulo(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_modulo.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modulo — wbt_modulo","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_modulo.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Modulo — wbt_modulo","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_mosaic.html","id":null,"dir":"Reference","previous_headings":"","what":"Mosaic — wbt_mosaic","title":"Mosaic — wbt_mosaic","text":"Mosaics two images together.","code":""},{"path":"/reference/wbt_mosaic.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Mosaic — wbt_mosaic","text":"","code":"wbt_mosaic(   output,   inputs = NULL,   method = \"nn\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_mosaic.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Mosaic — wbt_mosaic","text":"output Output raster file. inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', 'cc' (cubic convolution). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_mosaic.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Mosaic — wbt_mosaic","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_mosaic_with_feathering.html","id":null,"dir":"Reference","previous_headings":"","what":"Mosaic with feathering — wbt_mosaic_with_feathering","title":"Mosaic with feathering — wbt_mosaic_with_feathering","text":"Mosaics two images together using feathering technique overlapping areas reduce edge-effects.","code":""},{"path":"/reference/wbt_mosaic_with_feathering.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Mosaic with feathering — wbt_mosaic_with_feathering","text":"","code":"wbt_mosaic_with_feathering(   input1,   input2,   output,   method = \"cc\",   weight = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_mosaic_with_feathering.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Mosaic with feathering — wbt_mosaic_with_feathering","text":"input1 Input raster file modify. input2 Input reference raster file. output Output raster file. method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', 'cc' (cubic convolution). weight . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_mosaic_with_feathering.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Mosaic with feathering — wbt_mosaic_with_feathering","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multi_part_to_single_part.html","id":null,"dir":"Reference","previous_headings":"","what":"Multi part to single part — wbt_multi_part_to_single_part","title":"Multi part to single part — wbt_multi_part_to_single_part","text":"Converts vector file containing multi-part features vector containing single-part features.","code":""},{"path":"/reference/wbt_multi_part_to_single_part.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multi part to single part — wbt_multi_part_to_single_part","text":"","code":"wbt_multi_part_to_single_part(   input,   output,   exclude_holes = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multi_part_to_single_part.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multi part to single part — wbt_multi_part_to_single_part","text":"input Input vector line polygon file. output Output vector line polygon file. exclude_holes Exclude hole parts feature splitting? (holes continue belong features output.). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multi_part_to_single_part.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multi part to single part — wbt_multi_part_to_single_part","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multidirectional_hillshade.html","id":null,"dir":"Reference","previous_headings":"","what":"Multidirectional hillshade — wbt_multidirectional_hillshade","title":"Multidirectional hillshade — wbt_multidirectional_hillshade","text":"Calculates multi-direction hillshade raster input DEM.","code":""},{"path":"/reference/wbt_multidirectional_hillshade.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multidirectional hillshade — wbt_multidirectional_hillshade","text":"","code":"wbt_multidirectional_hillshade(   dem,   output,   altitude = 45,   zfactor = NULL,   full_mode = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multidirectional_hillshade.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multidirectional hillshade — wbt_multidirectional_hillshade","text":"dem Input raster DEM file. output Output raster file. altitude Illumination source altitude degrees. zfactor Optional multiplier vertical horizontal units . full_mode Optional flag indicating whether use full 360-degrees illumination sources. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multidirectional_hillshade.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multidirectional hillshade — wbt_multidirectional_hillshade","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiply.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiply — wbt_multiply","title":"Multiply — wbt_multiply","text":"Performs multiplication operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_multiply.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiply — wbt_multiply","text":"","code":"wbt_multiply(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiply.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiply — wbt_multiply","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiply.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiply — wbt_multiply","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiply_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiply overlay — wbt_multiply_overlay","title":"Multiply overlay — wbt_multiply_overlay","text":"Calculates sum grid cell group raster images.","code":""},{"path":"/reference/wbt_multiply_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiply overlay — wbt_multiply_overlay","text":"","code":"wbt_multiply_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiply_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiply overlay — wbt_multiply_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiply_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiply overlay — wbt_multiply_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_curvatures.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale curvatures — wbt_multiscale_curvatures","title":"Multiscale curvatures — wbt_multiscale_curvatures","text":"tool calculates several multiscale curvatures curvature-based indices input DEM.","code":""},{"path":"/reference/wbt_multiscale_curvatures.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale curvatures — wbt_multiscale_curvatures","text":"","code":"wbt_multiscale_curvatures(   dem,   out_mag,   curv_type = \"ProfileCurv\",   out_scale = NULL,   min_scale = 0,   step = 1,   num_steps = 1,   step_nonlinearity = 1,   log = TRUE,   standardize = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_curvatures.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale curvatures — wbt_multiscale_curvatures","text":"dem Name input raster DEM file. out_mag Output raster magnitude file. curv_type Curvature type. out_scale Output raster scale file. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). log Display output values using log-scale. standardize scale standardized z-scores?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_curvatures.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale curvatures — wbt_multiscale_curvatures","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_elevation_percentile.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale elevation percentile — wbt_multiscale_elevation_percentile","title":"Multiscale elevation percentile — wbt_multiscale_elevation_percentile","text":"Calculates surface roughness range spatial scales.","code":""},{"path":"/reference/wbt_multiscale_elevation_percentile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale elevation percentile — wbt_multiscale_elevation_percentile","text":"","code":"wbt_multiscale_elevation_percentile(   dem,   out_mag,   out_scale,   sig_digits = 3,   min_scale = 4,   step = 1,   num_steps = 10,   step_nonlinearity = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_elevation_percentile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale elevation percentile — wbt_multiscale_elevation_percentile","text":"dem Input raster DEM file. out_mag Output raster roughness magnitude file. out_scale Output raster roughness scale file. sig_digits Number significant digits. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_elevation_percentile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale elevation percentile — wbt_multiscale_elevation_percentile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_roughness.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale roughness — wbt_multiscale_roughness","title":"Multiscale roughness — wbt_multiscale_roughness","text":"Calculates surface roughness range spatial scales.","code":""},{"path":"/reference/wbt_multiscale_roughness.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale roughness — wbt_multiscale_roughness","text":"","code":"wbt_multiscale_roughness(   dem,   out_mag,   out_scale,   max_scale,   min_scale = 1,   step = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_roughness.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale roughness — wbt_multiscale_roughness","text":"dem Input raster DEM file. out_mag Output raster roughness magnitude file. out_scale Output raster roughness scale file. max_scale Maximum search neighbourhood radius grid cells. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_roughness.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale roughness — wbt_multiscale_roughness","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_roughness_signature.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale roughness signature — wbt_multiscale_roughness_signature","title":"Multiscale roughness signature — wbt_multiscale_roughness_signature","text":"Calculates surface roughness points range spatial scales.","code":""},{"path":"/reference/wbt_multiscale_roughness_signature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale roughness signature — wbt_multiscale_roughness_signature","text":"","code":"wbt_multiscale_roughness_signature(   dem,   points,   output,   max_scale,   min_scale = 1,   step = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_roughness_signature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale roughness signature — wbt_multiscale_roughness_signature","text":"dem Input raster DEM file. points Input vector points file. output Output HTML file. max_scale Maximum search neighbourhood radius grid cells. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_roughness_signature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale roughness signature — wbt_multiscale_roughness_signature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale std dev normals — wbt_multiscale_std_dev_normals","title":"Multiscale std dev normals — wbt_multiscale_std_dev_normals","text":"Calculates surface roughness range spatial scales.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale std dev normals — wbt_multiscale_std_dev_normals","text":"","code":"wbt_multiscale_std_dev_normals(   dem,   out_mag,   out_scale,   min_scale = 1,   step = 1,   num_steps = 10,   step_nonlinearity = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_std_dev_normals.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale std dev normals — wbt_multiscale_std_dev_normals","text":"dem Input raster DEM file. out_mag Output raster roughness magnitude file. out_scale Output raster roughness scale file. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale std dev normals — wbt_multiscale_std_dev_normals","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals_signature.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale std dev normals signature — wbt_multiscale_std_dev_normals_signature","title":"Multiscale std dev normals signature — wbt_multiscale_std_dev_normals_signature","text":"Calculates surface roughness points range spatial scales.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals_signature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale std dev normals signature — wbt_multiscale_std_dev_normals_signature","text":"","code":"wbt_multiscale_std_dev_normals_signature(   dem,   points,   output,   min_scale = 1,   step = 1,   num_steps = 10,   step_nonlinearity = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_std_dev_normals_signature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale std dev normals signature — wbt_multiscale_std_dev_normals_signature","text":"dem Input raster DEM file. points Input vector points file. output Output HTML file. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals_signature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale std dev normals signature — wbt_multiscale_std_dev_normals_signature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_topographic_position_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale topographic position image — wbt_multiscale_topographic_position_image","title":"Multiscale topographic position image — wbt_multiscale_topographic_position_image","text":"Creates multiscale topographic position image three DEVmax rasters differing spatial scale ranges.","code":""},{"path":"/reference/wbt_multiscale_topographic_position_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale topographic position image — wbt_multiscale_topographic_position_image","text":"","code":"wbt_multiscale_topographic_position_image(   local,   meso,   broad,   output,   hillshade = NULL,   lightness = 1.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_topographic_position_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale topographic position image — wbt_multiscale_topographic_position_image","text":"local Input local-scale topographic position (DEVmax) raster file. meso Input meso-scale topographic position (DEVmax) raster file. broad Input broad-scale topographic position (DEVmax) raster file. output Output raster file. hillshade Input optional hillshade raster file. Note: multi-directional (360-degree option) hillshade tends work best application. lightness Image lightness value (default 1.2). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_topographic_position_image.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale topographic position image — wbt_multiscale_topographic_position_image","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_narrowness_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Narrowness index — wbt_narrowness_index","title":"Narrowness index — wbt_narrowness_index","text":"Calculates narrowness raster polygons.","code":""},{"path":"/reference/wbt_narrowness_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Narrowness index — wbt_narrowness_index","text":"","code":"wbt_narrowness_index(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_narrowness_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Narrowness index — wbt_narrowness_index","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_narrowness_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Narrowness index — wbt_narrowness_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_natural_neighbour_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Natural neighbour interpolation — wbt_natural_neighbour_interpolation","title":"Natural neighbour interpolation — wbt_natural_neighbour_interpolation","text":"Creates raster grid based Sibson's natural neighbour method.","code":""},{"path":"/reference/wbt_natural_neighbour_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Natural neighbour interpolation — wbt_natural_neighbour_interpolation","text":"","code":"wbt_natural_neighbour_interpolation(   input,   output,   field = NULL,   use_z = FALSE,   cell_size = NULL,   base = NULL,   clip = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_natural_neighbour_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Natural neighbour interpolation — wbt_natural_neighbour_interpolation","text":"input Input vector points file. output Output raster file. field Input field name attribute table. use_z Use 'z' dimension Shapefile's geometry instead attribute field?. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. clip Clip data convex hull points?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_natural_neighbour_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Natural neighbour interpolation — wbt_natural_neighbour_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_nearest_neighbour_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Nearest neighbour gridding — wbt_nearest_neighbour_gridding","title":"Nearest neighbour gridding — wbt_nearest_neighbour_gridding","text":"Creates raster grid based set vector points assigns grid values using nearest neighbour.","code":""},{"path":"/reference/wbt_nearest_neighbour_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Nearest neighbour gridding — wbt_nearest_neighbour_gridding","text":"","code":"wbt_nearest_neighbour_gridding(   input,   field,   output,   use_z = FALSE,   cell_size = NULL,   base = NULL,   max_dist = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_nearest_neighbour_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Nearest neighbour gridding — wbt_nearest_neighbour_gridding","text":"input Input vector Points file. field Input field name attribute table. output Output raster file. use_z Use z-coordinate instead field?. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. max_dist Maximum search distance (optional). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_nearest_neighbour_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Nearest neighbour gridding — wbt_nearest_neighbour_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_negate.html","id":null,"dir":"Reference","previous_headings":"","what":"Negate — wbt_negate","title":"Negate — wbt_negate","text":"Changes sign values raster 0-1 values Boolean raster.","code":""},{"path":"/reference/wbt_negate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Negate — wbt_negate","text":"","code":"wbt_negate(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_negate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Negate — wbt_negate","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_negate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Negate — wbt_negate","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_new_raster_from_base.html","id":null,"dir":"Reference","previous_headings":"","what":"New raster from base — wbt_new_raster_from_base","title":"New raster from base — wbt_new_raster_from_base","text":"Creates new raster using base image.","code":""},{"path":"/reference/wbt_new_raster_from_base.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"New raster from base — wbt_new_raster_from_base","text":"","code":"wbt_new_raster_from_base(   base,   output,   value = \"nodata\",   data_type = \"float\",   cell_size = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_new_raster_from_base.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"New raster from base — wbt_new_raster_from_base","text":"base Input base raster file. output Output raster file. value Constant value fill raster ; either 'nodata' numeric value. data_type Output raster data type; options include 'double' (64-bit), 'float' (32-bit), 'integer' (signed 16-bit) (default 'float'). cell_size Optionally specified cell size output raster. used base raster specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_new_raster_from_base.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"New raster from base — wbt_new_raster_from_base","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_normal_vectors.html","id":null,"dir":"Reference","previous_headings":"","what":"Normal vectors — wbt_normal_vectors","title":"Normal vectors — wbt_normal_vectors","text":"Calculates normal vectors points within LAS file stores data (XYZ vector components) RGB field.","code":""},{"path":"/reference/wbt_normal_vectors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Normal vectors — wbt_normal_vectors","text":"","code":"wbt_normal_vectors(   input,   output,   radius = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_normal_vectors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Normal vectors — wbt_normal_vectors","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_normal_vectors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Normal vectors — wbt_normal_vectors","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_normalize_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Normalize lidar — wbt_normalize_lidar","title":"Normalize lidar — wbt_normalize_lidar","text":"Normalizes LiDAR point cloud.","code":""},{"path":"/reference/wbt_normalize_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Normalize lidar — wbt_normalize_lidar","text":"","code":"wbt_normalize_lidar(   input,   output,   dtm,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_normalize_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Normalize lidar — wbt_normalize_lidar","text":"input Name input LiDAR file. output Name output LiDAR file. dtm Name input digital terrain model (DTM) raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_normalize_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Normalize lidar — wbt_normalize_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_normalized_difference_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Normalized difference index — wbt_normalized_difference_index","title":"Normalized difference index — wbt_normalized_difference_index","text":"Calculate normalized-difference index (NDI) two bands multispectral image data.","code":""},{"path":"/reference/wbt_normalized_difference_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Normalized difference index — wbt_normalized_difference_index","text":"","code":"wbt_normalized_difference_index(   input1,   input2,   output,   clip = 0,   correction = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_normalized_difference_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Normalized difference index — wbt_normalized_difference_index","text":"input1 Input image 1 (e.g. near-infrared band). input2 Input image 2 (e.g. red band). output Output raster file. clip Optional amount clip distribution tails , percent. correction Optional adjustment value (e.g. 1, 0.16 optimal soil adjusted vegetation index, OSAVI). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_normalized_difference_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Normalized difference index — wbt_normalized_difference_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_not.html","id":null,"dir":"Reference","previous_headings":"","what":"Not — wbt_not","title":"Not — wbt_not","text":"Performs logical operator two Boolean raster images.","code":""},{"path":"/reference/wbt_not.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Not — wbt_not","text":"","code":"wbt_not(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_not.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Not — wbt_not","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_not.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Not — wbt_not","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_not_equal_to.html","id":null,"dir":"Reference","previous_headings":"","what":"Not equal to — wbt_not_equal_to","title":"Not equal to — wbt_not_equal_to","text":"Performs -equal-comparison operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_not_equal_to.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Not equal to — wbt_not_equal_to","text":"","code":"wbt_not_equal_to(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_not_equal_to.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Not equal to — wbt_not_equal_to","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_not_equal_to.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Not equal to — wbt_not_equal_to","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_num_downslope_neighbours.html","id":null,"dir":"Reference","previous_headings":"","what":"Num downslope neighbours — wbt_num_downslope_neighbours","title":"Num downslope neighbours — wbt_num_downslope_neighbours","text":"Calculates number downslope neighbours grid cell DEM.","code":""},{"path":"/reference/wbt_num_downslope_neighbours.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Num downslope neighbours — wbt_num_downslope_neighbours","text":"","code":"wbt_num_downslope_neighbours(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_num_downslope_neighbours.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Num downslope neighbours — wbt_num_downslope_neighbours","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_num_downslope_neighbours.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Num downslope neighbours — wbt_num_downslope_neighbours","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_num_inflowing_neighbours.html","id":null,"dir":"Reference","previous_headings":"","what":"Num inflowing neighbours — wbt_num_inflowing_neighbours","title":"Num inflowing neighbours — wbt_num_inflowing_neighbours","text":"Computes number inflowing neighbours cell input DEM based D8 algorithm.","code":""},{"path":"/reference/wbt_num_inflowing_neighbours.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Num inflowing neighbours — wbt_num_inflowing_neighbours","text":"","code":"wbt_num_inflowing_neighbours(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_num_inflowing_neighbours.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Num inflowing neighbours — wbt_num_inflowing_neighbours","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_num_inflowing_neighbours.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Num inflowing neighbours — wbt_num_inflowing_neighbours","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_num_upslope_neighbours.html","id":null,"dir":"Reference","previous_headings":"","what":"Num upslope neighbours — wbt_num_upslope_neighbours","title":"Num upslope neighbours — wbt_num_upslope_neighbours","text":"Calculates number upslope neighbours grid cell DEM.","code":""},{"path":"/reference/wbt_num_upslope_neighbours.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Num upslope neighbours — wbt_num_upslope_neighbours","text":"","code":"wbt_num_upslope_neighbours(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_num_upslope_neighbours.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Num upslope neighbours — wbt_num_upslope_neighbours","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_num_upslope_neighbours.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Num upslope neighbours — wbt_num_upslope_neighbours","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_olympic_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Olympic filter — wbt_olympic_filter","title":"Olympic filter — wbt_olympic_filter","text":"Performs olympic smoothing filter image.","code":""},{"path":"/reference/wbt_olympic_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Olympic filter — wbt_olympic_filter","text":"","code":"wbt_olympic_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_olympic_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Olympic filter — wbt_olympic_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_olympic_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Olympic filter — wbt_olympic_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_opening.html","id":null,"dir":"Reference","previous_headings":"","what":"Opening — wbt_opening","title":"Opening — wbt_opening","text":"opening mathematical morphology operation involving dilation (max filter) erosion (min filter) set.","code":""},{"path":"/reference/wbt_opening.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Opening — wbt_opening","text":"","code":"wbt_opening(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_opening.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Opening — wbt_opening","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_opening.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Opening — wbt_opening","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_openness.html","id":null,"dir":"Reference","previous_headings":"","what":"Openness — wbt_openness","title":"Openness — wbt_openness","text":"tool calculates topographic openness index input DEM.","code":""},{"path":"/reference/wbt_openness.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Openness — wbt_openness","text":"","code":"wbt_openness(   input,   pos_output,   neg_output,   dist = 20,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_openness.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Openness — wbt_openness","text":"input Name input raster DEM file. pos_output Name positive openness output raster file. neg_output Name negative openness output raster file. dist Search distance, grid cells. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_openness.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Openness — wbt_openness","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_or.html","id":null,"dir":"Reference","previous_headings":"","what":"Or — wbt_or","title":"Or — wbt_or","text":"Performs logical operator two Boolean raster images.","code":""},{"path":"/reference/wbt_or.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Or — wbt_or","text":"","code":"wbt_or(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_or.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Or — wbt_or","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_or.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Or — wbt_or","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_paired_sample_t_test.html","id":null,"dir":"Reference","previous_headings":"","what":"Paired sample t test — wbt_paired_sample_t_test","title":"Paired sample t test — wbt_paired_sample_t_test","text":"Performs 2-sample K-S test significant differences two input rasters.","code":""},{"path":"/reference/wbt_paired_sample_t_test.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Paired sample t test — wbt_paired_sample_t_test","text":"","code":"wbt_paired_sample_t_test(   input1,   input2,   output,   num_samples = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_paired_sample_t_test.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Paired sample t test — wbt_paired_sample_t_test","text":"input1 First input raster file. input2 Second input raster file. output Output HTML file. num_samples Number samples. Leave blank use whole image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_paired_sample_t_test.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Paired sample t test — wbt_paired_sample_t_test","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_panchromatic_sharpening.html","id":null,"dir":"Reference","previous_headings":"","what":"Panchromatic sharpening — wbt_panchromatic_sharpening","title":"Panchromatic sharpening — wbt_panchromatic_sharpening","text":"Increases spatial resolution image data combining multispectral bands panchromatic data.","code":""},{"path":"/reference/wbt_panchromatic_sharpening.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Panchromatic sharpening — wbt_panchromatic_sharpening","text":"","code":"wbt_panchromatic_sharpening(   pan,   output,   red = NULL,   green = NULL,   blue = NULL,   composite = NULL,   method = \"brovey\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_panchromatic_sharpening.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Panchromatic sharpening — wbt_panchromatic_sharpening","text":"pan Input panchromatic band file. output Output colour composite file. red Input red band image file. Optionally specified colour-composite specified. green Input green band image file. Optionally specified colour-composite specified. blue Input blue band image file. Optionally specified colour-composite specified. composite Input colour-composite image file. used individual bands specified. method Options include 'brovey' (default) 'ihs'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_panchromatic_sharpening.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Panchromatic sharpening — wbt_panchromatic_sharpening","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_parallelepiped_classification.html","id":null,"dir":"Reference","previous_headings":"","what":"Parallelepiped classification — wbt_parallelepiped_classification","title":"Parallelepiped classification — wbt_parallelepiped_classification","text":"Performs supervised parallelepiped classification using training site polygons multi-spectral images.","code":""},{"path":"/reference/wbt_parallelepiped_classification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parallelepiped classification — wbt_parallelepiped_classification","text":"","code":"wbt_parallelepiped_classification(   inputs,   polys,   field,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_parallelepiped_classification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parallelepiped classification — wbt_parallelepiped_classification","text":"inputs Name input band images. polys Name input training site polygons shapefile. field Name attribute containing class name data. output Name output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_parallelepiped_classification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parallelepiped classification — wbt_parallelepiped_classification","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_patch_orientation.html","id":null,"dir":"Reference","previous_headings":"","what":"Patch orientation — wbt_patch_orientation","title":"Patch orientation — wbt_patch_orientation","text":"Calculates orientation vector polygons.","code":""},{"path":"/reference/wbt_patch_orientation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Patch orientation — wbt_patch_orientation","text":"","code":"wbt_patch_orientation(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_patch_orientation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Patch orientation — wbt_patch_orientation","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_patch_orientation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Patch orientation — wbt_patch_orientation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_pennock_landform_class.html","id":null,"dir":"Reference","previous_headings":"","what":"Pennock landform class — wbt_pennock_landform_class","title":"Pennock landform class — wbt_pennock_landform_class","text":"Classifies hillslope zones based slope, profile curvature, plan curvature.","code":""},{"path":"/reference/wbt_pennock_landform_class.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pennock landform class — wbt_pennock_landform_class","text":"","code":"wbt_pennock_landform_class(   dem,   output,   slope = 3,   prof = 0.1,   plan = 0,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_pennock_landform_class.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pennock landform class — wbt_pennock_landform_class","text":"dem Input raster DEM file. output Output raster file. slope Slope threshold value, degrees (default 3.0). prof Profile curvature threshold value (default 0.1). plan Plan curvature threshold value (default 0.0). zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_pennock_landform_class.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pennock landform class — wbt_pennock_landform_class","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percent_elev_range.html","id":null,"dir":"Reference","previous_headings":"","what":"Percent elev range — wbt_percent_elev_range","title":"Percent elev range — wbt_percent_elev_range","text":"Calculates percent elevation range DEM.","code":""},{"path":"/reference/wbt_percent_elev_range.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percent elev range — wbt_percent_elev_range","text":"","code":"wbt_percent_elev_range(   dem,   output,   filterx = 3,   filtery = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percent_elev_range.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percent elev range — wbt_percent_elev_range","text":"dem Input raster DEM file. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percent_elev_range.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percent elev range — wbt_percent_elev_range","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percent_equal_to.html","id":null,"dir":"Reference","previous_headings":"","what":"Percent equal to — wbt_percent_equal_to","title":"Percent equal to — wbt_percent_equal_to","text":"Calculates percentage raster stack cell values equal input cell--cell basis.","code":""},{"path":"/reference/wbt_percent_equal_to.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percent equal to — wbt_percent_equal_to","text":"","code":"wbt_percent_equal_to(   inputs,   comparison,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percent_equal_to.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percent equal to — wbt_percent_equal_to","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. comparison Input comparison raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percent_equal_to.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percent equal to — wbt_percent_equal_to","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percent_greater_than.html","id":null,"dir":"Reference","previous_headings":"","what":"Percent greater than — wbt_percent_greater_than","title":"Percent greater than — wbt_percent_greater_than","text":"Calculates percentage raster stack cell values greater input cell--cell basis.","code":""},{"path":"/reference/wbt_percent_greater_than.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percent greater than — wbt_percent_greater_than","text":"","code":"wbt_percent_greater_than(   inputs,   comparison,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percent_greater_than.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percent greater than — wbt_percent_greater_than","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. comparison Input comparison raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percent_greater_than.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percent greater than — wbt_percent_greater_than","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percent_less_than.html","id":null,"dir":"Reference","previous_headings":"","what":"Percent less than — wbt_percent_less_than","title":"Percent less than — wbt_percent_less_than","text":"Calculates percentage raster stack cell values less input cell--cell basis.","code":""},{"path":"/reference/wbt_percent_less_than.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percent less than — wbt_percent_less_than","text":"","code":"wbt_percent_less_than(   inputs,   comparison,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percent_less_than.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percent less than — wbt_percent_less_than","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. comparison Input comparison raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percent_less_than.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percent less than — wbt_percent_less_than","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percentage_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Percentage contrast stretch — wbt_percentage_contrast_stretch","title":"Percentage contrast stretch — wbt_percentage_contrast_stretch","text":"Performs percentage linear contrast stretch input images.","code":""},{"path":"/reference/wbt_percentage_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percentage contrast stretch — wbt_percentage_contrast_stretch","text":"","code":"wbt_percentage_contrast_stretch(   input,   output,   clip = 1,   tail = \"both\",   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percentage_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percentage contrast stretch — wbt_percentage_contrast_stretch","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. clip Optional amount clip distribution tails , percent. tail Specified tails clip; options include 'upper', 'lower', '' (default ''). num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percentage_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percentage contrast stretch — wbt_percentage_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percentile_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Percentile filter — wbt_percentile_filter","title":"Percentile filter — wbt_percentile_filter","text":"Performs percentile filter input image.","code":""},{"path":"/reference/wbt_percentile_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percentile filter — wbt_percentile_filter","text":"","code":"wbt_percentile_filter(   input,   output,   filterx = 11,   filtery = 11,   sig_digits = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percentile_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percentile filter — wbt_percentile_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. sig_digits Number significant digits. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percentile_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percentile filter — wbt_percentile_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_perimeter_area_ratio.html","id":null,"dir":"Reference","previous_headings":"","what":"Perimeter area ratio — wbt_perimeter_area_ratio","title":"Perimeter area ratio — wbt_perimeter_area_ratio","text":"Calculates perimeter-area ratio vector polygons.","code":""},{"path":"/reference/wbt_perimeter_area_ratio.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Perimeter area ratio — wbt_perimeter_area_ratio","text":"","code":"wbt_perimeter_area_ratio(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_perimeter_area_ratio.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Perimeter area ratio — wbt_perimeter_area_ratio","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_perimeter_area_ratio.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Perimeter area ratio — wbt_perimeter_area_ratio","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_phi_coefficient.html","id":null,"dir":"Reference","previous_headings":"","what":"Phi coefficient — wbt_phi_coefficient","title":"Phi coefficient — wbt_phi_coefficient","text":"tool performs binary classification accuracy assessment.","code":""},{"path":"/reference/wbt_phi_coefficient.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Phi coefficient — wbt_phi_coefficient","text":"","code":"wbt_phi_coefficient(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_phi_coefficient.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Phi coefficient — wbt_phi_coefficient","text":"input1 Name first input raster image file. input2 Name second input raster image file. output Name output HTML file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_phi_coefficient.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Phi coefficient — wbt_phi_coefficient","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_pick_from_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Pick from list — wbt_pick_from_list","title":"Pick from list — wbt_pick_from_list","text":"Outputs value raster stack specified position raster.","code":""},{"path":"/reference/wbt_pick_from_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pick from list — wbt_pick_from_list","text":"","code":"wbt_pick_from_list(   inputs,   pos_input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_pick_from_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pick from list — wbt_pick_from_list","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. pos_input Input position raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_pick_from_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pick from list — wbt_pick_from_list","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_piecewise_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Piecewise contrast stretch — wbt_piecewise_contrast_stretch","title":"Piecewise contrast stretch — wbt_piecewise_contrast_stretch","text":"Performs piecewise contrast stretch input image.","code":""},{"path":"/reference/wbt_piecewise_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Piecewise contrast stretch — wbt_piecewise_contrast_stretch","text":"","code":"wbt_piecewise_contrast_stretch(   input,   output,   FUN = \"\",   greytones = 1024,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_piecewise_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Piecewise contrast stretch — wbt_piecewise_contrast_stretch","text":"input Name input raster image file. output Name output raster image file. FUN Piecewise break-points e.g. '(50, 0.1); (150, 0.8); (255; 1.0). greytones Number greytones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_piecewise_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Piecewise contrast stretch — wbt_piecewise_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_plan_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Plan curvature — wbt_plan_curvature","title":"Plan curvature — wbt_plan_curvature","text":"Calculates plan (contour) curvature raster input DEM.","code":""},{"path":"/reference/wbt_plan_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plan curvature — wbt_plan_curvature","text":"","code":"wbt_plan_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_plan_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plan curvature — wbt_plan_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_plan_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plan curvature — wbt_plan_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygon_area.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygon area — wbt_polygon_area","title":"Polygon area — wbt_polygon_area","text":"Calculates area vector polygons.","code":""},{"path":"/reference/wbt_polygon_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygon area — wbt_polygon_area","text":"","code":"wbt_polygon_area(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygon_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygon area — wbt_polygon_area","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygon_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygon area — wbt_polygon_area","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygon_long_axis.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygon long axis — wbt_polygon_long_axis","title":"Polygon long axis — wbt_polygon_long_axis","text":"Used map long axis polygon features.","code":""},{"path":"/reference/wbt_polygon_long_axis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygon long axis — wbt_polygon_long_axis","text":"","code":"wbt_polygon_long_axis(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygon_long_axis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygon long axis — wbt_polygon_long_axis","text":"input Input vector polygons file. output Output vector polyline file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygon_long_axis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygon long axis — wbt_polygon_long_axis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygon_perimeter.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygon perimeter — wbt_polygon_perimeter","title":"Polygon perimeter — wbt_polygon_perimeter","text":"Calculates perimeter vector polygons.","code":""},{"path":"/reference/wbt_polygon_perimeter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygon perimeter — wbt_polygon_perimeter","text":"","code":"wbt_polygon_perimeter(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygon_perimeter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygon perimeter — wbt_polygon_perimeter","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygon_perimeter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygon perimeter — wbt_polygon_perimeter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygon_short_axis.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygon short axis — wbt_polygon_short_axis","title":"Polygon short axis — wbt_polygon_short_axis","text":"Used map short axis polygon features.","code":""},{"path":"/reference/wbt_polygon_short_axis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygon short axis — wbt_polygon_short_axis","text":"","code":"wbt_polygon_short_axis(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygon_short_axis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygon short axis — wbt_polygon_short_axis","text":"input Input vector polygons file. output Output vector polyline file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygon_short_axis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygon short axis — wbt_polygon_short_axis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygonize.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygonize — wbt_polygonize","title":"Polygonize — wbt_polygonize","text":"Creates polygon layer two intersecting line features contained one input vector line files.","code":""},{"path":"/reference/wbt_polygonize.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygonize — wbt_polygonize","text":"","code":"wbt_polygonize(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygonize.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygonize — wbt_polygonize","text":"inputs Input vector polyline file. output Output vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygonize.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygonize — wbt_polygonize","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygons_to_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygons to lines — wbt_polygons_to_lines","title":"Polygons to lines — wbt_polygons_to_lines","text":"Converts vector polygons polylines.","code":""},{"path":"/reference/wbt_polygons_to_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygons to lines — wbt_polygons_to_lines","text":"","code":"wbt_polygons_to_lines(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygons_to_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygons to lines — wbt_polygons_to_lines","text":"input Input vector polygon file. output Output vector lines file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygons_to_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygons to lines — wbt_polygons_to_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_power.html","id":null,"dir":"Reference","previous_headings":"","what":"Power — wbt_power","title":"Power — wbt_power","text":"Raises values grid cells one rasters, constant value, values another raster constant value.","code":""},{"path":"/reference/wbt_power.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Power — wbt_power","text":"","code":"wbt_power(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_power.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Power — wbt_power","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_power.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Power — wbt_power","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_prewitt_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Prewitt filter — wbt_prewitt_filter","title":"Prewitt filter — wbt_prewitt_filter","text":"Performs Prewitt edge-detection filter image.","code":""},{"path":"/reference/wbt_prewitt_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Prewitt filter — wbt_prewitt_filter","text":"","code":"wbt_prewitt_filter(   input,   output,   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_prewitt_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Prewitt filter — wbt_prewitt_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_prewitt_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Prewitt filter — wbt_prewitt_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_principal_component_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Principal component analysis — wbt_principal_component_analysis","title":"Principal component analysis — wbt_principal_component_analysis","text":"Performs principal component analysis (PCA) multi-spectral dataset.","code":""},{"path":"/reference/wbt_principal_component_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Principal component analysis — wbt_principal_component_analysis","text":"","code":"wbt_principal_component_analysis(   inputs,   output,   num_comp = NULL,   standardized = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_principal_component_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Principal component analysis — wbt_principal_component_analysis","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output HTML report file. num_comp Number component images output; <= num. input images. standardized Perform standardized PCA?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_principal_component_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Principal component analysis — wbt_principal_component_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_print_geo_tiff_tags.html","id":null,"dir":"Reference","previous_headings":"","what":"Print geo tiff tags — wbt_print_geo_tiff_tags","title":"Print geo tiff tags — wbt_print_geo_tiff_tags","text":"Prints tags within GeoTIFF.","code":""},{"path":"/reference/wbt_print_geo_tiff_tags.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print geo tiff tags — wbt_print_geo_tiff_tags","text":"","code":"wbt_print_geo_tiff_tags(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_print_geo_tiff_tags.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print geo tiff tags — wbt_print_geo_tiff_tags","text":"input Input GeoTIFF file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_print_geo_tiff_tags.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Print geo tiff tags — wbt_print_geo_tiff_tags","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_profile.html","id":null,"dir":"Reference","previous_headings":"","what":"Profile — wbt_profile","title":"Profile — wbt_profile","text":"Plots profiles digital surface models.","code":""},{"path":"/reference/wbt_profile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Profile — wbt_profile","text":"","code":"wbt_profile(   lines,   surface,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_profile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Profile — wbt_profile","text":"lines Input vector line file. surface Input raster surface file. output Output HTML file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_profile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Profile — wbt_profile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_profile_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Profile curvature — wbt_profile_curvature","title":"Profile curvature — wbt_profile_curvature","text":"Calculates profile curvature raster input DEM.","code":""},{"path":"/reference/wbt_profile_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Profile curvature — wbt_profile_curvature","text":"","code":"wbt_profile_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_profile_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Profile curvature — wbt_profile_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_profile_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Profile curvature — wbt_profile_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_qin_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Qin flow accumulation — wbt_qin_flow_accumulation","title":"Qin flow accumulation — wbt_qin_flow_accumulation","text":"Calculates Qin et al. (2007) flow accumulation.","code":""},{"path":"/reference/wbt_qin_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Qin flow accumulation — wbt_qin_flow_accumulation","text":"","code":"wbt_qin_flow_accumulation(   dem,   output,   out_type = \"specific contributing area\",   exponent = 10,   max_slope = 45,   threshold = NULL,   log = FALSE,   clip = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_qin_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Qin flow accumulation — wbt_qin_flow_accumulation","text":"dem Name input DEM raster file; must depressionless. output Name output raster file. out_type Output type; one 'cells', 'specific contributing area' (default), 'catchment area'. exponent Optional upper-bound exponent parameter; default 10.0. max_slope Optional upper-bound slope parameter, degrees (0-90); default 45.0. threshold Optional convergence threshold parameter, grid cells; default infinity. log Log-transform output values?. clip Optional flag request clipping display max 1 percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_qin_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Qin flow accumulation — wbt_qin_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_quantiles.html","id":null,"dir":"Reference","previous_headings":"","what":"Quantiles — wbt_quantiles","title":"Quantiles — wbt_quantiles","text":"Transforms raster values quantiles.","code":""},{"path":"/reference/wbt_quantiles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Quantiles — wbt_quantiles","text":"","code":"wbt_quantiles(   input,   output,   num_quantiles = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_quantiles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Quantiles — wbt_quantiles","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. num_quantiles Number quantiles. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_quantiles.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Quantiles — wbt_quantiles","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_quinn_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Quinn flow accumulation — wbt_quinn_flow_accumulation","title":"Quinn flow accumulation — wbt_quinn_flow_accumulation","text":"Calculates Quinn et al. (1995) flow accumulation.","code":""},{"path":"/reference/wbt_quinn_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Quinn flow accumulation — wbt_quinn_flow_accumulation","text":"","code":"wbt_quinn_flow_accumulation(   dem,   output,   out_type = \"specific contributing area\",   exponent = 1,   threshold = NULL,   log = FALSE,   clip = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_quinn_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Quinn flow accumulation — wbt_quinn_flow_accumulation","text":"dem Name input DEM raster file; must depressionless. output Name output raster file. out_type Output type; one 'cells', 'specific contributing area' (default), 'catchment area'. exponent Optional exponent parameter; default 1.0. threshold Optional convergence threshold parameter, grid cells; default infinity. log Log-transform output values?. clip Optional flag request clipping display max 1 percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_quinn_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Quinn flow accumulation — wbt_quinn_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_radial_basis_function_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Radial basis function interpolation — wbt_radial_basis_function_interpolation","title":"Radial basis function interpolation — wbt_radial_basis_function_interpolation","text":"Interpolates vector points raster surface using radial basis function scheme.","code":""},{"path":"/reference/wbt_radial_basis_function_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Radial basis function interpolation — wbt_radial_basis_function_interpolation","text":"","code":"wbt_radial_basis_function_interpolation(   input,   field,   output,   use_z = FALSE,   radius = NULL,   min_points = NULL,   func_type = \"ThinPlateSpline\",   poly_order = \"none\",   weight = 0.1,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_radial_basis_function_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Radial basis function interpolation — wbt_radial_basis_function_interpolation","text":"input Input vector points file. field Input field name attribute table. output Output raster file. use_z Use z-coordinate instead field?. radius Search Radius (map units). min_points Minimum number points. func_type Radial basis function type; options 'ThinPlateSpline' (default), 'PolyHarmonic', 'Gaussian', 'MultiQuadric', 'InverseMultiQuadric'. poly_order Polynomial order; options 'none' (default), 'constant', 'affine'. weight Weight parameter used basis function. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_radial_basis_function_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Radial basis function interpolation — wbt_radial_basis_function_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_radius_of_gyration.html","id":null,"dir":"Reference","previous_headings":"","what":"Radius of gyration — wbt_radius_of_gyration","title":"Radius of gyration — wbt_radius_of_gyration","text":"Calculates distance cells polygon's centroid.","code":""},{"path":"/reference/wbt_radius_of_gyration.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Radius of gyration — wbt_radius_of_gyration","text":"","code":"wbt_radius_of_gyration(   input,   output,   text_output = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_radius_of_gyration.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Radius of gyration — wbt_radius_of_gyration","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. text_output Optional text output. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_radius_of_gyration.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Radius of gyration — wbt_radius_of_gyration","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raise_walls.html","id":null,"dir":"Reference","previous_headings":"","what":"Raise walls — wbt_raise_walls","title":"Raise walls — wbt_raise_walls","text":"Raises walls DEM along line around polygon, e.g. watershed.","code":""},{"path":"/reference/wbt_raise_walls.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raise walls — wbt_raise_walls","text":"","code":"wbt_raise_walls(   input,   dem,   output,   breach = NULL,   height = 100,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raise_walls.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raise walls — wbt_raise_walls","text":"input Input vector lines polygons file. dem Input raster DEM file. output Output raster file. breach Optional input vector breach lines. height Wall height. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raise_walls.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raise walls — wbt_raise_walls","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_random_field.html","id":null,"dir":"Reference","previous_headings":"","what":"Random field — wbt_random_field","title":"Random field — wbt_random_field","text":"Creates image containing random values.","code":""},{"path":"/reference/wbt_random_field.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Random field — wbt_random_field","text":"","code":"wbt_random_field(   base,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_random_field.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Random field — wbt_random_field","text":"base Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_random_field.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Random field — wbt_random_field","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_random_forest_classification.html","id":null,"dir":"Reference","previous_headings":"","what":"Random forest classification — wbt_random_forest_classification","title":"Random forest classification — wbt_random_forest_classification","text":"Performs supervised random forest classification using training site polygons/points predictor rasters.","code":""},{"path":"/reference/wbt_random_forest_classification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Random forest classification — wbt_random_forest_classification","text":"","code":"wbt_random_forest_classification(   inputs,   training,   field,   output = NULL,   split_criterion = \"Gini\",   n_trees = 500,   min_samples_leaf = 1,   min_samples_split = 2,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_random_forest_classification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Random forest classification — wbt_random_forest_classification","text":"inputs Names input predictor rasters. training Name input training site polygons/points shapefile. field Name attribute containing class data. output Name output raster file. split_criterion Split criterion use building tree. Options include 'Gini', 'Entropy', 'ClassificationError'. n_trees number trees forest. min_samples_leaf minimum number samples required leaf node. min_samples_split minimum number samples required split internal node. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_random_forest_classification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Random forest classification — wbt_random_forest_classification","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_random_forest_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Random forest regression — wbt_random_forest_regression","title":"Random forest regression — wbt_random_forest_regression","text":"Performs random forest regression analysis using training site data predictor rasters.","code":""},{"path":"/reference/wbt_random_forest_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Random forest regression — wbt_random_forest_regression","text":"","code":"wbt_random_forest_regression(   inputs,   training,   field,   output = NULL,   n_trees = 100,   min_samples_leaf = 1,   min_samples_split = 2,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_random_forest_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Random forest regression — wbt_random_forest_regression","text":"inputs Names input predictor rasters. training Name input training site points shapefile. field Name attribute containing response variable name data. output Name output raster file. parameter optional. unspecified, tool build model. specified, tool use built model predictor rasters perform spatial prediction. n_trees number trees forest. min_samples_leaf minimum number samples required leaf node. min_samples_split minimum number samples required split internal node. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_random_forest_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Random forest regression — wbt_random_forest_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_random_sample.html","id":null,"dir":"Reference","previous_headings":"","what":"Random sample — wbt_random_sample","title":"Random sample — wbt_random_sample","text":"Creates image containing randomly located sample grid cells unique IDs.","code":""},{"path":"/reference/wbt_random_sample.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Random sample — wbt_random_sample","text":"","code":"wbt_random_sample(   base,   output,   num_samples = 1000,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_random_sample.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Random sample — wbt_random_sample","text":"base Input raster file path. See wbt_file_path() details. output Output raster file. num_samples Number samples. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_random_sample.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Random sample — wbt_random_sample","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_range_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Range filter — wbt_range_filter","title":"Range filter — wbt_range_filter","text":"Assigns cell output grid range values moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_range_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Range filter — wbt_range_filter","text":"","code":"wbt_range_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_range_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Range filter — wbt_range_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_range_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Range filter — wbt_range_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_area.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster area — wbt_raster_area","title":"Raster area — wbt_raster_area","text":"Calculates area polygons classes within raster image.","code":""},{"path":"/reference/wbt_raster_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster area — wbt_raster_area","text":"","code":"wbt_raster_area(   input,   output = NULL,   out_text = FALSE,   units = \"grid cells\",   zero_back = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster area — wbt_raster_area","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. out_text like output polygon areas text?. units Area units; options include 'grid cells' 'map units'. zero_back Flag indicating whether zero values treated background. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster area — wbt_raster_area","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_calculator.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster calculator — wbt_raster_calculator","title":"Raster calculator — wbt_raster_calculator","text":"Performs complex mathematical operations one input raster images cell--cell basis.","code":""},{"path":"/reference/wbt_raster_calculator.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster calculator — wbt_raster_calculator","text":"","code":"wbt_raster_calculator(   output,   statement = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_calculator.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster calculator — wbt_raster_calculator","text":"output Name output raster file. statement Statement e.g. cos(\"raster1\") * 35.0 + \"raster2\". statement must valid Rust statement. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_calculator.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster calculator — wbt_raster_calculator","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_cell_assignment.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster cell assignment — wbt_raster_cell_assignment","title":"Raster cell assignment — wbt_raster_cell_assignment","text":"Assign row column number cells.","code":""},{"path":"/reference/wbt_raster_cell_assignment.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster cell assignment — wbt_raster_cell_assignment","text":"","code":"wbt_raster_cell_assignment(   input,   output,   assign = \"column\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_cell_assignment.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster cell assignment — wbt_raster_cell_assignment","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. assign variable like assign grid cells? Options include 'column', 'row', 'x', 'y'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_cell_assignment.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster cell assignment — wbt_raster_cell_assignment","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_histogram.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster histogram — wbt_raster_histogram","title":"Raster histogram — wbt_raster_histogram","text":"Creates histogram raster values.","code":""},{"path":"/reference/wbt_raster_histogram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster histogram — wbt_raster_histogram","text":"","code":"wbt_raster_histogram(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_histogram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster histogram — wbt_raster_histogram","text":"input Input raster file path. See wbt_file_path() details. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_histogram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster histogram — wbt_raster_histogram","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_perimeter.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster perimeter — wbt_raster_perimeter","title":"Raster perimeter — wbt_raster_perimeter","text":"Calculates perimeters polygons classes within raster image.","code":""},{"path":"/reference/wbt_raster_perimeter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster perimeter — wbt_raster_perimeter","text":"","code":"wbt_raster_perimeter(   input,   output = NULL,   out_text = FALSE,   units = \"grid cells\",   zero_back = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_perimeter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster perimeter — wbt_raster_perimeter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. out_text like output polygon areas text?. units Area units; options include 'grid cells' 'map units'. zero_back Flag indicating whether zero values treated background. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_perimeter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster perimeter — wbt_raster_perimeter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_streams_to_vector.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster streams to vector — wbt_raster_streams_to_vector","title":"Raster streams to vector — wbt_raster_streams_to_vector","text":"Converts raster stream file vector file.","code":""},{"path":"/reference/wbt_raster_streams_to_vector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster streams to vector — wbt_raster_streams_to_vector","text":"","code":"wbt_raster_streams_to_vector(   streams,   d8_pntr,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_streams_to_vector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster streams to vector — wbt_raster_streams_to_vector","text":"streams Input raster streams file. d8_pntr Input raster D8 pointer file. output Output vector file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_streams_to_vector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster streams to vector — wbt_raster_streams_to_vector","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_summary_stats.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster summary stats — wbt_raster_summary_stats","title":"Raster summary stats — wbt_raster_summary_stats","text":"Measures rasters min, max, average, standard deviation, num. non-nodata cells, total.","code":""},{"path":"/reference/wbt_raster_summary_stats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster summary stats — wbt_raster_summary_stats","text":"","code":"wbt_raster_summary_stats(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_summary_stats.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster summary stats — wbt_raster_summary_stats","text":"input Input raster file path. See wbt_file_path() details. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_summary_stats.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster summary stats — wbt_raster_summary_stats","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_to_vector_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster to vector lines — wbt_raster_to_vector_lines","title":"Raster to vector lines — wbt_raster_to_vector_lines","text":"Converts raster lines features vector POLYLINE shapetype.","code":""},{"path":"/reference/wbt_raster_to_vector_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster to vector lines — wbt_raster_to_vector_lines","text":"","code":"wbt_raster_to_vector_lines(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_to_vector_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster to vector lines — wbt_raster_to_vector_lines","text":"input Input raster lines file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_to_vector_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster to vector lines — wbt_raster_to_vector_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_to_vector_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster to vector points — wbt_raster_to_vector_points","title":"Raster to vector points — wbt_raster_to_vector_points","text":"Converts raster dataset vector POINT shapetype.","code":""},{"path":"/reference/wbt_raster_to_vector_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster to vector points — wbt_raster_to_vector_points","text":"","code":"wbt_raster_to_vector_points(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_to_vector_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster to vector points — wbt_raster_to_vector_points","text":"input Input raster file path. See wbt_file_path() details. output Output vector points file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_to_vector_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster to vector points — wbt_raster_to_vector_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_to_vector_polygons.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster to vector polygons — wbt_raster_to_vector_polygons","title":"Raster to vector polygons — wbt_raster_to_vector_polygons","text":"Converts raster dataset vector POLYGON shapetype.","code":""},{"path":"/reference/wbt_raster_to_vector_polygons.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster to vector polygons — wbt_raster_to_vector_polygons","text":"","code":"wbt_raster_to_vector_polygons(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_to_vector_polygons.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster to vector polygons — wbt_raster_to_vector_polygons","text":"input Input raster file path. See wbt_file_path() details. output Output vector polygons file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_to_vector_polygons.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster to vector polygons — wbt_raster_to_vector_polygons","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rasterize_streams.html","id":null,"dir":"Reference","previous_headings":"","what":"Rasterize streams — wbt_rasterize_streams","title":"Rasterize streams — wbt_rasterize_streams","text":"Rasterizes vector streams based Lindsay (2016) method.","code":""},{"path":"/reference/wbt_rasterize_streams.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rasterize streams — wbt_rasterize_streams","text":"","code":"wbt_rasterize_streams(   streams,   base,   output,   nodata = TRUE,   feature_id = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rasterize_streams.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rasterize streams — wbt_rasterize_streams","text":"streams Input vector streams file. base Input base raster file. output Output raster file. nodata Use NoData value background?. feature_id Use feature number output value?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rasterize_streams.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rasterize streams — wbt_rasterize_streams","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reciprocal.html","id":null,"dir":"Reference","previous_headings":"","what":"Reciprocal — wbt_reciprocal","title":"Reciprocal — wbt_reciprocal","text":"Returns reciprocal (.e. 1 / z) values raster.","code":""},{"path":"/reference/wbt_reciprocal.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reciprocal — wbt_reciprocal","text":"","code":"wbt_reciprocal(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reciprocal.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reciprocal — wbt_reciprocal","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reciprocal.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reciprocal — wbt_reciprocal","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reclass.html","id":null,"dir":"Reference","previous_headings":"","what":"Reclass — wbt_reclass","title":"Reclass — wbt_reclass","text":"Reclassifies values raster image.","code":""},{"path":"/reference/wbt_reclass.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reclass — wbt_reclass","text":"","code":"wbt_reclass(   input,   output,   reclass_vals,   assign_mode = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reclass.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reclass — wbt_reclass","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. reclass_vals Reclassification triplet values (new value; value; less ), e.g. '0.0;0.0;1.0;1.0;1.0;2.0'. assign_mode Optional Boolean flag indicating whether operate assign mode, reclass_vals values interpreted new value; old value pairs. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reclass.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reclass — wbt_reclass","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reclass_equal_interval.html","id":null,"dir":"Reference","previous_headings":"","what":"Reclass equal interval — wbt_reclass_equal_interval","title":"Reclass equal interval — wbt_reclass_equal_interval","text":"Reclassifies values raster image based equal-ranges.","code":""},{"path":"/reference/wbt_reclass_equal_interval.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reclass equal interval — wbt_reclass_equal_interval","text":"","code":"wbt_reclass_equal_interval(   input,   output,   interval = 10,   start_val = NULL,   end_val = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reclass_equal_interval.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reclass equal interval — wbt_reclass_equal_interval","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. interval Class interval size. start_val Optional starting value (default input minimum value). end_val Optional ending value (default input maximum value). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reclass_equal_interval.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reclass equal interval — wbt_reclass_equal_interval","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reclass_from_file.html","id":null,"dir":"Reference","previous_headings":"","what":"Reclass from file — wbt_reclass_from_file","title":"Reclass from file — wbt_reclass_from_file","text":"Reclassifies values raster image using reclass ranges text file.","code":""},{"path":"/reference/wbt_reclass_from_file.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reclass from file — wbt_reclass_from_file","text":"","code":"wbt_reclass_from_file(   input,   reclass_file,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reclass_from_file.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reclass from file — wbt_reclass_from_file","text":"input Input raster file path. See wbt_file_path() details. reclass_file Input text file containing reclass ranges. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reclass_from_file.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reclass from file — wbt_reclass_from_file","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reconcile_multiple_headers.html","id":null,"dir":"Reference","previous_headings":"","what":"Reconcile multiple headers — wbt_reconcile_multiple_headers","title":"Reconcile multiple headers — wbt_reconcile_multiple_headers","text":"tool adjusts crop yield values data sets collected multiple headers combines.","code":""},{"path":"/reference/wbt_reconcile_multiple_headers.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reconcile multiple headers — wbt_reconcile_multiple_headers","text":"","code":"wbt_reconcile_multiple_headers(   input,   region_field,   yield_field,   output,   radius = NULL,   min_yield = NULL,   max_yield = NULL,   mean_tonnage = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reconcile_multiple_headers.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reconcile multiple headers — wbt_reconcile_multiple_headers","text":"input Name input points shapefile. region_field Name attribute containing region data. yield_field Name attribute containing yield data. output Name output points shapefile. radius Optional search radius, metres. specify value want calculate locally normalized yield. min_yield Minimum yield value output. max_yield Maximum yield value output. mean_tonnage Use optional parameter force output certain overall average tonnage. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reconcile_multiple_headers.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reconcile multiple headers — wbt_reconcile_multiple_headers","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_recover_flightline_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Recover flightline info — wbt_recover_flightline_info","title":"Recover flightline info — wbt_recover_flightline_info","text":"Associates LiDAR points flightlines.","code":""},{"path":"/reference/wbt_recover_flightline_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Recover flightline info — wbt_recover_flightline_info","text":"","code":"wbt_recover_flightline_info(   input,   output,   max_time_diff = 5,   pt_src_id = FALSE,   user_data = FALSE,   rgb = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_recover_flightline_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Recover flightline info — wbt_recover_flightline_info","text":"input Name input LiDAR points. output Name output LiDAR points. max_time_diff Maximum -flightline time difference (seconds). pt_src_id Add flightline information point source ID. user_data Add flightline information user data. rgb Add flightline information RGB colour data. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_recover_flightline_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Recover flightline info — wbt_recover_flightline_info","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_recreate_pass_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Recreate pass lines — wbt_recreate_pass_lines","title":"Recreate pass lines — wbt_recreate_pass_lines","text":"tool can used approximate harvester pass lines yield points.","code":""},{"path":"/reference/wbt_recreate_pass_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Recreate pass lines — wbt_recreate_pass_lines","text":"","code":"wbt_recreate_pass_lines(   input,   yield_field_name,   output_lines,   output_points,   max_change_in_heading = 25,   ignore_zeros = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_recreate_pass_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Recreate pass lines — wbt_recreate_pass_lines","text":"input Name input points shapefile. yield_field_name Name attribute containing yield data. output_lines Name output pass lines shapefile. output_points Name output points shapefile. max_change_in_heading Max change heading. ignore_zeros Ignore zero-valued yield points?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_recreate_pass_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Recreate pass lines — wbt_recreate_pass_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reinitialize_attribute_table.html","id":null,"dir":"Reference","previous_headings":"","what":"Reinitialize attribute table — wbt_reinitialize_attribute_table","title":"Reinitialize attribute table — wbt_reinitialize_attribute_table","text":"Reinitializes vector's attribute table deleting fields feature ID (FID).","code":""},{"path":"/reference/wbt_reinitialize_attribute_table.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reinitialize attribute table — wbt_reinitialize_attribute_table","text":"","code":"wbt_reinitialize_attribute_table(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reinitialize_attribute_table.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reinitialize attribute table — wbt_reinitialize_attribute_table","text":"input Input vector file path. See wbt_file_path() details. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reinitialize_attribute_table.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reinitialize attribute table — wbt_reinitialize_attribute_table","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_related_circumscribing_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"Related circumscribing circle — wbt_related_circumscribing_circle","title":"Related circumscribing circle — wbt_related_circumscribing_circle","text":"Calculates related circumscribing circle vector polygons.","code":""},{"path":"/reference/wbt_related_circumscribing_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Related circumscribing circle — wbt_related_circumscribing_circle","text":"","code":"wbt_related_circumscribing_circle(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_related_circumscribing_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Related circumscribing circle — wbt_related_circumscribing_circle","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_related_circumscribing_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Related circumscribing circle — wbt_related_circumscribing_circle","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_relative_aspect.html","id":null,"dir":"Reference","previous_headings":"","what":"Relative aspect — wbt_relative_aspect","title":"Relative aspect — wbt_relative_aspect","text":"Calculates relative aspect (relative user-specified direction) input DEM.","code":""},{"path":"/reference/wbt_relative_aspect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Relative aspect — wbt_relative_aspect","text":"","code":"wbt_relative_aspect(   dem,   output,   azimuth = 0,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_relative_aspect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Relative aspect — wbt_relative_aspect","text":"dem Input raster DEM file. output Output raster file. azimuth Illumination source azimuth. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_relative_aspect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Relative aspect — wbt_relative_aspect","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_relative_topographic_position.html","id":null,"dir":"Reference","previous_headings":"","what":"Relative topographic position — wbt_relative_topographic_position","title":"Relative topographic position — wbt_relative_topographic_position","text":"Calculates relative topographic position index DEM.","code":""},{"path":"/reference/wbt_relative_topographic_position.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Relative topographic position — wbt_relative_topographic_position","text":"","code":"wbt_relative_topographic_position(   dem,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_relative_topographic_position.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Relative topographic position — wbt_relative_topographic_position","text":"dem Input raster DEM file. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_relative_topographic_position.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Relative topographic position — wbt_relative_topographic_position","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_field_edge_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove field edge points — wbt_remove_field_edge_points","title":"Remove field edge points — wbt_remove_field_edge_points","text":"tool can used remove, flag, points along edges crop yield data set.","code":""},{"path":"/reference/wbt_remove_field_edge_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove field edge points — wbt_remove_field_edge_points","text":"","code":"wbt_remove_field_edge_points(   input,   output,   dist = NULL,   max_change_in_heading = 25,   flag_edges = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_field_edge_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove field edge points — wbt_remove_field_edge_points","text":"input Name input points shapefile. output Name output points shapefile. dist Average distance passes, meters. max_change_in_heading Max change heading. flag_edges remove edge points, just flag attribute table?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_field_edge_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove field edge points — wbt_remove_field_edge_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_off_terrain_objects.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove off terrain objects — wbt_remove_off_terrain_objects","title":"Remove off terrain objects — wbt_remove_off_terrain_objects","text":"Removes -terrain objects raster digital elevation model (DEM).","code":""},{"path":"/reference/wbt_remove_off_terrain_objects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove off terrain objects — wbt_remove_off_terrain_objects","text":"","code":"wbt_remove_off_terrain_objects(   dem,   output,   filter = 11,   slope = 15,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_off_terrain_objects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove off terrain objects — wbt_remove_off_terrain_objects","text":"dem Input raster DEM file. output Output raster file. filter Filter size (cells). slope Slope threshold value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_off_terrain_objects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove off terrain objects — wbt_remove_off_terrain_objects","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_polygon_holes.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove polygon holes — wbt_remove_polygon_holes","title":"Remove polygon holes — wbt_remove_polygon_holes","text":"Removes holes within features vector polygon file.","code":""},{"path":"/reference/wbt_remove_polygon_holes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove polygon holes — wbt_remove_polygon_holes","text":"","code":"wbt_remove_polygon_holes(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_polygon_holes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove polygon holes — wbt_remove_polygon_holes","text":"input Input vector polygon file. output Output vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_polygon_holes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove polygon holes — wbt_remove_polygon_holes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_raster_polygon_holes.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove raster polygon holes — wbt_remove_raster_polygon_holes","title":"Remove raster polygon holes — wbt_remove_raster_polygon_holes","text":"Removes polygon holes, 'donut-holes', raster polygons.","code":""},{"path":"/reference/wbt_remove_raster_polygon_holes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove raster polygon holes — wbt_remove_raster_polygon_holes","text":"","code":"wbt_remove_raster_polygon_holes(   input,   output,   threshold = 3,   use_diagonals = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_raster_polygon_holes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove raster polygon holes — wbt_remove_raster_polygon_holes","text":"input Name input raster image file. output Name output raster file. threshold Maximum size removed holes, grid cells. Blank threshold, .e. remove holes. use_diagonals Use diagonal neighbours clumping operation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_raster_polygon_holes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove raster polygon holes — wbt_remove_raster_polygon_holes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_short_streams.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove short streams — wbt_remove_short_streams","title":"Remove short streams — wbt_remove_short_streams","text":"Removes short first-order streams stream network.","code":""},{"path":"/reference/wbt_remove_short_streams.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove short streams — wbt_remove_short_streams","text":"","code":"wbt_remove_short_streams(   d8_pntr,   streams,   output,   min_length,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_short_streams.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove short streams — wbt_remove_short_streams","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. min_length Minimum tributary length (map units) used network pruning. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_short_streams.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove short streams — wbt_remove_short_streams","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_spurs.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove spurs — wbt_remove_spurs","title":"Remove spurs — wbt_remove_spurs","text":"Removes spurs (pruning operation) Boolean line image; intended used output LineThinning tool.","code":""},{"path":"/reference/wbt_remove_spurs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove spurs — wbt_remove_spurs","text":"","code":"wbt_remove_spurs(   input,   output,   iterations = 10,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_spurs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove spurs — wbt_remove_spurs","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. iterations Maximum number iterations. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_spurs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove spurs — wbt_remove_spurs","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_repair_stream_vector_topology.html","id":null,"dir":"Reference","previous_headings":"","what":"Repair stream vector topology — wbt_repair_stream_vector_topology","title":"Repair stream vector topology — wbt_repair_stream_vector_topology","text":"tool resolves topological errors inconsistencies associated digitized vector streams.","code":""},{"path":"/reference/wbt_repair_stream_vector_topology.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Repair stream vector topology — wbt_repair_stream_vector_topology","text":"","code":"wbt_repair_stream_vector_topology(   input,   output,   dist = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_repair_stream_vector_topology.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Repair stream vector topology — wbt_repair_stream_vector_topology","text":"input Name input lines vector file. output Name output lines vector file. dist Snap distance, xy units (metres). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_repair_stream_vector_topology.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Repair stream vector topology — wbt_repair_stream_vector_topology","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_resample.html","id":null,"dir":"Reference","previous_headings":"","what":"Resample — wbt_resample","title":"Resample — wbt_resample","text":"Resamples one input images destination image.","code":""},{"path":"/reference/wbt_resample.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Resample — wbt_resample","text":"","code":"wbt_resample(   inputs,   output,   cell_size = NULL,   base = NULL,   method = \"cc\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_resample.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Resample — wbt_resample","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', 'cc' (cubic convolution). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_resample.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Resample — wbt_resample","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rescale_value_range.html","id":null,"dir":"Reference","previous_headings":"","what":"Rescale value range — wbt_rescale_value_range","title":"Rescale value range — wbt_rescale_value_range","text":"Performs min-max contrast stretch input greytone image.","code":""},{"path":"/reference/wbt_rescale_value_range.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rescale value range — wbt_rescale_value_range","text":"","code":"wbt_rescale_value_range(   input,   output,   out_min_val,   out_max_val,   clip_min = NULL,   clip_max = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rescale_value_range.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rescale value range — wbt_rescale_value_range","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. out_min_val New minimum value output image. out_max_val New maximum value output image. clip_min Optional lower tail clip value. clip_max Optional upper tail clip value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rescale_value_range.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rescale value range — wbt_rescale_value_range","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rgb_to_ihs.html","id":null,"dir":"Reference","previous_headings":"","what":"Rgb to ihs — wbt_rgb_to_ihs","title":"Rgb to ihs — wbt_rgb_to_ihs","text":"Converts red, green, blue (RGB) images intensity, hue, saturation (IHS) images.","code":""},{"path":"/reference/wbt_rgb_to_ihs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rgb to ihs — wbt_rgb_to_ihs","text":"","code":"wbt_rgb_to_ihs(   intensity,   hue,   saturation,   red = NULL,   green = NULL,   blue = NULL,   composite = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rgb_to_ihs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rgb to ihs — wbt_rgb_to_ihs","text":"intensity Output intensity raster file. hue Output hue raster file. saturation Output saturation raster file. red Input red band image file. Optionally specified colour-composite specified. green Input green band image file. Optionally specified colour-composite specified. blue Input blue band image file. Optionally specified colour-composite specified. composite Input colour-composite image file. used individual bands specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rgb_to_ihs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rgb to ihs — wbt_rgb_to_ihs","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rho8_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Rho8 flow accumulation — wbt_rho8_flow_accumulation","title":"Rho8 flow accumulation — wbt_rho8_flow_accumulation","text":"Calculates Fairfield Leymarie (1991) flow accumulation.","code":""},{"path":"/reference/wbt_rho8_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rho8 flow accumulation — wbt_rho8_flow_accumulation","text":"","code":"wbt_rho8_flow_accumulation(   input,   output,   out_type = \"specific contributing area\",   log = FALSE,   clip = FALSE,   pntr = FALSE,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rho8_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rho8 flow accumulation — wbt_rho8_flow_accumulation","text":"input Input DEM Rho8 pointer file; DEM used, must depressionless. output Name output raster file. out_type Output type; one 'cells', 'specific contributing area' (default), 'catchment area'. log Log-transform output values?. clip Optional flag request clipping display max 1 percent. pntr input raster Rho8 flow pointer rather DEM?. esri_pntr input Rho8 pointer use ESRI style scheme?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rho8_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rho8 flow accumulation — wbt_rho8_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rho8_pointer.html","id":null,"dir":"Reference","previous_headings":"","what":"Rho8 pointer — wbt_rho8_pointer","title":"Rho8 pointer — wbt_rho8_pointer","text":"Calculates stochastic Rho8 flow pointer raster input DEM.","code":""},{"path":"/reference/wbt_rho8_pointer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rho8 pointer — wbt_rho8_pointer","text":"","code":"wbt_rho8_pointer(   dem,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rho8_pointer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rho8 pointer — wbt_rho8_pointer","text":"dem Input raster DEM file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rho8_pointer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rho8 pointer — wbt_rho8_pointer","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ring_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Ring curvature — wbt_ring_curvature","title":"Ring curvature — wbt_ring_curvature","text":"tool calculates ring curvature input DEM.","code":""},{"path":"/reference/wbt_ring_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ring curvature — wbt_ring_curvature","text":"","code":"wbt_ring_curvature(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ring_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ring curvature — wbt_ring_curvature","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ring_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ring curvature — wbt_ring_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_river_centerlines.html","id":null,"dir":"Reference","previous_headings":"","what":"River centerlines — wbt_river_centerlines","title":"River centerlines — wbt_river_centerlines","text":"Maps river centerlines input water raster.","code":""},{"path":"/reference/wbt_river_centerlines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"River centerlines — wbt_river_centerlines","text":"","code":"wbt_river_centerlines(   input,   output,   min_length = 3,   radius = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_river_centerlines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"River centerlines — wbt_river_centerlines","text":"input Name input raster image file. output Name output vector lines file. min_length Minimum line length, grid cells. radius Search radius joining distant endnodes, grid cells. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_river_centerlines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"River centerlines — wbt_river_centerlines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_roberts_cross_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Roberts cross filter — wbt_roberts_cross_filter","title":"Roberts cross filter — wbt_roberts_cross_filter","text":"Performs Robert's cross edge-detection filter image.","code":""},{"path":"/reference/wbt_roberts_cross_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Roberts cross filter — wbt_roberts_cross_filter","text":"","code":"wbt_roberts_cross_filter(   input,   output,   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_roberts_cross_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Roberts cross filter — wbt_roberts_cross_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_roberts_cross_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Roberts cross filter — wbt_roberts_cross_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_root_mean_square_error.html","id":null,"dir":"Reference","previous_headings":"","what":"Root mean square error — wbt_root_mean_square_error","title":"Root mean square error — wbt_root_mean_square_error","text":"Calculates RMSE accuracy statistics.","code":""},{"path":"/reference/wbt_root_mean_square_error.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Root mean square error — wbt_root_mean_square_error","text":"","code":"wbt_root_mean_square_error(   input,   base,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_root_mean_square_error.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Root mean square error — wbt_root_mean_square_error","text":"input Input raster file path. See wbt_file_path() details. base Input base raster file used comparison. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_root_mean_square_error.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Root mean square error — wbt_root_mean_square_error","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rotor.html","id":null,"dir":"Reference","previous_headings":"","what":"Rotor — wbt_rotor","title":"Rotor — wbt_rotor","text":"tool calculates rotor input DEM.","code":""},{"path":"/reference/wbt_rotor.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rotor — wbt_rotor","text":"","code":"wbt_rotor(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rotor.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rotor — wbt_rotor","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rotor.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rotor — wbt_rotor","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_round.html","id":null,"dir":"Reference","previous_headings":"","what":"Round — wbt_round","title":"Round — wbt_round","text":"Rounds values input raster nearest integer value.","code":""},{"path":"/reference/wbt_round.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Round — wbt_round","text":"","code":"wbt_round(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_round.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Round — wbt_round","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_round.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Round — wbt_round","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ruggedness_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Ruggedness index — wbt_ruggedness_index","title":"Ruggedness index — wbt_ruggedness_index","text":"Calculates Riley et al.'s (1999) terrain ruggedness index input DEM.","code":""},{"path":"/reference/wbt_ruggedness_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ruggedness index — wbt_ruggedness_index","text":"","code":"wbt_ruggedness_index(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ruggedness_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ruggedness index — wbt_ruggedness_index","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ruggedness_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ruggedness index — wbt_ruggedness_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_run_tool.html","id":null,"dir":"Reference","previous_headings":"","what":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","title":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","text":"Runs tool specifies tool arguments. prefix \"whitebox::\" \"wbt_\" tool_name removed match definitions wbt_list_tools()","code":""},{"path":"/reference/wbt_run_tool.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","text":"","code":"wbt_run_tool(tool_name, args, verbose_mode = FALSE, command_only = FALSE)"},{"path":"/reference/wbt_run_tool.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","text":"tool_name name tool run. args Tool arguments. verbose_mode Verbose mode. Without flag, tool outputs printed. command_only Return command run system()? Default: FALSE","code":""},{"path":"/reference/wbt_run_tool.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","text":"Returns (character) output tool.","code":""},{"path":[]},{"path":"/reference/wbt_run_tool.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","text":"","code":"if (FALSE) { tool_name <- \"breach_depressions\" dem <- system.file(\"extdata\", \"DEM.tif\", package=\"whitebox\") output <- \"./output.tif\" arg1 <- paste0(\"--dem=\", dem) arg2 <- paste0(\"--output=\", output) args <- paste(arg1, arg2) wbt_run_tool(tool_name, args) }"},{"path":"/reference/wbt_rust_backtrace.html","id":null,"dir":"Reference","previous_headings":"","what":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","title":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","text":"Convenience method setting RUST_BACKTRACE options debugging","code":""},{"path":"/reference/wbt_rust_backtrace.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","text":"","code":"wbt_rust_backtrace(RUST_BACKTRACE = c(\"0\", \"1\", \"full\"))"},{"path":"/reference/wbt_rust_backtrace.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","text":"RUST_BACKTRACE One \"0\", \"1\", \"full\", Logical values converted integer character.","code":""},{"path":"/reference/wbt_rust_backtrace.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","text":"value system environment variable RUST_BACKTRACE","code":""},{"path":"/reference/wbt_rust_backtrace.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","text":"","code":"if (FALSE) { wbt_rust_backtrace(TRUE) }"},{"path":"/reference/wbt_scharr_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Scharr filter — wbt_scharr_filter","title":"Scharr filter — wbt_scharr_filter","text":"Performs Scharr edge-detection filter image.","code":""},{"path":"/reference/wbt_scharr_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Scharr filter — wbt_scharr_filter","text":"","code":"wbt_scharr_filter(   input,   output,   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_scharr_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Scharr filter — wbt_scharr_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_scharr_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Scharr filter — wbt_scharr_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sediment_transport_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Sediment transport index — wbt_sediment_transport_index","title":"Sediment transport index — wbt_sediment_transport_index","text":"Calculates sediment transport index.","code":""},{"path":"/reference/wbt_sediment_transport_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sediment transport index — wbt_sediment_transport_index","text":"","code":"wbt_sediment_transport_index(   sca,   slope,   output,   sca_exponent = 0.4,   slope_exponent = 1.3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sediment_transport_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sediment transport index — wbt_sediment_transport_index","text":"sca Input raster specific contributing area (SCA) file. slope Input raster slope file. output Output raster file. sca_exponent SCA exponent value. slope_exponent Slope exponent value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sediment_transport_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sediment transport index — wbt_sediment_transport_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_select_tiles_by_polygon.html","id":null,"dir":"Reference","previous_headings":"","what":"Select tiles by polygon — wbt_select_tiles_by_polygon","title":"Select tiles by polygon — wbt_select_tiles_by_polygon","text":"Copies LiDAR tiles overlapping polygon output directory.","code":""},{"path":"/reference/wbt_select_tiles_by_polygon.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Select tiles by polygon — wbt_select_tiles_by_polygon","text":"","code":"wbt_select_tiles_by_polygon(   indir,   outdir,   polygons,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_select_tiles_by_polygon.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Select tiles by polygon — wbt_select_tiles_by_polygon","text":"indir Input LAS file source directory. outdir Output directory LAS files within polygon copied. polygons Input vector polygons file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_select_tiles_by_polygon.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Select tiles by polygon — wbt_select_tiles_by_polygon","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_set_nodata_value.html","id":null,"dir":"Reference","previous_headings":"","what":"Set nodata value — wbt_set_nodata_value","title":"Set nodata value — wbt_set_nodata_value","text":"Assign NoData value input image.","code":""},{"path":"/reference/wbt_set_nodata_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set nodata value — wbt_set_nodata_value","text":"","code":"wbt_set_nodata_value(   input,   output,   back_value = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_set_nodata_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set nodata value — wbt_set_nodata_value","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. back_value Background value set nodata. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_set_nodata_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set nodata value — wbt_set_nodata_value","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shadow_animation.html","id":null,"dir":"Reference","previous_headings":"","what":"Shadow animation — wbt_shadow_animation","title":"Shadow animation — wbt_shadow_animation","text":"tool creates animated GIF shadows based input DEM.","code":""},{"path":"/reference/wbt_shadow_animation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shadow animation — wbt_shadow_animation","text":"","code":"wbt_shadow_animation(   input,   output,   palette = \"atlas\",   max_dist = \"\",   date = \"21/06/2021\",   interval = 15,   location = \"43.5448/-80.2482/-4\",   height = 600,   delay = 250,   label = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shadow_animation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shadow animation — wbt_shadow_animation","text":"input Name input digital surface model (DSM) raster file. output Name output HTML file (*.html). palette DSM image palette; options 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'light_quant', 'purple', 'viridis', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', 'none'. max_dist Optional maximum search distance, xy units. Minimum value 5 x cell size. date Date format DD/MM/YYYY. interval Time interval, minutes (1-60). location Location, defined Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4). height Image height, pixels. delay GIF time delay milliseconds. label Label text (leave blank none). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shadow_animation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shadow animation — wbt_shadow_animation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shadow_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Shadow image — wbt_shadow_image","title":"Shadow image — wbt_shadow_image","text":"tool creates raster shadow areas based input DEM.","code":""},{"path":"/reference/wbt_shadow_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shadow image — wbt_shadow_image","text":"","code":"wbt_shadow_image(   input,   output,   palette = \"soft\",   max_dist = \"\",   date = \"21/06/2021\",   time = \"13:00\",   location = \"43.5448/-80.2482/-4\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shadow_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shadow image — wbt_shadow_image","text":"input Name input digital surface model (DSM) raster file. output Name output raster file. palette DSM image palette; options 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'light_quant', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', 'none'. max_dist Optional maximum search distance, xy unites. Minimum value 5 x cell size. date Date format DD/MM/YYYY. time Time format HH::MM, e.g. 03:15AM 14:30. location Location, defined Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shadow_image.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shadow image — wbt_shadow_image","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shape_complexity_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Shape complexity index — wbt_shape_complexity_index","title":"Shape complexity index — wbt_shape_complexity_index","text":"Calculates overall polygon shape complexity irregularity.","code":""},{"path":"/reference/wbt_shape_complexity_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shape complexity index — wbt_shape_complexity_index","text":"","code":"wbt_shape_complexity_index(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shape_complexity_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shape complexity index — wbt_shape_complexity_index","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shape_complexity_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shape complexity index — wbt_shape_complexity_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shape_complexity_index_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Shape complexity index raster — wbt_shape_complexity_index_raster","title":"Shape complexity index raster — wbt_shape_complexity_index_raster","text":"Calculates complexity raster polygons classes.","code":""},{"path":"/reference/wbt_shape_complexity_index_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shape complexity index raster — wbt_shape_complexity_index_raster","text":"","code":"wbt_shape_complexity_index_raster(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shape_complexity_index_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shape complexity index raster — wbt_shape_complexity_index_raster","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shape_complexity_index_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shape complexity index raster — wbt_shape_complexity_index_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shape_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Shape index — wbt_shape_index","title":"Shape index — wbt_shape_index","text":"tool calculates shape index input DEM.","code":""},{"path":"/reference/wbt_shape_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shape index — wbt_shape_index","text":"","code":"wbt_shape_index(   dem,   output,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shape_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shape index — wbt_shape_index","text":"dem Name input raster DEM file. output Name output raster image file. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shape_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shape index — wbt_shape_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shreve_stream_magnitude.html","id":null,"dir":"Reference","previous_headings":"","what":"Shreve stream magnitude — wbt_shreve_stream_magnitude","title":"Shreve stream magnitude — wbt_shreve_stream_magnitude","text":"Assigns Shreve stream magnitude link stream network.","code":""},{"path":"/reference/wbt_shreve_stream_magnitude.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shreve stream magnitude — wbt_shreve_stream_magnitude","text":"","code":"wbt_shreve_stream_magnitude(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shreve_stream_magnitude.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shreve stream magnitude — wbt_shreve_stream_magnitude","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shreve_stream_magnitude.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shreve stream magnitude — wbt_shreve_stream_magnitude","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sigmoidal_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Sigmoidal contrast stretch — wbt_sigmoidal_contrast_stretch","title":"Sigmoidal contrast stretch — wbt_sigmoidal_contrast_stretch","text":"Performs sigmoidal contrast stretch input images.","code":""},{"path":"/reference/wbt_sigmoidal_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sigmoidal contrast stretch — wbt_sigmoidal_contrast_stretch","text":"","code":"wbt_sigmoidal_contrast_stretch(   input,   output,   cutoff = 0,   gain = 1,   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sigmoidal_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sigmoidal contrast stretch — wbt_sigmoidal_contrast_stretch","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. cutoff Cutoff value 0.0 0.95. gain Gain value. num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sigmoidal_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sigmoidal contrast stretch — wbt_sigmoidal_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sin.html","id":null,"dir":"Reference","previous_headings":"","what":"Sin — wbt_sin","title":"Sin — wbt_sin","text":"Returns sine (sin) values raster.","code":""},{"path":"/reference/wbt_sin.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sin — wbt_sin","text":"","code":"wbt_sin(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sin.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sin — wbt_sin","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sin.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sin — wbt_sin","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_single_part_to_multi_part.html","id":null,"dir":"Reference","previous_headings":"","what":"Single part to multi part — wbt_single_part_to_multi_part","title":"Single part to multi part — wbt_single_part_to_multi_part","text":"Converts vector file containing multi-part features vector containing single-part features.","code":""},{"path":"/reference/wbt_single_part_to_multi_part.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Single part to multi part — wbt_single_part_to_multi_part","text":"","code":"wbt_single_part_to_multi_part(   input,   output,   field = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_single_part_to_multi_part.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Single part to multi part — wbt_single_part_to_multi_part","text":"input Input vector line polygon file. output Output vector line polygon file. field Grouping ID field name attribute table. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_single_part_to_multi_part.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Single part to multi part — wbt_single_part_to_multi_part","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sinh.html","id":null,"dir":"Reference","previous_headings":"","what":"Sinh — wbt_sinh","title":"Sinh — wbt_sinh","text":"Returns hyperbolic sine (sinh) values raster.","code":""},{"path":"/reference/wbt_sinh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sinh — wbt_sinh","text":"","code":"wbt_sinh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sinh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sinh — wbt_sinh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sinh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sinh — wbt_sinh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sink.html","id":null,"dir":"Reference","previous_headings":"","what":"Sink — wbt_sink","title":"Sink — wbt_sink","text":"Identifies depressions DEM, giving feature unique identifier.","code":""},{"path":"/reference/wbt_sink.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sink — wbt_sink","text":"","code":"wbt_sink(   input,   output,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sink.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sink — wbt_sink","text":"input Input raster DEM file. output Output raster file. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sink.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sink — wbt_sink","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_slope.html","id":null,"dir":"Reference","previous_headings":"","what":"Slope — wbt_slope","title":"Slope — wbt_slope","text":"Calculates slope raster input DEM.","code":""},{"path":"/reference/wbt_slope.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Slope — wbt_slope","text":"","code":"wbt_slope(   dem,   output,   zfactor = NULL,   units = \"degrees\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_slope.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Slope — wbt_slope","text":"dem Input raster DEM file. output Output raster file. zfactor Optional multiplier vertical horizontal units . units Units output raster; options include 'degrees', 'radians', 'percent'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_slope.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Slope — wbt_slope","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_slope_vs_aspect_plot.html","id":null,"dir":"Reference","previous_headings":"","what":"Slope vs aspect plot — wbt_slope_vs_aspect_plot","title":"Slope vs aspect plot — wbt_slope_vs_aspect_plot","text":"tool creates slope-aspect relation plot input DEM.","code":""},{"path":"/reference/wbt_slope_vs_aspect_plot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Slope vs aspect plot — wbt_slope_vs_aspect_plot","text":"","code":"wbt_slope_vs_aspect_plot(   input,   output,   bin_size = 2,   min_slope = 0.1,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_slope_vs_aspect_plot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Slope vs aspect plot — wbt_slope_vs_aspect_plot","text":"input Name input raster image file. output Name output report file (*.html). bin_size Aspect bin size, degrees. min_slope Minimum slope, degrees. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_slope_vs_aspect_plot.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Slope vs aspect plot — wbt_slope_vs_aspect_plot","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_slope_vs_elevation_plot.html","id":null,"dir":"Reference","previous_headings":"","what":"Slope vs elevation plot — wbt_slope_vs_elevation_plot","title":"Slope vs elevation plot — wbt_slope_vs_elevation_plot","text":"Creates slope vs. elevation plot one DEMs.","code":""},{"path":"/reference/wbt_slope_vs_elevation_plot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Slope vs elevation plot — wbt_slope_vs_elevation_plot","text":"","code":"wbt_slope_vs_elevation_plot(   inputs,   output,   watershed = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_slope_vs_elevation_plot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Slope vs elevation plot — wbt_slope_vs_elevation_plot","text":"inputs Input DEM files. output Output HTML file (default name based input file unspecified). watershed Input watershed files (optional). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_slope_vs_elevation_plot.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Slope vs elevation plot — wbt_slope_vs_elevation_plot","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_smooth_vectors.html","id":null,"dir":"Reference","previous_headings":"","what":"Smooth vectors — wbt_smooth_vectors","title":"Smooth vectors — wbt_smooth_vectors","text":"Smooths vector coverage either POLYLINE POLYGON base ShapeType.","code":""},{"path":"/reference/wbt_smooth_vectors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Smooth vectors — wbt_smooth_vectors","text":"","code":"wbt_smooth_vectors(   input,   output,   filter = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_smooth_vectors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Smooth vectors — wbt_smooth_vectors","text":"input Input vector POLYLINE POLYGON file. output Output vector file. filter filter size, odd integer greater equal 3; default 3. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_smooth_vectors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Smooth vectors — wbt_smooth_vectors","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_smooth_vegetation_residual.html","id":null,"dir":"Reference","previous_headings":"","what":"Smooth vegetation residual — wbt_smooth_vegetation_residual","title":"Smooth vegetation residual — wbt_smooth_vegetation_residual","text":"tool can smooth residual roughness due vegetation cover LiDAR DEMs.","code":""},{"path":"/reference/wbt_smooth_vegetation_residual.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Smooth vegetation residual — wbt_smooth_vegetation_residual","text":"","code":"wbt_smooth_vegetation_residual(   input,   output,   max_scale = 30,   dev_threshold = 1,   scale_threshold = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_smooth_vegetation_residual.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Smooth vegetation residual — wbt_smooth_vegetation_residual","text":"input Name input digital elevation model (DEM) raster file. output Name output raster file. max_scale Maximum search neighbourhood radius grid cells. dev_threshold DEVmax Threshold. scale_threshold DEVmax scale threshold. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_smooth_vegetation_residual.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Smooth vegetation residual — wbt_smooth_vegetation_residual","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_snap_pour_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Snap pour points — wbt_snap_pour_points","title":"Snap pour points — wbt_snap_pour_points","text":"Moves outlet points used specify points interest watershedding operation cell highest flow accumulation neighbourhood.","code":""},{"path":"/reference/wbt_snap_pour_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Snap pour points — wbt_snap_pour_points","text":"","code":"wbt_snap_pour_points(   pour_pts,   flow_accum,   output,   snap_dist,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_snap_pour_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Snap pour points — wbt_snap_pour_points","text":"pour_pts Input vector pour points (outlet) file. flow_accum Input raster D8 flow accumulation file. output Output vector file. snap_dist Maximum snap distance map units. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_snap_pour_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Snap pour points — wbt_snap_pour_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sobel_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Sobel filter — wbt_sobel_filter","title":"Sobel filter — wbt_sobel_filter","text":"Performs Sobel edge-detection filter image.","code":""},{"path":"/reference/wbt_sobel_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sobel filter — wbt_sobel_filter","text":"","code":"wbt_sobel_filter(   input,   output,   variant = \"3x3\",   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sobel_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sobel filter — wbt_sobel_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. variant Optional variant value. Options include 3x3 5x5 (default 3x3). clip Optional amount clip distribution tails , percent (default 0.0). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sobel_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sobel filter — wbt_sobel_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sort_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Sort lidar — wbt_sort_lidar","title":"Sort lidar — wbt_sort_lidar","text":"Sorts LiDAR points based properties.","code":""},{"path":"/reference/wbt_sort_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sort lidar — wbt_sort_lidar","text":"","code":"wbt_sort_lidar(   input,   output = NULL,   criteria = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sort_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sort lidar — wbt_sort_lidar","text":"input Name input LiDAR points. output Name output LiDAR points. criteria Sort criteria e.g. 'x 50.0, y 50.0, z'; criteria may include x, y, z, intensity, class, user_data, point_source_id, scan_angle. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sort_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sort lidar — wbt_sort_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_source.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize an R object containing spatial data for use by WhiteboxTools — wbt_source","title":"Initialize an R object containing spatial data for use by WhiteboxTools — wbt_source","text":"Initialize R object containing spatial data use WhiteboxTools","code":""},{"path":"/reference/wbt_source.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize an R object containing spatial data for use by WhiteboxTools — wbt_source","text":"","code":"wbt_source(   x,   dsn = NULL,   layer = NULL,   force = FALSE,   verbose = wbt_verbose(),   ... )"},{"path":"/reference/wbt_source.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize an R object containing spatial data for use by WhiteboxTools — wbt_source","text":"x terra SpatVector sf object, path file can read SpatVectorProxy dsn Data source path / file name layer Data layer force Force write vector data file? Default: FALSE (write file exist) verbose Print information data source contents? ... Additional arguments passed terra::writeVector() sf::st_write()","code":""},{"path":"/reference/wbt_source.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize an R object containing spatial data for use by WhiteboxTools — wbt_source","text":"R object attributes wbt_dsn wbt_layer set needed support reading writing R objects file WhiteboxTools.","code":""},{"path":"/reference/wbt_spherical_std_dev_of_normals.html","id":null,"dir":"Reference","previous_headings":"","what":"Spherical std dev of normals — wbt_spherical_std_dev_of_normals","title":"Spherical std dev of normals — wbt_spherical_std_dev_of_normals","text":"Calculates spherical standard deviation surface normals DEM.","code":""},{"path":"/reference/wbt_spherical_std_dev_of_normals.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Spherical std dev of normals — wbt_spherical_std_dev_of_normals","text":"","code":"wbt_spherical_std_dev_of_normals(   dem,   output,   filter = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_spherical_std_dev_of_normals.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Spherical std dev of normals — wbt_spherical_std_dev_of_normals","text":"dem Input raster DEM file. output Output raster file. filter Size filter kernel. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_spherical_std_dev_of_normals.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Spherical std dev of normals — wbt_spherical_std_dev_of_normals","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_split_colour_composite.html","id":null,"dir":"Reference","previous_headings":"","what":"Split colour composite — wbt_split_colour_composite","title":"Split colour composite — wbt_split_colour_composite","text":"Splits RGB colour composite image separate multispectral images.","code":""},{"path":"/reference/wbt_split_colour_composite.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split colour composite — wbt_split_colour_composite","text":"","code":"wbt_split_colour_composite(   input,   red = NULL,   green = NULL,   blue = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_split_colour_composite.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split colour composite — wbt_split_colour_composite","text":"input Input colour composite image file. red Output red band file. green Output green band file. blue Output blue band file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_split_colour_composite.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split colour composite — wbt_split_colour_composite","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_split_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Split lidar — wbt_split_lidar","title":"Split lidar — wbt_split_lidar","text":"Splits LiDAR points series new files based properties.","code":""},{"path":"/reference/wbt_split_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split lidar — wbt_split_lidar","text":"","code":"wbt_split_lidar(   input,   criterion = \"num_pts\",   interval = \"\",   min_pts = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_split_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split lidar — wbt_split_lidar","text":"input Name input LiDAR points. criterion Criterion base split input file. Options include 'num_pts, 'x', 'y', 'z', intensity, 'class', 'user_data', 'point_source_id', 'scan_angle', 'time'. interval Interval. min_pts Minimum number points output file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_split_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split lidar — wbt_split_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_split_vector_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Split vector lines — wbt_split_vector_lines","title":"Split vector lines — wbt_split_vector_lines","text":"Used split vector line coverage even-lengthed segments.","code":""},{"path":"/reference/wbt_split_vector_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split vector lines — wbt_split_vector_lines","text":"","code":"wbt_split_vector_lines(   input,   output,   length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_split_vector_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split vector lines — wbt_split_vector_lines","text":"input Name input lines shapefile. output Name output lines shapefile. length Maximum segment length (m). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_split_vector_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split vector lines — wbt_split_vector_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_split_with_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Split with lines — wbt_split_with_lines","title":"Split with lines — wbt_split_with_lines","text":"Splits lines polygons one layer using lines another layer.","code":""},{"path":"/reference/wbt_split_with_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split with lines — wbt_split_with_lines","text":"","code":"wbt_split_with_lines(   input,   split,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_split_with_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split with lines — wbt_split_with_lines","text":"input Input vector line polygon file. split Input vector polyline file. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_split_with_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split with lines — wbt_split_with_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_square.html","id":null,"dir":"Reference","previous_headings":"","what":"Square — wbt_square","title":"Square — wbt_square","text":"Squares values raster.","code":""},{"path":"/reference/wbt_square.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Square — wbt_square","text":"","code":"wbt_square(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_square.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Square — wbt_square","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_square.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Square — wbt_square","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_square_root.html","id":null,"dir":"Reference","previous_headings":"","what":"Square root — wbt_square_root","title":"Square root — wbt_square_root","text":"Returns square root values raster.","code":""},{"path":"/reference/wbt_square_root.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Square root — wbt_square_root","text":"","code":"wbt_square_root(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_square_root.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Square root — wbt_square_root","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_square_root.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Square root — wbt_square_root","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_standard_deviation_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Standard deviation contrast stretch — wbt_standard_deviation_contrast_stretch","title":"Standard deviation contrast stretch — wbt_standard_deviation_contrast_stretch","text":"Performs standard-deviation contrast stretch input images.","code":""},{"path":"/reference/wbt_standard_deviation_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Standard deviation contrast stretch — wbt_standard_deviation_contrast_stretch","text":"","code":"wbt_standard_deviation_contrast_stretch(   input,   output,   stdev = 2,   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_standard_deviation_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Standard deviation contrast stretch — wbt_standard_deviation_contrast_stretch","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. stdev Standard deviation clip value. num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_standard_deviation_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Standard deviation contrast stretch — wbt_standard_deviation_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_standard_deviation_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Standard deviation filter — wbt_standard_deviation_filter","title":"Standard deviation filter — wbt_standard_deviation_filter","text":"Assigns cell output grid standard deviation values moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_standard_deviation_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Standard deviation filter — wbt_standard_deviation_filter","text":"","code":"wbt_standard_deviation_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_standard_deviation_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Standard deviation filter — wbt_standard_deviation_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_standard_deviation_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Standard deviation filter — wbt_standard_deviation_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_standard_deviation_of_slope.html","id":null,"dir":"Reference","previous_headings":"","what":"Standard deviation of slope — wbt_standard_deviation_of_slope","title":"Standard deviation of slope — wbt_standard_deviation_of_slope","text":"Calculates standard deviation slope input DEM.","code":""},{"path":"/reference/wbt_standard_deviation_of_slope.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Standard deviation of slope — wbt_standard_deviation_of_slope","text":"","code":"wbt_standard_deviation_of_slope(   input,   output,   zfactor = NULL,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_standard_deviation_of_slope.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Standard deviation of slope — wbt_standard_deviation_of_slope","text":"input Input raster DEM file. output Output raster DEM file. zfactor Optional multiplier vertical horizontal units . filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_standard_deviation_of_slope.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Standard deviation of slope — wbt_standard_deviation_of_slope","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stochastic_depression_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Stochastic depression analysis — wbt_stochastic_depression_analysis","title":"Stochastic depression analysis — wbt_stochastic_depression_analysis","text":"Performs stochastic analysis depressions within DEM.","code":""},{"path":"/reference/wbt_stochastic_depression_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stochastic depression analysis — wbt_stochastic_depression_analysis","text":"","code":"wbt_stochastic_depression_analysis(   dem,   output,   rmse,   range,   iterations = 100,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stochastic_depression_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stochastic depression analysis — wbt_stochastic_depression_analysis","text":"dem Input raster DEM file. output Output file. rmse DEM's root-mean-square-error (RMSE), z units. determines error magnitude. range error field's correlation length, xy-units. iterations number iterations. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stochastic_depression_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stochastic depression analysis — wbt_stochastic_depression_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_strahler_order_basins.html","id":null,"dir":"Reference","previous_headings":"","what":"Strahler order basins — wbt_strahler_order_basins","title":"Strahler order basins — wbt_strahler_order_basins","text":"Identifies Strahler-order basins input stream network.","code":""},{"path":"/reference/wbt_strahler_order_basins.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Strahler order basins — wbt_strahler_order_basins","text":"","code":"wbt_strahler_order_basins(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_strahler_order_basins.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Strahler order basins — wbt_strahler_order_basins","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_strahler_order_basins.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Strahler order basins — wbt_strahler_order_basins","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_strahler_stream_order.html","id":null,"dir":"Reference","previous_headings":"","what":"Strahler stream order — wbt_strahler_stream_order","title":"Strahler stream order — wbt_strahler_stream_order","text":"Assigns Strahler stream order link stream network.","code":""},{"path":"/reference/wbt_strahler_stream_order.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Strahler stream order — wbt_strahler_stream_order","text":"","code":"wbt_strahler_stream_order(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_strahler_stream_order.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Strahler stream order — wbt_strahler_stream_order","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_strahler_stream_order.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Strahler stream order — wbt_strahler_stream_order","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_link_class.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream link class — wbt_stream_link_class","title":"Stream link class — wbt_stream_link_class","text":"Identifies exterior/interior links nodes stream network.","code":""},{"path":"/reference/wbt_stream_link_class.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream link class — wbt_stream_link_class","text":"","code":"wbt_stream_link_class(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_link_class.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream link class — wbt_stream_link_class","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_link_class.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream link class — wbt_stream_link_class","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_link_identifier.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream link identifier — wbt_stream_link_identifier","title":"Stream link identifier — wbt_stream_link_identifier","text":"Assigns unique identifier link stream network.","code":""},{"path":"/reference/wbt_stream_link_identifier.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream link identifier — wbt_stream_link_identifier","text":"","code":"wbt_stream_link_identifier(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_link_identifier.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream link identifier — wbt_stream_link_identifier","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_link_identifier.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream link identifier — wbt_stream_link_identifier","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_link_length.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream link length — wbt_stream_link_length","title":"Stream link length — wbt_stream_link_length","text":"Estimates length link (tributary) stream network.","code":""},{"path":"/reference/wbt_stream_link_length.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream link length — wbt_stream_link_length","text":"","code":"wbt_stream_link_length(   d8_pntr,   linkid,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_link_length.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream link length — wbt_stream_link_length","text":"d8_pntr Input raster D8 pointer file. linkid Input raster streams link ID (tributary ID) file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_link_length.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream link length — wbt_stream_link_length","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_link_slope.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream link slope — wbt_stream_link_slope","title":"Stream link slope — wbt_stream_link_slope","text":"Estimates average slope link (tributary) stream network.","code":""},{"path":"/reference/wbt_stream_link_slope.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream link slope — wbt_stream_link_slope","text":"","code":"wbt_stream_link_slope(   d8_pntr,   linkid,   dem,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_link_slope.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream link slope — wbt_stream_link_slope","text":"d8_pntr Input raster D8 pointer file. linkid Input raster streams link ID (tributary ID) file. dem Input raster DEM file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_link_slope.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream link slope — wbt_stream_link_slope","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_power_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream power index — wbt_stream_power_index","title":"Stream power index — wbt_stream_power_index","text":"Calculates relative stream power index.","code":""},{"path":"/reference/wbt_stream_power_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream power index — wbt_stream_power_index","text":"","code":"wbt_stream_power_index(   sca,   slope,   output,   exponent = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_power_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream power index — wbt_stream_power_index","text":"sca Input raster specific contributing area (SCA) file. slope Input raster slope file. output Output raster file. exponent SCA exponent value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_power_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream power index — wbt_stream_power_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_slope_continuous.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream slope continuous — wbt_stream_slope_continuous","title":"Stream slope continuous — wbt_stream_slope_continuous","text":"Estimates slope grid cell stream network.","code":""},{"path":"/reference/wbt_stream_slope_continuous.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream slope continuous — wbt_stream_slope_continuous","text":"","code":"wbt_stream_slope_continuous(   d8_pntr,   streams,   dem,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_slope_continuous.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream slope continuous — wbt_stream_slope_continuous","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. dem Input raster DEM file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_slope_continuous.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream slope continuous — wbt_stream_slope_continuous","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_subbasins.html","id":null,"dir":"Reference","previous_headings":"","what":"Subbasins — wbt_subbasins","title":"Subbasins — wbt_subbasins","text":"Identifies catchments, sub-basin, draining link stream network.","code":""},{"path":"/reference/wbt_subbasins.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Subbasins — wbt_subbasins","text":"","code":"wbt_subbasins(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_subbasins.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Subbasins — wbt_subbasins","text":"d8_pntr Input D8 pointer raster file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_subbasins.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Subbasins — wbt_subbasins","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_subtract.html","id":null,"dir":"Reference","previous_headings":"","what":"Subtract — wbt_subtract","title":"Subtract — wbt_subtract","text":"Performs differencing operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_subtract.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Subtract — wbt_subtract","text":"","code":"wbt_subtract(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_subtract.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Subtract — wbt_subtract","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_subtract.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Subtract — wbt_subtract","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sum_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Sum overlay — wbt_sum_overlay","title":"Sum overlay — wbt_sum_overlay","text":"Calculates sum grid cell group raster images.","code":""},{"path":"/reference/wbt_sum_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sum overlay — wbt_sum_overlay","text":"","code":"wbt_sum_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sum_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sum overlay — wbt_sum_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sum_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sum overlay — wbt_sum_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_surface_area_ratio.html","id":null,"dir":"Reference","previous_headings":"","what":"Surface area ratio — wbt_surface_area_ratio","title":"Surface area ratio — wbt_surface_area_ratio","text":"Calculates surface area ratio grid cell input DEM.","code":""},{"path":"/reference/wbt_surface_area_ratio.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Surface area ratio — wbt_surface_area_ratio","text":"","code":"wbt_surface_area_ratio(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_surface_area_ratio.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Surface area ratio — wbt_surface_area_ratio","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_surface_area_ratio.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Surface area ratio — wbt_surface_area_ratio","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_svm_classification.html","id":null,"dir":"Reference","previous_headings":"","what":"Svm classification — wbt_svm_classification","title":"Svm classification — wbt_svm_classification","text":"Performs SVM binary classification using training site polygons/points multiple input images.","code":""},{"path":"/reference/wbt_svm_classification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Svm classification — wbt_svm_classification","text":"","code":"wbt_svm_classification(   inputs,   training,   field,   scaling = \"Normalize\",   output = NULL,   c = 200,   gamma = 50,   tolerance = 0.1,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_svm_classification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Svm classification — wbt_svm_classification","text":"inputs Names input predictor rasters. training Name input training site polygons/points Shapefile. field Name attribute containing class data. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. output Name output raster file. c c-value, regularization parameter. gamma Gamma parameter used setting RBF (Gaussian) kernel function. tolerance tolerance parameter used determining stopping condition. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_svm_classification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Svm classification — wbt_svm_classification","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_svm_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Svm regression — wbt_svm_regression","title":"Svm regression — wbt_svm_regression","text":"Performs supervised SVM regression analysis using training site points predictor rasters.","code":""},{"path":"/reference/wbt_svm_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Svm regression — wbt_svm_regression","text":"","code":"wbt_svm_regression(   inputs,   training,   field,   scaling = \"Normalize\",   output = NULL,   c = 50,   eps = 10,   gamma = 0.5,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_svm_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Svm regression — wbt_svm_regression","text":"inputs Names input predictor rasters. training Name input training site points Shapefile. field Name attribute containing class data. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. output Name output raster file. c c-value, regularization parameter. eps Epsilon epsilon-SVR model. gamma Gamma parameter used setting RBF (Gaussian) kernel function. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_svm_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Svm regression — wbt_svm_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_symmetrical_difference.html","id":null,"dir":"Reference","previous_headings":"","what":"Symmetrical difference — wbt_symmetrical_difference","title":"Symmetrical difference — wbt_symmetrical_difference","text":"Outputs features occur one two vector inputs , .e. overlapping features.","code":""},{"path":"/reference/wbt_symmetrical_difference.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Symmetrical difference — wbt_symmetrical_difference","text":"","code":"wbt_symmetrical_difference(   input,   overlay,   output,   snap = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_symmetrical_difference.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Symmetrical difference — wbt_symmetrical_difference","text":"input Input vector file path. See wbt_file_path() details. overlay Input overlay vector file. output Output vector file. snap Snap tolerance. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_symmetrical_difference.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Symmetrical difference — wbt_symmetrical_difference","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tan.html","id":null,"dir":"Reference","previous_headings":"","what":"Tan — wbt_tan","title":"Tan — wbt_tan","text":"Returns tangent (tan) values raster.","code":""},{"path":"/reference/wbt_tan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tan — wbt_tan","text":"","code":"wbt_tan(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tan — wbt_tan","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tan.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tan — wbt_tan","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tangential_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Tangential curvature — wbt_tangential_curvature","title":"Tangential curvature — wbt_tangential_curvature","text":"Calculates tangential curvature raster input DEM.","code":""},{"path":"/reference/wbt_tangential_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tangential curvature — wbt_tangential_curvature","text":"","code":"wbt_tangential_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tangential_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tangential curvature — wbt_tangential_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tangential_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tangential curvature — wbt_tangential_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tanh.html","id":null,"dir":"Reference","previous_headings":"","what":"Tanh — wbt_tanh","title":"Tanh — wbt_tanh","text":"Returns hyperbolic tangent (tanh) values raster.","code":""},{"path":"/reference/wbt_tanh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tanh — wbt_tanh","text":"","code":"wbt_tanh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tanh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tanh — wbt_tanh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tanh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tanh — wbt_tanh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_thicken_raster_line.html","id":null,"dir":"Reference","previous_headings":"","what":"Thicken raster line — wbt_thicken_raster_line","title":"Thicken raster line — wbt_thicken_raster_line","text":"Thickens single-cell wide lines within raster image.","code":""},{"path":"/reference/wbt_thicken_raster_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Thicken raster line — wbt_thicken_raster_line","text":"","code":"wbt_thicken_raster_line(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_thicken_raster_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Thicken raster line — wbt_thicken_raster_line","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_thicken_raster_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Thicken raster line — wbt_thicken_raster_line","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_time_in_daylight.html","id":null,"dir":"Reference","previous_headings":"","what":"Time in daylight — wbt_time_in_daylight","title":"Time in daylight — wbt_time_in_daylight","text":"Calculates proportion time location within area shadow.","code":""},{"path":"/reference/wbt_time_in_daylight.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Time in daylight — wbt_time_in_daylight","text":"","code":"wbt_time_in_daylight(   dem,   output,   lat,   long,   az_fraction = 10,   max_dist = 100,   utc_offset = \"00:00\",   start_day = 1,   end_day = 365,   start_time = \"00:00:00\",   end_time = \"23:59:59\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_time_in_daylight.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Time in daylight — wbt_time_in_daylight","text":"dem Input raster DEM file. output Output raster file. lat Centre point latitude. long Centre point longitude. az_fraction Azimuth fraction degrees. max_dist Optional maximum search distance. Minimum value 5 x cell size. utc_offset UTC time offset, hours (e.g. -04:00, +06:00). start_day Start day year (1-365). end_day End day year (1-365). start_time Starting hour track shadows (e.g. 5, 5:00, 05:00:00). Assumes 24-hour time: HH:MM:SS. 'sunrise' also valid time. end_time Ending hour track shadows (e.g. 21, 21:00, 21:00:00). Assumes 24-hour time: HH:MM:SS. 'sunset' also valid time. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_time_in_daylight.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Time in daylight — wbt_time_in_daylight","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tin_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Tin gridding — wbt_tin_gridding","title":"Tin gridding — wbt_tin_gridding","text":"Creates raster grid based triangular irregular network (TIN) fitted vector points.","code":""},{"path":"/reference/wbt_tin_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tin gridding — wbt_tin_gridding","text":"","code":"wbt_tin_gridding(   input,   output,   field = NULL,   use_z = FALSE,   resolution = NULL,   base = NULL,   max_triangle_edge_length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tin_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tin gridding — wbt_tin_gridding","text":"input Input vector points file. output Output raster file. field Input field name attribute table. use_z Use 'z' dimension Shapefile's geometry instead attribute field?. resolution Output raster's grid resolution. base Optionally specified input base raster file. used cell size specified. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tin_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tin gridding — wbt_tin_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_to_degrees.html","id":null,"dir":"Reference","previous_headings":"","what":"To degrees — wbt_to_degrees","title":"To degrees — wbt_to_degrees","text":"Converts raster radians degrees.","code":""},{"path":"/reference/wbt_to_degrees.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"To degrees — wbt_to_degrees","text":"","code":"wbt_to_degrees(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_to_degrees.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"To degrees — wbt_to_degrees","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_to_degrees.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"To degrees — wbt_to_degrees","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_to_radians.html","id":null,"dir":"Reference","previous_headings":"","what":"To radians — wbt_to_radians","title":"To radians — wbt_to_radians","text":"Converts raster degrees radians.","code":""},{"path":"/reference/wbt_to_radians.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"To radians — wbt_to_radians","text":"","code":"wbt_to_radians(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_to_radians.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"To radians — wbt_to_radians","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_to_radians.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"To radians — wbt_to_radians","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tool_help.html","id":null,"dir":"Reference","previous_headings":"","what":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"Retrieves help description specific tool.","code":""},{"path":"/reference/wbt_tool_help.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"","code":"wbt_tool_help(tool_name = NULL)"},{"path":"/reference/wbt_tool_help.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"tool_name name tool.","code":""},{"path":"/reference/wbt_tool_help.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"Returns help description specific tool.","code":""},{"path":"/reference/wbt_tool_help.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"Leaving tool_name default NULL returns results tools, work Windows.","code":""},{"path":"/reference/wbt_tool_help.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"","code":"if (FALSE) { wbt_tool_help(\"lidar_info\") }"},{"path":"/reference/wbt_tool_parameters.html","id":null,"dir":"Reference","previous_headings":"","what":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"Retrieves tool parameter descriptions specific tool.","code":""},{"path":"/reference/wbt_tool_parameters.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"","code":"wbt_tool_parameters(tool_name, quiet = FALSE)"},{"path":"/reference/wbt_tool_parameters.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"tool_name name tool. quiet Prevent tool output printed. Default: FALSE","code":""},{"path":"/reference/wbt_tool_parameters.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"Returns tool parameter descriptions specific tool.","code":""},{"path":"/reference/wbt_tool_parameters.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"quiet argument can set TRUE allow \"quiet\" internal use within functions.","code":""},{"path":"/reference/wbt_tool_parameters.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"","code":"if (FALSE) { wbt_tool_parameters(\"lidar_info\") }"},{"path":"/reference/wbt_toolbox.html","id":null,"dir":"Reference","previous_headings":"","what":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"Retrieve toolbox specific tool.","code":""},{"path":"/reference/wbt_toolbox.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"","code":"wbt_toolbox(tool_name = NULL)"},{"path":"/reference/wbt_toolbox.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"tool_name name tool.","code":""},{"path":"/reference/wbt_toolbox.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"Returns toolbox specific tool.","code":""},{"path":"/reference/wbt_toolbox.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"Leaving tool_name default NULL returns results tools, work Windows.","code":""},{"path":"/reference/wbt_toolbox.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"","code":"if (FALSE) { wbt_toolbox(\"breach_depressions\") }"},{"path":"/reference/wbt_tophat_transform.html","id":null,"dir":"Reference","previous_headings":"","what":"Tophat transform — wbt_tophat_transform","title":"Tophat transform — wbt_tophat_transform","text":"Performs either white black top-hat transform input image.","code":""},{"path":"/reference/wbt_tophat_transform.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tophat transform — wbt_tophat_transform","text":"","code":"wbt_tophat_transform(   input,   output,   filterx = 11,   filtery = 11,   variant = \"white\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tophat_transform.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tophat transform — wbt_tophat_transform","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. variant Optional variant value. Options include 'white' 'black'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tophat_transform.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tophat transform — wbt_tophat_transform","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_topo_render.html","id":null,"dir":"Reference","previous_headings":"","what":"Topo render — wbt_topo_render","title":"Topo render — wbt_topo_render","text":"tool creates pseudo-3D rendering input DEM, purpose effective topographic visualization.","code":""},{"path":"/reference/wbt_topo_render.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Topo render — wbt_topo_render","text":"","code":"wbt_topo_render(   dem,   output,   palette = \"soft\",   rev_palette = FALSE,   az = 315,   alt = 30,   background_hgt_offset = 10,   polygon = NULL,   background_clr = \"[255, 255, 255]\",   attenuation = 0.6,   ambient_light = 0.2,   z_factor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_topo_render.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Topo render — wbt_topo_render","text":"dem Name input digital elevation model (DEM) raster file. output Name output raster file. palette Palette name; options 'atlas', 'high_relief', 'arid', 'soft', 'earthtones', 'muted', 'light_quant', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', 'imhof', 'white'. rev_palette Reverse palette?. az Light source azimuth direction (degrees, 0-360). alt Light source altitude (degrees, 0-90). background_hgt_offset Offset height background, z-units. polygon Clipping polygon vector file (optional). background_clr Background red-green-blue (RGB) red-green-blue-alpha (RGBA) colour, e.g. '[255, 255, 245]', '[255, 255, 245, 200]'. attenuation Attenuation parameter. Range 0-4. Zero means attenuation. ambient_light Ambient light parameter. Range 0.0-0.7. Zero means ambient light. z_factor Elevation multiplier, vertical exageration. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_topo_render.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Topo render — wbt_topo_render","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_topographic_position_animation.html","id":null,"dir":"Reference","previous_headings":"","what":"Topographic position animation — wbt_topographic_position_animation","title":"Topographic position animation — wbt_topographic_position_animation","text":"tool creates animated GIF multi-scale local topographic position (elevation deviation).","code":""},{"path":"/reference/wbt_topographic_position_animation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Topographic position animation — wbt_topographic_position_animation","text":"","code":"wbt_topographic_position_animation(   input,   output,   palette = \"bl_yl_rd\",   min_scale = 1,   num_steps = 100,   step_nonlinearity = 1.5,   height = 600,   delay = 250,   label = \"\",   dev_max = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_topographic_position_animation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Topographic position animation — wbt_topographic_position_animation","text":"input Name input digital elevation model (DEM) raster file. output Name output HTML file (*.html). palette Image palette; options 'bl_yl_rd', 'bl_w_rd', 'purple', 'gn_yl', 'pi_y_g', 'viridis'. min_scale Minimum search neighbourhood radius grid cells. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). height Image height, pixels. delay GIF time delay milliseconds. label Label text (leave blank none). dev_max want use DEVmax instead DEV measuring local topographic position?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_topographic_position_animation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Topographic position animation — wbt_topographic_position_animation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_topological_stream_order.html","id":null,"dir":"Reference","previous_headings":"","what":"Topological stream order — wbt_topological_stream_order","title":"Topological stream order — wbt_topological_stream_order","text":"Assigns link stream network topological order.","code":""},{"path":"/reference/wbt_topological_stream_order.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Topological stream order — wbt_topological_stream_order","text":"","code":"wbt_topological_stream_order(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_topological_stream_order.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Topological stream order — wbt_topological_stream_order","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_topological_stream_order.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Topological stream order — wbt_topological_stream_order","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_total_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Total curvature — wbt_total_curvature","title":"Total curvature — wbt_total_curvature","text":"Calculates total curvature raster input DEM.","code":""},{"path":"/reference/wbt_total_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Total curvature — wbt_total_curvature","text":"","code":"wbt_total_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_total_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Total curvature — wbt_total_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_total_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Total curvature — wbt_total_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_total_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Total filter — wbt_total_filter","title":"Total filter — wbt_total_filter","text":"Performs total filter input image.","code":""},{"path":"/reference/wbt_total_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Total filter — wbt_total_filter","text":"","code":"wbt_total_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_total_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Total filter — wbt_total_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_total_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Total filter — wbt_total_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_trace_downslope_flowpaths.html","id":null,"dir":"Reference","previous_headings":"","what":"Trace downslope flowpaths — wbt_trace_downslope_flowpaths","title":"Trace downslope flowpaths — wbt_trace_downslope_flowpaths","text":"Traces downslope flowpaths one target sites (.e. seed points).","code":""},{"path":"/reference/wbt_trace_downslope_flowpaths.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Trace downslope flowpaths — wbt_trace_downslope_flowpaths","text":"","code":"wbt_trace_downslope_flowpaths(   seed_pts,   d8_pntr,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_trace_downslope_flowpaths.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Trace downslope flowpaths — wbt_trace_downslope_flowpaths","text":"seed_pts Input vector seed points file. d8_pntr Input D8 pointer raster file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_trace_downslope_flowpaths.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Trace downslope flowpaths — wbt_trace_downslope_flowpaths","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_travelling_salesman_problem.html","id":null,"dir":"Reference","previous_headings":"","what":"Travelling salesman problem — wbt_travelling_salesman_problem","title":"Travelling salesman problem — wbt_travelling_salesman_problem","text":"Finds approximate solutions travelling salesman problems, goal identify shortest route connecting set locations.","code":""},{"path":"/reference/wbt_travelling_salesman_problem.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Travelling salesman problem — wbt_travelling_salesman_problem","text":"","code":"wbt_travelling_salesman_problem(   input,   output,   duration = 60,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_travelling_salesman_problem.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Travelling salesman problem — wbt_travelling_salesman_problem","text":"input Name input points shapefile. output Name output lines shapefile. duration Maximum duration, seconds. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_travelling_salesman_problem.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Travelling salesman problem — wbt_travelling_salesman_problem","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_trend_surface.html","id":null,"dir":"Reference","previous_headings":"","what":"Trend surface — wbt_trend_surface","title":"Trend surface — wbt_trend_surface","text":"Estimates trend surface input raster file.","code":""},{"path":"/reference/wbt_trend_surface.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Trend surface — wbt_trend_surface","text":"","code":"wbt_trend_surface(   input,   output,   order = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_trend_surface.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Trend surface — wbt_trend_surface","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. order Polynomial order (1 10). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_trend_surface.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Trend surface — wbt_trend_surface","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_trend_surface_vector_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Trend surface vector points — wbt_trend_surface_vector_points","title":"Trend surface vector points — wbt_trend_surface_vector_points","text":"Estimates trend surface vector points.","code":""},{"path":"/reference/wbt_trend_surface_vector_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Trend surface vector points — wbt_trend_surface_vector_points","text":"","code":"wbt_trend_surface_vector_points(   input,   field,   output,   cell_size,   order = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_trend_surface_vector_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Trend surface vector points — wbt_trend_surface_vector_points","text":"input Input vector Points file. field Input field name attribute table. output Output raster file. cell_size Optionally specified cell size output raster. used base raster specified. order Polynomial order (1 10). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_trend_surface_vector_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Trend surface vector points — wbt_trend_surface_vector_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tributary_identifier.html","id":null,"dir":"Reference","previous_headings":"","what":"Tributary identifier — wbt_tributary_identifier","title":"Tributary identifier — wbt_tributary_identifier","text":"Assigns unique identifier tributary stream network.","code":""},{"path":"/reference/wbt_tributary_identifier.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tributary identifier — wbt_tributary_identifier","text":"","code":"wbt_tributary_identifier(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tributary_identifier.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tributary identifier — wbt_tributary_identifier","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tributary_identifier.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tributary identifier — wbt_tributary_identifier","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_truncate.html","id":null,"dir":"Reference","previous_headings":"","what":"Truncate — wbt_truncate","title":"Truncate — wbt_truncate","text":"Truncates values raster desired number decimal places.","code":""},{"path":"/reference/wbt_truncate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Truncate — wbt_truncate","text":"","code":"wbt_truncate(   input,   output,   num_decimals = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_truncate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Truncate — wbt_truncate","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. num_decimals Number decimals left truncation (default zero). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_truncate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Truncate — wbt_truncate","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_turning_bands_simulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Turning bands simulation — wbt_turning_bands_simulation","title":"Turning bands simulation — wbt_turning_bands_simulation","text":"Creates image containing random values based turning-bands simulation.","code":""},{"path":"/reference/wbt_turning_bands_simulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Turning bands simulation — wbt_turning_bands_simulation","text":"","code":"wbt_turning_bands_simulation(   base,   output,   range,   iterations = 1000,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_turning_bands_simulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Turning bands simulation — wbt_turning_bands_simulation","text":"base Input base raster file. output Output file. range field's range, xy-units, related extent spatial autocorrelation. iterations number iterations. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_turning_bands_simulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Turning bands simulation — wbt_turning_bands_simulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_two_sample_ks_test.html","id":null,"dir":"Reference","previous_headings":"","what":"Two sample ks test — wbt_two_sample_ks_test","title":"Two sample ks test — wbt_two_sample_ks_test","text":"Performs 2-sample K-S test significant differences two input rasters.","code":""},{"path":"/reference/wbt_two_sample_ks_test.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Two sample ks test — wbt_two_sample_ks_test","text":"","code":"wbt_two_sample_ks_test(   input1,   input2,   output,   num_samples = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_two_sample_ks_test.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Two sample ks test — wbt_two_sample_ks_test","text":"input1 First input raster file. input2 Second input raster file. output Output HTML file. num_samples Number samples. Leave blank use whole image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_two_sample_ks_test.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Two sample ks test — wbt_two_sample_ks_test","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_union.html","id":null,"dir":"Reference","previous_headings":"","what":"Union — wbt_union","title":"Union — wbt_union","text":"Splits vector layers overlaps, creating layer containing portions input overlay layers.","code":""},{"path":"/reference/wbt_union.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Union — wbt_union","text":"","code":"wbt_union(   input,   overlay,   output,   snap = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_union.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Union — wbt_union","text":"input Input vector file path. See wbt_file_path() details. overlay Input overlay vector file. output Output vector file. snap Snap tolerance. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_union.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Union — wbt_union","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_unnest_basins.html","id":null,"dir":"Reference","previous_headings":"","what":"Unnest basins — wbt_unnest_basins","title":"Unnest basins — wbt_unnest_basins","text":"Extract whole watersheds set outlet points.","code":""},{"path":"/reference/wbt_unnest_basins.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Unnest basins — wbt_unnest_basins","text":"","code":"wbt_unnest_basins(   d8_pntr,   pour_pts,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_unnest_basins.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Unnest basins — wbt_unnest_basins","text":"d8_pntr Input D8 pointer raster file. pour_pts Input vector pour points (outlet) file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_unnest_basins.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Unnest basins — wbt_unnest_basins","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_unsharp_masking.html","id":null,"dir":"Reference","previous_headings":"","what":"Unsharp masking — wbt_unsharp_masking","title":"Unsharp masking — wbt_unsharp_masking","text":"image sharpening technique enhances edges.","code":""},{"path":"/reference/wbt_unsharp_masking.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Unsharp masking — wbt_unsharp_masking","text":"","code":"wbt_unsharp_masking(   input,   output,   sigma = 0.75,   amount = 100,   threshold = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_unsharp_masking.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Unsharp masking — wbt_unsharp_masking","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma Standard deviation distance pixels. amount percentage controls magnitude overshoot. threshold Controls minimal brightness change sharpened. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_unsharp_masking.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Unsharp masking — wbt_unsharp_masking","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_unsphericity.html","id":null,"dir":"Reference","previous_headings":"","what":"Unsphericity — wbt_unsphericity","title":"Unsphericity — wbt_unsphericity","text":"tool calculates unsphericity curvature input DEM.","code":""},{"path":"/reference/wbt_unsphericity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Unsphericity — wbt_unsphericity","text":"","code":"wbt_unsphericity(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_unsphericity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Unsphericity — wbt_unsphericity","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_unsphericity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Unsphericity — wbt_unsphericity","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_update_nodata_cells.html","id":null,"dir":"Reference","previous_headings":"","what":"Update nodata cells — wbt_update_nodata_cells","title":"Update nodata cells — wbt_update_nodata_cells","text":"Replaces NoData values input raster corresponding values contained second update layer.","code":""},{"path":"/reference/wbt_update_nodata_cells.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update nodata cells — wbt_update_nodata_cells","text":"","code":"wbt_update_nodata_cells(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_update_nodata_cells.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update nodata cells — wbt_update_nodata_cells","text":"input1 Input raster file 1. input2 Input raster file 2; update layer. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_update_nodata_cells.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update nodata cells — wbt_update_nodata_cells","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_upslope_depression_storage.html","id":null,"dir":"Reference","previous_headings":"","what":"Upslope depression storage — wbt_upslope_depression_storage","title":"Upslope depression storage — wbt_upslope_depression_storage","text":"Estimates average upslope depression storage depth.","code":""},{"path":"/reference/wbt_upslope_depression_storage.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upslope depression storage — wbt_upslope_depression_storage","text":"","code":"wbt_upslope_depression_storage(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_upslope_depression_storage.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upslope depression storage — wbt_upslope_depression_storage","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_upslope_depression_storage.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Upslope depression storage — wbt_upslope_depression_storage","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_user_defined_weights_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"User ined weights filter — wbt_user_defined_weights_filter","title":"User ined weights filter — wbt_user_defined_weights_filter","text":"Performs user-defined weights filter image.","code":""},{"path":"/reference/wbt_user_defined_weights_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"User ined weights filter — wbt_user_defined_weights_filter","text":"","code":"wbt_user_defined_weights_filter(   input,   weights,   output,   center = \"center\",   normalize = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_user_defined_weights_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"User ined weights filter — wbt_user_defined_weights_filter","text":"input Input raster file path. See wbt_file_path() details. weights Input weights file. output Output raster file. center Kernel center cell; options include 'center', 'upper-left', 'upper-right', 'lower-left', 'lower-right'. normalize Normalize kernel weights? can reduce edge effects lessen impact data gaps (nodata) suited kernel weights sum zero. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_user_defined_weights_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"User ined weights filter — wbt_user_defined_weights_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_vector_hex_binning.html","id":null,"dir":"Reference","previous_headings":"","what":"Vector hex binning — wbt_vector_hex_binning","title":"Vector hex binning — wbt_vector_hex_binning","text":"Hex-bins set vector points.","code":""},{"path":"/reference/wbt_vector_hex_binning.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vector hex binning — wbt_vector_hex_binning","text":"","code":"wbt_vector_hex_binning(   input,   output,   width,   orientation = \"horizontal\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vector_hex_binning.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vector hex binning — wbt_vector_hex_binning","text":"input Input base file. output Output vector polygon file. width grid cell width. orientation Grid Orientation, 'horizontal' 'vertical'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vector_hex_binning.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vector hex binning — wbt_vector_hex_binning","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_vector_lines_to_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Vector lines to raster — wbt_vector_lines_to_raster","title":"Vector lines to raster — wbt_vector_lines_to_raster","text":"Converts vector containing polylines raster.","code":""},{"path":"/reference/wbt_vector_lines_to_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vector lines to raster — wbt_vector_lines_to_raster","text":"","code":"wbt_vector_lines_to_raster(   input,   output,   field = \"FID\",   nodata = TRUE,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vector_lines_to_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vector lines to raster — wbt_vector_lines_to_raster","text":"input Input vector lines file. output Output raster file. field Input field name attribute table. nodata Background value set NoData. Without flag, set 0.0. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vector_lines_to_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vector lines to raster — wbt_vector_lines_to_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_vector_points_to_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Vector points to raster — wbt_vector_points_to_raster","title":"Vector points to raster — wbt_vector_points_to_raster","text":"Converts vector containing points raster.","code":""},{"path":"/reference/wbt_vector_points_to_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vector points to raster — wbt_vector_points_to_raster","text":"","code":"wbt_vector_points_to_raster(   input,   output,   field = \"FID\",   assign = \"last\",   nodata = TRUE,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vector_points_to_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vector points to raster — wbt_vector_points_to_raster","text":"input Input vector Points file. output Output raster file. field Input field name attribute table. assign Assignment operation, multiple points grid cell; options include 'first', 'last' (default), 'min', 'max', 'sum', 'number'. nodata Background value set NoData. Without flag, set 0.0. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vector_points_to_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vector points to raster — wbt_vector_points_to_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_vector_polygons_to_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Vector polygons to raster — wbt_vector_polygons_to_raster","title":"Vector polygons to raster — wbt_vector_polygons_to_raster","text":"Converts vector containing polygons raster.","code":""},{"path":"/reference/wbt_vector_polygons_to_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vector polygons to raster — wbt_vector_polygons_to_raster","text":"","code":"wbt_vector_polygons_to_raster(   input,   output,   field = \"FID\",   nodata = TRUE,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vector_polygons_to_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vector polygons to raster — wbt_vector_polygons_to_raster","text":"input Input vector polygons file. output Output raster file. field Input field name attribute table. nodata Background value set NoData. Without flag, set 0.0. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vector_polygons_to_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vector polygons to raster — wbt_vector_polygons_to_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_vector_stream_network_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Vector stream network analysis — wbt_vector_stream_network_analysis","title":"Vector stream network analysis — wbt_vector_stream_network_analysis","text":"tool performs common stream network analysis operations input vector stream file.","code":""},{"path":"/reference/wbt_vector_stream_network_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vector stream network analysis — wbt_vector_stream_network_analysis","text":"","code":"wbt_vector_stream_network_analysis(   streams,   output,   snap = 0.1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vector_stream_network_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vector stream network analysis — wbt_vector_stream_network_analysis","text":"streams Name input streams vector file. output Name output lines shapefile. snap Snap distance, xy units (metres). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vector_stream_network_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vector stream network analysis — wbt_vector_stream_network_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Version information for 'WhiteboxTools' — wbt_version","title":"Version information for 'WhiteboxTools' — wbt_version","text":"Version information 'WhiteboxTools'","code":""},{"path":"/reference/wbt_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Version information for 'WhiteboxTools' — wbt_version","text":"","code":"wbt_version(extract = FALSE)"},{"path":"/reference/wbt_version.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Version information for 'WhiteboxTools' — wbt_version","text":"extract Extract semantic version number first line result? Default: FALSE","code":""},{"path":"/reference/wbt_version.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Version information for 'WhiteboxTools' — wbt_version","text":"Returns version information 'WhiteboxTools' R character vector.","code":""},{"path":"/reference/wbt_version.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Version information for 'WhiteboxTools' — wbt_version","text":"","code":"if (FALSE) { wbt_version() }"},{"path":"/reference/wbt_vertical_excess_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Vertical excess curvature — wbt_vertical_excess_curvature","title":"Vertical excess curvature — wbt_vertical_excess_curvature","text":"tool calculates vertical excess curvature input DEM.","code":""},{"path":"/reference/wbt_vertical_excess_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vertical excess curvature — wbt_vertical_excess_curvature","text":"","code":"wbt_vertical_excess_curvature(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vertical_excess_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vertical excess curvature — wbt_vertical_excess_curvature","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vertical_excess_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vertical excess curvature — wbt_vertical_excess_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_view_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","title":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","text":"Opens web browser view source code specific tool projects source code repository.","code":""},{"path":"/reference/wbt_view_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","text":"","code":"wbt_view_code(tool_name, viewer = FALSE)"},{"path":"/reference/wbt_view_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","text":"tool_name Name tool. viewer Show source code browser? default: TRUE","code":""},{"path":"/reference/wbt_view_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","text":"Returns GitHub URL view source code tool.","code":""},{"path":"/reference/wbt_view_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","text":"","code":"if (FALSE) { wbt_view_code(\"breach_depressions\") }"},{"path":"/reference/wbt_viewshed.html","id":null,"dir":"Reference","previous_headings":"","what":"Viewshed — wbt_viewshed","title":"Viewshed — wbt_viewshed","text":"Identifies viewshed point set points.","code":""},{"path":"/reference/wbt_viewshed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Viewshed — wbt_viewshed","text":"","code":"wbt_viewshed(   dem,   stations,   output,   height = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_viewshed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Viewshed — wbt_viewshed","text":"dem Input raster DEM file. stations Input viewing station vector file. output Output raster file. height Viewing station height, z units. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_viewshed.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Viewshed — wbt_viewshed","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_visibility_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Visibility index — wbt_visibility_index","title":"Visibility index — wbt_visibility_index","text":"Estimates relative visibility sites DEM.","code":""},{"path":"/reference/wbt_visibility_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Visibility index — wbt_visibility_index","text":"","code":"wbt_visibility_index(   dem,   output,   height = 2,   res_factor = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_visibility_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Visibility index — wbt_visibility_index","text":"dem Input raster DEM file. output Output raster file. height Viewing station height, z units. res_factor resolution factor determines density measured viewsheds. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_visibility_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Visibility index — wbt_visibility_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_voronoi_diagram.html","id":null,"dir":"Reference","previous_headings":"","what":"Voronoi diagram — wbt_voronoi_diagram","title":"Voronoi diagram — wbt_voronoi_diagram","text":"Creates vector Voronoi diagram set vector points.","code":""},{"path":"/reference/wbt_voronoi_diagram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Voronoi diagram — wbt_voronoi_diagram","text":"","code":"wbt_voronoi_diagram(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_voronoi_diagram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Voronoi diagram — wbt_voronoi_diagram","text":"input Input vector points file. output Output vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_voronoi_diagram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Voronoi diagram — wbt_voronoi_diagram","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_watershed.html","id":null,"dir":"Reference","previous_headings":"","what":"Watershed — wbt_watershed","title":"Watershed — wbt_watershed","text":"Identifies watershed, drainage basin, draining set target cells.","code":""},{"path":"/reference/wbt_watershed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Watershed — wbt_watershed","text":"","code":"wbt_watershed(   d8_pntr,   pour_pts,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_watershed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Watershed — wbt_watershed","text":"d8_pntr Input D8 pointer raster file. pour_pts Input pour points (outlet) file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_watershed.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Watershed — wbt_watershed","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_weighted_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Weighted overlay — wbt_weighted_overlay","title":"Weighted overlay — wbt_weighted_overlay","text":"Performs weighted sum multiple input rasters converting image common scale. tool performs multi-criteria evaluation (MCE).","code":""},{"path":"/reference/wbt_weighted_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Weighted overlay — wbt_weighted_overlay","text":"","code":"wbt_weighted_overlay(   factors,   weights,   output,   cost = NULL,   constraints = NULL,   scale_max = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_weighted_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Weighted overlay — wbt_weighted_overlay","text":"factors Input factor raster files. weights Weight values, contained quotes separated commas semicolons. Must number factors. output Output raster file. cost Boolean array indicating factors cost factors, contained quotes separated commas semicolons. Must number factors. constraints Input constraints raster files. scale_max Suitability scale maximum value (common values 1.0, 100.0, 255.0). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_weighted_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Weighted overlay — wbt_weighted_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_weighted_sum.html","id":null,"dir":"Reference","previous_headings":"","what":"Weighted sum — wbt_weighted_sum","title":"Weighted sum — wbt_weighted_sum","text":"Performs weighted-sum overlay multiple input raster images.","code":""},{"path":"/reference/wbt_weighted_sum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Weighted sum — wbt_weighted_sum","text":"","code":"wbt_weighted_sum(   inputs,   weights,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_weighted_sum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Weighted sum — wbt_weighted_sum","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. weights Weight values, contained quotes separated commas semicolons. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_weighted_sum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Weighted sum — wbt_weighted_sum","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_wetness_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Wetness index — wbt_wetness_index","title":"Wetness index — wbt_wetness_index","text":"Calculates topographic wetness index, Ln(/ tan(slope)).","code":""},{"path":"/reference/wbt_wetness_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wetness index — wbt_wetness_index","text":"","code":"wbt_wetness_index(   sca,   slope,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_wetness_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wetness index — wbt_wetness_index","text":"sca Input raster specific contributing area (SCA) file. slope Input raster slope file (degrees). output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_wetness_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Wetness index — wbt_wetness_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_wilcoxon_signed_rank_test.html","id":null,"dir":"Reference","previous_headings":"","what":"Wilcoxon signed rank test — wbt_wilcoxon_signed_rank_test","title":"Wilcoxon signed rank test — wbt_wilcoxon_signed_rank_test","text":"Performs 2-sample K-S test significant differences two input rasters.","code":""},{"path":"/reference/wbt_wilcoxon_signed_rank_test.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wilcoxon signed rank test — wbt_wilcoxon_signed_rank_test","text":"","code":"wbt_wilcoxon_signed_rank_test(   input1,   input2,   output,   num_samples = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_wilcoxon_signed_rank_test.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wilcoxon signed rank test — wbt_wilcoxon_signed_rank_test","text":"input1 First input raster file. input2 Second input raster file. output Output HTML file. num_samples Number samples. Leave blank use whole image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_wilcoxon_signed_rank_test.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Wilcoxon signed rank test — wbt_wilcoxon_signed_rank_test","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_write_function_memory_insertion.html","id":null,"dir":"Reference","previous_headings":"","what":"Write function memory insertion — wbt_write_function_memory_insertion","title":"Write function memory insertion — wbt_write_function_memory_insertion","text":"Performs write function memory insertion single-band multi-date change detection.","code":""},{"path":"/reference/wbt_write_function_memory_insertion.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Write function memory insertion — wbt_write_function_memory_insertion","text":"","code":"wbt_write_function_memory_insertion(   input1,   input2,   output,   input3 = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_write_function_memory_insertion.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Write function memory insertion — wbt_write_function_memory_insertion","text":"input1 Input raster file associated first date. input2 Input raster file associated second date. output Output raster file. input3 Optional input raster file associated third date. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_write_function_memory_insertion.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Write function memory insertion — wbt_write_function_memory_insertion","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_xor.html","id":null,"dir":"Reference","previous_headings":"","what":"Xor — wbt_xor","title":"Xor — wbt_xor","text":"Performs logical XOR operator two Boolean raster images.","code":""},{"path":"/reference/wbt_xor.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Xor — wbt_xor","text":"","code":"wbt_xor(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_xor.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Xor — wbt_xor","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_xor.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Xor — wbt_xor","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_yield_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Yield filter — wbt_yield_filter","title":"Yield filter — wbt_yield_filter","text":"Filters crop yield values point data derived combine harvester yield monitors.","code":""},{"path":"/reference/wbt_yield_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Yield filter — wbt_yield_filter","text":"","code":"wbt_yield_filter(   input,   yield_field,   pass_field,   output,   width = 6.096,   z_score_threshold = 2.5,   min_yield = 0,   max_yield = 99999.9,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_yield_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Yield filter — wbt_yield_filter","text":"input Name input points shapefile. yield_field Name attribute containing yield data. pass_field Name attribute containing pass line ID. output Name output points shapefile. width Pass swath width (m). z_score_threshold Z-score threshold value (default=2.5). min_yield Minimum yield value output. max_yield Maximum yield value output. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_yield_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Yield filter — wbt_yield_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_yield_map.html","id":null,"dir":"Reference","previous_headings":"","what":"Yield map — wbt_yield_map","title":"Yield map — wbt_yield_map","text":"tool can used create segmented-vector polygon yield map set harvester points.","code":""},{"path":"/reference/wbt_yield_map.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Yield map — wbt_yield_map","text":"","code":"wbt_yield_map(   input,   pass_field_name,   output,   width = 6.096,   max_change_in_heading = 25,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_yield_map.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Yield map — wbt_yield_map","text":"input Name input points shapefile. pass_field_name Name attribute containing pass line ID. output Name output polygon shapefile. width Pass swath width (m). max_change_in_heading Max change heading. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_yield_map.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Yield map — wbt_yield_map","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_yield_normalization.html","id":null,"dir":"Reference","previous_headings":"","what":"Yield normalization — wbt_yield_normalization","title":"Yield normalization — wbt_yield_normalization","text":"tool can used normalize yield points field.","code":""},{"path":"/reference/wbt_yield_normalization.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Yield normalization — wbt_yield_normalization","text":"","code":"wbt_yield_normalization(   input,   yield_field,   output,   standardize = FALSE,   radius = NULL,   min_yield = 0,   max_yield = 99999.9,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_yield_normalization.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Yield normalization — wbt_yield_normalization","text":"input Name input points shapefile. yield_field Name attribute containing yield data. output Name output points shapefile. standardize yield values standardized (converted z-scores) rather normalized?. radius Optional search radius, metres. specify value want calculate locally normalized yield. min_yield Minimum yield value output. max_yield Maximum yield value output. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_yield_normalization.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Yield normalization — wbt_yield_normalization","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_z_scores.html","id":null,"dir":"Reference","previous_headings":"","what":"Z scores — wbt_z_scores","title":"Z scores — wbt_z_scores","text":"Standardizes values input raster converting z-scores.","code":""},{"path":"/reference/wbt_z_scores.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Z scores — wbt_z_scores","text":"","code":"wbt_z_scores(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_z_scores.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Z scores — wbt_z_scores","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_z_scores.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Z scores — wbt_z_scores","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_zlidar_to_las.html","id":null,"dir":"Reference","previous_headings":"","what":"Zlidar to las — wbt_zlidar_to_las","title":"Zlidar to las — wbt_zlidar_to_las","text":"Converts one zlidar files LAS data format.","code":""},{"path":"/reference/wbt_zlidar_to_las.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Zlidar to las — wbt_zlidar_to_las","text":"","code":"wbt_zlidar_to_las(   inputs = NULL,   outdir = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_zlidar_to_las.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Zlidar to las — wbt_zlidar_to_las","text":"inputs Input ZLidar files. outdir Output directory zlidar files created. unspecified, assumed inputs. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_zlidar_to_las.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Zlidar to las — wbt_zlidar_to_las","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_zonal_statistics.html","id":null,"dir":"Reference","previous_headings":"","what":"Zonal statistics — wbt_zonal_statistics","title":"Zonal statistics — wbt_zonal_statistics","text":"Extracts descriptive statistics group patches raster.","code":""},{"path":"/reference/wbt_zonal_statistics.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Zonal statistics — wbt_zonal_statistics","text":"","code":"wbt_zonal_statistics(   input,   features,   output = NULL,   stat = \"mean\",   out_table = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_zonal_statistics.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Zonal statistics — wbt_zonal_statistics","text":"input Input data raster file. features Input feature definition raster file. output Output raster file. stat Statistic extract, including 'mean', 'median', 'minimum', 'maximum', 'range', 'standard deviation', 'total'. out_table Output HTML Table file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_zonal_statistics.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Zonal statistics — wbt_zonal_statistics","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbttoolparameters.html","id":null,"dir":"Reference","previous_headings":"","what":"'WhiteboxTools' Tool Parameters — wbttoolparameters","title":"'WhiteboxTools' Tool Parameters — wbttoolparameters","text":"data set data.frame containing tool parameters associated metadata","code":""},{"path":"/reference/wbttoolparameters.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"'WhiteboxTools' Tool Parameters — wbttoolparameters","text":"","code":"wbttoolparameters"},{"path":"/reference/wbttoolparameters.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"'WhiteboxTools' Tool Parameters — wbttoolparameters","text":"object class data.frame 2198 rows 13 columns.","code":""},{"path":"/reference/wbttoolparameters.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"'WhiteboxTools' Tool Parameters — wbttoolparameters","text":"WhiteboxTools","code":""},{"path":"/reference/wbttoolparameters.html","id":"variables","dir":"Reference","previous_headings":"","what":"Variables","title":"'WhiteboxTools' Tool Parameters — wbttoolparameters","text":"\"function_name\" - R function name \"tool_name\" - 'WhiteboxTools' tool name \"name\" - parameter name \"flags\" - flags used specify parameter command line; comma separated \"description\" - parameter description \"parameter_class\" - parameter type \"parameter_detail\" - parameter details; character: data type followed colon specifics, OptionList possible values, comma-separated (defined) \"default_value\" - parameter default value, \"optional\" - parameter \"optional\" flag; note combination optional parameters may required certain conditions \"label\" - labels selected subset \"flags\" used R function argument names wbt_ functions \"is_input\" - logical. Classification 'input' parameters \"is_output\" - logical. Classification 'output' parameters","code":""},{"path":[]},{"path":"/reference/wbttools.html","id":null,"dir":"Reference","previous_headings":"","what":"'WhiteboxTools' Tool List — wbttools","title":"'WhiteboxTools' Tool List — wbttools","text":"data set data.frame containing tools name associated R function name","code":""},{"path":"/reference/wbttools.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"'WhiteboxTools' Tool List — wbttools","text":"","code":"wbttools"},{"path":"/reference/wbttools.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"'WhiteboxTools' Tool List — wbttools","text":"object class data.frame 537 rows 8 columns.","code":""},{"path":"/reference/wbttools.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"'WhiteboxTools' Tool List — wbttools","text":"WhiteboxTools","code":""},{"path":"/reference/wbttools.html","id":"variables","dir":"Reference","previous_headings":"","what":"Variables","title":"'WhiteboxTools' Tool List — wbttools","text":"\"tool_name\" - 'WhiteboxTools' tool name \"function_name\" - R function name \"toolbox_name\" - 'WhiteboxTools' toolbox name \"label\" - 'WhiteboxTools' tool label \"description\" - Brief description \"github\" - Link related code 'GitHub' \"book\" - Link 'WhiteboxTools' Manual \"is_extension\" - Tool part 'General Toolset Extension' (GTE), opposed \"open core\"","code":""},{"path":[]},{"path":"/reference/whitebox-package.html","id":null,"dir":"Reference","previous_headings":"","what":"whitebox: 'WhiteboxTools' R Frontend — whitebox-package","title":"whitebox: 'WhiteboxTools' R Frontend — whitebox-package","text":"R frontend 'WhiteboxTools' library, advanced geospatial data analysis platform developed Prof. John Lindsay University Guelph's Geomorphometry Hydrogeomatics Research Group. 'WhiteboxTools' can used perform common geographical information systems (GIS) analysis operations, cost-distance analysis, distance buffering, raster reclassification. Remote sensing image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), common image transformations. 'WhiteboxTools' also contains advanced tooling spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), LiDAR data processing. Suggested citation: Lindsay (2016) doi:10.1016/j.cageo.2016.07.003 .","code":""},{"path":"/reference/whitebox-package.html","id":"package-options","dir":"Reference","previous_headings":"","what":"Package options","title":"whitebox: 'WhiteboxTools' R Frontend — whitebox-package","text":"whitebox.exe_path - character. Path executable file. default value package installation directory, subdirectory \"WBT\", followed whitebox_tools.exe whitebox_tools. Set whitebox.exe_path option using wbt_init() exe_path argument whitebox.wd - character. Path WhiteboxTools working directory. Used --wd argument tools support wd specified elsewhere. Note set working directory, directory needs reset \"replace\" old value; just dropping flag change working directory back original R working directory. \"unset\" option R package can use wbt_wd(\"\") equivalent wbt_wd(getwd()). WhiteboxTools settings package settings updated reflect directory change running next tool --wd flag dropped system calls. whitebox.verbose - logical. standard output calls executable cat() readability? Default result interactive(). Individual tools may verbose_mode setting produce single-line output FALSE. argument values left defaults defined package documentation function. whitebox.verbose=FALSE output produced. Set value whitebox.verbose wbt_verbose() verbose argument. whitebox.compress_rasters - logical. raster output WhiteboxTools compressed? Default: FALSE. Set value whitebox.compress_rasters wbt_compress_rasters() compress_rasters argument. whitebox.max_procs - integer. Maximum number processes tools run parallel partially parallelize. Default: -1 uses available cores. package options can overridden system environment variables: R_WHITEBOX_EXE_PATH, R_WHITEBOX_WD, R_WHITEBOX_VERBOSE, R_WHITEBOX_COMPRESS_RASTERS R_WHITEBOX_MAX_PROCS.","code":""},{"path":[]},{"path":"/reference/whitebox-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"whitebox: 'WhiteboxTools' R Frontend — whitebox-package","text":"Maintainer: Andrew Brown brown.andrewg@gmail.com [contributor] Authors: Qiusheng Wu giswqs@gmail.com","code":""},{"path":"/news/index.html","id":"whitebox-240","dir":"Changelog","previous_headings":"","what":"whitebox 2.4.0","title":"whitebox 2.4.0","text":"Updates WhiteboxTools v2.4.0 (https://github.com/jblindsay/whitebox-tools/releases/tag/v2.4.0) Fix new ZIP file folder structure WhiteboxTools v2.4.0+ wbt_install() / install_whitebox()","code":""},{"path":"/news/index.html","id":"whitebox-234","dir":"Changelog","previous_headings":"","what":"whitebox 2.3.4","title":"whitebox 2.3.4","text":"CRAN release: 2023-11-18 Exported wbt_file_path(), function previously used internally creating safe, expanded, quoted, paths building WhiteboxTools commands. function also supports input terra objects backed file sources supported WhiteboxTools.","code":""},{"path":"/news/index.html","id":"whitebox-233","dir":"Changelog","previous_headings":"","what":"whitebox 2.3.3","title":"whitebox 2.3.3","text":"default values compress_rasters verbose_mode set NULL better reflect derived WhiteboxTools settings.json file. See wbt_options() details. user specifies arguments wbt_*() function call flag passed command line call. Otherwise default NULL value ignored. Links corresponding option-setting functions added documentation wbt_*() tool functions.","code":""},{"path":"/news/index.html","id":"whitebox-232","dir":"Changelog","previous_headings":"","what":"whitebox 2.3.2","title":"whitebox 2.3.2","text":"Fix file paths passed optional base argument wbt_resample(); thanks @Pentaonia reporting Also fixed : wbt_vector_lines_to_raster(), wbt_vector_points_to_raster(), wbt_vector_polygons_to_raster(), wbt_block_maximum_gridding(), wbt_block_minimum_gridding(), wbt_heat_map(), wbt_idw_interpolation(), wbt_natural_neighbour_interpolation(), wbt_nearest_neighbour_gridding(), wbt_radial_basis_function_interpolation(), wbt_tin_gridding()","code":""},{"path":"/news/index.html","id":"whitebox-231","dir":"Changelog","previous_headings":"","what":"whitebox 2.3.1","title":"whitebox 2.3.1","text":"CRAN release: 2023-06-07 wbt_install() wbt_install_extension() gain optional platform argument used suffix ZIP file, allowing download alternate binaries Linux macOS (Darwin). Add wbt_runner_path() (analog wbt_exe_path() whitebox_runner GUI executable) wbt_launch_runner() simple function launch GUI. wbt_wd(\"\") now sets value working_directory WhiteboxTools settings.json file \"\" triggers background options prevent --wd flag added new working directory set. long-standing issue, resolved following https://github.com/opengeos/whiteboxR/issues/108.","code":""},{"path":"/news/index.html","id":"whitebox-230","dir":"Changelog","previous_headings":"","what":"whitebox 2.3.0","title":"whitebox 2.3.0","text":"CRAN release: 2023-03-29 Updates WhiteboxTools v2.3.0 (https://github.com/jblindsay/whitebox-tools/releases/tag/v2.3.0) Add wbt(), wbt_source(), related methods; new functionality calling tools name various R object types input. See wbt() method vignette details.","code":""},{"path":"/news/index.html","id":"whitebox-221","dir":"Changelog","previous_headings":"","what":"whitebox 2.2.1","title":"whitebox 2.2.1","text":"Adds wbt_data_dir() managing WhiteboxTools “WBT” directory installed. new default path preferred location generated tools::R_user_dir(package=\"whitebox\") R 4.0+ \"whitebox_tools\" found PATH, longer need custom setup whitebox.exe_path. path options detected automatically via Sys.(\"whitebox_tools\"). Custom options set within session environment take precedence PATH.","code":""},{"path":"/news/index.html","id":"whitebox-220","dir":"Changelog","previous_headings":"","what":"whitebox 2.2.0","title":"whitebox 2.2.0","text":"CRAN release: 2022-10-27 Updates WhiteboxTools v2.2.0 wbt_rust_backtrace(), helper method debugging Rust-related failures command-line tool, now exported wbt_run_tool(): Fix potentially length > 1 logic () statement error status messages avoid warnings/future errors download.file() method=\"wininet\" deprecated longer possible set methods try Windows download fails","code":""},{"path":"/news/index.html","id":"whitebox-215","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.5","title":"whitebox 2.1.5","text":"CRAN release: 2022-07-11 Added wbt_install_extension() wbt_activate() downloading, installing activating WhiteboxTools extensions wbt_internal_tool_name() now returns tool names CamelCase, tool names passed via command line","code":""},{"path":"/news/index.html","id":"whitebox-214","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.4","title":"whitebox 2.1.4","text":"CRAN release: 2022-05-15 Suggest {terra} instead {raster} update demo vignette accordingly; drops {rgdal} suggest Add support path expansion wd arguments passed directly tool functions; already supported methods setting working directory Updates wbttools wbttoolparameters datasets Fix argument_name='k' Remove several one two character flag aliases argument_name replace full name Add support showing warning messages regular interactive/verbose mode, thanks @alenahav reporting issue (https://github.com/opengeos/whiteboxR/issues/75) wbt_fd8_flow_accumulation() Functions take multiple files auto-quoted default; thanks François-Nicolas Robinne reporting issue (@FNRobinne; https://github.com/opengeos/whiteboxR/issues/55) wbt_mosaic() Error output now verbose, ensuring relevant tool output displayed user error regardless verbosity, platform, etc. Thanks Jeffrey W. Rozelle reporting issue (@jwilliamrozelle; https://github.com/opengeos/whiteboxR/issues/80) getting error messages unsupported raster types","code":""},{"path":"/news/index.html","id":"whitebox-213","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.3","title":"whitebox 2.1.3","text":"Generated whitebox_tools commands longer include flags default arguments stored settings.json unless specified user. Updates fix issues permissions write settings.json; thanks Henrik (@hewag1975) reporting problems Shiny Server (https://github.com/opengeos/whiteboxR/issues/67) wbt_install() / install_whitebox() now removes downloaded zip file exit thanks Christoph Stepper (@cstepper; https://github.com/opengeos/whiteboxR/issues/72) New default arguments wbt_list_tools(), wbt_time_in_daylight(), wbt_shadow_image() thanks Jens Wiesehahn (@wiesehahn; https://github.com/opengeos/whiteboxR/issues/70, https://github.com/opengeos/whiteboxR/issues/73)","code":""},{"path":"/news/index.html","id":"whitebox-212","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.2","title":"whitebox 2.1.2","text":"CRAN release: 2022-03-21 Fixes regression checking “Demo” vignette CRAN","code":""},{"path":"/news/index.html","id":"whitebox-211","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.1","title":"whitebox 2.1.1","text":"CRAN release: 2022-03-15 File path arguments tools now automatically perform path expansion (converting ~ home directory path.expand()). also works arguments contain comma semicolon delimited lists. (https://github.com/opengeos/whiteboxR/issues/62) Corrections wbttoolparameters dataset (updated classification input/output parameters) Fix wbt_lidar_tin_gridding() exclude_cls argument Add wbt_compress_rasters() set package option whitebox.compress_rasters Updated --compress_rasters parameter passed via command line. Now flag added commands regardless whether value TRUE FALSE. allows update settings.json accordingly --compress_rasters=FALSE. RE: https://github.com/jblindsay/whitebox-tools/issues/233#issuecomment-1065955783 Add wbt_max_procs() set package option whitebox.max_procs wbt_*() tool functions now take command_only argument passed wbt_run_tool(). TRUE, function returns command run system() instead running tool.","code":""},{"path":"/news/index.html","id":"whitebox-210","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.0","title":"whitebox 2.1.0","text":"CRAN release: 2022-02-11 Update WhiteboxTools v2.1.0 See https://www.whiteboxgeo.com/whitebox-geospatial-news/ details","code":""},{"path":"/news/index.html","id":"whitebox-200","dir":"Changelog","previous_headings":"","what":"whitebox 2.0.0","title":"whitebox 2.0.0","text":"CRAN release: 2021-09-10 Update WhiteboxTools v2.0.0 See https://github.com/jblindsay/whitebox-tools/releases/tag/v2.0.0 details Enhancements: whitebox::install_whitebox() call wbt_init() exe_path unpacking target directory wbt_init() exe_path, wbt_wd() wd, install_whitebox() pkg_dir paths can specified shorthand ~ home directory, expanded path.expand() Unsetting working directories requires single call wbt_wd(\"\") Functions longer use match.call() unconventional/automated methods calling tools parsable tool name call result now work (#45)","code":""},{"path":"/news/index.html","id":"whitebox-151","dir":"Changelog","previous_headings":"","what":"whitebox 1.5.1","title":"whitebox 1.5.1","text":"Add package options custom EXE path verbosity Changes behavior wbt_init(); now checks EXE path Adds install_whitebox() handle downloading installing WhiteboxTools","code":""},{"path":"/news/index.html","id":"new-package-options-1-5-1","dir":"Changelog","previous_headings":"","what":"New package options","title":"whitebox 1.5.1","text":"wbt_init() can set options call custom EXE path. wbt_options() returns current option values Use system environment variable (R_WHITEBOX_EXE_PATH) package option (whitebox.exe_path) Get / set wbt_init(). Verbosity controlled (R_WHITEBOX_VERBOSE) package option (whitebox.verbose) Get / set wbt_verbose() Working directory controlled (R_WHITEBOX_WD) package option (whitebox.wd) Get / set wbt_wd() New “whitebox Demo” vignette New data wbttools wbttoolparameters data.frame built WhiteboxTools v1.5.0 wbt_tool_parameters() output full tool library See “whitebox Tool Metadata” vignette","code":""},{"path":"/news/index.html","id":"whitebox-150","dir":"Changelog","previous_headings":"","what":"whitebox 1.5.0","title":"whitebox 1.5.0","text":"Update WhiteboxTools v1.5.0 information version can found https://github.com/jblindsay/whitebox-tools/releases/tag/1.5.0 info.","code":""},{"path":"/news/index.html","id":"whitebox-140","dir":"Changelog","previous_headings":"","what":"whitebox 1.4.0","title":"whitebox 1.4.0","text":"Update WhiteboxTools v1.4.0 information version can found https://github.com/jblindsay/whitebox-tools/releases/tag/v1.4.0","code":""},{"path":"/news/index.html","id":"whitebox-131","dir":"Changelog","previous_headings":"","what":"whitebox 1.3.1","title":"whitebox 1.3.1","text":"Update WhiteboxTools v1.3.1 information version can found https://github.com/jblindsay/whitebox-tools/releases/tag/v1.3.1","code":""},{"path":"/news/index.html","id":"whitebox-130","dir":"Changelog","previous_headings":"","what":"whitebox 1.3.0","title":"whitebox 1.3.0","text":"Update WhiteboxTools v1.3.0","code":""},{"path":"/news/index.html","id":"whitebox-110","dir":"Changelog","previous_headings":"","what":"whitebox 1.1.0","title":"whitebox 1.1.0","text":"Update WhiteboxTools v1.1.0","code":""},{"path":"/news/index.html","id":"whitebox-102","dir":"Changelog","previous_headings":"","what":"whitebox 1.0.2","title":"whitebox 1.0.2","text":"Update WhiteboxTools v1.0.2","code":""},{"path":"/news/index.html","id":"whitebox-101","dir":"Changelog","previous_headings":"","what":"whitebox 1.0.1","title":"whitebox 1.0.1","text":"Prep v1.0.1","code":""},{"path":"/news/index.html","id":"whitebox-050","dir":"Changelog","previous_headings":"","what":"whitebox 0.5.0","title":"whitebox 0.5.0","text":"Fix bugs logical parameters","code":""},{"path":"/news/index.html","id":"whitebox-030","dir":"Changelog","previous_headings":"","what":"whitebox 0.3.0","title":"whitebox 0.3.0","text":"update WhiteboxTools v0.15.0","code":""},{"path":"/news/index.html","id":"whitebox-020","dir":"Changelog","previous_headings":"","what":"whitebox 0.2.0","title":"whitebox 0.2.0","text":"Change way download WBT binaries","code":""},{"path":"/news/index.html","id":"whitebox-011","dir":"Changelog","previous_headings":"","what":"whitebox 0.1.1","title":"whitebox 0.1.1","text":"Update use secure download mechanisms (https)","code":""},{"path":"/news/index.html","id":"whitebox-01","dir":"Changelog","previous_headings":"","what":"whitebox 0.1","title":"whitebox 0.1","text":"Initial release","code":""}]
+[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 whitebox authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"/articles/datasets.html","id":"whitebox-tool-metadata","dir":"Articles","previous_headings":"","what":"whitebox Tool Metadata","title":"whitebox Tool Metadata","text":"vignette provides introduction data sets included whitebox package. data sets contain names, arguments metadata tools available WhiteboxTools.","code":""},{"path":"/articles/datasets.html","id":"what-version-of-whiteboxtools-are-these-data-sets-generated-from","dir":"Articles","previous_headings":"whitebox Tool Metadata","what":"What version of WhiteboxTools are these data sets generated from?","title":"whitebox Tool Metadata","text":"Current version: 2.4.0 Internal data sets functions defined R package correspond tool names available recent version WhiteboxTools. Data sets dynamically generated WhiteboxTools installation. Relatively recent versions WhiteboxTools supported backward-compatibly, though newer functionality usable.","code":""},{"path":"/articles/datasets.html","id":"whiteboxtools-tool-names-and-r-function-names","dir":"Articles","previous_headings":"whitebox Tool Metadata","what":"WhiteboxTools Tool Names and R Function Names","title":"whitebox Tool Metadata","text":"first data set describes tool names WhiteboxTools corresponding exported function R package, along WhiteboxTools Toolbox name brief description. wbttools data set data.frame 537 tools 7 variables \"tool_name\" - WhiteboxTools tool name \"function_name\" - R function tool name \"toolbox_name\" - WhiteboxTools toolbox name \"label\" - WhiteboxTools tool label \"description\" - Brief description \"github\" - GitHub link \"book\" - Reference manual link \"is_extension\" - Tool part General Toolset Extension (GTE), opposed “open core” R function naming style differs tool names WhiteboxTools, core words . R function names derived WhiteboxTools name follows: PascalCase tool names change snake_case R function names get prefix wbt_ example, StreamSlopeContinuous WhiteboxTools becomes wbt_stream_slope_continuous() R.","code":"data(\"wbttools\", package = \"whitebox\")  str(wbttools) #> 'data.frame':    537 obs. of  8 variables: #>  $ tool_name    : chr  \"AbsoluteValue\" \"AccumulationCurvature\" \"AdaptiveFilter\" \"Add\" ... #>  $ function_name: chr  \"wbt_absolute_value\" \"wbt_accumulation_curvature\" \"wbt_adaptive_filter\" \"wbt_add\" ... #>  $ toolbox_name : chr  \"Math and Stats Tools\" \"Geomorphometric Analysis\" \"Image Processing Tools\" \"Math and Stats Tools\" ... #>  $ label        : chr  \"Absolute Value\" \"Accumulation Curvature\" \"Adaptive Filter\" \"Add\" ... #>  $ description  : chr  \"Calculates the absolute value of every cell in a raster.\" \"This tool calculates accumulation curvature from an input DEM.\" \"Performs an adaptive filter on an image.\" \"Performs an addition operation on two rasters or a raster and a constant value.\" ... #>  $ github       : chr  \"https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/math_stat_analysis/abs.rs\" \"Source code is unavailable due to proprietary license.\" \"https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/image_analysis/adaptive_filter.rs\" \"https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/math_stat_analysis/add.rs\" ... #>  $ book         : chr  \"https://www.whiteboxgeo.com/manual/wbt_book/available_tools/mathand_stats_tools.html#AbsoluteValue\" \"https://www.whiteboxgeo.com/manual/wbt_book/available_tools/geomorphometric_analysis.html#AccumulationCurvature\" \"https://www.whiteboxgeo.com/manual/wbt_book/available_tools/image_processing_tools.html#AdaptiveFilter\" \"https://www.whiteboxgeo.com/manual/wbt_book/available_tools/mathand_stats_tools.html#Add\" ... #>  $ is_extension : logi  FALSE TRUE FALSE FALSE FALSE FALSE ... #>  - attr(*, \"version\")= chr \"2.4.0\" head(wbttools) #>                    tool_name                      function_name #> 1              AbsoluteValue                 wbt_absolute_value #> 2      AccumulationCurvature         wbt_accumulation_curvature #> 3             AdaptiveFilter                wbt_adaptive_filter #> 4                        Add                            wbt_add #> 5 AddPointCoordinatesToTable wbt_add_point_coordinates_to_table #> 6            AggregateRaster               wbt_aggregate_raster #>               toolbox_name                          label #> 1     Math and Stats Tools                 Absolute Value #> 2 Geomorphometric Analysis         Accumulation Curvature #> 3   Image Processing Tools                Adaptive Filter #> 4     Math and Stats Tools                            Add #> 5               Data Tools Add Point Coordinates To Table #> 6             GIS Analysis               Aggregate Raster #>                                                                                                    description #> 1                                                     Calculates the absolute value of every cell in a raster. #> 2                                               This tool calculates accumulation curvature from an input DEM. #> 3                                                                     Performs an adaptive filter on an image. #> 4                              Performs an addition operation on two rasters or a raster and a constant value. #> 5 Modifies the attribute table of a point vector by adding fields containing each point's X and Y coordinates. #> 6                                                                   Aggregates a raster to a lower resolution. #>                                                                                                                              github #> 1                    https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/math_stat_analysis/abs.rs #> 2                                                                            Source code is unavailable due to proprietary license. #> 3            https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/image_analysis/adaptive_filter.rs #> 4                    https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/math_stat_analysis/add.rs #> 5 https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/data_tools/add_point_coordinates_to_table.rs #> 6             https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/gis_analysis/aggregate_raster.rs #>                                                                                                              book #> 1              https://www.whiteboxgeo.com/manual/wbt_book/available_tools/mathand_stats_tools.html#AbsoluteValue #> 2 https://www.whiteboxgeo.com/manual/wbt_book/available_tools/geomorphometric_analysis.html#AccumulationCurvature #> 3          https://www.whiteboxgeo.com/manual/wbt_book/available_tools/image_processing_tools.html#AdaptiveFilter #> 4                        https://www.whiteboxgeo.com/manual/wbt_book/available_tools/mathand_stats_tools.html#Add #> 5          https://www.whiteboxgeo.com/manual/wbt_book/available_tools/data_tools.html#AddPointCoordinatesToTable #> 6                   https://www.whiteboxgeo.com/manual/wbt_book/available_tools/gis_analysis.html#AggregateRaster #>   is_extension #> 1        FALSE #> 2         TRUE #> 3        FALSE #> 4        FALSE #> 5        FALSE #> 6        FALSE"},{"path":"/articles/datasets.html","id":"whiteboxtools-tool-and-parameter-names","dir":"Articles","previous_headings":"whitebox Tool Metadata","what":"WhiteboxTools Tool and Parameter Names","title":"whitebox Tool Metadata","text":"second data set provides details available function arguments tool name. wbttoolparameters data set data.frame 2198 parameters 13 variables: \"tool_name\" - WhiteboxTools tool name \"function_name\" - R function name \"toolbox_name\" - WhiteboxTools toolbox name \"name\" - WhiteboxTools tool parameter name \"flags\" - flags used specify parameter command line; comma-separated \"description\" - parameter description \"default_value\" - parameter default value, \"optional\" - parameter “optional” flag; note combination optional parameters may required certain conditions \"parameter_class\" - parameter type \"parameter_detail\" - parameter details; character: data type followed colon specifics, OptionList possible values, comma-separated (defined) \"is_input\" - logical. Classification ‘input’ parameters \"is_output\" - logical. Classification ‘output’ parameters \"argument_name\" - labels selected subset \"flags\" used R function argument names wbt_ functions Several fields table flags parameter_type “flattened” relative nested wbt_tool_parameters() output. nested parameter_type JSON result replaced two variables data set: parameter_class parameter_details parameter data.frame useful construct functions wbt_run_tool() inspecting types tools can run particular data types. find tool_name function_name present, can look whatever convenient. variable argument_name processed subset flags corresponds arguments R functions, denoted function_name.","code":"data(\"wbttoolparameters\", package = \"whitebox\") head(wbttoolparameters) #>               tool_name              function_name             toolbox_name #> 1         AbsoluteValue         wbt_absolute_value     Math and Stats Tools #> 2         AbsoluteValue         wbt_absolute_value     Math and Stats Tools #> 3 AccumulationCurvature wbt_accumulation_curvature Geomorphometric Analysis #> 4 AccumulationCurvature wbt_accumulation_curvature Geomorphometric Analysis #> 5 AccumulationCurvature wbt_accumulation_curvature Geomorphometric Analysis #> 6 AccumulationCurvature wbt_accumulation_curvature Geomorphometric Analysis #>                        name       flags #> 1                Input File  -i,--input #> 2               Output File -o,--output #> 3          Input Raster DEM    -i,--dem #> 4       Output Raster Image -o,--output #> 5 Log-transform the output?       --log #> 6                  Z-factor   --zfactor #>                                description default_value optional #> 1                       Input raster file.              FALSE #> 2                      Output raster file.              FALSE #> 3       Name of the input raster DEM file.              FALSE #> 4    Name of the output raster image file.              FALSE #> 5 Display output values using a log-scale.         false     TRUE #> 6                     Z conversion factor.           1.0     TRUE #>   parameter_class parameter_detail is_input is_output argument_name #> 1    ExistingFile           Raster     TRUE     FALSE         input #> 2         NewFile           Raster    FALSE      TRUE        output #> 3    ExistingFile           Raster     TRUE     FALSE           dem #> 4         NewFile           Raster    FALSE      TRUE        output #> 5         Boolean          Boolean    FALSE     FALSE           log #> 6           Float            Float    FALSE     FALSE       zfactor str(wbttoolparameters, max.level = 1) #> 'data.frame':    2198 obs. of  13 variables: #>  $ tool_name       : chr  \"AbsoluteValue\" \"AbsoluteValue\" \"AccumulationCurvature\" \"AccumulationCurvature\" ... #>  $ function_name   : chr  \"wbt_absolute_value\" \"wbt_absolute_value\" \"wbt_accumulation_curvature\" \"wbt_accumulation_curvature\" ... #>  $ toolbox_name    : chr  \"Math and Stats Tools\" \"Math and Stats Tools\" \"Geomorphometric Analysis\" \"Geomorphometric Analysis\" ... #>  $ name            : chr  \"Input File\" \"Output File\" \"Input Raster DEM\" \"Output Raster Image\" ... #>  $ flags           : chr  \"-i,--input\" \"-o,--output\" \"-i,--dem\" \"-o,--output\" ... #>  $ description     : chr  \"Input raster file.\" \"Output raster file.\" \"Name of the input raster DEM file.\" \"Name of the output raster image file.\" ... #>  $ default_value   : chr  NA NA NA NA ... #>  $ optional        : logi  FALSE FALSE FALSE FALSE TRUE TRUE ... #>  $ parameter_class : chr  \"ExistingFile\" \"NewFile\" \"ExistingFile\" \"NewFile\" ... #>  $ parameter_detail: chr  \"Raster\" \"Raster\" \"Raster\" \"Raster\" ... #>  $ is_input        : logi  TRUE FALSE TRUE FALSE FALSE FALSE ... #>  $ is_output       : logi  FALSE TRUE FALSE TRUE FALSE FALSE ... #>  $ argument_name   : chr  \"input\" \"output\" \"dem\" \"output\" ... #>  - attr(*, \"version\")= chr \"2.4.0\""},{"path":"/articles/datasets.html","id":"example-finding-tools-by-parameter-type","dir":"Articles","previous_headings":"whitebox Tool Metadata > WhiteboxTools Tool and Parameter Names","what":"Example: Finding Tools by Parameter Type","title":"whitebox Tool Metadata","text":"find tools “ExistingFile” argument file type “Raster” can use subset().","code":"head(subset(wbttoolparameters, grepl(\"ExistingFile\", parameter_class) & grepl(\"Raster\", parameter_detail))) #>                tool_name              function_name             toolbox_name #> 1          AbsoluteValue         wbt_absolute_value     Math and Stats Tools #> 3  AccumulationCurvature wbt_accumulation_curvature Geomorphometric Analysis #> 7         AdaptiveFilter        wbt_adaptive_filter   Image Processing Tools #> 12                   Add                    wbt_add     Math and Stats Tools #> 13                   Add                    wbt_add     Math and Stats Tools #> 16       AggregateRaster       wbt_aggregate_raster             GIS Analysis #>                            name      flags                          description #> 1                    Input File -i,--input                   Input raster file. #> 3              Input Raster DEM   -i,--dem   Name of the input raster DEM file. #> 7                    Input File -i,--input                   Input raster file. #> 12 Input File Or Constant Value   --input1 Input raster file or constant value. #> 13 Input File Or Constant Value   --input2 Input raster file or constant value. #> 16                   Input File -i,--input                   Input raster file. #>    default_value optional     parameter_class parameter_detail is_input #> 1               FALSE        ExistingFile           Raster     TRUE #> 3               FALSE        ExistingFile           Raster     TRUE #> 7               FALSE        ExistingFile           Raster     TRUE #> 12              FALSE ExistingFileOrFloat           Raster     TRUE #> 13              FALSE ExistingFileOrFloat           Raster     TRUE #> 16              FALSE        ExistingFile           Raster     TRUE #>    is_output argument_name #> 1      FALSE         input #> 3      FALSE           dem #> 7      FALSE         input #> 12     FALSE        input1 #> 13     FALSE        input2 #> 16     FALSE         input"},{"path":"/articles/datasets.html","id":"appendix-tables-of-function-names-by-toolbox","dir":"Articles","previous_headings":"whitebox Tool Metadata","what":"Appendix: Tables of Function Names by Toolbox","title":"whitebox Tool Metadata","text":"remainder vignette tables R function names tool descriptions wbttoolparameters, organized WhiteboxTools toolbox/extension name.","code":""},{"path":"/articles/datasets.html","id":"data-tools","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Data Tools","title":"whitebox Tool Metadata","text":"Toolbox: Data Tools","code":""},{"path":"/articles/datasets.html","id":"geomorphometric-analysis","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Geomorphometric Analysis","title":"whitebox Tool Metadata","text":"Toolbox: Geomorphometric Analysis","code":""},{"path":"/articles/datasets.html","id":"gis-analysis","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"GIS Analysis","title":"whitebox Tool Metadata","text":"Toolbox: GIS Analysis","code":""},{"path":"/articles/datasets.html","id":"hydrological-analysis","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Hydrological Analysis","title":"whitebox Tool Metadata","text":"Toolbox: Hydrological Analysis","code":""},{"path":"/articles/datasets.html","id":"image-processing-tools","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Image Processing Tools","title":"whitebox Tool Metadata","text":"Toolbox: Image Processing Tools","code":""},{"path":"/articles/datasets.html","id":"lidar-tools","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"LiDAR Tools","title":"whitebox Tool Metadata","text":"Toolbox: LiDAR Tools","code":""},{"path":"/articles/datasets.html","id":"machine-learning","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Machine Learning","title":"whitebox Tool Metadata","text":"Toolbox: Machine Learning","code":""},{"path":"/articles/datasets.html","id":"math-and-stats-tools","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Math and Stats Tools","title":"whitebox Tool Metadata","text":"Toolbox: Math Stats Tools","code":""},{"path":"/articles/datasets.html","id":"precision-agriculture","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Precision Agriculture","title":"whitebox Tool Metadata","text":"Toolbox: Precision Agriculture","code":""},{"path":"/articles/datasets.html","id":"stream-network-analysis","dir":"Articles","previous_headings":"whitebox Tool Metadata > Appendix: Tables of Function Names by Toolbox","what":"Stream Network Analysis","title":"whitebox Tool Metadata","text":"Toolbox: Stream Network Analysis","code":""},{"path":"/articles/demo.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"whitebox Demo","text":"whitebox R frontend ‘WhiteboxTools’ library, advanced geospatial data analysis platform developed Prof. John Lindsay University Guelph’s Geomorphometry Hydrogeomatics Research Group. ‘WhiteboxTools’ can used perform common geographical information systems (GIS) analysis operations, cost-distance analysis, distance buffering, raster reclassification. Remote sensing image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), common image transformations. ‘WhiteboxTools’ also contains advanced tooling spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), LiDAR data processing. WhiteboxTools cartographic spatial data visualization package; instead meant serve analytical backend data visualization software, mainly GIS. vignette shows use whitebox R package run WhiteboxTools. Suggested citation: Lindsay, J. B. (2016). Whitebox GAT: case study geomorphometric analysis. Computers & Geosciences, 95, 75-84. doi: http://dx.doi.org/10.1016/j.cageo.2016.07.003","code":""},{"path":"/articles/demo.html","id":"setup","dir":"Articles","previous_headings":"","what":"Setup","title":"whitebox Demo","text":"Load whitebox library.","code":"library(whitebox)"},{"path":"/articles/demo.html","id":"how-whitebox-works","dir":"Articles","previous_headings":"Setup","what":"How whitebox works","title":"whitebox Demo","text":"whitebox generates system() calls local WhiteboxTools binary: whitebox_tools whitebox_tools.exe can find binary path package going use wbt_exe_path() command always returns “default” path, whether WhiteboxTools installed.","code":"wbt_exe_path(shell_quote = FALSE) #> [1] \"/home/runner/.local/share/R/whitebox/WBT/whitebox_tools\""},{"path":"/articles/demo.html","id":"interfacing-with-r-spatial-packages","dir":"Articles","previous_headings":"Setup","what":"Interfacing with R spatial packages","title":"whitebox Demo","text":"WhiteboxTools input output specified file paths rasters GeoTIFF format, shapefiles, HTML output, LiDAR-related files, . vignette use terra package visualization. Just easily used raster, stars options available R ecosystem handling GeoTIFF output. main way view output save “output” file paths variable can use processing load result R spatial object.","code":""},{"path":"/articles/demo.html","id":"working-with-raster-data","dir":"Articles","previous_headings":"Setup > Interfacing with R spatial packages","what":"Working with Raster Data","title":"whitebox Demo","text":"demonstration employing {terra} package follows: Run tool wbt_slope() \"Slope\". WhiteboxTools reads input writes output. case, can achieve similar slope map result using terra::terrain(), create plot SpatRaster output compare two.  SpatRaster, RasterLayer related classes terra raster packages perfect maintaining linkage file output R object data memory. Use terra::sources() get “source” file name(s). using raster RasterLayer objects equivalent method raster::filename().","code":"library(terra) #> terra 1.7.79 library(whitebox)  # DEMO: calculate slope with WhiteboxTools and raster  # Typically the input/output paths are stored as variables  # sample DEM input GeoTIFF input <- sample_dem_data()  # output file (to be created) output <- file.path(tempdir(), \"slope.tif\") wbt_slope(input, output, units = 'radians') if (file.exists(output)) {   # create a SpatRaster from file output path   outputras <- terra::rast(output) } if (file.exists(input) && file.exists(output) && !is.null(outputras)) {   # par(mfrow = c(2, 1), mar = c(1, 1, 1, 1))      # inspect the output graphically   plot(     outputras,     main = \"whitebox::wbt_slope() [radians]\",     axes = FALSE   )      # calculate equivalent using raster::terrain() on input   plot(     terra::terrain(terra::rast(input)),     main = \"terra::terrain() [radians]\",     axes = FALSE   ) } # the SpatRaster retains a reference to the input file name terra::sources(outputras) #> [1] \"/tmp/RtmpniWwxL/slope.tif\""},{"path":[]},{"path":"/articles/demo.html","id":"installing-whiteboxtools","dir":"Articles","previous_headings":"Setup","what":"Installing WhiteboxTools","title":"whitebox Demo","text":"whitebox wbt_init() standard way set “exe_path” session. WhiteboxTools installed default location, whitebox_tools PATH, set package options, package able find WhiteboxTools installation load. Usually can use whitebox::install_whitebox() download latest binaries correspond available version R package. However, required. may download/compile WhiteboxTools install anywhere use whitebox R package. general information consult WhiteboxTools User Manual: https://www.whiteboxgeo.com/manual/wbt_book/install.html details building source see: https://github.com/jblindsay/whitebox-tools","code":""},{"path":"/articles/demo.html","id":"package-settings-with-wbt_init","dir":"Articles","previous_headings":"Setup","what":"Package Settings with wbt_init()","title":"whitebox Demo","text":"wbt_init() used set check path binary executable commands passed . executable path options stored package options, can overridden system environment variables. default value wbt_exe_path(shell_quote = FALSE) passed exe_path argument unspecified. section cover optional arguments wbt_init() (exe_path, wd verbose) corresponding options helper functions.","code":"# inspect where wbt_init() will be checking wbt_exe_path(shell_quote = FALSE) #> [1] \"/home/runner/.local/share/R/whitebox/WBT/whitebox_tools\" # TRUE when file is found at one of the user specified paths or package default # FALSE when whitebox_tools does not exist at path wbt_init()"},{"path":"/articles/demo.html","id":"exe_path-argument","dir":"Articles","previous_headings":"Setup > Package Settings with wbt_init()","what":"exe_path argument","title":"whitebox Demo","text":"exe_path argument wbt_init() sets whitebox.exe_path package option. exe_path path WhiteboxTools executable file. default value package installation directory, subdirectory \"WBT\", followed whitebox_tools.exe whitebox_tools depending operating system. package automatically find existing installation whitebox_tools directory PATH. Package options exe_path (detailed ?whitebox::whitebox ?wbt_init) can set wbt_init(exe_path, ...), ... additional named arguments corresponding * suffix whitebox.* package options names. Use wbt_options() specific methods like wbt_verbose(), wbt_wd() get values set specific values.","code":"# set path manually to whitebox_tools executable, for instance: wbt_init(exe_path = '/home/andrew/workspace/whitebox-tools/target/release/whitebox_tools')"},{"path":"/articles/demo.html","id":"wd-argument","dir":"Articles","previous_headings":"Setup > Package Settings with wbt_init()","what":"wd argument","title":"whitebox Demo","text":"wd argument can used set WhiteboxTools working directory. working directory specifies base folder path WhiteboxTools can find inputs create outputs. Setting whitebox.wd package option (via wd argument wbt_init() wbt_wd()) aids process setting file paths. value set option --wd directory flag added tools support . set working directory session default output current R working directory unless directory specified input/output arguments. can change working directory time setting wd argument wbt_wd() running tool. NOTE: set working directory session, directory needs set somewhere new “replace” old value; just dropping flag automatically change working directory back R working directory* output show whatever folder set initially. helper method setting whitebox.wd option wbt_wd(). “unset” option R package can use wbt_wd(\"\") equivalent wbt_wd(getwd()). next tool call change WhiteboxTools working directory setting new path. point flag need specified [wish change ].","code":"wbt_wd(\"\") # \"\" equivalent to getwd()"},{"path":"/articles/demo.html","id":"verbose-argument","dir":"Articles","previous_headings":"Setup > Package Settings with wbt_init()","what":"verbose argument","title":"whitebox Demo","text":"verbose argument used set package option related tool “verbosity”: whitebox.verbose. whitebox.verbose FALSE output cat() console running tools. helper method getting setting whitebox.verbose option wbt_verbose(). wbt_verbose() used throughout package check level verbosity used. default, result wbt_verbose() result interactive() tools print extra console output see . used variety wbt_* methods allow package option control output many functions consistent manner, hide output automated tests, markdown documents, vignettes etc. vignette use wbt_verbose(TRUE) package option whitebox.verbose set TRUE mainly print tool name elapsed time whenever run tool: package-level verbose option can also control verbose_mode values passed wbt_* tool functions. Turning “full” output requires third option set argument: \"\". Use wbt_verbose(\"\"). wbt_verbose() still return TRUE whitebox.verbose option \"\".","code":"# force output when run non-interactively (knitr) wbt_verbose(TRUE) #> wbt_breach_depressions - Elapsed Time (excluding I/O): 0.12s"},{"path":"/articles/demo.html","id":"long-term-package-option-settings","dir":"Articles","previous_headings":"Setup","what":"Long-term Package Option Settings","title":"whitebox Demo","text":"package detect added WhiteboxTools directory PATH environment variable. long-term package option settings can put whitebox_tools $PATH set R_WHITEBOX_EXE_PATH user .Rprofile .Renviron. Windows can add path whitebox_tools.exe new entry R_WHITEBOX_EXE_PATH User System Environment variable. Linux/Mac can set R_WHITEBOX_EXE_PATH directly export R_WHITEBOX_EXE_PATH=\"/path//whitebox_tools\". Note set $PATH regular shell profile (.profile/.bashrc/.zshrc) sourced RStudio R session default. requires Unix tool one analogues. can also set R_WHITEBOX_EXE_PATH manually R: Replace Sys.() call custom path string needed \"C:/path//whitebox_tools.exe\". package options can similarly set environment variables. prefixed R_WHITEBOX_*. See ?whitebox details.","code":"Sys.setenv(R_WHITEBOX_EXE_PATH = Sys.which(\"whitebox_tools\"))"},{"path":"/articles/demo.html","id":"running-tools","dir":"Articles","previous_headings":"","what":"Running tools","title":"whitebox Demo","text":"Specify input output paths, options, specified package reference: https://whiteboxR.gishub.org/reference/index.html instance, “BreachDepressions” used process Digital Elevation Model (DEM) identify flow pathways. tool uses uses Lindsay’s (2016) algorithm, preferred depression filling cases. info see: ?wbt_breach_depressions wbt_*_tool_name_*() functions wrappers around wbt_run_tool() function system() call given function-specific argument string. method creating wbt_breach_depressions(dem = ..., output = ...) handle wbt_run_tool(\"BreachDepressions\", args = ...) makes easy generate static methods parity latest WhiteboxTools interface.","code":"# sample DEM file path in package extdata folder input <- sample_dem_data()  # output file name output <- file.path(tempdir(), \"output.tif\")  # run breach_depressions tool wbt_breach_depressions(dem = input, output = output) #> breach_depressions - Elapsed Time (excluding I/O): 0.6s # sample DEM file path in package extdata folder input <- sample_dem_data()  # output file name output <- file.path(tempdir(), \"output.tif\")  # run breach_depressions tool wbt_run_tool(tool_name = \"BreachDepressions\", args = paste0(\"--dem=\", input, \" --output=\", output)) #> BreachDepressions - Elapsed Time (excluding I/O): 0.7s"},{"path":"/articles/demo.html","id":"example-compare-input-v-s--output-with-terra","dir":"Articles","previous_headings":"Running tools","what":"Example: Compare input v.s. output with terra","title":"whitebox Demo","text":"use {terra} package read GeoTIFF file output WhiteboxTools.","code":""},{"path":"/articles/demo.html","id":"setup-1","dir":"Articles","previous_headings":"Running tools > Example: Compare input v.s. output with terra","what":"Setup","title":"whitebox Demo","text":"","code":"library(terra)  # sample DEM file path in package extdata folder input <- sample_dem_data()  # output file name output <- file.path(tempdir(), \"output.tif\")"},{"path":"/articles/demo.html","id":"run-wbt_breach_depressions-breachdepressions-tool","dir":"Articles","previous_headings":"Running tools > Example: Compare input v.s. output with terra","what":"Run wbt_breach_depressions() (BreachDepressions tool)","title":"whitebox Demo","text":"","code":"# run breach_depressions tool wbt_breach_depressions(dem = input, output = output) #> breach_depressions - Elapsed Time (excluding I/O): 0.7s"},{"path":"/articles/demo.html","id":"visualize-results-with-terra","dir":"Articles","previous_headings":"Running tools > Example: Compare input v.s. output with terra","what":"Visualize results with terra","title":"whitebox Demo","text":"","code":"# create raster object from input file input <- rast(input)  if (file.exists(output)) {   # create raster object from output file   output <- rast(output)      # par(mar = c(2, 1, 2, 1))   # inspect input v.s. output   plot(input, axes = FALSE, main = \"DEM\")   plot(output, axes = FALSE, main = \"DEM (Breached Depressions)\")      # inspect numeric difference (output - input)    plot(output - input, axes = FALSE,  main = \"Difference ([Breached Depressions] - [DEM])\") }"},{"path":"/articles/demo.html","id":"example-identifying-tributaries","dir":"Articles","previous_headings":"Running tools","what":"Example: Identifying Tributaries","title":"whitebox Demo","text":"take processing DEMs bit performing several WhiteboxTools operations sequence. interested identifying ranking tributaries watercourses (streams rivers). R package makes use whitebox R package hydroweight. brief example beginning hydroweight README showing breached DEM can used spatial analysis stream networks.","code":""},{"path":"/articles/demo.html","id":"setup-2","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"Setup","title":"whitebox Demo","text":"","code":"library(whitebox) library(terra)  ## Sample DEM from whitebox package toy_file <- sample_dem_data() toy_dem <- rast(x = toy_file)  ## Generate wd as a temporary directory.  ## Replace with your own path, or \".\" for current directory wd <- tempdir()  ## Write toy_dem to working directory writeRaster(   x = toy_dem, filename = file.path(wd, \"toy_dem.tif\"),   overwrite = TRUE )"},{"path":"/articles/demo.html","id":"wbt_breach_depressions-breach-dem-depressions","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"wbt_breach_depressions() – Breach DEM Depressions","title":"whitebox Demo","text":"First pre-process breaching depressions DEM","code":"## Breach depressions to ensure continuous flow wbt_breach_depressions(   dem = file.path(wd, \"toy_dem.tif\"),   output = file.path(wd, \"toy_dem_breached.tif\") ) #> breach_depressions - Elapsed Time (excluding I/O): 0.7s"},{"path":"/articles/demo.html","id":"wbt_d8_pointer-calculate-flow-direction","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"wbt_d8_pointer() – Calculate Flow Direction","title":"whitebox Demo","text":"generate direction flow DEM surface using “D8” flow pointer method","code":"## Generate d8 flow pointer (note: other flow directions are available) wbt_d8_pointer(   dem = file.path(wd, \"toy_dem_breached.tif\"),   output = file.path(wd, \"toy_dem_breached_d8.tif\") ) #> d8_pointer - Elapsed Time (excluding I/O): 0.1s"},{"path":"/articles/demo.html","id":"wbt_d8_flow_accumulation-flow-accumulation","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"wbt_d8_flow_accumulation() – Flow Accumulation","title":"whitebox Demo","text":"calculate direction flow method, calculate cumulative flow example wbt_d8_flow_accumulation():","code":"## Generate d8 flow accumulation in units of cells (note: other flow directions are available) wbt_d8_flow_accumulation(   input = file.path(wd, \"toy_dem_breached.tif\"),   output = file.path(wd, \"toy_dem_breached_accum.tif\"),   out_type = \"cells\" ) #> d8_flow_accumulation - Elapsed Time (excluding I/O): 0.6s"},{"path":"/articles/demo.html","id":"additional-flow-direction-and-accumulation-tools","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries > wbt_d8_flow_accumulation() – Flow Accumulation","what":"Additional Flow Direction and Accumulation Tools","title":"whitebox Demo","text":"addition D8 flow pointers (flow direction), several options direction accumulation FD8, D-infinity, D-infinity. Keyword “Pointer” tools: \"D8Pointer\", \"DInfPointer\", \"FD8Pointer\", \"Rho8Pointer\" Keyword “FlowAccumulation” tools: \"D8FlowAccumulation\", \"DInfFlowAccumulation\", \"FD8FlowAccumulation\", \"Rho8FlowAccumulation\", \"MDInfFlowAccumulation\" Search tools involving \"flow pointer\" key word: wbt_list_tools(keyword = \"flow pointer\") just example wealth tool options made available WhiteboxTools platform.","code":"#> All 27 Tools containing keywords: #> AverageFlowpathSlope: Measures the average slope gradient from each grid cell to all upslope divide cells. #> AverageUpslopeFlowpathLength: Measures the average length of all upslope flowpaths draining each grid cell. #> D8FlowAccumulation: Calculates a D8 flow accumulation raster from an input DEM or flow pointer. #> D8Pointer: Calculates a D8 flow pointer raster from an input DEM. #> DInfFlowAccumulation: Calculates a D-infinity flow accumulation raster from an input DEM. #> DInfPointer: Calculates a D-infinity flow pointer (flow direction) raster from an input DEM. #> DownslopeFlowpathLength: Calculates the downslope flowpath length from each cell to basin outlet. #> ExtractStreams: Extracts stream grid cells from a flow accumulation raster. #> FD8FlowAccumulation: Calculates an FD8 flow accumulation raster from an input DEM. #> FD8Pointer: Calculates an FD8 flow pointer raster from an input DEM. #> FindNoFlowCells: Finds grid cells with no downslope neighbours. #> FindParallelFlow: Finds areas of parallel flow in D8 flow direction rasters. #> FlowAccumulationFullWorkflow: Resolves all of the depressions in a DEM, outputting a breached DEM, an aspect-aligned non-divergent flow pointer, and a flow accumulation raster. #> FlowLengthDiff: Calculates the local maximum absolute difference in downslope flowpath length, useful in mapping drainage divides and ridges. #> LongProfileFromPoints: Plots the longitudinal profiles from flow-paths initiating from a set of vector points. #> LongestFlowpath: Delineates the longest flowpaths for a group of subbasins or watersheds.  #> MDInfFlowAccumulation: Calculates an FD8 flow accumulation raster from an input DEM. #> MaxUpslopeFlowpathLength: Measures the maximum length of all upslope flowpaths draining each grid cell. #> NumInflowingNeighbours: Computes the number of inflowing neighbours to each cell in an input DEM based on the D8 algorithm. #> Rho8Pointer: Calculates a stochastic Rho8 flow pointer raster from an input DEM. #> SnapPourPoints: Moves outlet points used to specify points of interest in a watershedding operation to the cell with the highest flow accumulation in its neighbourhood. #> TraceDownslopeFlowpaths: Traces downslope flowpaths from one or more target sites (i.e. seed points). #> QinFlowAccumulation: Calculates Qin et al. (2007) flow accumulation. #> MaxUpslopeValue: Calculates the maximum upslope value from an input values raster along flowpaths. #> QuinnFlowAccumulation: Calculates Quinn et al. (1995) flow accumulation. #> Rho8FlowAccumulation: Calculates Fairfield and Leymarie (1991) flow accumulation. #> ConvergenceIndex: Calculates Qin et al. (2007) flow accumulation."},{"path":"/articles/demo.html","id":"wbt_extract_streams-extract-stream-network","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"wbt_extract_streams() – Extract Stream Network","title":"whitebox Demo","text":"flow accumulation raster hand, can extract stream network wbt_extract_streams() based threshold (e.g. 100) accumulated flow. threshold value choose depend analysis goals, choice flow accumulation algorithm used, local topography, well resolution extent DEM.","code":"## Generate streams with a stream initiation threshold of 100 cells wbt_extract_streams(   flow_accum = file.path(wd, \"toy_dem_breached_accum.tif\"),   output = file.path(wd, \"toy_dem_streams.tif\"),   threshold = 100 ) #> extract_streams - Elapsed Time (excluding I/O): 0.1s"},{"path":"/articles/demo.html","id":"wbt_tributary_identifier-identify-tributaries","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"wbt_tributary_identifier() – Identify Tributaries","title":"whitebox Demo","text":"Next, let’s identify tributaries. function wbt_tributary_identifier() little complicated takes takes two inputs: raster D8 pointer file. raster streams file.","code":"wbt_tributary_identifier(   d8_pntr = file.path(wd, \"toy_dem_breached_d8.tif\"),   streams = file.path(wd, \"toy_dem_streams.tif\"),   output = file.path(wd, \"toy_dem_tributaries.tif\") ) #> tributary_identifier - Elapsed Time (excluding I/O): 0.1s"},{"path":"/articles/demo.html","id":"compare-results","dir":"Articles","previous_headings":"Running tools > Example: Identifying Tributaries","what":"Compare results","title":"whitebox Demo","text":"Finally, compare results wbt_extract_streams() wbt_tributary_identifier()","code":"if (file.exists(file.path(wd, \"toy_dem_streams.tif\"))) {   par(mfrow = c(2, 1), mar = c(3, 1, 2, 1))      plot(     rast(file.path(wd, \"toy_dem_streams.tif\")),     main = \"Streams\",     col = \"black\"   )      plot(     rast(file.path(wd, \"toy_dem_tributaries.tif\")),     main = \"TributaryIdentifier\"   ) }"},{"path":"/articles/demo.html","id":"appendix-wbt_-utility-functions","dir":"Articles","previous_headings":"","what":"Appendix: wbt_* utility functions","title":"whitebox Demo","text":"methods provide access WhiteboxTools executable parameters metadata.","code":""},{"path":"/articles/demo.html","id":"wbt_help","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_help()","title":"whitebox Demo","text":"wbt_help() prints WhiteboxTools help: listing available commands executable","code":"wbt_help() #> WhiteboxTools Help #>  #> The following commands are recognized: #> --cd, --wd          Changes the working directory; used in conjunction with --run flag. #> --compress_rasters  Sets the compress_raster option in the settings.json file; determines if newly created rasters are compressed. e.g. --compress_rasters=true #> -h, --help          Prints help information. #> -l, --license       Prints the whitebox-tools license. Tool names may also be used, --license=\"Slope\" #> --listtools         Lists all available tools. Keywords may also be used, --listtools slope. #> --max_procs         Sets the maximum number of processors used. -1 = all available processors. e.g. --max_procs=2 #> -r, --run           Runs a tool; used in conjunction with --wd flag; -r=\"LidarInfo\". #> --toolbox           Prints the toolbox associated with a tool; --toolbox=Slope. #> --toolhelp          Prints the help associated with a tool; --toolhelp=\"LidarInfo\". #> --toolparameters    Prints the parameters (in json form) for a specific tool; --toolparameters=\"LidarInfo\". #> -v                  Verbose mode. Without this flag, tool outputs will not be printed. #> --viewcode          Opens the source code of a tool in a web browser; --viewcode=\"LidarInfo\". #> --version           Prints the version information. #>  #> Example Usage: #> >> ./whitebox_tools -r=lidar_info --cd=\"/path/to/data/\" -i=input.las --vlr --geokeys"},{"path":"/articles/demo.html","id":"wbt_license","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_license()","title":"whitebox Demo","text":"wbt_license() prints WhiteboxTools license","code":"wbt_license() #> WhiteboxTools License #> Copyright 2017-2023 John Lindsay #>  #> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and #> associated documentation files (the \"Software\"), to deal in the Software without restriction, #> including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, #> and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, #> subject to the following conditions: #>  #> The above copyright notice and this permission notice shall be included in all copies or substantial #> portions of the Software. #>  #> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT #> NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND #> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES #> OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN #> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."},{"path":"/articles/demo.html","id":"wbt_version","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_version()","title":"whitebox Demo","text":"Prints WhiteboxTools version","code":"wbt_version() #> WhiteboxTools v2.4.0 (c) Dr. John Lindsay 2017-2023 #>  #> WhiteboxTools is an advanced geospatial data analysis platform developed at #> the University of Guelph's Geomorphometry and Hydrogeomatics Research  #> Group (GHRG). See www.whiteboxgeo.com for more details."},{"path":"/articles/demo.html","id":"wbt_list_tools","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_list_tools()","title":"whitebox Demo","text":"Use wbt_list_tools() list available tools WhiteboxTools. version 2.4.0 484 tools! See available toolboxes extensions. full list can overwhelming amount output, pass keywords argument search filter. example list tools keyword ‘flowaccumulation’ tool name description.","code":"wbt_list_tools() wbt_list_tools(keywords = \"flowaccumulation\") #> All 8 Tools containing keywords: #> D8FlowAccumulation: Calculates a D8 flow accumulation raster from an input DEM or flow pointer. #> DInfFlowAccumulation: Calculates a D-infinity flow accumulation raster from an input DEM. #> FD8FlowAccumulation: Calculates an FD8 flow accumulation raster from an input DEM. #> FlowAccumulationFullWorkflow: Resolves all of the depressions in a DEM, outputting a breached DEM, an aspect-aligned non-divergent flow pointer, and a flow accumulation raster. #> MDInfFlowAccumulation: Calculates an FD8 flow accumulation raster from an input DEM. #> Rho8FlowAccumulation: Calculates Fairfield and Leymarie (1991) flow accumulation. #> QinFlowAccumulation: Calculates Qin et al. (2007) flow accumulation. #> QuinnFlowAccumulation: Calculates Quinn et al. (1995) flow accumulation."},{"path":"/articles/demo.html","id":"wbt_tool_help","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_tool_help()","title":"whitebox Demo","text":"find tool interested using, can investigate sort parameters takes. R methods generally take named parameters. R functions naming scheme wbt_tool_name _ used spaces, whereas tools spaces. wbt_tool_help(\"tributaryidentifier\") shows command line help tool name. ?wbt_tributary_identifier shows corresponding R function help, derived command line help page metadata.","code":"wbt_tool_help(\"tributaryidentifier\") #> TributaryIdentifier #> Description: #> Assigns a unique identifier to each tributary in a stream network. #> Toolbox: Stream Network Analysis #> Parameters: #>  #> Flag               Description #> -----------------  ----------- #> --d8_pntr          Input raster D8 pointer file. #> --streams          Input raster streams file. #> -o, --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. #>  #>  #> Example usage: #> >>./whitebox_tools -r=TributaryIdentifier -v --wd=\"/path/to/data/\" --d8_pntr=D8.tif --streams=streams.tif -o=output.tif #> >>./whitebox_tools -r=TributaryIdentifier -v --wd=\"/path/to/data/\" --d8_pntr=D8.tif --streams=streams.tif -o=output.tif --esri_pntr --zero_background"},{"path":"/articles/demo.html","id":"wbt_toolbox","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_toolbox()","title":"whitebox Demo","text":"Another way tools organized WhiteboxTools “toolbox.” wbt_toolbox() prints toolbox specific tool (tools none specified) Print full list specifying tool_name","code":"wbt_toolbox(tool_name = \"aspect\") #> Geomorphometric Analysis wbt_toolbox() #> AbsoluteValue: Math and Stats Tools #> AdaptiveFilter: Image Processing Tools/Filters #> Add: Math and Stats Tools #> AddPointCoordinatesToTable: Data Tools #> AggregateRaster: GIS Analysis #> And: Math and Stats Tools #> Anova: Math and Stats Tools #> ArcCos: Math and Stats Tools #> ArcSin: Math and Stats Tools #> ArcTan: Math and Stats Tools #> Arcosh: Math and Stats Tools #> Arsinh: Math and Stats Tools #> Artanh: Math and Stats Tools #> AsciiToLas: LiDAR Tools #> Aspect: Geomorphometric Analysis #> Atan2: Math and Stats Tools #> AttributeCorrelation: Math and Stats Tools #> AttributeCorrelationNeighbourhoodAnalysis: Math and Stats Tools #> AttributeHistogram: Math and Stats Tools #> AttributeScattergram: Math and Stats Tools #> AverageFlowpathSlope: Hydrological Analysis #> AverageNormalVectorAngularDeviation: Geomorphometric Analysis #> AverageOverlay: GIS Analysis/Overlay Tools #> AverageUpslopeFlowpathLength: Hydrological Analysis #> BalanceContrastEnhancement: Image Processing Tools/Image Enhancement #> Basins: Hydrological Analysis #> BilateralFilter: Image Processing Tools/Filters #> BlockMaximumGridding: GIS Analysis #> BlockMinimumGridding: GIS Analysis #> BoundaryShapeComplexity: GIS Analysis/Patch Shape Tools #> BreachDepressions: Hydrological Analysis #> BreachDepressionsLeastCost: Hydrological Analysis #> BreachSingleCellPits: Hydrological Analysis #> BufferRaster: GIS Analysis/Distance Tools #> BurnStreamsAtRoads: Hydrological Analysis #> Ceil: Math and Stats Tools #> Centroid: GIS Analysis #> CentroidVector: GIS Analysis #> ChangeVectorAnalysis: Image Processing Tools #> CircularVarianceOfAspect: Geomorphometric Analysis #> ClassifyBuildingsInLidar: LiDAR Tools #> ClassifyOverlapPoints: LiDAR Tools #> CleanVector: Data Tools #> Clip: GIS Analysis/Overlay Tools #> ClipLidarToPolygon: LiDAR Tools #> ClipRasterToPolygon: GIS Analysis/Overlay Tools #> Closing: Image Processing Tools #> Clump: GIS Analysis #> CompactnessRatio: GIS Analysis/Patch Shape Tools #> ConditionalEvaluation: Math and Stats Tools #> ConditionedLatinHypercube: Math and Stats Tools #> ConservativeSmoothingFilter: Image Processing Tools/Filters #> ConstructVectorTIN: GIS Analysis #> ContoursFromPoints: Geomorphometric Analysis #> ContoursFromRaster: Geomorphometric Analysis #> ConvergenceIndex: Geomorphometric Analysis #> ConvertNodataToZero: Data Tools #> ConvertRasterFormat: Data Tools #> CornerDetection: Image Processing Tools/Filters #> CorrectStreamVectorDirection: Stream Network Analysis #> CorrectVignetting: Image Processing Tools/Image Enhancement #> Cos: Math and Stats Tools #> Cosh: Math and Stats Tools #> CostAllocation: GIS Analysis/Distance Tools #> CostDistance: GIS Analysis/Distance Tools #> CostPathway: GIS Analysis/Distance Tools #> CountIf: GIS Analysis/Overlay Tools #> CreateColourComposite: Image Processing Tools #> CreateHexagonalVectorGrid: GIS Analysis #> CreatePlane: GIS Analysis #> CreateRectangularVectorGrid: GIS Analysis #> CrispnessIndex: Math and Stats Tools #> CrossTabulation: Math and Stats Tools #> CsvPointsToVector: Data Tools #> CumulativeDistribution: Math and Stats Tools #> D8FlowAccumulation: Hydrological Analysis #> D8MassFlux: Hydrological Analysis #> D8Pointer: Hydrological Analysis #> DInfFlowAccumulation: Hydrological Analysis #> DInfMassFlux: Hydrological Analysis #> DInfPointer: Hydrological Analysis #> Decrement: Math and Stats Tools #> DepthInSink: Hydrological Analysis #> DevFromMeanElev: Geomorphometric Analysis #> DeviationFromRegionalDirection: GIS Analysis/Patch Shape Tools #> DiffFromMeanElev: Geomorphometric Analysis #> DiffOfGaussianFilter: Image Processing Tools/Filters #> Difference: GIS Analysis/Overlay Tools #> DirectDecorrelationStretch: Image Processing Tools/Image Enhancement #> DirectionalRelief: Geomorphometric Analysis #> Dissolve: GIS Analysis #> DistanceToOutlet: Stream Network Analysis #> DiversityFilter: Image Processing Tools/Filters #> Divide: Math and Stats Tools #> DownslopeDistanceToStream: Hydrological Analysis #> DownslopeFlowpathLength: Hydrological Analysis #> DownslopeIndex: Geomorphometric Analysis #> EdgeContamination: Hydrological Analysis #> EdgeDensity: Geomorphometric Analysis #> EdgePreservingMeanFilter: Image Processing Tools/Filters #> EdgeProportion: GIS Analysis/Patch Shape Tools #> ElevAbovePit: Geomorphometric Analysis #> ElevPercentile: Geomorphometric Analysis #> ElevRelativeToMinMax: Geomorphometric Analysis #> ElevRelativeToWatershedMinMax: Geomorphometric Analysis #> ElevationAboveStream: Hydrological Analysis #> ElevationAboveStreamEuclidean: Hydrological Analysis #> EliminateCoincidentPoints: GIS Analysis #> ElongationRatio: GIS Analysis/Patch Shape Tools #> EmbankmentMapping: Geomorphometric Analysis #> EmbossFilter: Image Processing Tools/Filters #> EqualTo: Math and Stats Tools #> Erase: GIS Analysis/Overlay Tools #> ErasePolygonFromLidar: LiDAR Tools #> ErasePolygonFromRaster: GIS Analysis/Overlay Tools #> EuclideanAllocation: GIS Analysis/Distance Tools #> EuclideanDistance: GIS Analysis/Distance Tools #> Exp: Math and Stats Tools #> Exp2: Math and Stats Tools #> ExportTableToCsv: Data Tools #> ExposureTowardsWindFlux: Geomorphometric Analysis #> ExtendVectorLines: GIS Analysis #> ExtractByAttribute: GIS Analysis #> ExtractNodes: GIS Analysis #> ExtractRasterValuesAtPoints: GIS Analysis #> ExtractStreams: Stream Network Analysis #> ExtractValleys: Stream Network Analysis #> FD8FlowAccumulation: Hydrological Analysis #> FD8Pointer: Hydrological Analysis #> FarthestChannelHead: Stream Network Analysis #> FastAlmostGaussianFilter: Image Processing Tools/Filters #> FeaturePreservingSmoothing: Geomorphometric Analysis #> FetchAnalysis: Geomorphometric Analysis #> FillBurn: Hydrological Analysis #> FillDepressions: Hydrological Analysis #> FillDepressionsPlanchonAndDarboux: Hydrological Analysis #> FillDepressionsWangAndLiu: Hydrological Analysis #> FillMissingData: Geomorphometric Analysis #> FillSingleCellPits: Hydrological Analysis #> FilterLidarClasses: LiDAR Tools #> FilterLidarScanAngles: LiDAR Tools #> FilterRasterFeaturesByArea: GIS Analysis #> FindFlightlineEdgePoints: LiDAR Tools #> FindLowestOrHighestPoints: GIS Analysis #> FindMainStem: Stream Network Analysis #> FindNoFlowCells: Hydrological Analysis #> FindParallelFlow: Hydrological Analysis #> FindPatchOrClassEdgeCells: GIS Analysis/Patch Shape Tools #> FindRidges: Geomorphometric Analysis #> FlattenLakes: Hydrological Analysis #> FlightlineOverlap: LiDAR Tools #> FlipImage: Image Processing Tools #> FloodOrder: Hydrological Analysis #> Floor: Math and Stats Tools #> FlowAccumulationFullWorkflow: Hydrological Analysis #> FlowLengthDiff: Hydrological Analysis #> GammaCorrection: Image Processing Tools/Image Enhancement #> GaussianContrastStretch: Image Processing Tools/Image Enhancement #> GaussianCurvature: Geomorphometric Analysis #> GaussianFilter: Image Processing Tools/Filters #> GaussianScaleSpace: Geomorphometric Analysis #> Geomorphons: Geomorphometric Analysis #> GreaterThan: Math and Stats Tools #> HackStreamOrder: Stream Network Analysis #> HeatMap: GIS Analysis #> HeightAboveGround: LiDAR Tools #> HighPassBilateralFilter: Image Processing Tools/Filters #> HighPassFilter: Image Processing Tools/Filters #> HighPassMedianFilter: Image Processing Tools/Filters #> HighestPosition: GIS Analysis/Overlay Tools #> Hillshade: Geomorphometric Analysis #> Hillslopes: Hydrological Analysis #> HistogramEqualization: Image Processing Tools/Image Enhancement #> HistogramMatching: Image Processing Tools/Image Enhancement #> HistogramMatchingTwoImages: Image Processing Tools/Image Enhancement #> HoleProportion: GIS Analysis/Patch Shape Tools #> HorizonAngle: Geomorphometric Analysis #> HortonStreamOrder: Stream Network Analysis #> HypsometricAnalysis: Geomorphometric Analysis #> HypsometricallyTintedHillshade: Geomorphometric Analysis #> IdwInterpolation: GIS Analysis #> IhsToRgb: Image Processing Tools #> ImageAutocorrelation: Math and Stats Tools #> ImageCorrelation: Math and Stats Tools #> ImageCorrelationNeighbourhoodAnalysis: Math and Stats Tools #> ImageRegression: Math and Stats Tools #> ImageStackProfile: Image Processing Tools #> ImpoundmentSizeIndex: Hydrological Analysis #> InPlaceAdd: Math and Stats Tools #> InPlaceDivide: Math and Stats Tools #> InPlaceMultiply: Math and Stats Tools #> InPlaceSubtract: Math and Stats Tools #> Increment: Math and Stats Tools #> IndividualTreeDetection: LiDAR Tools #> InsertDams: Hydrological Analysis #> InstallWbExtension: Whitebox Utilities #> IntegerDivision: Math and Stats Tools #> IntegralImage: Image Processing Tools #> Intersect: GIS Analysis/Overlay Tools #> IsNoData: Math and Stats Tools #> Isobasins: Hydrological Analysis #> JensonSnapPourPoints: Hydrological Analysis #> JoinTables: Data Tools #> KMeansClustering: Machine Learning #> KNearestMeanFilter: Image Processing Tools/Filters #> KappaIndex: Math and Stats Tools #> KsTestForNormality: Math and Stats Tools #> LaplacianFilter: Image Processing Tools/Filters #> LaplacianOfGaussianFilter: Image Processing Tools/Filters #> LasToAscii: LiDAR Tools #> LasToMultipointShapefile: LiDAR Tools #> LasToShapefile: LiDAR Tools #> LasToZlidar: LiDAR Tools #> LaunchWbRunner: Whitebox Utilities #> LayerFootprint: GIS Analysis #> LeeSigmaFilter: Image Processing Tools/Filters #> LengthOfUpstreamChannels: Stream Network Analysis #> LessThan: Math and Stats Tools #> LidarBlockMaximum: LiDAR Tools #> LidarBlockMinimum: LiDAR Tools #> LidarClassifySubset: LiDAR Tools #> LidarColourize: LiDAR Tools #> LidarDigitalSurfaceModel: LiDAR Tools #> LidarElevationSlice: LiDAR Tools #> LidarGroundPointFilter: LiDAR Tools #> LidarHexBinning: LiDAR Tools #> LidarHillshade: LiDAR Tools #> LidarHistogram: LiDAR Tools #> LidarIdwInterpolation: LiDAR Tools #> LidarInfo: LiDAR Tools #> LidarJoin: LiDAR Tools #> LidarKappaIndex: LiDAR Tools #> LidarNearestNeighbourGridding: LiDAR Tools #> LidarPointDensity: LiDAR Tools #> LidarPointStats: LiDAR Tools #> LidarRansacPlanes: LiDAR Tools #> LidarRbfInterpolation: LiDAR Tools #> LidarRemoveDuplicates: LiDAR Tools #> LidarRemoveOutliers: LiDAR Tools #> LidarRooftopAnalysis: LiDAR Tools #> LidarSegmentation: LiDAR Tools #> LidarSegmentationBasedFilter: LiDAR Tools #> LidarShift: LiDAR Tools #> LidarTINGridding: LiDAR Tools #> LidarThin: LiDAR Tools #> LidarThinHighDensity: LiDAR Tools #> LidarTile: LiDAR Tools #> LidarTileFootprint: LiDAR Tools #> LidarTophatTransform: LiDAR Tools #> LineDetectionFilter: Image Processing Tools/Filters #> LineIntersections: GIS Analysis/Overlay Tools #> LineThinning: Image Processing Tools #> LinearityIndex: GIS Analysis/Patch Shape Tools #> LinesToPolygons: Data Tools #> ListUniqueValues: Math and Stats Tools #> ListUniqueValuesRaster: Math and Stats Tools #> Ln: Math and Stats Tools #> LocalQuadraticRegression: Geomorphometric Analysis #> Log10: Math and Stats Tools #> Log2: Math and Stats Tools #> LongProfile: Stream Network Analysis #> LongProfileFromPoints: Stream Network Analysis #> LongestFlowpath: Hydrological Analysis #> LowestPosition: GIS Analysis/Overlay Tools #> MDInfFlowAccumulation: Hydrological Analysis #> MajorityFilter: Image Processing Tools/Filters #> MapOffTerrainObjects: Geomorphometric Analysis #> Max: Math and Stats Tools #> MaxAbsoluteOverlay: GIS Analysis/Overlay Tools #> MaxAnisotropyDev: Geomorphometric Analysis #> MaxAnisotropyDevSignature: Geomorphometric Analysis #> MaxBranchLength: Geomorphometric Analysis #> MaxDifferenceFromMean: Geomorphometric Analysis #> MaxDownslopeElevChange: Geomorphometric Analysis #> MaxElevDevSignature: Geomorphometric Analysis #> MaxElevationDeviation: Geomorphometric Analysis #> MaxOverlay: GIS Analysis/Overlay Tools #> MaxUpslopeElevChange: Geomorphometric Analysis #> MaxUpslopeFlowpathLength: Hydrological Analysis #> MaxUpslopeValue: Hydrological Analysis #> MaximalCurvature: Geomorphometric Analysis #> MaximumFilter: Image Processing Tools/Filters #> MeanCurvature: Geomorphometric Analysis #> MeanFilter: Image Processing Tools/Filters #> MedianFilter: Image Processing Tools/Filters #> Medoid: GIS Analysis #> MergeLineSegments: GIS Analysis/Overlay Tools #> MergeTableWithCsv: Data Tools #> MergeVectors: Data Tools #> Min: Math and Stats Tools #> MinAbsoluteOverlay: GIS Analysis/Overlay Tools #> MinDownslopeElevChange: Geomorphometric Analysis #> MinMaxContrastStretch: Image Processing Tools/Image Enhancement #> MinOverlay: GIS Analysis/Overlay Tools #> MinimalCurvature: Geomorphometric Analysis #> MinimumBoundingBox: GIS Analysis #> MinimumBoundingCircle: GIS Analysis #> MinimumBoundingEnvelope: GIS Analysis #> MinimumConvexHull: GIS Analysis #> MinimumFilter: Image Processing Tools/Filters #> ModifiedKMeansClustering: Machine Learning #> ModifyNoDataValue: Data Tools #> Modulo: Math and Stats Tools #> Mosaic: Image Processing Tools #> MosaicWithFeathering: Image Processing Tools #> MultiPartToSinglePart: Data Tools #> MultidirectionalHillshade: Geomorphometric Analysis #> Multiply: Math and Stats Tools #> MultiplyOverlay: GIS Analysis/Overlay Tools #> MultiscaleElevationPercentile: Geomorphometric Analysis #> MultiscaleRoughness: Geomorphometric Analysis #> MultiscaleRoughnessSignature: Geomorphometric Analysis #> MultiscaleStdDevNormals: Geomorphometric Analysis #> MultiscaleStdDevNormalsSignature: Geomorphometric Analysis #> MultiscaleTopographicPositionImage: Geomorphometric Analysis #> NarrownessIndex: GIS Analysis/Patch Shape Tools #> NaturalNeighbourInterpolation: GIS Analysis #> NearestNeighbourGridding: GIS Analysis #> Negate: Math and Stats Tools #> NewRasterFromBase: Data Tools #> NormalVectors: LiDAR Tools #> NormalizeLidar: LiDAR Tools #> NormalizedDifferenceIndex: Image Processing Tools #> Not: Math and Stats Tools #> NotEqualTo: Math and Stats Tools #> NumDownslopeNeighbours: Geomorphometric Analysis #> NumInflowingNeighbours: Hydrological Analysis #> NumUpslopeNeighbours: Geomorphometric Analysis #> OlympicFilter: Image Processing Tools/Filters #> Opening: Image Processing Tools #> Or: Math and Stats Tools #> OtsuThresholding: Image Processing Tools #> PairedSampleTTest: Math and Stats Tools #> PanchromaticSharpening: Image Processing Tools/Image Enhancement #> PatchOrientation: GIS Analysis/Patch Shape Tools #> PennockLandformClass: Geomorphometric Analysis #> PercentElevRange: Geomorphometric Analysis #> PercentEqualTo: GIS Analysis/Overlay Tools #> PercentGreaterThan: GIS Analysis/Overlay Tools #> PercentLessThan: GIS Analysis/Overlay Tools #> PercentageContrastStretch: Image Processing Tools/Image Enhancement #> PercentileFilter: Image Processing Tools/Filters #> PerimeterAreaRatio: GIS Analysis/Patch Shape Tools #> PickFromList: GIS Analysis/Overlay Tools #> PlanCurvature: Geomorphometric Analysis #> PolygonArea: GIS Analysis #> PolygonLongAxis: GIS Analysis #> PolygonPerimeter: GIS Analysis #> PolygonShortAxis: GIS Analysis #> Polygonize: GIS Analysis/Overlay Tools #> PolygonsToLines: Data Tools #> Power: Math and Stats Tools #> PrewittFilter: Image Processing Tools/Filters #> PrincipalComponentAnalysis: Math and Stats Tools #> PrintGeoTiffTags: Data Tools #> Profile: Geomorphometric Analysis #> ProfileCurvature: Geomorphometric Analysis #> QinFlowAccumulation: Hydrological Analysis #> Quantiles: Math and Stats Tools #> QuinnFlowAccumulation: Hydrological Analysis #> RadialBasisFunctionInterpolation: GIS Analysis #> RadiusOfGyration: GIS Analysis/Patch Shape Tools #> RaiseWalls: Hydrological Analysis #> RandomField: Math and Stats Tools #> RandomSample: Math and Stats Tools #> RangeFilter: Image Processing Tools/Filters #> RasterArea: GIS Analysis #> RasterCalculator: Math and Stats Tools #> RasterCellAssignment: GIS Analysis #> RasterHistogram: Math and Stats Tools #> RasterPerimeter: GIS Analysis #> RasterStreamsToVector: Stream Network Analysis #> RasterSummaryStats: Math and Stats Tools #> RasterToVectorLines: Data Tools #> RasterToVectorPoints: Data Tools #> RasterToVectorPolygons: Data Tools #> RasterizeStreams: Stream Network Analysis #> Reciprocal: Math and Stats Tools #> Reclass: GIS Analysis #> ReclassEqualInterval: GIS Analysis #> ReclassFromFile: GIS Analysis #> ReinitializeAttributeTable: Data Tools #> RelatedCircumscribingCircle: GIS Analysis/Patch Shape Tools #> RelativeAspect: Geomorphometric Analysis #> RelativeTopographicPosition: Geomorphometric Analysis #> RemoveOffTerrainObjects: Geomorphometric Analysis #> RemovePolygonHoles: Data Tools #> RemoveShortStreams: Stream Network Analysis #> RemoveSpurs: Image Processing Tools #> RepairStreamVectorTopology: Stream Network Analysis #> Resample: Image Processing Tools #> RescaleValueRange: Math and Stats Tools #> RgbToIhs: Image Processing Tools #> Rho8FlowAccumulation: Hydrological Analysis #> Rho8Pointer: Hydrological Analysis #> RobertsCrossFilter: Image Processing Tools/Filters #> RootMeanSquareError: Math and Stats Tools #> Round: Math and Stats Tools #> RuggednessIndex: Geomorphometric Analysis #> ScharrFilter: Image Processing Tools/Filters #> SedimentTransportIndex: Geomorphometric Analysis #> SelectTilesByPolygon: LiDAR Tools #> SetNodataValue: Data Tools #> ShapeComplexityIndex: GIS Analysis/Patch Shape Tools #> ShapeComplexityIndexRaster: GIS Analysis/Patch Shape Tools #> ShreveStreamMagnitude: Stream Network Analysis #> SigmoidalContrastStretch: Image Processing Tools/Image Enhancement #> Sin: Math and Stats Tools #> SinglePartToMultiPart: Data Tools #> Sinh: Math and Stats Tools #> Sink: Hydrological Analysis #> Slope: Geomorphometric Analysis #> SlopeVsElevationPlot: Geomorphometric Analysis #> SmoothVectors: GIS Analysis #> SnapPourPoints: Hydrological Analysis #> SobelFilter: Image Processing Tools/Filters #> SphericalStdDevOfNormals: Geomorphometric Analysis #> SplitColourComposite: Image Processing Tools #> SplitVectorLines: GIS Analysis #> SplitWithLines: GIS Analysis/Overlay Tools #> Square: Math and Stats Tools #> SquareRoot: Math and Stats Tools #> StandardDeviationContrastStretch: Image Processing Tools/Image Enhancement #> StandardDeviationFilter: Image Processing Tools/Filters #> StandardDeviationOfSlope: Geomorphometric Analysis #> StochasticDepressionAnalysis: Hydrological Analysis #> StrahlerOrderBasins: Hydrological Analysis #> StrahlerStreamOrder: Stream Network Analysis #> StreamLinkClass: Stream Network Analysis #> StreamLinkIdentifier: Stream Network Analysis #> StreamLinkLength: Stream Network Analysis #> StreamLinkSlope: Stream Network Analysis #> StreamPowerIndex: Geomorphometric Analysis #> StreamSlopeContinuous: Stream Network Analysis #> Subbasins: Hydrological Analysis #> Subtract: Math and Stats Tools #> SumOverlay: GIS Analysis/Overlay Tools #> SurfaceAreaRatio: Geomorphometric Analysis #> SymmetricalDifference: GIS Analysis/Overlay Tools #> TINGridding: GIS Analysis #> Tan: Math and Stats Tools #> TangentialCurvature: Geomorphometric Analysis #> Tanh: Math and Stats Tools #> ThickenRasterLine: Image Processing Tools #> TimeInDaylight: Geomorphometric Analysis #> ToDegrees: Math and Stats Tools #> ToRadians: Math and Stats Tools #> TophatTransform: Image Processing Tools #> TopographicHachures: Geomorphometric Analysis #> TopologicalStreamOrder: Stream Network Analysis #> TotalCurvature: Geomorphometric Analysis #> TotalFilter: Image Processing Tools/Filters #> TraceDownslopeFlowpaths: Hydrological Analysis #> TravellingSalesmanProblem: GIS Analysis #> TrendSurface: Math and Stats Tools #> TrendSurfaceVectorPoints: Math and Stats Tools #> TributaryIdentifier: Stream Network Analysis #> Truncate: Math and Stats Tools #> TurningBandsSimulation: Math and Stats Tools #> TwoSampleKsTest: Math and Stats Tools #> Union: GIS Analysis/Overlay Tools #> UnnestBasins: Hydrological Analysis #> UnsharpMasking: Image Processing Tools/Filters #> UpdateNodataCells: GIS Analysis/Overlay Tools #> UpslopeDepressionStorage: Hydrological Analysis #> UserDefinedWeightsFilter: Image Processing Tools/Filters #> VectorHexBinning: GIS Analysis #> VectorLinesToRaster: Data Tools #> VectorPointsToRaster: Data Tools #> VectorPolygonsToRaster: Data Tools #> VectorStreamNetworkAnalysis: Stream Network Analysis #> Viewshed: Geomorphometric Analysis #> VisibilityIndex: Geomorphometric Analysis #> VoronoiDiagram: GIS Analysis #> Watershed: Hydrological Analysis #> WeightedOverlay: GIS Analysis/Overlay Tools #> WeightedSum: GIS Analysis/Overlay Tools #> WetnessIndex: Geomorphometric Analysis #> WilcoxonSignedRankTest: Math and Stats Tools #> WriteFunctionMemoryInsertion: Image Processing Tools #> Xor: Math and Stats Tools #> ZScores: Math and Stats Tools #> ZlidarToLas: LiDAR Tools #> ZonalStatistics: Math and Stats Tools"},{"path":"/articles/demo.html","id":"wbt_tool_parameters","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_tool_parameters()","title":"whitebox Demo","text":"wbt_tool_parameters() retrieves tool parameter descriptions specific tool JSON formatted string.","code":"wbt_tool_parameters(\"slope\") #> {\"parameters\": [{\"name\":\"Input DEM File\",\"flags\":[\"-i\",\"--dem\"],\"description\":\"Input raster DEM file.\",\"parameter_type\":{\"ExistingFile\":\"Raster\"},\"default_value\":null,\"optional\":false},{\"name\":\"Output File\",\"flags\":[\"-o\",\"--output\"],\"description\":\"Output raster file.\",\"parameter_type\":{\"NewFile\":\"Raster\"},\"default_value\":null,\"optional\":false},{\"name\":\"Z Conversion Factor\",\"flags\":[\"--zfactor\"],\"description\":\"Optional multiplier for when the vertical and horizontal units are not the same.\",\"parameter_type\":\"Float\",\"default_value\":null,\"optional\":true},{\"name\":\"Units\",\"flags\":[\"--units\"],\"description\":\"Units of output raster; options include 'degrees', 'radians', 'percent'\",\"parameter_type\":{\"OptionList\":[\"degrees\",\"radians\",\"percent\"]},\"default_value\":\"degrees\",\"optional\":true}]}"},{"path":"/articles/demo.html","id":"wbt_view_code","dir":"Articles","previous_headings":"Appendix: wbt_* utility functions","what":"wbt_view_code()","title":"whitebox Demo","text":"WhiteboxTools written Rust open source. can view source code specific tool source code repository. Use argument viewer=TRUE use browseURL() open browser window corresponding GitHub page.","code":"wbt_view_code(\"breach_depressions\") #> https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/hydro_analysis/breach_depressions.rs"},{"path":"/articles/wbt-method.html","id":"wbt","dir":"Articles","previous_headings":"","what":"wbt()","title":"`wbt()` method: call 'Whitebox' tools by name","text":"wbt() method high-level wrapper function manage flow information R WhiteboxTools. wbt() one can run sequential analyses Whitebox R prepare inputs, generate commands, visualize results.","code":"library(whitebox)"},{"path":"/articles/wbt-method.html","id":"getting-started","dir":"Articles","previous_headings":"wbt()","what":"Getting Started","title":"`wbt()` method: call 'Whitebox' tools by name","text":"Know tool want run can’t remember required parameters? Just type wbt(\"toolname\") Output produced error invalid arguments helps guide use interactively prompting required optional arguments checklist.","code":"wbt(\"slope\") #> Required arguments: #> - [ ] dem -- Input raster DEM file. #> - [ ] output -- Output raster file. #>  #> Optional arguments: #> - [ ] zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. #> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent' #>  #> No parameters (Slope) #>  #>  Slope ERROR: 'dem', 'output' required"},{"path":"/articles/wbt-method.html","id":"result-objects","dir":"Articles","previous_headings":"wbt()","what":"Result Objects","title":"`wbt()` method: call 'Whitebox' tools by name","text":"calls wbt() return S3 object class wbt_result. Whether system call succeeds fails parameters passed WhiteboxTools executable references output file paths specified returned. output files reference spatial data (e.g. GeoTIFF file) may converted file-based R object providing information result. call fails informative error message issued, error cached inside result. Prior runs references stored well sequential tool runs; .","code":"# get file path of sample DEM dem <- sample_dem_data()  wbt(\"slope\", dem = dem, output = file.path(tempdir(), \"slope.tif\")) #>  #> --- PARAMETERS (Slope) --- #> dem  : '/home/runner/work/_temp/Library/whitebox/extdata/DEM.tif' #> output   : '/tmp/RtmpTo4IsY/slope.tif'  #> --- RESULT --- #> $output #>   File result:  //tmp/RtmpTo4IsY/slope.tif exists (Last modified: 2024-05-27 13:49:06.160806) wbt(\"slope\", goof = dem, output = file.path(tempdir(), \"slope.tif\")) #> Error: invalid parameter 'goof' #> Required arguments: #> - [ ] dem -- Input raster DEM file. #> - [*] output -- Output raster file. #>  #> Optional arguments: #> - [ ] zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. #> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent' #>  #> --- PARAMETERS (Slope) --- #> goof : '/home/runner/work/_temp/Library/whitebox/extdata/DEM.tif' #> output   : '/tmp/RtmpTo4IsY/slope.tif'  #>  #>  Slope ERROR: 'goof' invalid; 'dem' required"},{"path":"/articles/wbt-method.html","id":"wbt_result-class","dir":"Articles","previous_headings":"wbt() > Result Objects","what":"wbt_result class","title":"`wbt()` method: call 'Whitebox' tools by name","text":"wbt_result class object base R list() standard element names (\"tool\", \"args\", \"stdout\", \"crs\", \"result\", \"history\") \"class\" attribute \"wbt_result\". output produced tool (usually file paths set user) included wbt_result$result list.","code":"str(wbt(\"slope\", dem = dem, output = file.path(tempdir(), \"slope.tif\")), max.level = 1) #> List of 6 #>  $ tool   : chr \"Slope\" #>  $ args   : chr \"--dem=/home/runner/work/_temp/Library/whitebox/extdata/DEM.tif --output=/tmp/RtmpTo4IsY/slope.tif\" #>  $ stdout : chr \"Slope - Elapsed Time (excluding I/O): 0.11s\" #>  $ crs    : chr \"\" #>   ..- attr(*, \"package\")= Named chr \"\" #>   .. ..- attr(*, \"names\")= chr \"dem\" #>  $ result :List of 1 #>  $ history:List of 1 #>  - attr(*, \"class\")= chr \"wbt_result\""},{"path":"/articles/wbt-method.html","id":"wbt_result-on-error","dir":"Articles","previous_headings":"wbt() > Result Objects","what":"wbt_result on error","title":"`wbt()` method: call 'Whitebox' tools by name","text":"error try-error class object error message returned lieu list $result","code":"# on error there is a try-error object in $result x <- wbt(\"slope\") #> Required arguments: #> - [ ] dem -- Input raster DEM file. #> - [ ] output -- Output raster file. #>  #> Optional arguments: #> - [ ] zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. #> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent' inherits(x$result, 'try-error') #> [1] TRUE message(x$result[1]) #> ERROR: 'dem', 'output' required"},{"path":"/articles/wbt-method.html","id":"vignette-topics","dir":"Articles","previous_headings":"wbt()","what":"Vignette Topics","title":"`wbt()` method: call 'Whitebox' tools by name","text":"now cover wbt() method wbt_result class can used following: Input Output R spatial objects Running Sequences Tools (optionally: pipe |> %>%) Handling Coordinate Reference Systems","code":""},{"path":"/articles/wbt-method.html","id":"input-and-output-with-r-spatial-objects","dir":"Articles","previous_headings":"","what":"Input and Output with R spatial objects","title":"`wbt()` method: call 'Whitebox' tools by name","text":"feature wbt() handles input/output file name management using R objects input. can onerous task manage files workflows involving many tool runs. use terra object input, get SpatRaster. use raster object input object frontend, get RasterLayer object output tools produce raster. file paths associated R object.","code":""},{"path":"/articles/wbt-method.html","id":"compare-raster-and-terra-as-r-raster-object-frontends","dir":"Articles","previous_headings":"Input and Output with R spatial objects","what":"Compare raster and terra as R raster object frontends","title":"`wbt()` method: call 'Whitebox' tools by name","text":"user still needs specify paths wbt() eases process converting input objects paths reading output paths R objects tool run. principle R object references file type Whitebox supports can handled current (simple; proof concept) system. Using file-based representations may efficient, allows tangible trail steps workflow followed otherwise might hard track.","code":"if (requireNamespace(\"raster\")) {   rdem <- raster::raster(dem)    # raster input; raster output   r1 <- wbt(\"slope\", dem = rdem, output = file.path(tempdir(), \"slope.tif\"))   r1   class(r1$result$output) } #> Loading required namespace: raster #> [1] \"RasterLayer\" #> attr(,\"package\") #> [1] \"raster\" tdem <- terra::rast(dem)  ## terra input; terra output t1 <- wbt(\"slope\", dem = tdem, output =  file.path(tempdir(), \"slope.tif\")) t1 #>  #> --- PARAMETERS (Slope) --- #> dem  : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e574d43b9f7.tif' #> output   : '/tmp/RtmpTo4IsY/slope.tif'  #> --- RESULT --- #> $output #> class       : SpatRaster  #> dimensions  : 188, 237, 1  (nrow, ncol, nlyr) #> resolution  : 90, 90  (x, y) #> extent      : 664692, 686022, 4878904, 4895824  (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83 / UTM zone 18N (EPSG:26918)  #> source      : slope.tif  #> name        : slope class(t1$result$output) #> [1] \"SpatRaster\" #> attr(,\"package\") #> [1] \"terra\""},{"path":"/articles/wbt-method.html","id":"wbt_source-rasters-in-memory-and-vector-data","dir":"Articles","previous_headings":"","what":"wbt_source(): rasters in memory, and vector data","title":"`wbt()` method: call 'Whitebox' tools by name","text":"terra raster packages use pointers file/raster connection except grid entirely memory. Processing types rasters whitebox requires writing temporary GeoTIFF file tool input. general wbt() can handle . Vector data (point, line polygon geometries) commonly stored stored sf data.frames, sp objects, terra SpatVector objects. types read memory creation. Reading vector data R memory needed run Whitebox tools, wbt_source() provides means annotate objects information source file path (similar terra/raster handle raster sources) can processed wbt() minimal overhead. Objects like terra SpatVectorProxy use delayed read default. Passing file path wbt_source() create SpatVectorProxy necessary information use wbt(). instance, can create reference sample ESRI Shapefile via wbt_source(). result SpatVectorProxy. SpatVectorProxy provides light-weight means create R object reference large file; allowing “heavy” lifting file done primarily WhiteboxTools (GDAL via {terra}). time writing document, WhiteboxTools support vector data inputs Shapefile. , example, GeoPackage, wbt_source() convert input temporary shapefile return SpatVectorProxy references file. object can used input wbt().","code":"library(terra) #> terra 1.7.79 shp <- system.file(\"ex/lux.shp\", package = \"terra\") x <- wbt_source(shp) x #>  class       : SpatVectorProxy #>  geometry    : polygons  #>  dimensions  : 12, 6  (geometries, attributes) #>  extent      : 5.74414, 6.528252, 49.44781, 50.18162  (xmin, xmax, ymin, ymax) #>  source      : lux.shp #>  coord. ref. : lon/lat WGS 84 (EPSG:4326)  #>  names       :  ID_1 NAME_1  ID_2 NAME_2  AREA   POP #>  type        :         # load the data x2 <- query(x)  # remove area column x2$AREA <- NULL  # create a GeoPackage terra::writeVector(x2, filename = file.path(tempdir(), \"lux.gpkg\"), overwrite = TRUE) #> Warning in x@ptr$write(filename, layer, filetype, insert[1], overwrite[1], : #> GDAL Message 6: dataset /tmp/RtmpTo4IsY/lux.gpkg does not support layer #> creation option ENCODING # now the source is a temporary .shp x3 <- wbt_source(file.path(tempdir(), \"lux.gpkg\"))  wbt(\"polygon_area\", input = x3) #>  #> --- PARAMETERS (PolygonArea) --- #> input    : '/tmp/RtmpTo4IsY/lux.gpkg_file3e576b34a951.shp'  #> --- RESULT --- #> $output #>  class       : SpatVectorProxy #>  geometry    : polygons  #>  dimensions  : 12, 6  (geometries, attributes) #>  extent      : 5.74414, 6.528252, 49.44781, 50.18162  (xmin, xmax, ymin, ymax) #>  source      : lux.gpkg_file3e576b34a951.shp #>  coord. ref. : lon/lat WGS 84 (EPSG:4326)  #>  names       :  ID_1 NAME_1  ID_2 NAME_2   POP  AREA #>  type        :        "},{"path":"/articles/wbt-method.html","id":"running-sequences-of-tools","dir":"Articles","previous_headings":"","what":"Running Sequences of Tools","title":"`wbt()` method: call 'Whitebox' tools by name","text":"call wbt() first argument wbt_result output input wbt_result passed first input new tool run. general “pass output first input” works even first input parameter (\"-\" flag) something different dem input1. makes possible chain different operations together sequence. required parameters specified tool run. run “Slope” DEM, run “Slope” get second derivative “curvature”.","code":"x <- wbt(\"slope\", dem = dem, output = file.path(tempdir(), \"slope.tif\")) x2 <- wbt(x, tool_name = \"slope\", output = file.path(tempdir(), \"curvature.tif\"))"},{"path":"/articles/wbt-method.html","id":"using-pipes","dir":"Articles","previous_headings":"Running Sequences of Tools","what":"Using pipes","title":"`wbt()` method: call 'Whitebox' tools by name","text":"Nested chained operation syntax can transformed use pipe operators ({base} R 4.1+ |> {magrittr} %>%). can improve readability code (fewer nested parentheses) first argument transfer behavior allows results step transferred input next. wbt_result output prints console reflect input/output parameters recent tool run tool chain. wbt_result() method get $result single runs $result $history chained runs wbt_result object. $history element list wbt_result individual runs. pass invalid results one step next, get informative error message.","code":"wbt(\"slope\", dem = dem, output = file.path(tempdir(), \"slope.tif\")) |>   wbt(\"slope\", output = file.path(tempdir(), \"curvature.tif\")) x2 #>  #> --- PARAMETERS (Slope) --- #> dem  : '//tmp/RtmpTo4IsY/slope.tif' #> output   : '/tmp/RtmpTo4IsY/curvature.tif'  #> --- RESULT --- #> $output #>   File result:  //tmp/RtmpTo4IsY/curvature.tif exists (Last modified: 2024-05-27 13:49:08.588789) #> --- HISTORY --- #> Prior results (n=1) for: Slope  #>  - Slope (output) str(wbt_result(x2), max.level = 1) #>  chr [1:2] \"//tmp/RtmpTo4IsY/slope.tif\" \"//tmp/RtmpTo4IsY/curvature.tif\" str(x2$history, max.level = 1) #> List of 2 #>  $ :List of 5 #>   ..- attr(*, \"class\")= chr \"wbt_result\" #>  $ :List of 5 #>   ..- attr(*, \"class\")= chr \"wbt_result\" x <- wbt(\"slope\") #> Required arguments: #> - [ ] dem -- Input raster DEM file. #> - [ ] output -- Output raster file. #>  #> Optional arguments: #> - [ ] zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. #> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent' wbt(x, \"slope\", output = file.path(tempdir(), \"foo.tif\")) #> NOTE: try-error result cannot be used as `dem` #> Required arguments: #> - [ ] dem -- Input raster DEM file. #> - [*] output -- Output raster file. #>  #> Optional arguments: #> - [ ] zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. #> - [ ] units -- Units of output raster; options include 'degrees', 'radians', 'percent' #>  #> --- PARAMETERS (Slope) --- #> output   : '/tmp/RtmpTo4IsY/foo.tif'  #>  #>  Slope ERROR: 'dem' required  #> --- HISTORY --- #> Prior results (n=1) for: Slope  #>  - Slope ()"},{"path":"/articles/wbt-method.html","id":"coordinate-reference-systems-crs","dir":"Articles","previous_headings":"","what":"Coordinate Reference Systems (CRS)","title":"`wbt()` method: call 'Whitebox' tools by name","text":"top handling file paths necessary Geographic Information Systems handle Coordinate Reference System (CRS) information. Many R tools GDAL/PROJ sphere require valid CRS operate. WhiteboxTools read GeoKey information GeoTIFF files specified path propagate output file result. read files R, find original file’s CRS transferred. wbt() wbt_result help ensure consistent file CRS information across sequences operations within calls–especially involving R spatial objects. specified CRS R, made raster entirely R, might need hand setting file-based representation WhiteboxTools use. easy enough crs(), writeRaster() equivalent often requires boilerplate code just specifying argument, CRS propagate input. inputs file-based representation (e.g. RasterLayer SpatRaster objects) wbt() provides interface R objects can substituted file names vice versa. User workflow level attributes like CRS working directory handled time. process reading/writing files may contain CRS information, sample DEM, CRS can inspected, modified propagated file R objects.","code":"dem <- sample_dem_data()  ## equivalent to: # dem <- system.file(\"extdata/DEM.tif\", package = \"whitebox\")"},{"path":"/articles/wbt-method.html","id":"setting-the-crs","dir":"Articles","previous_headings":"Coordinate Reference Systems (CRS)","what":"Setting the CRS","title":"`wbt()` method: call 'Whitebox' tools by name","text":"CRS specified input SpatRaster object, wbt() makes sure propagated R object result. wbt() alter copy source output files may may CRS information. Alternately can specify crs argument wbt() instead rast(). directly set crs element wbt_result output. either case wherever specify crs argument crs stored wbt_result propagated relevant output. , source files unchanged CRS invalid CRS (write updated CRS file). two input R objects different () CRS wbt() method provide message user: message suppressed output CRS set accordingly crs argument specified. user set CRS SpatRaster object, necessarily match file used input returned output.","code":"araster <- terra::rast(dem) wbt(\"slope\", dem = araster, output = file.path(tempdir(), \"foo.tif\")) #>  #> --- PARAMETERS (Slope) --- #> dem  : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e57550f98f.tif' #> output   : '/tmp/RtmpTo4IsY/foo.tif'  #> --- RESULT --- #> $output #> class       : SpatRaster  #> dimensions  : 188, 237, 1  (nrow, ncol, nlyr) #> resolution  : 90, 90  (x, y) #> extent      : 664692, 686022, 4878904, 4895824  (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83 / UTM zone 18N (EPSG:26918)  #> source      : foo.tif  #> name        : foo wbt(\"slope\", dem = terra::rast(dem), crs = \"EPSG:26918\", output = file.path(tempdir(), \"foo.tif\")) #>  #> --- PARAMETERS (Slope) --- #> dem  : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e573510aabe.tif' #> output   : '/tmp/RtmpTo4IsY/foo.tif'  #> --- RESULT --- #> $output #> class       : SpatRaster  #> dimensions  : 188, 237, 1  (nrow, ncol, nlyr) #> resolution  : 90, 90  (x, y) #> extent      : 664692, 686022, 4878904, 4895824  (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83 / UTM zone 18N (EPSG:26918)  #> source      : foo.tif  #> name        : foo r1 <- terra::rast(dem) # default: EPSG:26918 r2 <- terra::deepcopy(r1) crs(r2) <- \"EPSG:26917\" # something else/wrong wbt(\"add\",      input1 = r1,      input2 = r2,      output = file.path(tempdir(), \"foo.tif\")    ) #> NOTE: Input CRS do not match. #>  #> --- PARAMETERS (Add) --- #> input1   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e57320ccaad.tif' #> input2   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e5720a6616b.tif' #> output   : '/tmp/RtmpTo4IsY/foo.tif'  #> --- RESULT --- #> $output #> class       : SpatRaster  #> dimensions  : 188, 237, 1  (nrow, ncol, nlyr) #> resolution  : 90, 90  (x, y) #> extent      : 664692, 686022, 4878904, 4895824  (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83 / UTM zone 18N (EPSG:26918)  #> source      : foo.tif  #> name        : foo wbt(\"add\",      input1 = r1,     input2 = r2,      crs = \"EPSG:26918\",     output = file.path(tempdir(), \"foo.tif\")    ) #>  #> --- PARAMETERS (Add) --- #> input1   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e572052046b.tif' #> input2   : '/home/runner/work/whiteboxR/whiteboxR/vignettes/file3e573c4e050b.tif' #> output   : '/tmp/RtmpTo4IsY/foo.tif'  #> --- RESULT --- #> $output #> class       : SpatRaster  #> dimensions  : 188, 237, 1  (nrow, ncol, nlyr) #> resolution  : 90, 90  (x, y) #> extent      : 664692, 686022, 4878904, 4895824  (xmin, xmax, ymin, ymax) #> coord. ref. : NAD83 / UTM zone 18N (EPSG:26918)  #> source      : foo.tif  #> name        : foo"},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Qiusheng Wu. Author. Andrew Brown. Contributor, maintainer.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Wu, Q., Brown, . (2022). whitebox: 'WhiteboxTools' R Frontend. R package version 2.2.0.  Lindsay, J. B. (2016). Whitebox GAT: case study geomorphometric analysis. Computers & Geosciences, 95, 75-84. doi: http://dx.doi.org/10.1016/j.cageo.2016.07.003","code":"@Manual{,   title = {'whitebox': 'WhiteboxTools' R Frontend},   author = {Qiusheng Wu and Andrew Brown},   note = {R package version 2.2.0},   url = {https://CRAN.R-project.org/package=whitebox},   year = {2022}, } @Article{,   title = {Whitebox GAT: A case study in geomorphometric analysis.},   author = {J. B. Lindsay},   journal = {Computers & Geosciences},   year = {2016},   volume = {95},   pages = {75-84},   url = {http://dx.doi.org/10.1016/j.cageo.2016.07.003}, }"},{"path":"/index.html","id":"whitebox","dir":"","previous_headings":"","what":"WhiteboxTools R Frontend","title":"WhiteboxTools R Frontend","text":"WhiteboxTools R Frontend. repository related whitebox R package geospatial analysis, R frontend stand-alone executable command-line program called WhiteboxTools. Authors: John Lindsay (https://jblindsay.github.io/ghrg/index.html) Qiusheng Wu (https://wetlands.io) Andrew G. Brown (https://humus.rocks) GitHub repo: https://github.com/opengeos/whiteboxR CRAN link: https://cran.r-project.org/package=whitebox WhiteboxTools: https://github.com/jblindsay/whitebox-tools User Manual: https://jblindsay.github.io/wbt_book/ Free software: MIT license Contents Description Installation Usage Available Tools Contributing License Reporting Bugs","code":""},{"path":"/index.html","id":"description","dir":"","previous_headings":"","what":"Description","title":"WhiteboxTools R Frontend","text":"whitebox R package built WhiteboxTools, advanced geospatial data analysis platform developed Prof. John Lindsay (webpage; jblindsay) University Guelph’s Geomorphometry Hydrogeomatics Research Group. WhiteboxTools can used perform common geographical information systems (GIS) analysis operations, cost-distance analysis, distance buffering, raster reclassification. Remote sensing image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), common image transformations. WhiteboxTools also contains advanced tooling spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), LiDAR data processing. LiDAR point clouds can interrogated (LidarInfo, LidarHistogram), segmented, tiled joined, analyzed outliers, interpolated rasters (DEMs, intensity images), ground-points can classified filtered. WhiteboxTools cartographic spatial data visualization package; instead meant serve analytical backend data visualization software, mainly GIS. Suggested citation: Lindsay, J. B. (2016). Whitebox GAT: case study geomorphometric analysis. Computers & Geosciences, 95, 75-84. doi: http://dx.doi.org/10.1016/j.cageo.2016.07.003","code":""},{"path":"/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"WhiteboxTools R Frontend","text":"three ways install whitebox R package.","code":""},{"path":"/index.html","id":"id_1-cran","dir":"","previous_headings":"Installation","what":"1. CRAN","title":"WhiteboxTools R Frontend","text":"whitebox now available CRAN, can install :","code":"install.packages(\"whitebox\")"},{"path":"/index.html","id":"id_2-github","dir":"","previous_headings":"Installation","what":"2. GitHub","title":"WhiteboxTools R Frontend","text":"can alternatively install development version whitebox GitHub follows:","code":"if (!require(\"remotes\")) install.packages('remotes') remotes::install_github(\"opengeos/whiteboxR\", build = FALSE)"},{"path":"/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"WhiteboxTools R Frontend","text":"function wbt_init() checks path ‘WhiteboxTools’ binary. (invisibly) returns logical (TRUE/FALSE) value reflecting whether file found one default paths, including specified package options. See ?whitebox::whitebox. ‘WhiteboxTools’ installed already non-standard location run wbt_init(exe_path=...) set options current R session. Additional arguments wbt_init() can set package options, whether tools print standard console output cat(). want turn , set verbose = FALSE, instance:","code":"wbt_init() wbt_init(exe_path = 'C:/home/user/path/to/whitebox_tools.exe') wbt_init(exe_path = 'C:/home/user/path/to/whitebox_tools.exe', verbose = FALSE)"},{"path":"/index.html","id":"documentation","dir":"","previous_headings":"","what":"Documentation","title":"WhiteboxTools R Frontend","text":"whitebox package documentation R, ask help: list functions, try wbt_ prefix search: complete list functions available whitebox R package can found . Check demo examples.","code":"??whitebox ??wbt_"},{"path":"/index.html","id":"installing-whiteboxtools","dir":"","previous_headings":"","what":"Installing ‘WhiteboxTools’","title":"WhiteboxTools R Frontend","text":"quickest way get started 64-bit Windows, Linux MacOS architectures download install ‘WhiteboxTools’ binary. Linux binaries compiled ‘musl’ instead ‘glibc’ Ubuntu 22.04 available platform=\"linux_musl\". MacOS, Intel Apple ‘M’ series processors (‘arm64’) supported. method install_whitebox() provided download version binaries corresponds wrapper functions available package. default install ‘WhiteboxTools’ whitebox R package data directory (see wbt_data_dir()), subdirectory “WBT”.","code":"whitebox::install_whitebox()"},{"path":"/index.html","id":"whitebox-1","dir":"","previous_headings":"","what":"whitebox","title":"WhiteboxTools R Frontend","text":"run tools? Tool names whitebox R package can called corresponding function using wbt_snake_case() naming convention (e.g. wbt_lidar_info() R function \"LidarInfo\" ‘WhiteboxTools’ tool name). First load library perform necessary setup. Many ‘WhiteboxTools’ take GeoTIFF files input, ‘WhiteboxTools’ supports several grid input formats. sample Digital Elevation Model (DEM) included whitebox package. can get path follows demo: use DEM sequence ‘WhiteboxTools’ processing routines. Run tools passing file paths input output files. Apply feature-preserving smoothing (FeaturePreservingSmoothing) Breach depressions DEM (BreachDepressions) Calculate D-Infinity flow accumulation (DInfFlowAccumulation) filter argument wbt_feature_preserving_smoothing() sets size filter kernel.  ‘WhiteboxTools’","code":"library(whitebox)  # set up as needed wbt_init() # Set input raster DEM file dem <- sample_dem_data() ## 1. FeaturePreservingSmoothing wbt_feature_preserving_smoothing(   dem = dem,   output = \"./smoothed.tif\",   filter = 9 )  ## 2. BreachDepressions wbt_breach_depressions(dem = \"./smoothed.tif\", output = \"./breached.tif\")  ## 3. DInfFlowAccumulation wbt_d_inf_flow_accumulation(input = dem, output = \"./flow_accum.tif\")  if (requireNamespace('terra')) {   terra::plot(terra::rast(\"./flow_accum.tif\")) } #> Loading required namespace: terra library(whitebox)  # cat() output in non-interactive mode wbt_verbose(TRUE)  # Prints the whitebox-tools help...a listing of available commands wbt_help() #> WhiteboxTools Help #>  #> The following commands are recognized: #> --cd, --wd          Changes the working directory; used in conjunction with --run flag. #> --compress_rasters  Sets the compress_raster option in the settings.json file; determines if newly created rasters are compressed. e.g. --compress_rasters=true #> -h, --help          Prints help information. #> -l, --license       Prints the whitebox-tools license. Tool names may also be used, --license=\"Slope\" #> --listtools         Lists all available tools. Keywords may also be used, --listtools slope. #> --max_procs         Sets the maximum number of processors used. -1 = all available processors. e.g. --max_procs=2 #> -r, --run           Runs a tool; used in conjunction with --wd flag; -r=\"LidarInfo\". #> --toolbox           Prints the toolbox associated with a tool; --toolbox=Slope. #> --toolhelp          Prints the help associated with a tool; --toolhelp=\"LidarInfo\". #> --toolparameters    Prints the parameters (in json form) for a specific tool; --toolparameters=\"LidarInfo\". #> -v                  Verbose mode. Without this flag, tool outputs will not be printed. #> --viewcode          Opens the source code of a tool in a web browser; --viewcode=\"LidarInfo\". #> --version           Prints the version information. #>  #> Example Usage: #> >> ./whitebox_tools -r=lidar_info --cd=\"/path/to/data/\" -i=input.las --vlr --geokeys   # Prints the whitebox-tools license wbt_license() #> WhiteboxTools License #> Copyright 2017-2023 John Lindsay #>  #> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and #> associated documentation files (the \"Software\"), to deal in the Software without restriction, #> including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, #> and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, #> subject to the following conditions: #>  #> The above copyright notice and this permission notice shall be included in all copies or substantial #> portions of the Software. #>  #> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT #> NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND #> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES #> OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN #> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.   # Prints the whitebox-tools version wbt_version() #> WhiteboxTools v2.4.0 (c) Dr. John Lindsay 2017-2023 #>  #> WhiteboxTools is an advanced geospatial data analysis platform developed at #> the University of Guelph's Geomorphometry and Hydrogeomatics Research  #> Group (GHRG). See www.whiteboxgeo.com for more details.   # Prints the toolbox for a specific tool. wbt_toolbox(\"AsciiToLas\") #> LiDAR Tools   # Lists tools with 'lidar' in tool name or description. wbt_list_tools(\"lidar\") #> All 66 Tools containing keywords: #> AsciiToLas: Converts one or more ASCII files containing LiDAR points into LAS files. #> ClassifyBuildingsInLidar: Reclassifies a LiDAR points that lie within vector building footprints. #> ClassifyOverlapPoints: Classifies or filters LAS points in regions of overlapping flight lines. #> ClipLidarToPolygon: Clips a LiDAR point cloud to a vector polygon or polygons. #> ErasePolygonFromLidar: Erases (cuts out) a vector polygon or polygons from a LiDAR point cloud. #> FilterLidarClasses: Removes points in a LAS file with certain specified class values. #> FilterLidarScanAngles: Removes points in a LAS file with scan angles greater than a threshold. #> FindFlightlineEdgePoints: Identifies points along a flightline's edge in a LAS file. #> FlightlineOverlap: Reads a LiDAR (LAS) point file and outputs a raster containing the number of overlapping flight-lines in each grid cell. #> HeightAboveGround: Normalizes a LiDAR point cloud, providing the height above the nearest ground-classified point. #> LasToAscii: Converts one or more LAS files into ASCII text files. #> LasToMultipointShapefile: 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. #> LasToShapefile: Converts one or more LAS files into a vector Shapefile of POINT ShapeType. #> LasToZlidar: Converts one or more LAS files into the zlidar compressed LiDAR data format. #> LidarBlockMaximum: 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. #> LidarBlockMinimum: 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. #> LidarClassifySubset: Classifies the values in one LiDAR point cloud that correspond with points in a subset cloud. #> LidarColourize: Adds the red-green-blue colour fields of a LiDAR (LAS) file based on an input image. #> LidarDigitalSurfaceModel: Creates a top-surface digital surface model (DSM) from a LiDAR point cloud. #> LidarElevationSlice: Outputs all of the points within a LiDAR (LAS) point file that lie between a specified elevation range. #> LidarGroundPointFilter: Identifies ground points within LiDAR dataset using a slope-based method. #> LidarHexBinning: Hex-bins a set of LiDAR points. #> LidarHillshade: Calculates a hillshade value for points within a LAS file and stores these data in the RGB field. #> LidarHistogram: Creates a histogram of LiDAR data. #> LidarIdwInterpolation: 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. #> LidarInfo: 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. #> LidarJoin: Joins multiple LiDAR (LAS) files into a single LAS file. #> LidarKappaIndex: Performs a kappa index of agreement (KIA) analysis on the classifications of two LAS files. #> LidarNearestNeighbourGridding: 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. #> LidarPointDensity: 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. #> LidarPointStats: 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. #> LidarRansacPlanes: Performs a RANSAC analysis to identify points within a LiDAR point cloud that belong to linear planes. #> LidarRbfInterpolation: 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. #> LidarRemoveDuplicates: Removes duplicate points from a LiDAR data set. #> LidarRemoveOutliers: Removes outliers (high and low points) in a LiDAR point cloud. #> LidarRooftopAnalysis: Identifies roof segments in a LiDAR point cloud. #> LidarSegmentation: Segments a LiDAR point cloud based on differences in the orientation of fitted planar surfaces and point proximity. #> LidarSegmentationBasedFilter: Identifies ground points within LiDAR point clouds using a segmentation based approach. #> LidarTINGridding: Creates a raster grid based on a Delaunay triangular irregular network (TIN) fitted to LiDAR points. #> LidarThin: Thins a LiDAR point cloud, reducing point density. #> LidarThinHighDensity: Thins points from high density areas within a LiDAR point cloud. #> LidarTile: Tiles a LiDAR LAS file into multiple LAS files. #> LidarTileFootprint: 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. #> LidarTophatTransform: 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. #> NormalVectors: Calculates normal vectors for points within a LAS file and stores these data (XYZ vector components) in the RGB field. #> SelectTilesByPolygon: Copies LiDAR tiles overlapping with a polygon into an output directory. #> ZlidarToLas: Converts one or more zlidar files into the LAS data format. #> ModifyLidar: Modify points within a LiDAR point cloud based on point properties. #> ColourizeBasedOnPointReturns: Sets the RGB values of a LiDAR point cloud based on the point returns. #> FilterLidarByReferenceSurface: Filters points within a LiDAR point cloud based on a reference surface. #> SmoothVegetationResidual: This tool can smooth the residual roughness due to vegetation cover in LiDAR DEMs. #> SortLidar: Sorts LiDAR points based on their properties. #> IndividualTreeDetection: Identifies points in a LiDAR point cloud that are associated with the tops of individual trees. #> SplitLidar: Splits LiDAR points up into a series of new files based on their properties. #> RecoverFlightlineInfo: Associates LiDAR points by their flightlines. #> ColourizeBasedOnClass: Sets the RGB values of a LiDAR point cloud based on the point classification values. #> LidarPointReturnAnalysis: This tool performs a quality control check on the return values of points in a LiDAR file. #> LidarShift: Shifts the x,y,z coordinates of a LiDAR file. #> FilterLidarByPercentile: Filters points within a LiDAR point cloud based on local elevation percentile. #> LidarContour: This tool creates a vector contour coverage from an input LiDAR point file. #> ImprovedGroundPointFilter: Filters points within a LiDAR point cloud based on a reference surface. #> LidarSibsonInterpolation: This tool interpolates one or more LiDAR tiles using Sibson's natural neighbour method. #> ClassifyLidar: Classify points within a LiDAR point cloud based on point properties. #> LidarEigenvalueFeatures: Calculate eigenvalue-based metrics from a LiDAR point cloud. #> FilterLidar: Filters points within a LiDAR point cloud based on point properties. #> NormalizeLidar: Normalizes a LiDAR point cloud.   # Prints the help for a specific tool. wbt_tool_help(\"lidar_info\") #> LidarInfo #> Description: #> 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. #> Toolbox: LiDAR Tools #> Parameters: #>  #> Flag               Description #> -----------------  ----------- #> -i, --input        Input LiDAR file. #> -o, --output       Output HTML file for summary report. #> --density          Flag indicating whether or not to calculate the average point density and nominal point spacing. #> --vlr              Flag indicating whether or not to print the variable length records (VLRs). #> --geokeys          Flag indicating whether or not to print the geokeys. #>  #>  #> Example usage: #> >>./whitebox_tools -r=LidarInfo -v --wd=\"/path/to/data/\" -i=file.las --vlr --geokeys\" #> ./whitebox_tools -r=LidarInfo --wd=\"/path/to/data/\" -i=file.las   # Retrieves the tool parameter descriptions for a specific tool. wbt_tool_parameters(\"slope\") #> {\"parameters\": [{\"name\":\"Input DEM File\",\"flags\":[\"-i\",\"--dem\"],\"description\":\"Input raster DEM file.\",\"parameter_type\":{\"ExistingFile\":\"Raster\"},\"default_value\":null,\"optional\":false},{\"name\":\"Output File\",\"flags\":[\"-o\",\"--output\"],\"description\":\"Output raster file.\",\"parameter_type\":{\"NewFile\":\"Raster\"},\"default_value\":null,\"optional\":false},{\"name\":\"Z Conversion Factor\",\"flags\":[\"--zfactor\"],\"description\":\"Optional multiplier for when the vertical and horizontal units are not the same.\",\"parameter_type\":\"Float\",\"default_value\":null,\"optional\":true},{\"name\":\"Units\",\"flags\":[\"--units\"],\"description\":\"Units of output raster; options include 'degrees', 'radians', 'percent'\",\"parameter_type\":{\"OptionList\":[\"degrees\",\"radians\",\"percent\"]},\"default_value\":\"degrees\",\"optional\":true}]}   # View the source code for a specific tool on the source code repository. wbt_view_code(\"breach_depressions\") #> https://github.com/jblindsay/whitebox-tools/blob/master/whitebox-tools-app/src/tools/hydro_analysis/breach_depressions.rs"},{"path":"/index.html","id":"available-tools","dir":"","previous_headings":"","what":"Available Tools","title":"WhiteboxTools R Frontend","text":"WhiteboxTools library currently contains 537 tools, grouped based main function one following categories: Data Tools, GIS Analysis, Hydrological Analysis, Image Analysis, LiDAR Analysis, Mathematical Statistical Analysis, Stream Network Analysis, Terrain Analysis. listing available tools, complete documentation usage details, please see ‘WhiteboxTools’ User Manual. interested using ‘WhiteboxTools’ command-line program, check ‘WhiteboxTools’ Usage","code":""},{"path":"/index.html","id":"contributing","dir":"","previous_headings":"","what":"Contributing","title":"WhiteboxTools R Frontend","text":"like contribute project developer, follow instructions get started: Fork whiteboxR repository (https://github.com/opengeos/whiteboxR) Create feature branch (git checkout -b -new-feature) Commit changes (git commit -‘Add feature’) Push branch (git push origin -new-feature) Create new Pull Request Unless explicitly stated otherwise, contribution intentionally submitted inclusion work shall licensed MIT license without additional terms conditions.","code":""},{"path":"/index.html","id":"license","dir":"","previous_headings":"","what":"License","title":"WhiteboxTools R Frontend","text":"whitebox R package distributed MIT license, permissive open-source (free software) license.","code":""},{"path":"/index.html","id":"reporting-bugs","dir":"","previous_headings":"","what":"Reporting Bugs","title":"WhiteboxTools R Frontend","text":"whitebox distributed without warranty suitability application. encounter flaws software (.e. bugs) please report issue. Providing detailed description conditions bug occurred help identify bug. Use Issues tracker GitHub report issues software request feature enchancements. Please email Dr. Lindsay directly bugs.","code":""},{"path":"/reference/check_whitebox_binary.html","id":null,"dir":"Reference","previous_headings":"","what":"Check for 'WhiteboxTools' executable path — check_whitebox_binary","title":"Check for 'WhiteboxTools' executable path — check_whitebox_binary","text":"Check 'WhiteboxTools' executable path","code":""},{"path":"/reference/check_whitebox_binary.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check for 'WhiteboxTools' executable path — check_whitebox_binary","text":"","code":"check_whitebox_binary(silent = TRUE)"},{"path":"/reference/check_whitebox_binary.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check for 'WhiteboxTools' executable path — check_whitebox_binary","text":"silent logical. Print help installation/setting path. Default TRUE.","code":""},{"path":"/reference/check_whitebox_binary.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check for 'WhiteboxTools' executable path — check_whitebox_binary","text":"logical 'WhiteboxTools' executable file exists.","code":""},{"path":[]},{"path":"/reference/install_whitebox.html","id":null,"dir":"Reference","previous_headings":"","what":"Download and Install 'WhiteboxTools' — wbt_install","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"function downloads 'WhiteboxTools' binary needed. Pre-compiled binaries available download 64-bit Linux (default compiled glibc Ubuntu 22.04; use platform=\"linux_musl\" musl/earlier versions glibc), Windows Mac OS (ARM Intel) platforms. need WhiteboxTools another platform follow instructions build source: https://github.com/jblindsay/whitebox-tools","code":""},{"path":"/reference/install_whitebox.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"","code":"wbt_install(   pkg_dir = wbt_data_dir(),   platform = NULL,   force = FALSE,   remove = FALSE )  install_whitebox(   pkg_dir = wbt_data_dir(),   platform = NULL,   force = FALSE,   remove = FALSE )  wbt_install_extension(   extension = c(\"GeneralToolsetExtension\", \"AgricultureToolset\",     \"DemAndSpatialHydrologyToolset\", \"LidarAndRemoteSensingToolset\"),   platform = NULL,   destdir = dirname(wbt_exe_path(shell_quote = FALSE)) )"},{"path":"/reference/install_whitebox.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"pkg_dir default install path whitebox package \"WBT\" folder platform character. Optional: suffix used alternate platform names. Linux, can choose \"linux_amd64\" (default; Linux) \"linux_musl\" older glibc versions. macOS Darwin can choose \"darwin_amd64\" (default; macOS) \"darwin_m_series\" Apple M series hardware. Note wbt_install_extension() Apple M series use \"MacOS_ARM\". one Windows binary available: \"win_amd64\" (default; Windows). force logical. Force install? Default FALSE. remove=TRUE passed unlink() change permissions allow removal files/directories. remove logical. Remove contents \"WBT\" folder pkg_dir? Default: FALSE extension Extension name destdir Directory create /plugins/ directory extracting extensions","code":""},{"path":"/reference/install_whitebox.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"Prints location WhiteboxTools binary, found. NULL otherwise.","code":""},{"path":"/reference/install_whitebox.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"'WhiteboxTools' extensions can uninstalled passing remove=TRUE argument.","code":""},{"path":"/reference/install_whitebox.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Download and Install 'WhiteboxTools' — wbt_install","text":"","code":"if (FALSE) { install_whitebox() }"},{"path":"/reference/sample_dem_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Convenience method for path to sample DEM — sample_dem_data","title":"Convenience method for path to sample DEM — sample_dem_data","text":"Get file path DEM.tif stored extdata subfolder whitebox package installation directory. needed, download TIFF file GitHub.","code":""},{"path":"/reference/sample_dem_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convenience method for path to sample DEM — sample_dem_data","text":"","code":"sample_dem_data(   destfile = file.path(system.file(\"extdata\", package = \"whitebox\"), \"DEM.tif\"),   ... )"},{"path":"/reference/sample_dem_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convenience method for path to sample DEM — sample_dem_data","text":"destfile Path target location sample data. downloaded exist. Defaults file path extdata subfolder whitebox package installation directory. ... additional arguments download.file()","code":""},{"path":"/reference/sample_dem_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convenience method for path to sample DEM — sample_dem_data","text":"character.","code":""},{"path":"/reference/sample_dem_data.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convenience method for path to sample DEM — sample_dem_data","text":"","code":"if (check_whitebox_binary()) {   wbt_slope(sample_dem_data(), output = \"slope.tif\") } unlink(c('slope.tif', 'settings.json'))"},{"path":"/reference/wbt.html","id":null,"dir":"Reference","previous_headings":"","what":"Run WhiteboxTools by Tool Name — wbt","title":"Run WhiteboxTools by Tool Name — wbt","text":"required specify required arguments either paths files, R object types can associated file. wbt_result(): return combined list results either history wbt_result (present history=TRUE), result wbt_result","code":""},{"path":"/reference/wbt.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run WhiteboxTools by Tool Name — wbt","text":"","code":"wbt(   result,   tool_name,   ...,   crs = NULL,   verbose_mode = FALSE,   command_only = FALSE )  # S3 method for wbt_result wbt(   result,   tool_name,   ...,   crs = NULL,   verbose_mode = FALSE,   command_only = FALSE )  wbt_result(result, i = NULL, history = TRUE, attribute = \"output\")  # S3 method for character wbt(   result,   tool_name,   ...,   crs = NULL,   verbose_mode = FALSE,   command_only = FALSE )  # S3 method for `function` wbt(   result,   tool_name,   ...,   crs = NULL,   verbose_mode = FALSE,   command_only = FALSE )  # S3 method for missing wbt(   result,   tool_name,   ...,   crs = NULL,   verbose_mode = FALSE,   command_only = FALSE )"},{"path":"/reference/wbt.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run WhiteboxTools by Tool Name — wbt","text":"result object class wbt_result tool_name character. name tool run. tool/function name (.e. symbol) non-standard evaluated character. ... arguments tool crs character Optional: WKT Coordinate Reference System string, identifier EPSG code PROJ string verbose_mode passed wbt_run_tool() command_only Return command run system()? Default: FALSE Optional index result list element return result. Default whole list. history Default: TRUE returns list history results attribute Default: \"output\"","code":""},{"path":"/reference/wbt.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run WhiteboxTools by Tool Name — wbt","text":"list class \"wbt_result\" containing elements: tool - tool name args - arguments passed executable stdout - console output (result wbt_run_tool()) crs - Coordinate Reference System string (WKT PROJ) result - 'result' parameters (--output) can converted R objects run. list RasterLayer character. May try-error arguments specified incorrectly. history - history 'result' wbt_result passed input, recent output end list result attribute \"history\" present, otherwise result attribute. specified, just ith element list.","code":""},{"path":"/reference/wbt.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Run WhiteboxTools by Tool Name — wbt","text":"Supports SpatRaster / RasterLayer input / output. Arguments transformed source class passed WhiteboxTools executable standard character string arguments involving file paths. print help tool, see wbt_tool_help() tool_name may specified without quotes wbt_ prefix. e.g. \"wbt_slope\", wbt_slope, slope, \"slope\" identical.","code":""},{"path":[]},{"path":"/reference/wbt_absolute_value.html","id":null,"dir":"Reference","previous_headings":"","what":"Absolute value — wbt_absolute_value","title":"Absolute value — wbt_absolute_value","text":"Calculates absolute value every cell raster.","code":""},{"path":"/reference/wbt_absolute_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Absolute value — wbt_absolute_value","text":"","code":"wbt_absolute_value(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_absolute_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Absolute value — wbt_absolute_value","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_absolute_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Absolute value — wbt_absolute_value","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_accumulation_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Accumulation curvature — wbt_accumulation_curvature","title":"Accumulation curvature — wbt_accumulation_curvature","text":"tool calculates accumulation curvature input DEM.","code":""},{"path":"/reference/wbt_accumulation_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Accumulation curvature — wbt_accumulation_curvature","text":"","code":"wbt_accumulation_curvature(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_accumulation_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Accumulation curvature — wbt_accumulation_curvature","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_accumulation_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Accumulation curvature — wbt_accumulation_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_activate.html","id":null,"dir":"Reference","previous_headings":"","what":"Activate 'WhiteboxTools' Extensions — wbt_activate","title":"Activate 'WhiteboxTools' Extensions — wbt_activate","text":"Activate 'WhiteboxTools' Extensions","code":""},{"path":"/reference/wbt_activate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Activate 'WhiteboxTools' Extensions — wbt_activate","text":"","code":"wbt_activate(   email,   activation_key,   seat = 1,   destdir = dirname(wbt_exe_path(shell_quote = FALSE)) )"},{"path":"/reference/wbt_activate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Activate 'WhiteboxTools' Extensions — wbt_activate","text":"email Email Address activation_key Activation Key seat Seat Number (Default 1) destdir Directory containing whitebox_tools /plugins/ folder.","code":""},{"path":"/reference/wbt_activate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Activate 'WhiteboxTools' Extensions — wbt_activate","text":"0 success (invisibly). Try-error error.","code":""},{"path":"/reference/wbt_adaptive_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Adaptive filter — wbt_adaptive_filter","title":"Adaptive filter — wbt_adaptive_filter","text":"Performs adaptive filter image.","code":""},{"path":"/reference/wbt_adaptive_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Adaptive filter — wbt_adaptive_filter","text":"","code":"wbt_adaptive_filter(   input,   output,   filterx = 11,   filtery = 11,   threshold = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_adaptive_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Adaptive filter — wbt_adaptive_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. threshold Difference mean threshold, standard deviations. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_adaptive_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Adaptive filter — wbt_adaptive_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_add.html","id":null,"dir":"Reference","previous_headings":"","what":"Add — wbt_add","title":"Add — wbt_add","text":"Performs addition operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_add.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add — wbt_add","text":"","code":"wbt_add(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_add.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add — wbt_add","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_add.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add — wbt_add","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_add_point_coordinates_to_table.html","id":null,"dir":"Reference","previous_headings":"","what":"Add point coordinates to table — wbt_add_point_coordinates_to_table","title":"Add point coordinates to table — wbt_add_point_coordinates_to_table","text":"Modifies attribute table point vector adding fields containing point's X Y coordinates.","code":""},{"path":"/reference/wbt_add_point_coordinates_to_table.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add point coordinates to table — wbt_add_point_coordinates_to_table","text":"","code":"wbt_add_point_coordinates_to_table(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_add_point_coordinates_to_table.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add point coordinates to table — wbt_add_point_coordinates_to_table","text":"input Input vector Points file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_add_point_coordinates_to_table.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add point coordinates to table — wbt_add_point_coordinates_to_table","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_aggregate_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Aggregate raster — wbt_aggregate_raster","title":"Aggregate raster — wbt_aggregate_raster","text":"Aggregates raster lower resolution.","code":""},{"path":"/reference/wbt_aggregate_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Aggregate raster — wbt_aggregate_raster","text":"","code":"wbt_aggregate_raster(   input,   output,   agg_factor = 2,   type = \"mean\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_aggregate_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Aggregate raster — wbt_aggregate_raster","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. agg_factor Aggregation factor, pixels. type Statistic used fill output pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_aggregate_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Aggregate raster — wbt_aggregate_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_and.html","id":null,"dir":"Reference","previous_headings":"","what":"And — wbt_and","title":"And — wbt_and","text":"Performs logical operator two Boolean raster images.","code":""},{"path":"/reference/wbt_and.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"And — wbt_and","text":"","code":"wbt_and(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_and.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"And — wbt_and","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_and.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"And — wbt_and","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_anova.html","id":null,"dir":"Reference","previous_headings":"","what":"Anova — wbt_anova","title":"Anova — wbt_anova","text":"Performs analysis variance (ANOVA) test raster dataset.","code":""},{"path":"/reference/wbt_anova.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Anova — wbt_anova","text":"","code":"wbt_anova(   input,   features,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_anova.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Anova — wbt_anova","text":"input Input raster file path. See wbt_file_path() details. features Feature definition (class) raster. output Output HTML file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_anova.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Anova — wbt_anova","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_arc_cos.html","id":null,"dir":"Reference","previous_headings":"","what":"Arc cos — wbt_arc_cos","title":"Arc cos — wbt_arc_cos","text":"Returns inverse cosine (arccos) values raster.","code":""},{"path":"/reference/wbt_arc_cos.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Arc cos — wbt_arc_cos","text":"","code":"wbt_arc_cos(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_arc_cos.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Arc cos — wbt_arc_cos","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_arc_cos.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Arc cos — wbt_arc_cos","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_arc_sin.html","id":null,"dir":"Reference","previous_headings":"","what":"Arc sin — wbt_arc_sin","title":"Arc sin — wbt_arc_sin","text":"Returns inverse sine (arcsin) values raster.","code":""},{"path":"/reference/wbt_arc_sin.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Arc sin — wbt_arc_sin","text":"","code":"wbt_arc_sin(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_arc_sin.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Arc sin — wbt_arc_sin","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_arc_sin.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Arc sin — wbt_arc_sin","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_arc_tan.html","id":null,"dir":"Reference","previous_headings":"","what":"Arc tan — wbt_arc_tan","title":"Arc tan — wbt_arc_tan","text":"Returns inverse tangent (arctan) values raster.","code":""},{"path":"/reference/wbt_arc_tan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Arc tan — wbt_arc_tan","text":"","code":"wbt_arc_tan(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_arc_tan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Arc tan — wbt_arc_tan","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_arc_tan.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Arc tan — wbt_arc_tan","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_arcosh.html","id":null,"dir":"Reference","previous_headings":"","what":"Arcosh — wbt_arcosh","title":"Arcosh — wbt_arcosh","text":"Returns inverse hyperbolic cosine (arcosh) values raster.","code":""},{"path":"/reference/wbt_arcosh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Arcosh — wbt_arcosh","text":"","code":"wbt_arcosh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_arcosh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Arcosh — wbt_arcosh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_arcosh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Arcosh — wbt_arcosh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_arsinh.html","id":null,"dir":"Reference","previous_headings":"","what":"Arsinh — wbt_arsinh","title":"Arsinh — wbt_arsinh","text":"Returns inverse hyperbolic sine (arsinh) values raster.","code":""},{"path":"/reference/wbt_arsinh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Arsinh — wbt_arsinh","text":"","code":"wbt_arsinh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_arsinh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Arsinh — wbt_arsinh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_arsinh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Arsinh — wbt_arsinh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_artanh.html","id":null,"dir":"Reference","previous_headings":"","what":"Artanh — wbt_artanh","title":"Artanh — wbt_artanh","text":"Returns inverse hyperbolic tangent (arctanh) values raster.","code":""},{"path":"/reference/wbt_artanh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Artanh — wbt_artanh","text":"","code":"wbt_artanh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_artanh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Artanh — wbt_artanh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_artanh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Artanh — wbt_artanh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ascii_to_las.html","id":null,"dir":"Reference","previous_headings":"","what":"Ascii to las — wbt_ascii_to_las","title":"Ascii to las — wbt_ascii_to_las","text":"Converts one ASCII files containing LiDAR points LAS files.","code":""},{"path":"/reference/wbt_ascii_to_las.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ascii to las — wbt_ascii_to_las","text":"","code":"wbt_ascii_to_las(   inputs,   pattern,   proj = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ascii_to_las.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ascii to las — wbt_ascii_to_las","text":"inputs Input LiDAR  ASCII files (.csv). pattern Input field pattern. proj Well-known-text string EPSG code describing projection. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ascii_to_las.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ascii to las — wbt_ascii_to_las","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_aspect.html","id":null,"dir":"Reference","previous_headings":"","what":"Aspect — wbt_aspect","title":"Aspect — wbt_aspect","text":"Calculates aspect raster input DEM.","code":""},{"path":"/reference/wbt_aspect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Aspect — wbt_aspect","text":"","code":"wbt_aspect(   dem,   output,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_aspect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Aspect — wbt_aspect","text":"dem Input raster DEM file. output Output raster file. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_aspect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Aspect — wbt_aspect","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_assess_route.html","id":null,"dir":"Reference","previous_headings":"","what":"Assess route — wbt_assess_route","title":"Assess route — wbt_assess_route","text":"tool assesses route slope, elevation, visibility variation.","code":""},{"path":"/reference/wbt_assess_route.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Assess route — wbt_assess_route","text":"","code":"wbt_assess_route(   routes,   dem,   output,   length = \"\",   dist = 20,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_assess_route.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Assess route — wbt_assess_route","text":"routes Name input routes vector file. dem Name input DEM raster file. output Name output lines shapefile. length Maximum segment length (m). dist Search distance, grid cells, used visibility analysis. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_assess_route.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Assess route — wbt_assess_route","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_atan2.html","id":null,"dir":"Reference","previous_headings":"","what":"Atan2 — wbt_atan2","title":"Atan2 — wbt_atan2","text":"Returns 2-argument inverse tangent (atan2).","code":""},{"path":"/reference/wbt_atan2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Atan2 — wbt_atan2","text":"","code":"wbt_atan2(   input_y,   input_x,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_atan2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Atan2 — wbt_atan2","text":"input_y Input y raster file constant value (rise). input_x Input x raster file constant value (run). output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_atan2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Atan2 — wbt_atan2","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_attribute_correlation.html","id":null,"dir":"Reference","previous_headings":"","what":"Attribute correlation — wbt_attribute_correlation","title":"Attribute correlation — wbt_attribute_correlation","text":"Performs correlation analysis attribute fields vector database.","code":""},{"path":"/reference/wbt_attribute_correlation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attribute correlation — wbt_attribute_correlation","text":"","code":"wbt_attribute_correlation(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_attribute_correlation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attribute correlation — wbt_attribute_correlation","text":"input Input vector file path. See wbt_file_path() details. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_attribute_correlation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attribute correlation — wbt_attribute_correlation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_attribute_correlation_neighbourhood_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Attribute correlation neighbourhood analysis — wbt_attribute_correlation_neighbourhood_analysis","title":"Attribute correlation neighbourhood analysis — wbt_attribute_correlation_neighbourhood_analysis","text":"Performs correlation two input vector attributes within neighbourhood search windows.","code":""},{"path":"/reference/wbt_attribute_correlation_neighbourhood_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attribute correlation neighbourhood analysis — wbt_attribute_correlation_neighbourhood_analysis","text":"","code":"wbt_attribute_correlation_neighbourhood_analysis(   input,   field1,   field2,   radius = NULL,   min_points = NULL,   stat = \"pearson\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_attribute_correlation_neighbourhood_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attribute correlation neighbourhood analysis — wbt_attribute_correlation_neighbourhood_analysis","text":"input Input vector file path. See wbt_file_path() details. field1 First input field name (dependent variable) attribute table. field2 Second input field name (independent variable) attribute table. radius Search Radius (map units). min_points Minimum number points. stat Correlation type; one 'pearson' (default) 'spearman'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_attribute_correlation_neighbourhood_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attribute correlation neighbourhood analysis — wbt_attribute_correlation_neighbourhood_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_attribute_histogram.html","id":null,"dir":"Reference","previous_headings":"","what":"Attribute histogram — wbt_attribute_histogram","title":"Attribute histogram — wbt_attribute_histogram","text":"Creates histogram field values vector's attribute table.","code":""},{"path":"/reference/wbt_attribute_histogram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attribute histogram — wbt_attribute_histogram","text":"","code":"wbt_attribute_histogram(   input,   field,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_attribute_histogram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attribute histogram — wbt_attribute_histogram","text":"input Input vector file path. See wbt_file_path() details. field Input field name attribute table. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_attribute_histogram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attribute histogram — wbt_attribute_histogram","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_attribute_scattergram.html","id":null,"dir":"Reference","previous_headings":"","what":"Attribute scattergram — wbt_attribute_scattergram","title":"Attribute scattergram — wbt_attribute_scattergram","text":"Creates scattergram two field values vector's attribute table.","code":""},{"path":"/reference/wbt_attribute_scattergram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attribute scattergram — wbt_attribute_scattergram","text":"","code":"wbt_attribute_scattergram(   input,   fieldx,   fieldy,   output,   trendline = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_attribute_scattergram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attribute scattergram — wbt_attribute_scattergram","text":"input Input raster file path. See wbt_file_path() details. fieldx Input field name attribute table x-axis. fieldy Input field name attribute table y-axis. output Output HTML file (default name based input file unspecified). trendline Draw trendline. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_attribute_scattergram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attribute scattergram — wbt_attribute_scattergram","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_average_flowpath_slope.html","id":null,"dir":"Reference","previous_headings":"","what":"Average flowpath slope — wbt_average_flowpath_slope","title":"Average flowpath slope — wbt_average_flowpath_slope","text":"Measures average slope gradient grid cell upslope divide cells.","code":""},{"path":"/reference/wbt_average_flowpath_slope.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Average flowpath slope — wbt_average_flowpath_slope","text":"","code":"wbt_average_flowpath_slope(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_average_flowpath_slope.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Average flowpath slope — wbt_average_flowpath_slope","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_average_flowpath_slope.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Average flowpath slope — wbt_average_flowpath_slope","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_average_normal_vector_angular_deviation.html","id":null,"dir":"Reference","previous_headings":"","what":"Average normal vector angular deviation — wbt_average_normal_vector_angular_deviation","title":"Average normal vector angular deviation — wbt_average_normal_vector_angular_deviation","text":"Calculates circular variance aspect scale DEM.","code":""},{"path":"/reference/wbt_average_normal_vector_angular_deviation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Average normal vector angular deviation — wbt_average_normal_vector_angular_deviation","text":"","code":"wbt_average_normal_vector_angular_deviation(   dem,   output,   filter = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_average_normal_vector_angular_deviation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Average normal vector angular deviation — wbt_average_normal_vector_angular_deviation","text":"dem Input raster DEM file. output Output raster file. filter Size filter kernel. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_average_normal_vector_angular_deviation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Average normal vector angular deviation — wbt_average_normal_vector_angular_deviation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_average_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Average overlay — wbt_average_overlay","title":"Average overlay — wbt_average_overlay","text":"Calculates average grid cell group raster images.","code":""},{"path":"/reference/wbt_average_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Average overlay — wbt_average_overlay","text":"","code":"wbt_average_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_average_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Average overlay — wbt_average_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_average_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Average overlay — wbt_average_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_average_upslope_flowpath_length.html","id":null,"dir":"Reference","previous_headings":"","what":"Average upslope flowpath length — wbt_average_upslope_flowpath_length","title":"Average upslope flowpath length — wbt_average_upslope_flowpath_length","text":"Measures average length upslope flowpaths draining grid cell.","code":""},{"path":"/reference/wbt_average_upslope_flowpath_length.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Average upslope flowpath length — wbt_average_upslope_flowpath_length","text":"","code":"wbt_average_upslope_flowpath_length(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_average_upslope_flowpath_length.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Average upslope flowpath length — wbt_average_upslope_flowpath_length","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_average_upslope_flowpath_length.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Average upslope flowpath length — wbt_average_upslope_flowpath_length","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_balance_contrast_enhancement.html","id":null,"dir":"Reference","previous_headings":"","what":"Balance contrast enhancement — wbt_balance_contrast_enhancement","title":"Balance contrast enhancement — wbt_balance_contrast_enhancement","text":"Performs balance contrast enhancement colour-composite image multispectral data.","code":""},{"path":"/reference/wbt_balance_contrast_enhancement.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Balance contrast enhancement — wbt_balance_contrast_enhancement","text":"","code":"wbt_balance_contrast_enhancement(   input,   output,   band_mean = 100,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_balance_contrast_enhancement.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Balance contrast enhancement — wbt_balance_contrast_enhancement","text":"input Input colour composite image file. output Output raster file. band_mean Band mean value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_balance_contrast_enhancement.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Balance contrast enhancement — wbt_balance_contrast_enhancement","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_basins.html","id":null,"dir":"Reference","previous_headings":"","what":"Basins — wbt_basins","title":"Basins — wbt_basins","text":"Identifies drainage basins drain DEM edge.","code":""},{"path":"/reference/wbt_basins.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Basins — wbt_basins","text":"","code":"wbt_basins(   d8_pntr,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_basins.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Basins — wbt_basins","text":"d8_pntr Input raster D8 pointer file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_basins.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Basins — wbt_basins","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_bilateral_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Bilateral filter — wbt_bilateral_filter","title":"Bilateral filter — wbt_bilateral_filter","text":"bilateral filter edge-preserving smoothing filter introduced Tomasi Manduchi (1998).","code":""},{"path":"/reference/wbt_bilateral_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bilateral filter — wbt_bilateral_filter","text":"","code":"wbt_bilateral_filter(   input,   output,   sigma_dist = 0.75,   sigma_int = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_bilateral_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bilateral filter — wbt_bilateral_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma_dist Standard deviation distance pixels. sigma_int Standard deviation intensity pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_bilateral_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Bilateral filter — wbt_bilateral_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_block_maximum_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Block maximum gridding — wbt_block_maximum_gridding","title":"Block maximum gridding — wbt_block_maximum_gridding","text":"Creates raster grid based set vector points assigns grid values using block maximum scheme.","code":""},{"path":"/reference/wbt_block_maximum_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Block maximum gridding — wbt_block_maximum_gridding","text":"","code":"wbt_block_maximum_gridding(   input,   field,   output,   use_z = FALSE,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_block_maximum_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Block maximum gridding — wbt_block_maximum_gridding","text":"input Input vector Points file. field Input field name attribute table. output Output raster file. use_z Use z-coordinate instead field?. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_block_maximum_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Block maximum gridding — wbt_block_maximum_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_block_minimum_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Block minimum gridding — wbt_block_minimum_gridding","title":"Block minimum gridding — wbt_block_minimum_gridding","text":"Creates raster grid based set vector points assigns grid values using block minimum scheme.","code":""},{"path":"/reference/wbt_block_minimum_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Block minimum gridding — wbt_block_minimum_gridding","text":"","code":"wbt_block_minimum_gridding(   input,   field,   output,   use_z = FALSE,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_block_minimum_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Block minimum gridding — wbt_block_minimum_gridding","text":"input Input vector Points file. field Input field name attribute table. output Output raster file. use_z Use z-coordinate instead field?. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_block_minimum_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Block minimum gridding — wbt_block_minimum_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_boundary_shape_complexity.html","id":null,"dir":"Reference","previous_headings":"","what":"Boundary shape complexity — wbt_boundary_shape_complexity","title":"Boundary shape complexity — wbt_boundary_shape_complexity","text":"Calculates complexity boundaries raster polygons.","code":""},{"path":"/reference/wbt_boundary_shape_complexity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Boundary shape complexity — wbt_boundary_shape_complexity","text":"","code":"wbt_boundary_shape_complexity(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_boundary_shape_complexity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Boundary shape complexity — wbt_boundary_shape_complexity","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_boundary_shape_complexity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Boundary shape complexity — wbt_boundary_shape_complexity","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_breach_depressions.html","id":null,"dir":"Reference","previous_headings":"","what":"Breach depressions — wbt_breach_depressions","title":"Breach depressions — wbt_breach_depressions","text":"Breaches depressions DEM using Lindsay's (2016) algorithm. preferred depression filling cases.","code":""},{"path":"/reference/wbt_breach_depressions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Breach depressions — wbt_breach_depressions","text":"","code":"wbt_breach_depressions(   dem,   output,   max_depth = NULL,   max_length = NULL,   flat_increment = NULL,   fill_pits = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_breach_depressions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Breach depressions — wbt_breach_depressions","text":"dem Input raster DEM file. output Output raster file. max_depth Optional maximum breach depth (default Inf). max_length Optional maximum breach channel length (grid cells; default Inf). flat_increment Optional elevation increment applied flat areas. fill_pits Optional flag indicating whether fill single-cell pits. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_breach_depressions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Breach depressions — wbt_breach_depressions","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_breach_depressions_least_cost.html","id":null,"dir":"Reference","previous_headings":"","what":"Breach depressions least cost — wbt_breach_depressions_least_cost","title":"Breach depressions least cost — wbt_breach_depressions_least_cost","text":"Breaches depressions DEM using least-cost pathway method.","code":""},{"path":"/reference/wbt_breach_depressions_least_cost.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Breach depressions least cost — wbt_breach_depressions_least_cost","text":"","code":"wbt_breach_depressions_least_cost(   dem,   output,   dist,   max_cost = NULL,   min_dist = TRUE,   flat_increment = NULL,   fill = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_breach_depressions_least_cost.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Breach depressions least cost — wbt_breach_depressions_least_cost","text":"dem Input raster DEM file. output Output raster file. dist Maximum search distance breach paths cells. max_cost Optional maximum breach cost (default Inf). min_dist Optional flag indicating whether minimize breach distances. flat_increment Optional elevation increment applied flat areas. fill Optional flag indicating whether fill remaining unbreached depressions. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_breach_depressions_least_cost.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Breach depressions least cost — wbt_breach_depressions_least_cost","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_breach_single_cell_pits.html","id":null,"dir":"Reference","previous_headings":"","what":"Breach single cell pits — wbt_breach_single_cell_pits","title":"Breach single cell pits — wbt_breach_single_cell_pits","text":"Removes single-cell pits input DEM breaching.","code":""},{"path":"/reference/wbt_breach_single_cell_pits.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Breach single cell pits — wbt_breach_single_cell_pits","text":"","code":"wbt_breach_single_cell_pits(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_breach_single_cell_pits.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Breach single cell pits — wbt_breach_single_cell_pits","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_breach_single_cell_pits.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Breach single cell pits — wbt_breach_single_cell_pits","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_breakline_mapping.html","id":null,"dir":"Reference","previous_headings":"","what":"Breakline mapping — wbt_breakline_mapping","title":"Breakline mapping — wbt_breakline_mapping","text":"tool maps breaklines input DEM.","code":""},{"path":"/reference/wbt_breakline_mapping.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Breakline mapping — wbt_breakline_mapping","text":"","code":"wbt_breakline_mapping(   dem,   output,   threshold = 2,   min_length = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_breakline_mapping.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Breakline mapping — wbt_breakline_mapping","text":"dem Name input raster image file. output Name output vector lines file. threshold Threshold value (0 - infinity typically 1 5 works well). min_length Minimum line length, grid cells. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_breakline_mapping.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Breakline mapping — wbt_breakline_mapping","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_buffer_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Buffer raster — wbt_buffer_raster","title":"Buffer raster — wbt_buffer_raster","text":"Maps distance-based buffer around non-background (non-zero/non-nodata) grid cell input image.","code":""},{"path":"/reference/wbt_buffer_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Buffer raster — wbt_buffer_raster","text":"","code":"wbt_buffer_raster(   input,   output,   size,   gridcells = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_buffer_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Buffer raster — wbt_buffer_raster","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. size Buffer size. gridcells Optional flag indicate 'size' threshold measured grid cells instead default map units. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_buffer_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Buffer raster — wbt_buffer_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_burn_streams_at_roads.html","id":null,"dir":"Reference","previous_headings":"","what":"Burn streams at roads — wbt_burn_streams_at_roads","title":"Burn streams at roads — wbt_burn_streams_at_roads","text":"Burns-streams sites road embankments.","code":""},{"path":"/reference/wbt_burn_streams_at_roads.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Burn streams at roads — wbt_burn_streams_at_roads","text":"","code":"wbt_burn_streams_at_roads(   dem,   streams,   roads,   output,   width = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_burn_streams_at_roads.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Burn streams at roads — wbt_burn_streams_at_roads","text":"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, map units. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_burn_streams_at_roads.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Burn streams at roads — wbt_burn_streams_at_roads","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_canny_edge_detection.html","id":null,"dir":"Reference","previous_headings":"","what":"Canny edge detection — wbt_canny_edge_detection","title":"Canny edge detection — wbt_canny_edge_detection","text":"tool performs Canny edge-detection filter input image.","code":""},{"path":"/reference/wbt_canny_edge_detection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Canny edge detection — wbt_canny_edge_detection","text":"","code":"wbt_canny_edge_detection(   input,   output,   sigma = 0.5,   low = 0.05,   high = 0.15,   add_back = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_canny_edge_detection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Canny edge detection — wbt_canny_edge_detection","text":"input Name input raster image file. output Name output raster image file. sigma Sigma value used Gaussian filtering, default = 0.5. low Low threshold, default = 0.05. high High threshold, default = 0.15. add_back Add edge cells back input image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_canny_edge_detection.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Canny edge detection — wbt_canny_edge_detection","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ceil.html","id":null,"dir":"Reference","previous_headings":"","what":"Ceil — wbt_ceil","title":"Ceil — wbt_ceil","text":"Returns smallest (closest negative infinity) value greater equal values raster.","code":""},{"path":"/reference/wbt_ceil.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ceil — wbt_ceil","text":"","code":"wbt_ceil(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ceil.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ceil — wbt_ceil","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ceil.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ceil — wbt_ceil","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_centroid.html","id":null,"dir":"Reference","previous_headings":"","what":"Centroid — wbt_centroid","title":"Centroid — wbt_centroid","text":"Calculates centroid, average location, raster polygon objects.","code":""},{"path":"/reference/wbt_centroid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Centroid — wbt_centroid","text":"","code":"wbt_centroid(   input,   output,   text_output = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_centroid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Centroid — wbt_centroid","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. text_output Optional text output. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_centroid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Centroid — wbt_centroid","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_centroid_vector.html","id":null,"dir":"Reference","previous_headings":"","what":"Centroid vector — wbt_centroid_vector","title":"Centroid vector — wbt_centroid_vector","text":"Identifies centroid point vector polyline polygon feature group vector points.","code":""},{"path":"/reference/wbt_centroid_vector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Centroid vector — wbt_centroid_vector","text":"","code":"wbt_centroid_vector(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_centroid_vector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Centroid vector — wbt_centroid_vector","text":"input Input vector file path. See wbt_file_path() details. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_centroid_vector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Centroid vector — wbt_centroid_vector","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_change_vector_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Change vector analysis — wbt_change_vector_analysis","title":"Change vector analysis — wbt_change_vector_analysis","text":"Performs change vector analysis two-date multi-spectral dataset.","code":""},{"path":"/reference/wbt_change_vector_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Change vector analysis — wbt_change_vector_analysis","text":"","code":"wbt_change_vector_analysis(   date1,   date2,   magnitude,   direction,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_change_vector_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Change vector analysis — wbt_change_vector_analysis","text":"date1 Input raster files earlier date. date2 Input raster files later date. magnitude Output vector magnitude raster file. direction Output vector Direction raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_change_vector_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Change vector analysis — wbt_change_vector_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_circular_variance_of_aspect.html","id":null,"dir":"Reference","previous_headings":"","what":"Circular variance of aspect — wbt_circular_variance_of_aspect","title":"Circular variance of aspect — wbt_circular_variance_of_aspect","text":"Calculates circular variance aspect scale DEM.","code":""},{"path":"/reference/wbt_circular_variance_of_aspect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Circular variance of aspect — wbt_circular_variance_of_aspect","text":"","code":"wbt_circular_variance_of_aspect(   dem,   output,   filter = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_circular_variance_of_aspect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Circular variance of aspect — wbt_circular_variance_of_aspect","text":"dem Input raster DEM file. output Output raster file. filter Size filter kernel. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_circular_variance_of_aspect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Circular variance of aspect — wbt_circular_variance_of_aspect","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_classify_buildings_in_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Classify buildings in lidar — wbt_classify_buildings_in_lidar","title":"Classify buildings in lidar — wbt_classify_buildings_in_lidar","text":"Reclassifies LiDAR points lie within vector building footprints.","code":""},{"path":"/reference/wbt_classify_buildings_in_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Classify buildings in lidar — wbt_classify_buildings_in_lidar","text":"","code":"wbt_classify_buildings_in_lidar(   input,   buildings,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_classify_buildings_in_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Classify buildings in lidar — wbt_classify_buildings_in_lidar","text":"input Input LiDAR file. buildings Input vector polygons file. output Output LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_classify_buildings_in_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Classify buildings in lidar — wbt_classify_buildings_in_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_classify_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Classify lidar — wbt_classify_lidar","title":"Classify lidar — wbt_classify_lidar","text":"Classify points within LiDAR point cloud based point properties.","code":""},{"path":"/reference/wbt_classify_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Classify lidar — wbt_classify_lidar","text":"","code":"wbt_classify_lidar(   input,   output = NULL,   radius = 1.5,   grd_threshold = 0.1,   oto_threshold = 2,   planarity_threshold = 0.85,   linearity_threshold = 0.7,   iterations = 30,   facade_threshold = 0.5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_classify_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Classify lidar — wbt_classify_lidar","text":"input Name input LiDAR points. output Name output LiDAR points. radius Search distance used neighbourhood search (metres). grd_threshold Ground threshold (metres). oto_threshold -terrain object threshold (metres). planarity_threshold Planarity threshold (0-1). linearity_threshold Linearity threshold (0-1). iterations Number iterations. facade_threshold Facade threshold (metres). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_classify_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Classify lidar — wbt_classify_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_classify_overlap_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Classify overlap points — wbt_classify_overlap_points","title":"Classify overlap points — wbt_classify_overlap_points","text":"Classifies filters LAS points regions overlapping flight lines.","code":""},{"path":"/reference/wbt_classify_overlap_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Classify overlap points — wbt_classify_overlap_points","text":"","code":"wbt_classify_overlap_points(   input,   output,   resolution = 2,   criterion = \"max scan angle\",   filter = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_classify_overlap_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Classify overlap points — wbt_classify_overlap_points","text":"input Input LiDAR file. output Output LiDAR file. resolution size square area used evaluate nearby points LiDAR data. criterion Criterion used identify overlapping points; options 'max scan angle', 'min point source ID', 'min time', 'multiple point source IDs'. filter Filter points overlapping flightlines? false, overlaps simply classified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_classify_overlap_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Classify overlap points — wbt_classify_overlap_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_clean_vector.html","id":null,"dir":"Reference","previous_headings":"","what":"Clean vector — wbt_clean_vector","title":"Clean vector — wbt_clean_vector","text":"Removes null features lines/polygons fewer required number vertices.","code":""},{"path":"/reference/wbt_clean_vector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clean vector — wbt_clean_vector","text":"","code":"wbt_clean_vector(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_clean_vector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clean vector — wbt_clean_vector","text":"input Input vector file path. See wbt_file_path() details. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_clean_vector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clean vector — wbt_clean_vector","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_clip.html","id":null,"dir":"Reference","previous_headings":"","what":"Clip — wbt_clip","title":"Clip — wbt_clip","text":"Extract features, parts features, overlap features clip vector.","code":""},{"path":"/reference/wbt_clip.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clip — wbt_clip","text":"","code":"wbt_clip(   input,   clip,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_clip.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clip — wbt_clip","text":"input Input vector file path. See wbt_file_path() details. clip Input clip polygon vector file. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_clip.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clip — wbt_clip","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_clip_lidar_to_polygon.html","id":null,"dir":"Reference","previous_headings":"","what":"Clip lidar to polygon — wbt_clip_lidar_to_polygon","title":"Clip lidar to polygon — wbt_clip_lidar_to_polygon","text":"Clips LiDAR point cloud vector polygon polygons.","code":""},{"path":"/reference/wbt_clip_lidar_to_polygon.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clip lidar to polygon — wbt_clip_lidar_to_polygon","text":"","code":"wbt_clip_lidar_to_polygon(   input,   polygons,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_clip_lidar_to_polygon.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clip lidar to polygon — wbt_clip_lidar_to_polygon","text":"input Input LiDAR file. polygons Input vector polygons file. output Output LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_clip_lidar_to_polygon.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clip lidar to polygon — wbt_clip_lidar_to_polygon","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_clip_raster_to_polygon.html","id":null,"dir":"Reference","previous_headings":"","what":"Clip raster to polygon — wbt_clip_raster_to_polygon","title":"Clip raster to polygon — wbt_clip_raster_to_polygon","text":"Clips raster vector polygon.","code":""},{"path":"/reference/wbt_clip_raster_to_polygon.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clip raster to polygon — wbt_clip_raster_to_polygon","text":"","code":"wbt_clip_raster_to_polygon(   input,   polygons,   output,   maintain_dimensions = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_clip_raster_to_polygon.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clip raster to polygon — wbt_clip_raster_to_polygon","text":"input Input raster file path. See wbt_file_path() details. polygons Input vector polygons file. output Output raster file. maintain_dimensions Maintain input raster dimensions?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_clip_raster_to_polygon.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clip raster to polygon — wbt_clip_raster_to_polygon","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_closing.html","id":null,"dir":"Reference","previous_headings":"","what":"Closing — wbt_closing","title":"Closing — wbt_closing","text":"closing mathematical morphology operation involving erosion (min filter) dilation (max filter) set.","code":""},{"path":"/reference/wbt_closing.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Closing — wbt_closing","text":"","code":"wbt_closing(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_closing.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Closing — wbt_closing","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_closing.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Closing — wbt_closing","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_clump.html","id":null,"dir":"Reference","previous_headings":"","what":"Clump — wbt_clump","title":"Clump — wbt_clump","text":"Groups cells form discrete areas, assigning unique identifiers.","code":""},{"path":"/reference/wbt_clump.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clump — wbt_clump","text":"","code":"wbt_clump(   input,   output,   diag = TRUE,   zero_back = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_clump.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clump — wbt_clump","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. diag Flag indicating whether diagonal connections considered. zero_back Flag indicating whether zero values treated background. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_clump.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clump — wbt_clump","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_colourize_based_on_class.html","id":null,"dir":"Reference","previous_headings":"","what":"Colourize based on class — wbt_colourize_based_on_class","title":"Colourize based on class — wbt_colourize_based_on_class","text":"Sets RGB values LiDAR point cloud based point classification values.","code":""},{"path":"/reference/wbt_colourize_based_on_class.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Colourize based on class — wbt_colourize_based_on_class","text":"","code":"wbt_colourize_based_on_class(   input,   output = NULL,   intensity_blending = 50,   clr_str = \"\",   use_unique_clrs_for_buildings = FALSE,   radius = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_colourize_based_on_class.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Colourize based on class — wbt_colourize_based_on_class","text":"input Name input LiDAR points. output Name output LiDAR points. intensity_blending Intensity blending amount (0-100 percent). clr_str Colour values, e.g. 2: (184, 167, 108); 5: #9ab86c. use_unique_clrs_for_buildings Use unique colours building?. radius Search distance used neighbourhood search. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_colourize_based_on_class.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Colourize based on class — wbt_colourize_based_on_class","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_colourize_based_on_point_returns.html","id":null,"dir":"Reference","previous_headings":"","what":"Colourize based on point returns — wbt_colourize_based_on_point_returns","title":"Colourize based on point returns — wbt_colourize_based_on_point_returns","text":"Sets RGB values LiDAR point cloud based point returns.","code":""},{"path":"/reference/wbt_colourize_based_on_point_returns.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Colourize based on point returns — wbt_colourize_based_on_point_returns","text":"","code":"wbt_colourize_based_on_point_returns(   input,   output = NULL,   intensity_blending = 50,   only = \"(230,214,170)\",   first = \"(0,140,0)\",   intermediate = \"(255,0,255)\",   last = \"(0,0,255)\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_colourize_based_on_point_returns.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Colourize based on point returns — wbt_colourize_based_on_point_returns","text":"input Name input LiDAR points. output Name output LiDAR points. intensity_blending Intensity blending amount (0-100 percent). return colour, e.g. (230,214,170), #e6d6aa, 0xe6d6aa. first First return colour, e.g. (230,214,170), #e6d6aa, 0xe6d6aa. intermediate Intermediate return colour, e.g. (230,214,170), #e6d6aa, 0xe6d6aa. last Last return colour, e.g. (230,214,170), #e6d6aa, 0xe6d6aa. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_colourize_based_on_point_returns.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Colourize based on point returns — wbt_colourize_based_on_point_returns","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_compactness_ratio.html","id":null,"dir":"Reference","previous_headings":"","what":"Compactness ratio — wbt_compactness_ratio","title":"Compactness ratio — wbt_compactness_ratio","text":"Calculates compactness ratio (/P), measure shape complexity, vector polygons.","code":""},{"path":"/reference/wbt_compactness_ratio.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compactness ratio — wbt_compactness_ratio","text":"","code":"wbt_compactness_ratio(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_compactness_ratio.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compactness ratio — wbt_compactness_ratio","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_compactness_ratio.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compactness ratio — wbt_compactness_ratio","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_conditional_evaluation.html","id":null,"dir":"Reference","previous_headings":"","what":"Conditional evaluation — wbt_conditional_evaluation","title":"Conditional evaluation — wbt_conditional_evaluation","text":"Performs conditional evaluation (--else) operation raster.","code":""},{"path":"/reference/wbt_conditional_evaluation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Conditional evaluation — wbt_conditional_evaluation","text":"","code":"wbt_conditional_evaluation(   input,   output,   statement = \"\",   true = NULL,   false = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_conditional_evaluation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Conditional evaluation — wbt_conditional_evaluation","text":"input Name input raster file. output Name output raster file. statement Conditional statement e.g. value > 35.0. statement must valid Rust statement. true Value condition evaluates TRUE (input raster constant value). false Value condition evaluates FALSE (input raster constant value). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_conditional_evaluation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Conditional evaluation — wbt_conditional_evaluation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_conditioned_latin_hypercube.html","id":null,"dir":"Reference","previous_headings":"","what":"Conditioned latin hypercube — wbt_conditioned_latin_hypercube","title":"Conditioned latin hypercube — wbt_conditioned_latin_hypercube","text":"Implements conditioned Latin Hypercube sampling.","code":""},{"path":"/reference/wbt_conditioned_latin_hypercube.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Conditioned latin hypercube — wbt_conditioned_latin_hypercube","text":"","code":"wbt_conditioned_latin_hypercube(   inputs,   output,   samples = 500,   iterations = 25000,   seed = NULL,   prob = 0.5,   threshold = NULL,   temp = 1,   temp_decay = 0.05,   cycle = 10,   average = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_conditioned_latin_hypercube.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Conditioned latin hypercube — wbt_conditioned_latin_hypercube","text":"inputs Name input raster file. output Output shapefile. samples Number sample sites returned. iterations Maximum iterations (stopping criteria reached). seed Seed RNG consistency. prob Probability random resample resampling worst strata [0,1]. threshold Objective function values threshold stop resampling iterations. temp Initial annealing temperature [0,1]. temp_decay Annealing temperature decay proportion [0,1]. Reduce temperature proportion annealing cycle. cycle Number iterations decaying annealing temperature. average Weight continuous objective function 1/N contributing strata. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_conditioned_latin_hypercube.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Conditioned latin hypercube — wbt_conditioned_latin_hypercube","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_conservative_smoothing_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Conservative smoothing filter — wbt_conservative_smoothing_filter","title":"Conservative smoothing filter — wbt_conservative_smoothing_filter","text":"Performs conservative-smoothing filter image.","code":""},{"path":"/reference/wbt_conservative_smoothing_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Conservative smoothing filter — wbt_conservative_smoothing_filter","text":"","code":"wbt_conservative_smoothing_filter(   input,   output,   filterx = 3,   filtery = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_conservative_smoothing_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Conservative smoothing filter — wbt_conservative_smoothing_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_conservative_smoothing_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Conservative smoothing filter — wbt_conservative_smoothing_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_construct_vector_tin.html","id":null,"dir":"Reference","previous_headings":"","what":"Construct vector tin — wbt_construct_vector_tin","title":"Construct vector tin — wbt_construct_vector_tin","text":"Creates vector triangular irregular network (TIN) set vector points.","code":""},{"path":"/reference/wbt_construct_vector_tin.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Construct vector tin — wbt_construct_vector_tin","text":"","code":"wbt_construct_vector_tin(   input,   output,   field = NULL,   use_z = FALSE,   max_triangle_edge_length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_construct_vector_tin.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Construct vector tin — wbt_construct_vector_tin","text":"input Input vector points file. output Output vector polygon file. field Input field name attribute table. use_z Use 'z' dimension Shapefile's geometry instead attribute field?. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_construct_vector_tin.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Construct vector tin — wbt_construct_vector_tin","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_contours_from_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Contours from points — wbt_contours_from_points","title":"Contours from points — wbt_contours_from_points","text":"Creates contour coverage set input points.","code":""},{"path":"/reference/wbt_contours_from_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Contours from points — wbt_contours_from_points","text":"","code":"wbt_contours_from_points(   input,   output,   field = NULL,   use_z = FALSE,   max_triangle_edge_length = NULL,   interval = 10,   base = 0,   smooth = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_contours_from_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Contours from points — wbt_contours_from_points","text":"input Input vector points file. output Output vector lines file. field Input field name attribute table. use_z Use 'z' dimension Shapefile's geometry instead attribute field?. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. interval Contour interval. base Base contour height. smooth Smoothing filter size (num. points), e.g. 3, 5, 7, 9, 11. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_contours_from_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Contours from points — wbt_contours_from_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_contours_from_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Contours from raster — wbt_contours_from_raster","title":"Contours from raster — wbt_contours_from_raster","text":"Derives vector contour coverage raster surface.","code":""},{"path":"/reference/wbt_contours_from_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Contours from raster — wbt_contours_from_raster","text":"","code":"wbt_contours_from_raster(   input,   output,   interval = 10,   base = 0,   smooth = 9,   tolerance = 10,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_contours_from_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Contours from raster — wbt_contours_from_raster","text":"input Input surface raster file. output Output vector contour file. interval Contour interval. base Base contour height. smooth Smoothing filter size (num. points), e.g. 3, 5, 7, 9, 11. tolerance Tolerance factor, degrees (0-45); determines generalization level. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_contours_from_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Contours from raster — wbt_contours_from_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_convert_nodata_to_zero.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert nodata to zero — wbt_convert_nodata_to_zero","title":"Convert nodata to zero — wbt_convert_nodata_to_zero","text":"Converts nodata values raster zero.","code":""},{"path":"/reference/wbt_convert_nodata_to_zero.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert nodata to zero — wbt_convert_nodata_to_zero","text":"","code":"wbt_convert_nodata_to_zero(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_convert_nodata_to_zero.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert nodata to zero — wbt_convert_nodata_to_zero","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_convert_nodata_to_zero.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert nodata to zero — wbt_convert_nodata_to_zero","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_convert_raster_format.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert raster format — wbt_convert_raster_format","title":"Convert raster format — wbt_convert_raster_format","text":"Converts raster data one format another.","code":""},{"path":"/reference/wbt_convert_raster_format.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert raster format — wbt_convert_raster_format","text":"","code":"wbt_convert_raster_format(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_convert_raster_format.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert raster format — wbt_convert_raster_format","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_convert_raster_format.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert raster format — wbt_convert_raster_format","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_corner_detection.html","id":null,"dir":"Reference","previous_headings":"","what":"Corner detection — wbt_corner_detection","title":"Corner detection — wbt_corner_detection","text":"Identifies corner patterns boolean images using hit--miss pattern matching.","code":""},{"path":"/reference/wbt_corner_detection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Corner detection — wbt_corner_detection","text":"","code":"wbt_corner_detection(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_corner_detection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Corner detection — wbt_corner_detection","text":"input Input boolean image. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_corner_detection.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Corner detection — wbt_corner_detection","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_correct_vignetting.html","id":null,"dir":"Reference","previous_headings":"","what":"Correct vignetting — wbt_correct_vignetting","title":"Correct vignetting — wbt_correct_vignetting","text":"Corrects darkening images towards corners.","code":""},{"path":"/reference/wbt_correct_vignetting.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Correct vignetting — wbt_correct_vignetting","text":"","code":"wbt_correct_vignetting(   input,   pp,   output,   focal_length = 304.8,   image_width = 228.6,   n = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_correct_vignetting.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Correct vignetting — wbt_correct_vignetting","text":"input Input raster file path. See wbt_file_path() details. pp Input principal point file. output Output raster file. focal_length Camera focal length, millimeters. image_width Distance photograph edges, millimeters. n 'n' parameter. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_correct_vignetting.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Correct vignetting — wbt_correct_vignetting","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cos.html","id":null,"dir":"Reference","previous_headings":"","what":"Cos — wbt_cos","title":"Cos — wbt_cos","text":"Returns cosine (cos) values raster.","code":""},{"path":"/reference/wbt_cos.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cos — wbt_cos","text":"","code":"wbt_cos(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cos.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cos — wbt_cos","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cos.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cos — wbt_cos","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cosh.html","id":null,"dir":"Reference","previous_headings":"","what":"Cosh — wbt_cosh","title":"Cosh — wbt_cosh","text":"Returns hyperbolic cosine (cosh) values raster.","code":""},{"path":"/reference/wbt_cosh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cosh — wbt_cosh","text":"","code":"wbt_cosh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cosh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cosh — wbt_cosh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cosh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cosh — wbt_cosh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cost_allocation.html","id":null,"dir":"Reference","previous_headings":"","what":"Cost allocation — wbt_cost_allocation","title":"Cost allocation — wbt_cost_allocation","text":"Identifies source cell grid cell connected least-cost pathway cost-distance analysis.","code":""},{"path":"/reference/wbt_cost_allocation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cost allocation — wbt_cost_allocation","text":"","code":"wbt_cost_allocation(   source,   backlink,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cost_allocation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cost allocation — wbt_cost_allocation","text":"source Input source raster file. backlink Input backlink raster file generated cost-distance tool. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cost_allocation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cost allocation — wbt_cost_allocation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cost_distance.html","id":null,"dir":"Reference","previous_headings":"","what":"Cost distance — wbt_cost_distance","title":"Cost distance — wbt_cost_distance","text":"Performs cost-distance accumulation cost surface group source cells.","code":""},{"path":"/reference/wbt_cost_distance.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cost distance — wbt_cost_distance","text":"","code":"wbt_cost_distance(   source,   cost,   out_accum,   out_backlink,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cost_distance.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cost distance — wbt_cost_distance","text":"source Input source raster file. cost Input cost (friction) raster file. out_accum Output cost accumulation raster file. out_backlink Output backlink raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cost_distance.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cost distance — wbt_cost_distance","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cost_pathway.html","id":null,"dir":"Reference","previous_headings":"","what":"Cost pathway — wbt_cost_pathway","title":"Cost pathway — wbt_cost_pathway","text":"Performs cost-distance pathway analysis using series destination grid cells.","code":""},{"path":"/reference/wbt_cost_pathway.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cost pathway — wbt_cost_pathway","text":"","code":"wbt_cost_pathway(   destination,   backlink,   output,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cost_pathway.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cost pathway — wbt_cost_pathway","text":"destination Input destination raster file. backlink Input backlink raster file generated cost-distance tool. output Output cost pathway raster file. zero_background Flag indicating whether zero values treated background. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cost_pathway.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cost pathway — wbt_cost_pathway","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_count_if.html","id":null,"dir":"Reference","previous_headings":"","what":"Count if — wbt_count_if","title":"Count if — wbt_count_if","text":"Counts number occurrences specified value cell-stack rasters.","code":""},{"path":"/reference/wbt_count_if.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Count if — wbt_count_if","text":"","code":"wbt_count_if(   inputs,   output,   value,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_count_if.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Count if — wbt_count_if","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. value Search value (e.g. countif value = 5.0). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_count_if.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Count if — wbt_count_if","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_create_colour_composite.html","id":null,"dir":"Reference","previous_headings":"","what":"Create colour composite — wbt_create_colour_composite","title":"Create colour composite — wbt_create_colour_composite","text":"Creates colour-composite image three bands multispectral imagery.","code":""},{"path":"/reference/wbt_create_colour_composite.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create colour composite — wbt_create_colour_composite","text":"","code":"wbt_create_colour_composite(   red,   green,   blue,   output,   opacity = NULL,   enhance = TRUE,   zeros = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_create_colour_composite.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create colour composite — wbt_create_colour_composite","text":"red Input red band image file. green Input green band image file. blue Input blue band image file. output Output colour composite file. opacity Input opacity band image file (optional). enhance Optional flag indicating whether balance contrast enhancement performed. zeros Optional flag indicate zeros nodata values. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_create_colour_composite.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create colour composite — wbt_create_colour_composite","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_create_hexagonal_vector_grid.html","id":null,"dir":"Reference","previous_headings":"","what":"Create hexagonal vector grid — wbt_create_hexagonal_vector_grid","title":"Create hexagonal vector grid — wbt_create_hexagonal_vector_grid","text":"Creates hexagonal vector grid.","code":""},{"path":"/reference/wbt_create_hexagonal_vector_grid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create hexagonal vector grid — wbt_create_hexagonal_vector_grid","text":"","code":"wbt_create_hexagonal_vector_grid(   input,   output,   width,   orientation = \"horizontal\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_create_hexagonal_vector_grid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create hexagonal vector grid — wbt_create_hexagonal_vector_grid","text":"input Input base file. output Output vector polygon file. width grid cell width. orientation Grid Orientation, 'horizontal' 'vertical'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_create_hexagonal_vector_grid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create hexagonal vector grid — wbt_create_hexagonal_vector_grid","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_create_plane.html","id":null,"dir":"Reference","previous_headings":"","what":"Create plane — wbt_create_plane","title":"Create plane — wbt_create_plane","text":"Creates raster image based equation simple plane.","code":""},{"path":"/reference/wbt_create_plane.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create plane — wbt_create_plane","text":"","code":"wbt_create_plane(   base,   output,   gradient = 15,   aspect = 90,   constant = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_create_plane.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create plane — wbt_create_plane","text":"base Input base raster file. output Output raster file. gradient Slope gradient degrees (-85.0 85.0). aspect Aspect (direction) degrees clockwise north (0.0-360.0). constant Constant value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_create_plane.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create plane — wbt_create_plane","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_create_rectangular_vector_grid.html","id":null,"dir":"Reference","previous_headings":"","what":"Create rectangular vector grid — wbt_create_rectangular_vector_grid","title":"Create rectangular vector grid — wbt_create_rectangular_vector_grid","text":"Creates rectangular vector grid.","code":""},{"path":"/reference/wbt_create_rectangular_vector_grid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create rectangular vector grid — wbt_create_rectangular_vector_grid","text":"","code":"wbt_create_rectangular_vector_grid(   input,   output,   width,   height,   xorig = 0,   yorig = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_create_rectangular_vector_grid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create rectangular vector grid — wbt_create_rectangular_vector_grid","text":"input Input base file. output Output vector polygon file. width grid cell width. height grid cell height. xorig grid origin x-coordinate. yorig grid origin y-coordinate. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_create_rectangular_vector_grid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create rectangular vector grid — wbt_create_rectangular_vector_grid","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_crispness_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Crispness index — wbt_crispness_index","title":"Crispness index — wbt_crispness_index","text":"Calculates Crispness Index, used quantify crisp (conversely fuzzy) probability image .","code":""},{"path":"/reference/wbt_crispness_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Crispness index — wbt_crispness_index","text":"","code":"wbt_crispness_index(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_crispness_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Crispness index — wbt_crispness_index","text":"input Input raster file path. See wbt_file_path() details. output Optional output html file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_crispness_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Crispness index — wbt_crispness_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cross_tabulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Cross tabulation — wbt_cross_tabulation","title":"Cross tabulation — wbt_cross_tabulation","text":"Performs cross-tabulation two categorical images.","code":""},{"path":"/reference/wbt_cross_tabulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cross tabulation — wbt_cross_tabulation","text":"","code":"wbt_cross_tabulation(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cross_tabulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cross tabulation — wbt_cross_tabulation","text":"input1 Input raster file 1. input2 Input raster file 1. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cross_tabulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cross tabulation — wbt_cross_tabulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_csv_points_to_vector.html","id":null,"dir":"Reference","previous_headings":"","what":"Csv points to vector — wbt_csv_points_to_vector","title":"Csv points to vector — wbt_csv_points_to_vector","text":"Converts CSV text file vector points.","code":""},{"path":"/reference/wbt_csv_points_to_vector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Csv points to vector — wbt_csv_points_to_vector","text":"","code":"wbt_csv_points_to_vector(   input,   output,   xfield = 0,   yfield = 1,   epsg = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_csv_points_to_vector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Csv points to vector — wbt_csv_points_to_vector","text":"input Input CSV file (.e. source data imported). output Output vector file. xfield X field number (e.g. 0 first field). yfield Y field number (e.g. 1 second field). epsg EPSG projection (e.g. 2958). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_csv_points_to_vector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Csv points to vector — wbt_csv_points_to_vector","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_cumulative_distribution.html","id":null,"dir":"Reference","previous_headings":"","what":"Cumulative distribution — wbt_cumulative_distribution","title":"Cumulative distribution — wbt_cumulative_distribution","text":"Converts raster image cumulative distribution function.","code":""},{"path":"/reference/wbt_cumulative_distribution.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cumulative distribution — wbt_cumulative_distribution","text":"","code":"wbt_cumulative_distribution(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_cumulative_distribution.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cumulative distribution — wbt_cumulative_distribution","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_cumulative_distribution.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cumulative distribution — wbt_cumulative_distribution","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_curvedness.html","id":null,"dir":"Reference","previous_headings":"","what":"Curvedness — wbt_curvedness","title":"Curvedness — wbt_curvedness","text":"tool calculates curvedness input DEM.","code":""},{"path":"/reference/wbt_curvedness.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Curvedness — wbt_curvedness","text":"","code":"wbt_curvedness(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_curvedness.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Curvedness — wbt_curvedness","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_curvedness.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Curvedness — wbt_curvedness","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d8_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"D8 flow accumulation — wbt_d8_flow_accumulation","title":"D8 flow accumulation — wbt_d8_flow_accumulation","text":"Calculates D8 flow accumulation raster input DEM flow pointer.","code":""},{"path":"/reference/wbt_d8_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D8 flow accumulation — wbt_d8_flow_accumulation","text":"","code":"wbt_d8_flow_accumulation(   input,   output,   out_type = \"cells\",   log = FALSE,   clip = FALSE,   pntr = FALSE,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d8_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D8 flow accumulation — wbt_d8_flow_accumulation","text":"input Input raster DEM D8 pointer file. output Output raster file. out_type Output type; one 'cells' (default), 'catchment area', 'specific contributing area'. log Optional flag request output log-transformed. clip Optional flag request clipping display max 1 percent. pntr input raster D8 flow pointer rather DEM?. esri_pntr Input D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d8_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D8 flow accumulation — wbt_d8_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d8_mass_flux.html","id":null,"dir":"Reference","previous_headings":"","what":"D8 mass flux — wbt_d8_mass_flux","title":"D8 mass flux — wbt_d8_mass_flux","text":"Performs D8 mass flux calculation.","code":""},{"path":"/reference/wbt_d8_mass_flux.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D8 mass flux — wbt_d8_mass_flux","text":"","code":"wbt_d8_mass_flux(   dem,   loading,   efficiency,   absorption,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d8_mass_flux.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D8 mass flux — wbt_d8_mass_flux","text":"dem Input raster DEM file. loading Input loading raster file. efficiency Input efficiency raster file. absorption Input absorption raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d8_mass_flux.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D8 mass flux — wbt_d8_mass_flux","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d8_pointer.html","id":null,"dir":"Reference","previous_headings":"","what":"D8 pointer — wbt_d8_pointer","title":"D8 pointer — wbt_d8_pointer","text":"Calculates D8 flow pointer raster input DEM.","code":""},{"path":"/reference/wbt_d8_pointer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D8 pointer — wbt_d8_pointer","text":"","code":"wbt_d8_pointer(   dem,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d8_pointer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D8 pointer — wbt_d8_pointer","text":"dem Input raster DEM file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d8_pointer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D8 pointer — wbt_d8_pointer","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d_inf_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"D inf flow accumulation — wbt_d_inf_flow_accumulation","title":"D inf flow accumulation — wbt_d_inf_flow_accumulation","text":"Calculates D-infinity flow accumulation raster input DEM.","code":""},{"path":"/reference/wbt_d_inf_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D inf flow accumulation — wbt_d_inf_flow_accumulation","text":"","code":"wbt_d_inf_flow_accumulation(   input,   output,   out_type = \"Specific Contributing Area\",   threshold = NULL,   log = FALSE,   clip = FALSE,   pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d_inf_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D inf flow accumulation — wbt_d_inf_flow_accumulation","text":"input Input raster DEM D-infinity pointer file. output Output raster file. out_type Output type; one 'cells', 'sca' (default), 'ca'. threshold Optional convergence threshold parameter, grid cells; default infinity. log Optional flag request output log-transformed. clip Optional flag request clipping display max 1 percent. pntr input raster D-infinity flow pointer rather DEM?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d_inf_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D inf flow accumulation — wbt_d_inf_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d_inf_mass_flux.html","id":null,"dir":"Reference","previous_headings":"","what":"D inf mass flux — wbt_d_inf_mass_flux","title":"D inf mass flux — wbt_d_inf_mass_flux","text":"Performs D-infinity mass flux calculation.","code":""},{"path":"/reference/wbt_d_inf_mass_flux.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D inf mass flux — wbt_d_inf_mass_flux","text":"","code":"wbt_d_inf_mass_flux(   dem,   loading,   efficiency,   absorption,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d_inf_mass_flux.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D inf mass flux — wbt_d_inf_mass_flux","text":"dem Input raster DEM file. loading Input loading raster file. efficiency Input efficiency raster file. absorption Input absorption raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d_inf_mass_flux.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D inf mass flux — wbt_d_inf_mass_flux","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_d_inf_pointer.html","id":null,"dir":"Reference","previous_headings":"","what":"D inf pointer — wbt_d_inf_pointer","title":"D inf pointer — wbt_d_inf_pointer","text":"Calculates D-infinity flow pointer (flow direction) raster input DEM.","code":""},{"path":"/reference/wbt_d_inf_pointer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"D inf pointer — wbt_d_inf_pointer","text":"","code":"wbt_d_inf_pointer(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_d_inf_pointer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"D inf pointer — wbt_d_inf_pointer","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_d_inf_pointer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"D inf pointer — wbt_d_inf_pointer","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_dbscan.html","id":null,"dir":"Reference","previous_headings":"","what":"Dbscan — wbt_dbscan","title":"Dbscan — wbt_dbscan","text":"Performs DBSCAN-based unsupervised clustering operation.","code":""},{"path":"/reference/wbt_dbscan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dbscan — wbt_dbscan","text":"","code":"wbt_dbscan(   inputs,   output,   scaling = \"Normalize\",   search_dist = 0.01,   min_points = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_dbscan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Dbscan — wbt_dbscan","text":"inputs Names input rasters. output Name output raster file. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. search_dist Search-distance parameter. min_points Minimum point density needed define 'core' point cluster. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_dbscan.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Dbscan — wbt_dbscan","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_decrement.html","id":null,"dir":"Reference","previous_headings":"","what":"Decrement — wbt_decrement","title":"Decrement — wbt_decrement","text":"Decreases values grid cell input raster 1.0 (see also InPlaceSubtract).","code":""},{"path":"/reference/wbt_decrement.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Decrement — wbt_decrement","text":"","code":"wbt_decrement(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_decrement.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Decrement — wbt_decrement","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_decrement.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Decrement — wbt_decrement","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_dem_void_filling.html","id":null,"dir":"Reference","previous_headings":"","what":"Dem void filling — wbt_dem_void_filling","title":"Dem void filling — wbt_dem_void_filling","text":"tool can used fill void areas DEM using another fill DEM data set.","code":""},{"path":"/reference/wbt_dem_void_filling.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dem void filling — wbt_dem_void_filling","text":"","code":"wbt_dem_void_filling(   dem,   fill,   output,   mean_plane_dist = 20,   edge_treatment = \"use DEM\",   weight_value = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_dem_void_filling.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Dem void filling — wbt_dem_void_filling","text":"dem Name input raster DEM file, containing void areas. fill Name input fill DEM file, containing values used fill void areas DEM. output Name output void-filled DEM file. mean_plane_dist Distance void edge mean-plane value used offset, measured grid cells. edge_treatment void-edge cells treated? Options include 'use DEM' (default), 'use Fill', 'average'. weight_value Weight value used IDW interpolation (default 2.0). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_dem_void_filling.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Dem void filling — wbt_dem_void_filling","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_depth_in_sink.html","id":null,"dir":"Reference","previous_headings":"","what":"Depth in sink — wbt_depth_in_sink","title":"Depth in sink — wbt_depth_in_sink","text":"Measures depth sinks (depressions) DEM.","code":""},{"path":"/reference/wbt_depth_in_sink.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Depth in sink — wbt_depth_in_sink","text":"","code":"wbt_depth_in_sink(   dem,   output,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_depth_in_sink.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Depth in sink — wbt_depth_in_sink","text":"dem Input raster DEM file. output Output raster file. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_depth_in_sink.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Depth in sink — wbt_depth_in_sink","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_depth_to_water.html","id":null,"dir":"Reference","previous_headings":"","what":"Depth to water — wbt_depth_to_water","title":"Depth to water — wbt_depth_to_water","text":"tool calculates cartographic depth--water (DTW) index.","code":""},{"path":"/reference/wbt_depth_to_water.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Depth to water — wbt_depth_to_water","text":"","code":"wbt_depth_to_water(   dem,   output,   streams = NULL,   lakes = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_depth_to_water.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Depth to water — wbt_depth_to_water","text":"dem Name input raster DEM file. output Name output raster image file. streams Name input streams vector (optional). lakes Name input lakes vector (optional). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_depth_to_water.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Depth to water — wbt_depth_to_water","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_dev_from_mean_elev.html","id":null,"dir":"Reference","previous_headings":"","what":"Dev from mean elev — wbt_dev_from_mean_elev","title":"Dev from mean elev — wbt_dev_from_mean_elev","text":"Calculates deviation mean elevation.","code":""},{"path":"/reference/wbt_dev_from_mean_elev.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dev from mean elev — wbt_dev_from_mean_elev","text":"","code":"wbt_dev_from_mean_elev(   dem,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_dev_from_mean_elev.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Dev from mean elev — wbt_dev_from_mean_elev","text":"dem Input raster DEM file. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_dev_from_mean_elev.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Dev from mean elev — wbt_dev_from_mean_elev","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_diff_from_mean_elev.html","id":null,"dir":"Reference","previous_headings":"","what":"Diff from mean elev — wbt_diff_from_mean_elev","title":"Diff from mean elev — wbt_diff_from_mean_elev","text":"Calculates difference mean elevation (equivalent high-pass filter).","code":""},{"path":"/reference/wbt_diff_from_mean_elev.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Diff from mean elev — wbt_diff_from_mean_elev","text":"","code":"wbt_diff_from_mean_elev(   dem,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_diff_from_mean_elev.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Diff from mean elev — wbt_diff_from_mean_elev","text":"dem Input raster DEM file. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_diff_from_mean_elev.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Diff from mean elev — wbt_diff_from_mean_elev","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_diff_of_gaussian_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Diff of gaussian filter — wbt_diff_of_gaussian_filter","title":"Diff of gaussian filter — wbt_diff_of_gaussian_filter","text":"Performs Difference Gaussian (DoG) filter image.","code":""},{"path":"/reference/wbt_diff_of_gaussian_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Diff of gaussian filter — wbt_diff_of_gaussian_filter","text":"","code":"wbt_diff_of_gaussian_filter(   input,   output,   sigma1 = 2,   sigma2 = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_diff_of_gaussian_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Diff of gaussian filter — wbt_diff_of_gaussian_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma1 Standard deviation distance pixels. sigma2 Standard deviation distance pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_diff_of_gaussian_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Diff of gaussian filter — wbt_diff_of_gaussian_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_difference.html","id":null,"dir":"Reference","previous_headings":"","what":"Difference — wbt_difference","title":"Difference — wbt_difference","text":"Outputs features occur one two vector inputs , .e. overlapping features.","code":""},{"path":"/reference/wbt_difference.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Difference — wbt_difference","text":"","code":"wbt_difference(   input,   overlay,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_difference.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Difference — wbt_difference","text":"input Input vector file path. See wbt_file_path() details. overlay Input overlay vector file. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_difference.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Difference — wbt_difference","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_difference_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Difference curvature — wbt_difference_curvature","title":"Difference curvature — wbt_difference_curvature","text":"tool calculates difference curvature input DEM.","code":""},{"path":"/reference/wbt_difference_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Difference curvature — wbt_difference_curvature","text":"","code":"wbt_difference_curvature(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_difference_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Difference curvature — wbt_difference_curvature","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_difference_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Difference curvature — wbt_difference_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_direct_decorrelation_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Direct decorrelation stretch — wbt_direct_decorrelation_stretch","title":"Direct decorrelation stretch — wbt_direct_decorrelation_stretch","text":"Performs direct decorrelation stretch enhancement colour-composite image multispectral data.","code":""},{"path":"/reference/wbt_direct_decorrelation_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Direct decorrelation stretch — wbt_direct_decorrelation_stretch","text":"","code":"wbt_direct_decorrelation_stretch(   input,   output,   k = 0.5,   clip = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_direct_decorrelation_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Direct decorrelation stretch — wbt_direct_decorrelation_stretch","text":"input Input colour composite image file. output Output raster file. k Achromatic factor (k) ranges 0 (effect) 1 (full saturation stretch), although typical values range 0.3 0.7. clip Optional percent clip upper tail stretch. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_direct_decorrelation_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Direct decorrelation stretch — wbt_direct_decorrelation_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_directional_relief.html","id":null,"dir":"Reference","previous_headings":"","what":"Directional relief — wbt_directional_relief","title":"Directional relief — wbt_directional_relief","text":"Calculates relief cells input DEM specified direction.","code":""},{"path":"/reference/wbt_directional_relief.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Directional relief — wbt_directional_relief","text":"","code":"wbt_directional_relief(   dem,   output,   azimuth = 0,   max_dist = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_directional_relief.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Directional relief — wbt_directional_relief","text":"dem Input raster DEM file. output Output raster file. azimuth Wind azimuth degrees. max_dist Optional maximum search distance (unspecified none; xy units). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_directional_relief.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Directional relief — wbt_directional_relief","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_dissolve.html","id":null,"dir":"Reference","previous_headings":"","what":"Dissolve — wbt_dissolve","title":"Dissolve — wbt_dissolve","text":"Removes interior, shared, boundaries within vector polygon coverage.","code":""},{"path":"/reference/wbt_dissolve.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dissolve — wbt_dissolve","text":"","code":"wbt_dissolve(   input,   output,   field = NULL,   snap = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_dissolve.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Dissolve — wbt_dissolve","text":"input Input vector file path. See wbt_file_path() details. output Output vector file. field Dissolve field attribute (optional). snap Snap tolerance. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_dissolve.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Dissolve — wbt_dissolve","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_distance_to_outlet.html","id":null,"dir":"Reference","previous_headings":"","what":"Distance to outlet — wbt_distance_to_outlet","title":"Distance to outlet — wbt_distance_to_outlet","text":"Calculates distance stream grid cells channel network outlet cell.","code":""},{"path":"/reference/wbt_distance_to_outlet.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Distance to outlet — wbt_distance_to_outlet","text":"","code":"wbt_distance_to_outlet(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_distance_to_outlet.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Distance to outlet — wbt_distance_to_outlet","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_distance_to_outlet.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Distance to outlet — wbt_distance_to_outlet","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_diversity_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Diversity filter — wbt_diversity_filter","title":"Diversity filter — wbt_diversity_filter","text":"Assigns cell output grid number different values moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_diversity_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Diversity filter — wbt_diversity_filter","text":"","code":"wbt_diversity_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_diversity_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Diversity filter — wbt_diversity_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_diversity_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Diversity filter — wbt_diversity_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_divide.html","id":null,"dir":"Reference","previous_headings":"","what":"Divide — wbt_divide","title":"Divide — wbt_divide","text":"Performs division operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_divide.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Divide — wbt_divide","text":"","code":"wbt_divide(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_divide.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Divide — wbt_divide","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_divide.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Divide — wbt_divide","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_downslope_distance_to_stream.html","id":null,"dir":"Reference","previous_headings":"","what":"Downslope distance to stream — wbt_downslope_distance_to_stream","title":"Downslope distance to stream — wbt_downslope_distance_to_stream","text":"Measures distance nearest downslope stream cell.","code":""},{"path":"/reference/wbt_downslope_distance_to_stream.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Downslope distance to stream — wbt_downslope_distance_to_stream","text":"","code":"wbt_downslope_distance_to_stream(   dem,   streams,   output,   dinf = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_downslope_distance_to_stream.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Downslope distance to stream — wbt_downslope_distance_to_stream","text":"dem Input raster DEM file. streams Input raster streams file. output Output raster file. dinf Use D-infinity flow algorithm instead D8?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_downslope_distance_to_stream.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Downslope distance to stream — wbt_downslope_distance_to_stream","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_downslope_flowpath_length.html","id":null,"dir":"Reference","previous_headings":"","what":"Downslope flowpath length — wbt_downslope_flowpath_length","title":"Downslope flowpath length — wbt_downslope_flowpath_length","text":"Calculates downslope flowpath length cell basin outlet.","code":""},{"path":"/reference/wbt_downslope_flowpath_length.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Downslope flowpath length — wbt_downslope_flowpath_length","text":"","code":"wbt_downslope_flowpath_length(   d8_pntr,   output,   watersheds = NULL,   weights = NULL,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_downslope_flowpath_length.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Downslope flowpath length — wbt_downslope_flowpath_length","text":"d8_pntr Input D8 pointer raster file. output Output raster file. watersheds Optional input watershed raster file. weights Optional input weights raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_downslope_flowpath_length.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Downslope flowpath length — wbt_downslope_flowpath_length","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_downslope_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Downslope index — wbt_downslope_index","title":"Downslope index — wbt_downslope_index","text":"Calculates Hjerdt et al. (2004) downslope index.","code":""},{"path":"/reference/wbt_downslope_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Downslope index — wbt_downslope_index","text":"","code":"wbt_downslope_index(   dem,   output,   drop = 2,   out_type = \"tangent\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_downslope_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Downslope index — wbt_downslope_index","text":"dem Input raster DEM file. output Output raster file. drop Vertical drop value (default 2.0). out_type Output type, options include 'tangent', 'degrees', 'radians', 'distance' (default 'tangent'). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_downslope_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Downslope index — wbt_downslope_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_edge_contamination.html","id":null,"dir":"Reference","previous_headings":"","what":"Edge contamination — wbt_edge_contamination","title":"Edge contamination — wbt_edge_contamination","text":"Identifies grid cells within input DEM may impacted edge contamination hydrological applications.","code":""},{"path":"/reference/wbt_edge_contamination.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Edge contamination — wbt_edge_contamination","text":"","code":"wbt_edge_contamination(   dem,   output,   flow_type = \"mfd\",   zfactor = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_edge_contamination.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Edge contamination — wbt_edge_contamination","text":"dem Name input DEM raster file; must depressionless. output Name output raster file. flow_type Flow algorithm type, one 'd8', 'mfd', 'dinf'. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_edge_contamination.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Edge contamination — wbt_edge_contamination","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_edge_density.html","id":null,"dir":"Reference","previous_headings":"","what":"Edge density — wbt_edge_density","title":"Edge density — wbt_edge_density","text":"Calculates density edges, breaks--slope within DEMs.","code":""},{"path":"/reference/wbt_edge_density.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Edge density — wbt_edge_density","text":"","code":"wbt_edge_density(   dem,   output,   filter = 11,   norm_diff = 5,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_edge_density.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Edge density — wbt_edge_density","text":"dem Input raster DEM file. output Output raster file. filter Size filter kernel. norm_diff Maximum difference normal vectors, degrees. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_edge_density.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Edge density — wbt_edge_density","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_edge_preserving_mean_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Edge preserving mean filter — wbt_edge_preserving_mean_filter","title":"Edge preserving mean filter — wbt_edge_preserving_mean_filter","text":"Performs simple edge-preserving mean filter input image.","code":""},{"path":"/reference/wbt_edge_preserving_mean_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Edge preserving mean filter — wbt_edge_preserving_mean_filter","text":"","code":"wbt_edge_preserving_mean_filter(   input,   output,   threshold,   filter = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_edge_preserving_mean_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Edge preserving mean filter — wbt_edge_preserving_mean_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. threshold Maximum difference values. filter Size filter kernel. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_edge_preserving_mean_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Edge preserving mean filter — wbt_edge_preserving_mean_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_edge_proportion.html","id":null,"dir":"Reference","previous_headings":"","what":"Edge proportion — wbt_edge_proportion","title":"Edge proportion — wbt_edge_proportion","text":"Calculate proportion cells raster polygon edge cells.","code":""},{"path":"/reference/wbt_edge_proportion.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Edge proportion — wbt_edge_proportion","text":"","code":"wbt_edge_proportion(   input,   output,   output_text = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_edge_proportion.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Edge proportion — wbt_edge_proportion","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. output_text flag indicating whether text report also output. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_edge_proportion.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Edge proportion — wbt_edge_proportion","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elev_above_pit.html","id":null,"dir":"Reference","previous_headings":"","what":"Elev above pit — wbt_elev_above_pit","title":"Elev above pit — wbt_elev_above_pit","text":"Calculate elevation grid cell nearest downstream pit cell grid edge cell.","code":""},{"path":"/reference/wbt_elev_above_pit.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elev above pit — wbt_elev_above_pit","text":"","code":"wbt_elev_above_pit(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elev_above_pit.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elev above pit — wbt_elev_above_pit","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elev_above_pit.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elev above pit — wbt_elev_above_pit","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elev_percentile.html","id":null,"dir":"Reference","previous_headings":"","what":"Elev percentile — wbt_elev_percentile","title":"Elev percentile — wbt_elev_percentile","text":"Calculates elevation percentile raster DEM.","code":""},{"path":"/reference/wbt_elev_percentile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elev percentile — wbt_elev_percentile","text":"","code":"wbt_elev_percentile(   dem,   output,   filterx = 11,   filtery = 11,   sig_digits = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elev_percentile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elev percentile — wbt_elev_percentile","text":"dem Input raster DEM file. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. sig_digits Number significant digits. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elev_percentile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elev percentile — wbt_elev_percentile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elev_relative_to_min_max.html","id":null,"dir":"Reference","previous_headings":"","what":"Elev relative to min max — wbt_elev_relative_to_min_max","title":"Elev relative to min max — wbt_elev_relative_to_min_max","text":"Calculates elevation location relative minimum maximum elevations DEM.","code":""},{"path":"/reference/wbt_elev_relative_to_min_max.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elev relative to min max — wbt_elev_relative_to_min_max","text":"","code":"wbt_elev_relative_to_min_max(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elev_relative_to_min_max.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elev relative to min max — wbt_elev_relative_to_min_max","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elev_relative_to_min_max.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elev relative to min max — wbt_elev_relative_to_min_max","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elev_relative_to_watershed_min_max.html","id":null,"dir":"Reference","previous_headings":"","what":"Elev relative to watershed min max — wbt_elev_relative_to_watershed_min_max","title":"Elev relative to watershed min max — wbt_elev_relative_to_watershed_min_max","text":"Calculates elevation location relative minimum maximum elevations watershed.","code":""},{"path":"/reference/wbt_elev_relative_to_watershed_min_max.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elev relative to watershed min max — wbt_elev_relative_to_watershed_min_max","text":"","code":"wbt_elev_relative_to_watershed_min_max(   dem,   watersheds,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elev_relative_to_watershed_min_max.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elev relative to watershed min max — wbt_elev_relative_to_watershed_min_max","text":"dem Input raster DEM file. watersheds Input raster watersheds file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elev_relative_to_watershed_min_max.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elev relative to watershed min max — wbt_elev_relative_to_watershed_min_max","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elevation_above_stream.html","id":null,"dir":"Reference","previous_headings":"","what":"Elevation above stream — wbt_elevation_above_stream","title":"Elevation above stream — wbt_elevation_above_stream","text":"Calculates elevation cells nearest downslope stream cell.","code":""},{"path":"/reference/wbt_elevation_above_stream.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elevation above stream — wbt_elevation_above_stream","text":"","code":"wbt_elevation_above_stream(   dem,   streams,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elevation_above_stream.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elevation above stream — wbt_elevation_above_stream","text":"dem Input raster DEM file. streams Input raster streams file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elevation_above_stream.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elevation above stream — wbt_elevation_above_stream","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elevation_above_stream_euclidean.html","id":null,"dir":"Reference","previous_headings":"","what":"Elevation above stream euclidean — wbt_elevation_above_stream_euclidean","title":"Elevation above stream euclidean — wbt_elevation_above_stream_euclidean","text":"Calculates elevation cells nearest (Euclidean distance) stream cell.","code":""},{"path":"/reference/wbt_elevation_above_stream_euclidean.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elevation above stream euclidean — wbt_elevation_above_stream_euclidean","text":"","code":"wbt_elevation_above_stream_euclidean(   dem,   streams,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elevation_above_stream_euclidean.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elevation above stream euclidean — wbt_elevation_above_stream_euclidean","text":"dem Input raster DEM file. streams Input raster streams file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elevation_above_stream_euclidean.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elevation above stream euclidean — wbt_elevation_above_stream_euclidean","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_eliminate_coincident_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Eliminate coincident points — wbt_eliminate_coincident_points","title":"Eliminate coincident points — wbt_eliminate_coincident_points","text":"Removes coincident, nearly coincident, points vector points file.","code":""},{"path":"/reference/wbt_eliminate_coincident_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Eliminate coincident points — wbt_eliminate_coincident_points","text":"","code":"wbt_eliminate_coincident_points(   input,   output,   tolerance,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_eliminate_coincident_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Eliminate coincident points — wbt_eliminate_coincident_points","text":"input Input vector file path. See wbt_file_path() details. output Output vector points file. tolerance distance tolerance points. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_eliminate_coincident_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Eliminate coincident points — wbt_eliminate_coincident_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_elongation_ratio.html","id":null,"dir":"Reference","previous_headings":"","what":"Elongation ratio — wbt_elongation_ratio","title":"Elongation ratio — wbt_elongation_ratio","text":"Calculates elongation ratio vector polygons.","code":""},{"path":"/reference/wbt_elongation_ratio.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elongation ratio — wbt_elongation_ratio","text":"","code":"wbt_elongation_ratio(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_elongation_ratio.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elongation ratio — wbt_elongation_ratio","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_elongation_ratio.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elongation ratio — wbt_elongation_ratio","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_embankment_mapping.html","id":null,"dir":"Reference","previous_headings":"","what":"Embankment mapping — wbt_embankment_mapping","title":"Embankment mapping — wbt_embankment_mapping","text":"Maps /removes road embankments input fine-resolution DEM.","code":""},{"path":"/reference/wbt_embankment_mapping.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Embankment mapping — wbt_embankment_mapping","text":"","code":"wbt_embankment_mapping(   dem,   road_vec,   output,   search_dist = 2.5,   min_road_width = 6,   typical_width = 30,   max_height = 2,   max_width = 60,   max_increment = 0.05,   spillout_slope = 4,   remove_embankments = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_embankment_mapping.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Embankment mapping — wbt_embankment_mapping","text":"dem Input raster DEM file. road_vec Input vector polygons file. output Output raster file. search_dist Search distance used reposition transportation vectors onto road embankments (map units). min_road_width Minimum road width; width paved road surface (map units). typical_width Typical embankment width; maximum width embankment roadside ditches (map units). max_height Typical embankment maximum height; height typical embankment roadside ditches (map units). max_width Maximum embankment width, typically embankments traverse steep-sided valleys (map units). max_increment Maximum upwards increment neighbouring cells embankment (elevation units). spillout_slope Spillout slope (degrees). remove_embankments Optional flag indicating whether output DEM embankments removed (true) embankment raster map (false). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_embankment_mapping.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Embankment mapping — wbt_embankment_mapping","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_emboss_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Emboss filter — wbt_emboss_filter","title":"Emboss filter — wbt_emboss_filter","text":"Performs emboss filter image, similar hillshade operation.","code":""},{"path":"/reference/wbt_emboss_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Emboss filter — wbt_emboss_filter","text":"","code":"wbt_emboss_filter(   input,   output,   direction = \"n\",   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_emboss_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Emboss filter — wbt_emboss_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. direction Direction reflection; options include 'n', 's', 'e', 'w', 'ne', 'se', 'nw', 'sw'. clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_emboss_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Emboss filter — wbt_emboss_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_equal_to.html","id":null,"dir":"Reference","previous_headings":"","what":"Equal to — wbt_equal_to","title":"Equal to — wbt_equal_to","text":"Performs equal-comparison operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_equal_to.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Equal to — wbt_equal_to","text":"","code":"wbt_equal_to(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_equal_to.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Equal to — wbt_equal_to","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_equal_to.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Equal to — wbt_equal_to","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_erase.html","id":null,"dir":"Reference","previous_headings":"","what":"Erase — wbt_erase","title":"Erase — wbt_erase","text":"Removes features, parts features, overlap features erase vector polygon.","code":""},{"path":"/reference/wbt_erase.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Erase — wbt_erase","text":"","code":"wbt_erase(   input,   erase,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_erase.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Erase — wbt_erase","text":"input Input vector file path. See wbt_file_path() details. erase Input erase polygon vector file. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_erase.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Erase — wbt_erase","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_erase_polygon_from_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Erase polygon from lidar — wbt_erase_polygon_from_lidar","title":"Erase polygon from lidar — wbt_erase_polygon_from_lidar","text":"Erases (cuts ) vector polygon polygons LiDAR point cloud.","code":""},{"path":"/reference/wbt_erase_polygon_from_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Erase polygon from lidar — wbt_erase_polygon_from_lidar","text":"","code":"wbt_erase_polygon_from_lidar(   input,   polygons,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_erase_polygon_from_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Erase polygon from lidar — wbt_erase_polygon_from_lidar","text":"input Input LiDAR file. polygons Input vector polygons file. output Output LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_erase_polygon_from_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Erase polygon from lidar — wbt_erase_polygon_from_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_erase_polygon_from_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Erase polygon from raster — wbt_erase_polygon_from_raster","title":"Erase polygon from raster — wbt_erase_polygon_from_raster","text":"Erases (cuts ) vector polygon raster.","code":""},{"path":"/reference/wbt_erase_polygon_from_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Erase polygon from raster — wbt_erase_polygon_from_raster","text":"","code":"wbt_erase_polygon_from_raster(   input,   polygons,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_erase_polygon_from_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Erase polygon from raster — wbt_erase_polygon_from_raster","text":"input Input raster file path. See wbt_file_path() details. polygons Input vector polygons file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_erase_polygon_from_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Erase polygon from raster — wbt_erase_polygon_from_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_euclidean_allocation.html","id":null,"dir":"Reference","previous_headings":"","what":"Euclidean allocation — wbt_euclidean_allocation","title":"Euclidean allocation — wbt_euclidean_allocation","text":"Assigns grid cells output raster value nearest target cell input image, measured Shih Wu (2004) Euclidean distance transform.","code":""},{"path":"/reference/wbt_euclidean_allocation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Euclidean allocation — wbt_euclidean_allocation","text":"","code":"wbt_euclidean_allocation(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_euclidean_allocation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Euclidean allocation — wbt_euclidean_allocation","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_euclidean_allocation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Euclidean allocation — wbt_euclidean_allocation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_euclidean_distance.html","id":null,"dir":"Reference","previous_headings":"","what":"Euclidean distance — wbt_euclidean_distance","title":"Euclidean distance — wbt_euclidean_distance","text":"Calculates Shih Wu (2004) Euclidean distance transform.","code":""},{"path":"/reference/wbt_euclidean_distance.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Euclidean distance — wbt_euclidean_distance","text":"","code":"wbt_euclidean_distance(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_euclidean_distance.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Euclidean distance — wbt_euclidean_distance","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_euclidean_distance.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Euclidean distance — wbt_euclidean_distance","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_evaluate_training_sites.html","id":null,"dir":"Reference","previous_headings":"","what":"Evaluate training sites — wbt_evaluate_training_sites","title":"Evaluate training sites — wbt_evaluate_training_sites","text":"tool can used inspect overlap spectral signatures training sites various classes.","code":""},{"path":"/reference/wbt_evaluate_training_sites.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Evaluate training sites — wbt_evaluate_training_sites","text":"","code":"wbt_evaluate_training_sites(   inputs,   polys,   field,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_evaluate_training_sites.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Evaluate training sites — wbt_evaluate_training_sites","text":"inputs Name input band images. polys Name input training site polygons shapefile. field Name attribute containing class name data. output Name output report file (*.html). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_evaluate_training_sites.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Evaluate training sites — wbt_evaluate_training_sites","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_exp.html","id":null,"dir":"Reference","previous_headings":"","what":"Exp — wbt_exp","title":"Exp — wbt_exp","text":"Returns exponential (base e) values raster.","code":""},{"path":"/reference/wbt_exp.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Exp — wbt_exp","text":"","code":"wbt_exp(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_exp.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Exp — wbt_exp","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_exp.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Exp — wbt_exp","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_exp2.html","id":null,"dir":"Reference","previous_headings":"","what":"Exp2 — wbt_exp2","title":"Exp2 — wbt_exp2","text":"Returns exponential (base 2) values raster.","code":""},{"path":"/reference/wbt_exp2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Exp2 — wbt_exp2","text":"","code":"wbt_exp2(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_exp2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Exp2 — wbt_exp2","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_exp2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Exp2 — wbt_exp2","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_export_table_to_csv.html","id":null,"dir":"Reference","previous_headings":"","what":"Export table to csv — wbt_export_table_to_csv","title":"Export table to csv — wbt_export_table_to_csv","text":"Exports attribute table CSV text file.","code":""},{"path":"/reference/wbt_export_table_to_csv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Export table to csv — wbt_export_table_to_csv","text":"","code":"wbt_export_table_to_csv(   input,   output,   headers = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_export_table_to_csv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Export table to csv — wbt_export_table_to_csv","text":"input Input vector file path. See wbt_file_path() details. output Output csv file. headers Export field names file header?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_export_table_to_csv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Export table to csv — wbt_export_table_to_csv","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_exposure_towards_wind_flux.html","id":null,"dir":"Reference","previous_headings":"","what":"Exposure towards wind flux — wbt_exposure_towards_wind_flux","title":"Exposure towards wind flux — wbt_exposure_towards_wind_flux","text":"Evaluates hydrologic connectivity within DEM.","code":""},{"path":"/reference/wbt_exposure_towards_wind_flux.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Exposure towards wind flux — wbt_exposure_towards_wind_flux","text":"","code":"wbt_exposure_towards_wind_flux(   dem,   output,   azimuth = \"\",   max_dist = \"\",   zfactor = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_exposure_towards_wind_flux.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Exposure towards wind flux — wbt_exposure_towards_wind_flux","text":"dem Name input DEM raster file. output Name output raster file. azimuth Wind azimuth, degrees. max_dist Optional maximum search distance. Minimum value 5 x cell size. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_exposure_towards_wind_flux.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Exposure towards wind flux — wbt_exposure_towards_wind_flux","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_extend_vector_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Extend vector lines — wbt_extend_vector_lines","title":"Extend vector lines — wbt_extend_vector_lines","text":"Extends vector lines specified distance.","code":""},{"path":"/reference/wbt_extend_vector_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extend vector lines — wbt_extend_vector_lines","text":"","code":"wbt_extend_vector_lines(   input,   output,   dist,   extend = \"both ends\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_extend_vector_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extend vector lines — wbt_extend_vector_lines","text":"input Input vector polyline file. output Output vector polyline file. dist distance extend. extend Extend direction, 'ends' (default), 'line start', 'line end'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_extend_vector_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extend vector lines — wbt_extend_vector_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_extract_nodes.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract nodes — wbt_extract_nodes","title":"Extract nodes — wbt_extract_nodes","text":"Converts vector lines polygons vertex points.","code":""},{"path":"/reference/wbt_extract_nodes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract nodes — wbt_extract_nodes","text":"","code":"wbt_extract_nodes(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_extract_nodes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract nodes — wbt_extract_nodes","text":"input Input vector lines polygon file. output Output vector points file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_extract_nodes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extract nodes — wbt_extract_nodes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_extract_raster_values_at_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract raster values at points — wbt_extract_raster_values_at_points","title":"Extract raster values at points — wbt_extract_raster_values_at_points","text":"Extracts values raster(s) vector point locations.","code":""},{"path":"/reference/wbt_extract_raster_values_at_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract raster values at points — wbt_extract_raster_values_at_points","text":"","code":"wbt_extract_raster_values_at_points(   inputs,   points,   out_text = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_extract_raster_values_at_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract raster values at points — wbt_extract_raster_values_at_points","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. points Input vector points file. out_text Output point values text? Otherwise, output points file's attribute table. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_extract_raster_values_at_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extract raster values at points — wbt_extract_raster_values_at_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_extract_streams.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract streams — wbt_extract_streams","title":"Extract streams — wbt_extract_streams","text":"Extracts stream grid cells flow accumulation raster.","code":""},{"path":"/reference/wbt_extract_streams.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract streams — wbt_extract_streams","text":"","code":"wbt_extract_streams(   flow_accum,   output,   threshold,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_extract_streams.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract streams — wbt_extract_streams","text":"flow_accum Input raster D8 flow accumulation file. output Output raster file. threshold Threshold flow accumulation values channelization. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_extract_streams.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extract streams — wbt_extract_streams","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_extract_valleys.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract valleys — wbt_extract_valleys","title":"Extract valleys — wbt_extract_valleys","text":"Identifies potential valley bottom grid cells based local topolography alone.","code":""},{"path":"/reference/wbt_extract_valleys.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract valleys — wbt_extract_valleys","text":"","code":"wbt_extract_valleys(   dem,   output,   variant = \"LQ\",   line_thin = TRUE,   filter = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_extract_valleys.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract valleys — wbt_extract_valleys","text":"dem Input raster DEM file. output Output raster file. variant Options include 'LQ' (lower quartile), 'JandR' (Johnston Rosenfeld), 'PandD' (Peucker Douglas); default 'LQ'. line_thin Optional flag indicating whether post-processing line-thinning performed. filter Optional argument (used variant='lq') providing filter size, grid cells, used lq-filtering (default 5). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_extract_valleys.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extract valleys — wbt_extract_valleys","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_farthest_channel_head.html","id":null,"dir":"Reference","previous_headings":"","what":"Farthest channel head — wbt_farthest_channel_head","title":"Farthest channel head — wbt_farthest_channel_head","text":"Calculates distance furthest upstream channel head stream cell.","code":""},{"path":"/reference/wbt_farthest_channel_head.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Farthest channel head — wbt_farthest_channel_head","text":"","code":"wbt_farthest_channel_head(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_farthest_channel_head.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Farthest channel head — wbt_farthest_channel_head","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_farthest_channel_head.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Farthest channel head — wbt_farthest_channel_head","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fast_almost_gaussian_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Fast almost gaussian filter — wbt_fast_almost_gaussian_filter","title":"Fast almost gaussian filter — wbt_fast_almost_gaussian_filter","text":"Performs fast approximate Gaussian filter image.","code":""},{"path":"/reference/wbt_fast_almost_gaussian_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fast almost gaussian filter — wbt_fast_almost_gaussian_filter","text":"","code":"wbt_fast_almost_gaussian_filter(   input,   output,   sigma = 1.8,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fast_almost_gaussian_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fast almost gaussian filter — wbt_fast_almost_gaussian_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma Standard deviation distance pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fast_almost_gaussian_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fast almost gaussian filter — wbt_fast_almost_gaussian_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fd8_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Fd8 flow accumulation — wbt_fd8_flow_accumulation","title":"Fd8 flow accumulation — wbt_fd8_flow_accumulation","text":"Calculates FD8 flow accumulation raster input DEM.","code":""},{"path":"/reference/wbt_fd8_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fd8 flow accumulation — wbt_fd8_flow_accumulation","text":"","code":"wbt_fd8_flow_accumulation(   dem,   output,   out_type = \"specific contributing area\",   exponent = 1.1,   threshold = NULL,   log = FALSE,   clip = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fd8_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fd8 flow accumulation — wbt_fd8_flow_accumulation","text":"dem Input raster DEM file. output Output raster file. out_type Output type; one 'cells', 'specific contributing area' (default), 'catchment area'. exponent Optional exponent parameter; default 1.1. threshold Optional convergence threshold parameter, grid cells; default infinity. log Optional flag request output log-transformed. clip Optional flag request clipping display max 1 percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fd8_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fd8 flow accumulation — wbt_fd8_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fd8_pointer.html","id":null,"dir":"Reference","previous_headings":"","what":"Fd8 pointer — wbt_fd8_pointer","title":"Fd8 pointer — wbt_fd8_pointer","text":"Calculates FD8 flow pointer raster input DEM.","code":""},{"path":"/reference/wbt_fd8_pointer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fd8 pointer — wbt_fd8_pointer","text":"","code":"wbt_fd8_pointer(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fd8_pointer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fd8 pointer — wbt_fd8_pointer","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fd8_pointer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fd8 pointer — wbt_fd8_pointer","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_feature_preserving_smoothing.html","id":null,"dir":"Reference","previous_headings":"","what":"Feature preserving smoothing — wbt_feature_preserving_smoothing","title":"Feature preserving smoothing — wbt_feature_preserving_smoothing","text":"Reduces short-scale variation input DEM using modified Sun et al. (2007) algorithm.","code":""},{"path":"/reference/wbt_feature_preserving_smoothing.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Feature preserving smoothing — wbt_feature_preserving_smoothing","text":"","code":"wbt_feature_preserving_smoothing(   dem,   output,   filter = 11,   norm_diff = 15,   num_iter = 3,   max_diff = 0.5,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_feature_preserving_smoothing.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Feature preserving smoothing — wbt_feature_preserving_smoothing","text":"dem Input raster DEM file. output Output raster file. filter Size filter kernel. norm_diff Maximum difference normal vectors, degrees. num_iter Number iterations. max_diff Maximum allowable absolute elevation change (optional). zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_feature_preserving_smoothing.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Feature preserving smoothing — wbt_feature_preserving_smoothing","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fetch_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch analysis — wbt_fetch_analysis","title":"Fetch analysis — wbt_fetch_analysis","text":"Performs analysis fetch upwind distance obstacle.","code":""},{"path":"/reference/wbt_fetch_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch analysis — wbt_fetch_analysis","text":"","code":"wbt_fetch_analysis(   dem,   output,   azimuth = 0,   hgt_inc = 0.05,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fetch_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch analysis — wbt_fetch_analysis","text":"dem Input raster DEM file. output Output raster file. azimuth Wind azimuth degrees degrees. hgt_inc Height increment value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fetch_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch analysis — wbt_fetch_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_file_path.html","id":null,"dir":"Reference","previous_headings":"","what":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"Performs path expansion path.expand() shell quotes shQuote() input paths.","code":""},{"path":"/reference/wbt_file_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"","code":"wbt_file_path(x, shell_quote = TRUE, delimiter = \",\", check_exists = FALSE)"},{"path":"/reference/wbt_file_path.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"x character terra object. Vector file paths strings file paths passing arguments WhiteboxTools. object class SpatRaster, SpatRasterCollection, SpatVector SpatVectorProxy sources extracted terra::sources() shell_quote logical. Shell quotes around result? Default: TRUE delimiter character. Either \",\" (default) \";\" allowed WhiteboxTools. check_exists logical. Check file(s) x exist? Useful input values. Default: FALSE","code":""},{"path":"/reference/wbt_file_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"character. Length 1. safe input string use WhiteboxTools commands, paths expanded concatenated, necessary, optionally shell quoted.","code":""},{"path":"/reference/wbt_file_path.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"input vector contains \";\" \",\" considered, path expansion performed substrings. input vector length greater 1, vector concatenated \",\" \";\" create single output string.","code":""},{"path":"/reference/wbt_file_path.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Prepare File Paths for WhiteboxTools Commands — wbt_file_path","text":"","code":"wbt_file_path(\"./abc.tif\") #> [1] \"'./abc.tif'\"  wbt_file_path(\"./abc.tif;./def.tif\") #> [1] \"'./abc.tif,./def.tif'\"  wbt_file_path(\"./abc.tif,./def.tif\") #> [1] \"'./abc.tif,./def.tif'\"  wbt_file_path(c(\"./abc.tif\", \"./def.tif\")) #> [1] \"'./abc.tif,./def.tif'\"  wbt_file_path(\"~/abc.tif\", shell_quote = FALSE) #> [1] \"/home/runner/abc.tif\"  wbt_file_path(c(\"~/abc.tif\", \"~/def.tif\")) #> [1] \"'/home/runner/abc.tif,/home/runner/def.tif'\""},{"path":"/reference/wbt_fill_burn.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill burn — wbt_fill_burn","title":"Fill burn — wbt_fill_burn","text":"Burns streams DEM using FillBurn (Saunders, 1999) method.","code":""},{"path":"/reference/wbt_fill_burn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill burn — wbt_fill_burn","text":"","code":"wbt_fill_burn(   dem,   streams,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_burn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill burn — wbt_fill_burn","text":"dem Input raster DEM file. streams Input vector streams file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_burn.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill burn — wbt_fill_burn","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fill_depressions.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill depressions — wbt_fill_depressions","title":"Fill depressions — wbt_fill_depressions","text":"Fills depressions DEM. Depression breaching preferred cases.","code":""},{"path":"/reference/wbt_fill_depressions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill depressions — wbt_fill_depressions","text":"","code":"wbt_fill_depressions(   dem,   output,   fix_flats = TRUE,   flat_increment = NULL,   max_depth = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_depressions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill depressions — wbt_fill_depressions","text":"dem Input raster DEM file. output Output raster file. fix_flats Optional flag indicating whether flat areas small gradient applied. flat_increment Optional elevation increment applied flat areas. max_depth Optional maximum depression depth fill. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_depressions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill depressions — wbt_fill_depressions","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fill_depressions_planchon_and_darboux.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill depressions planchon and darboux — wbt_fill_depressions_planchon_and_darboux","title":"Fill depressions planchon and darboux — wbt_fill_depressions_planchon_and_darboux","text":"Fills depressions DEM using Planchon Darboux (2002) method.","code":""},{"path":"/reference/wbt_fill_depressions_planchon_and_darboux.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill depressions planchon and darboux — wbt_fill_depressions_planchon_and_darboux","text":"","code":"wbt_fill_depressions_planchon_and_darboux(   dem,   output,   fix_flats = TRUE,   flat_increment = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_depressions_planchon_and_darboux.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill depressions planchon and darboux — wbt_fill_depressions_planchon_and_darboux","text":"dem Input raster DEM file. output Output raster file. fix_flats Optional flag indicating whether flat areas small gradient applied. flat_increment Optional elevation increment applied flat areas. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_depressions_planchon_and_darboux.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill depressions planchon and darboux — wbt_fill_depressions_planchon_and_darboux","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fill_depressions_wang_and_liu.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill depressions wang and liu — wbt_fill_depressions_wang_and_liu","title":"Fill depressions wang and liu — wbt_fill_depressions_wang_and_liu","text":"Fills depressions DEM using Wang Liu (2006) method. Depression breaching preferred cases.","code":""},{"path":"/reference/wbt_fill_depressions_wang_and_liu.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill depressions wang and liu — wbt_fill_depressions_wang_and_liu","text":"","code":"wbt_fill_depressions_wang_and_liu(   dem,   output,   fix_flats = TRUE,   flat_increment = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_depressions_wang_and_liu.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill depressions wang and liu — wbt_fill_depressions_wang_and_liu","text":"dem Input raster DEM file. output Output raster file. fix_flats Optional flag indicating whether flat areas small gradient applied. flat_increment Optional elevation increment applied flat areas. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_depressions_wang_and_liu.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill depressions wang and liu — wbt_fill_depressions_wang_and_liu","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fill_missing_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill missing data — wbt_fill_missing_data","title":"Fill missing data — wbt_fill_missing_data","text":"Fills NoData holes DEM.","code":""},{"path":"/reference/wbt_fill_missing_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill missing data — wbt_fill_missing_data","text":"","code":"wbt_fill_missing_data(   input,   output,   filter = 11,   weight = 2,   no_edges = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_missing_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill missing data — wbt_fill_missing_data","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filter Filter size (cells). weight IDW weight value. no_edges Optional flag indicating whether exclude NoData cells edge regions. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_missing_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill missing data — wbt_fill_missing_data","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fill_single_cell_pits.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill single cell pits — wbt_fill_single_cell_pits","title":"Fill single cell pits — wbt_fill_single_cell_pits","text":"Raises pit cells elevation lowest neighbour.","code":""},{"path":"/reference/wbt_fill_single_cell_pits.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill single cell pits — wbt_fill_single_cell_pits","text":"","code":"wbt_fill_single_cell_pits(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fill_single_cell_pits.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill single cell pits — wbt_fill_single_cell_pits","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fill_single_cell_pits.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill single cell pits — wbt_fill_single_cell_pits","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_filter_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter lidar — wbt_filter_lidar","title":"Filter lidar — wbt_filter_lidar","text":"Filters points within LiDAR point cloud based point properties.","code":""},{"path":"/reference/wbt_filter_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter lidar — wbt_filter_lidar","text":"","code":"wbt_filter_lidar(   input,   output = NULL,   statement = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_filter_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter lidar — wbt_filter_lidar","text":"input Name input LiDAR points. output Name output LiDAR points. statement Filter statement e.g. x < 5000.0 && y > 100.0 && is_late && !is_noise. statement must valid Rust statement. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_filter_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter lidar — wbt_filter_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_filter_lidar_classes.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter lidar classes — wbt_filter_lidar_classes","title":"Filter lidar classes — wbt_filter_lidar_classes","text":"Removes points LAS file certain specified class values.","code":""},{"path":"/reference/wbt_filter_lidar_classes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter lidar classes — wbt_filter_lidar_classes","text":"","code":"wbt_filter_lidar_classes(   input,   output,   exclude_cls = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_filter_lidar_classes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter lidar classes — wbt_filter_lidar_classes","text":"input Input LiDAR file. output Output LiDAR file. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_filter_lidar_classes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter lidar classes — wbt_filter_lidar_classes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_filter_lidar_scan_angles.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter lidar scan angles — wbt_filter_lidar_scan_angles","title":"Filter lidar scan angles — wbt_filter_lidar_scan_angles","text":"Removes points LAS file scan angles greater threshold.","code":""},{"path":"/reference/wbt_filter_lidar_scan_angles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter lidar scan angles — wbt_filter_lidar_scan_angles","text":"","code":"wbt_filter_lidar_scan_angles(   input,   output,   threshold,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_filter_lidar_scan_angles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter lidar scan angles — wbt_filter_lidar_scan_angles","text":"input Input LiDAR file. output Output LiDAR file. threshold Scan angle threshold. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_filter_lidar_scan_angles.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter lidar scan angles — wbt_filter_lidar_scan_angles","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_filter_raster_features_by_area.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter raster features by area — wbt_filter_raster_features_by_area","title":"Filter raster features by area — wbt_filter_raster_features_by_area","text":"Removes small-area features raster.","code":""},{"path":"/reference/wbt_filter_raster_features_by_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter raster features by area — wbt_filter_raster_features_by_area","text":"","code":"wbt_filter_raster_features_by_area(   input,   output,   threshold,   background = \"zero\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_filter_raster_features_by_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter raster features by area — wbt_filter_raster_features_by_area","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. threshold Remove features fewer grid cells threshold value. background Background value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_filter_raster_features_by_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter raster features by area — wbt_filter_raster_features_by_area","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_flightline_edge_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Find flightline edge points — wbt_find_flightline_edge_points","title":"Find flightline edge points — wbt_find_flightline_edge_points","text":"Identifies points along flightline's edge LAS file.","code":""},{"path":"/reference/wbt_find_flightline_edge_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find flightline edge points — wbt_find_flightline_edge_points","text":"","code":"wbt_find_flightline_edge_points(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_flightline_edge_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find flightline edge points — wbt_find_flightline_edge_points","text":"input Input LiDAR file. output Output file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_flightline_edge_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find flightline edge points — wbt_find_flightline_edge_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_lowest_or_highest_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Find lowest or highest points — wbt_find_lowest_or_highest_points","title":"Find lowest or highest points — wbt_find_lowest_or_highest_points","text":"Locates lowest /highest valued cells raster.","code":""},{"path":"/reference/wbt_find_lowest_or_highest_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find lowest or highest points — wbt_find_lowest_or_highest_points","text":"","code":"wbt_find_lowest_or_highest_points(   input,   output,   out_type = \"lowest\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_lowest_or_highest_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find lowest or highest points — wbt_find_lowest_or_highest_points","text":"input Input raster file path. See wbt_file_path() details. output Output vector points file. out_type Output type; one 'area' (default) 'volume'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_lowest_or_highest_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find lowest or highest points — wbt_find_lowest_or_highest_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_main_stem.html","id":null,"dir":"Reference","previous_headings":"","what":"Find main stem — wbt_find_main_stem","title":"Find main stem — wbt_find_main_stem","text":"Finds main stem, based stream lengths, stream network.","code":""},{"path":"/reference/wbt_find_main_stem.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find main stem — wbt_find_main_stem","text":"","code":"wbt_find_main_stem(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_main_stem.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find main stem — wbt_find_main_stem","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_main_stem.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find main stem — wbt_find_main_stem","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_no_flow_cells.html","id":null,"dir":"Reference","previous_headings":"","what":"Find no flow cells — wbt_find_no_flow_cells","title":"Find no flow cells — wbt_find_no_flow_cells","text":"Finds grid cells downslope neighbours.","code":""},{"path":"/reference/wbt_find_no_flow_cells.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find no flow cells — wbt_find_no_flow_cells","text":"","code":"wbt_find_no_flow_cells(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_no_flow_cells.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find no flow cells — wbt_find_no_flow_cells","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_no_flow_cells.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find no flow cells — wbt_find_no_flow_cells","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_parallel_flow.html","id":null,"dir":"Reference","previous_headings":"","what":"Find parallel flow — wbt_find_parallel_flow","title":"Find parallel flow — wbt_find_parallel_flow","text":"Finds areas parallel flow D8 flow direction rasters.","code":""},{"path":"/reference/wbt_find_parallel_flow.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find parallel flow — wbt_find_parallel_flow","text":"","code":"wbt_find_parallel_flow(   d8_pntr,   streams,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_parallel_flow.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find parallel flow — wbt_find_parallel_flow","text":"d8_pntr Input D8 pointer raster file. streams Input raster streams file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_parallel_flow.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find parallel flow — wbt_find_parallel_flow","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_patch_or_class_edge_cells.html","id":null,"dir":"Reference","previous_headings":"","what":"Find patch or class edge cells — wbt_find_patch_or_class_edge_cells","title":"Find patch or class edge cells — wbt_find_patch_or_class_edge_cells","text":"Finds cells located edge patch class features.","code":""},{"path":"/reference/wbt_find_patch_or_class_edge_cells.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find patch or class edge cells — wbt_find_patch_or_class_edge_cells","text":"","code":"wbt_find_patch_or_class_edge_cells(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_patch_or_class_edge_cells.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find patch or class edge cells — wbt_find_patch_or_class_edge_cells","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_patch_or_class_edge_cells.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find patch or class edge cells — wbt_find_patch_or_class_edge_cells","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_find_ridges.html","id":null,"dir":"Reference","previous_headings":"","what":"Find ridges — wbt_find_ridges","title":"Find ridges — wbt_find_ridges","text":"Identifies potential ridge peak grid cells.","code":""},{"path":"/reference/wbt_find_ridges.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find ridges — wbt_find_ridges","text":"","code":"wbt_find_ridges(   dem,   output,   line_thin = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_find_ridges.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find ridges — wbt_find_ridges","text":"dem Input raster DEM file. output Output raster file. line_thin Optional flag indicating whether post-processing line-thinning performed. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_find_ridges.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find ridges — wbt_find_ridges","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_fix_dangling_arcs.html","id":null,"dir":"Reference","previous_headings":"","what":"Fix dangling arcs — wbt_fix_dangling_arcs","title":"Fix dangling arcs — wbt_fix_dangling_arcs","text":"tool fixes undershot overshot arcs, two common topological errors, input vector lines file.","code":""},{"path":"/reference/wbt_fix_dangling_arcs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fix dangling arcs — wbt_fix_dangling_arcs","text":"","code":"wbt_fix_dangling_arcs(   input,   output,   dist = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_fix_dangling_arcs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fix dangling arcs — wbt_fix_dangling_arcs","text":"input Name input lines vector file. output Name output lines vector file. dist Snap distance, xy units (metres). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_fix_dangling_arcs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fix dangling arcs — wbt_fix_dangling_arcs","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flatten_lakes.html","id":null,"dir":"Reference","previous_headings":"","what":"Flatten lakes — wbt_flatten_lakes","title":"Flatten lakes — wbt_flatten_lakes","text":"Flattens lake polygons raster DEM.","code":""},{"path":"/reference/wbt_flatten_lakes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flatten lakes — wbt_flatten_lakes","text":"","code":"wbt_flatten_lakes(   dem,   lakes,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flatten_lakes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flatten lakes — wbt_flatten_lakes","text":"dem Input raster DEM file. lakes Input lakes vector polygons file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flatten_lakes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flatten lakes — wbt_flatten_lakes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flightline_overlap.html","id":null,"dir":"Reference","previous_headings":"","what":"Flightline overlap — wbt_flightline_overlap","title":"Flightline overlap — wbt_flightline_overlap","text":"Reads LiDAR (LAS) point file outputs raster containing number overlapping flight-lines grid cell.","code":""},{"path":"/reference/wbt_flightline_overlap.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flightline overlap — wbt_flightline_overlap","text":"","code":"wbt_flightline_overlap(   input,   output = NULL,   resolution = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flightline_overlap.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flightline overlap — wbt_flightline_overlap","text":"input Input LiDAR file. output Output file. resolution Output raster's grid resolution. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flightline_overlap.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flightline overlap — wbt_flightline_overlap","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flip_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Flip image — wbt_flip_image","title":"Flip image — wbt_flip_image","text":"Reflects image vertical horizontal axis.","code":""},{"path":"/reference/wbt_flip_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flip image — wbt_flip_image","text":"","code":"wbt_flip_image(   input,   output,   direction = \"vertical\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flip_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flip image — wbt_flip_image","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. direction Direction reflection; options include 'v' (vertical), 'h' (horizontal), 'b' (). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flip_image.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flip image — wbt_flip_image","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flood_order.html","id":null,"dir":"Reference","previous_headings":"","what":"Flood order — wbt_flood_order","title":"Flood order — wbt_flood_order","text":"Assigns DEM grid cell order sequence inundations encountered search starting edges, moving inward increasing elevations.","code":""},{"path":"/reference/wbt_flood_order.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flood order — wbt_flood_order","text":"","code":"wbt_flood_order(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flood_order.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flood order — wbt_flood_order","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flood_order.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flood order — wbt_flood_order","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_floor.html","id":null,"dir":"Reference","previous_headings":"","what":"Floor — wbt_floor","title":"Floor — wbt_floor","text":"Returns largest (closest positive infinity) value less equal values raster.","code":""},{"path":"/reference/wbt_floor.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Floor — wbt_floor","text":"","code":"wbt_floor(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_floor.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Floor — wbt_floor","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_floor.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Floor — wbt_floor","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flow_accumulation_full_workflow.html","id":null,"dir":"Reference","previous_headings":"","what":"Flow accumulation full workflow — wbt_flow_accumulation_full_workflow","title":"Flow accumulation full workflow — wbt_flow_accumulation_full_workflow","text":"Resolves depressions DEM, outputting breached DEM, aspect-aligned non-divergent flow pointer, flow accumulation raster.","code":""},{"path":"/reference/wbt_flow_accumulation_full_workflow.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flow accumulation full workflow — wbt_flow_accumulation_full_workflow","text":"","code":"wbt_flow_accumulation_full_workflow(   dem,   out_dem,   out_pntr,   out_accum,   out_type = \"Specific Contributing Area\",   log = FALSE,   clip = FALSE,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flow_accumulation_full_workflow.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flow accumulation full workflow — wbt_flow_accumulation_full_workflow","text":"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 'cells', 'sca' (default), 'ca'. log Optional flag request output log-transformed. clip Optional flag request clipping display max 1 percent. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flow_accumulation_full_workflow.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flow accumulation full workflow — wbt_flow_accumulation_full_workflow","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_flow_length_diff.html","id":null,"dir":"Reference","previous_headings":"","what":"Flow length diff — wbt_flow_length_diff","title":"Flow length diff — wbt_flow_length_diff","text":"Calculates local maximum absolute difference downslope flowpath length, useful mapping drainage divides ridges.","code":""},{"path":"/reference/wbt_flow_length_diff.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Flow length diff — wbt_flow_length_diff","text":"","code":"wbt_flow_length_diff(   d8_pntr,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_flow_length_diff.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Flow length diff — wbt_flow_length_diff","text":"d8_pntr Input D8 pointer raster file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_flow_length_diff.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Flow length diff — wbt_flow_length_diff","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_gamma_correction.html","id":null,"dir":"Reference","previous_headings":"","what":"Gamma correction — wbt_gamma_correction","title":"Gamma correction — wbt_gamma_correction","text":"Performs gamma correction input images.","code":""},{"path":"/reference/wbt_gamma_correction.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Gamma correction — wbt_gamma_correction","text":"","code":"wbt_gamma_correction(   input,   output,   gamma = 0.5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_gamma_correction.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Gamma correction — wbt_gamma_correction","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. gamma Gamma value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_gamma_correction.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Gamma correction — wbt_gamma_correction","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_gaussian_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Gaussian contrast stretch — wbt_gaussian_contrast_stretch","title":"Gaussian contrast stretch — wbt_gaussian_contrast_stretch","text":"Performs Gaussian contrast stretch input images.","code":""},{"path":"/reference/wbt_gaussian_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Gaussian contrast stretch — wbt_gaussian_contrast_stretch","text":"","code":"wbt_gaussian_contrast_stretch(   input,   output,   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_gaussian_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Gaussian contrast stretch — wbt_gaussian_contrast_stretch","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_gaussian_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Gaussian contrast stretch — wbt_gaussian_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_gaussian_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Gaussian curvature — wbt_gaussian_curvature","title":"Gaussian curvature — wbt_gaussian_curvature","text":"Calculates mean curvature raster input DEM.","code":""},{"path":"/reference/wbt_gaussian_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Gaussian curvature — wbt_gaussian_curvature","text":"","code":"wbt_gaussian_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_gaussian_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Gaussian curvature — wbt_gaussian_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_gaussian_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Gaussian curvature — wbt_gaussian_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_gaussian_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Gaussian filter — wbt_gaussian_filter","title":"Gaussian filter — wbt_gaussian_filter","text":"Performs Gaussian filter image.","code":""},{"path":"/reference/wbt_gaussian_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Gaussian filter — wbt_gaussian_filter","text":"","code":"wbt_gaussian_filter(   input,   output,   sigma = 0.75,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_gaussian_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Gaussian filter — wbt_gaussian_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma Standard deviation distance pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_gaussian_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Gaussian filter — wbt_gaussian_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_gaussian_scale_space.html","id":null,"dir":"Reference","previous_headings":"","what":"Gaussian scale space — wbt_gaussian_scale_space","title":"Gaussian scale space — wbt_gaussian_scale_space","text":"Uses fast Gaussian approximation algorithm produce scaled land-surface parameter measurements input DEM.","code":""},{"path":"/reference/wbt_gaussian_scale_space.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Gaussian scale space — wbt_gaussian_scale_space","text":"","code":"wbt_gaussian_scale_space(   dem,   output,   output_zscore,   output_scale,   points = NULL,   sigma = 0.5,   step = 0.5,   num_steps = 10,   lsp = \"Slope\",   z_factor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_gaussian_scale_space.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Gaussian scale space — wbt_gaussian_scale_space","text":"dem Name input DEM raster file. output Name output land-surface parameter raster file. output_zscore Name output z-score raster file. output_scale Name output scale raster file. points Name input vector points shapefile. sigma Initial sigma value (cells). step Step size positive non-zero integer. num_steps Number steps. lsp Output land-surface parameter; one 'AnisotropyLTP', 'Aspect', 'DiffMeanElev', 'Eastness', 'Elevation', 'Hillshade', 'MeanCurvature', 'Northness', 'PlanCurvature', 'ProfileCurvature', 'Ruggedness', 'Slope', 'TanCurvature', 'TotalCurvature'. z_factor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_gaussian_scale_space.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Gaussian scale space — wbt_gaussian_scale_space","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_generalize_classified_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Generalize classified raster — wbt_generalize_classified_raster","title":"Generalize classified raster — wbt_generalize_classified_raster","text":"Generalizes raster containing class object features removing small features.","code":""},{"path":"/reference/wbt_generalize_classified_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generalize classified raster — wbt_generalize_classified_raster","text":"","code":"wbt_generalize_classified_raster(   input,   output,   min_size = 4,   method = \"longest\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_generalize_classified_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generalize classified raster — wbt_generalize_classified_raster","text":"input Name input raster image file. output Name output raster file. min_size Minimum feature size, grid cells. method Grouping method; one 'longest' (default), 'largest', 'nearest'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_generalize_classified_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generalize classified raster — wbt_generalize_classified_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_generalize_with_similarity.html","id":null,"dir":"Reference","previous_headings":"","what":"Generalize with similarity — wbt_generalize_with_similarity","title":"Generalize with similarity — wbt_generalize_with_similarity","text":"Generalizes raster containing class object features removing small features using similarity criteria neighbouring features.","code":""},{"path":"/reference/wbt_generalize_with_similarity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generalize with similarity — wbt_generalize_with_similarity","text":"","code":"wbt_generalize_with_similarity(   input,   similarity,   output,   min_size = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_generalize_with_similarity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generalize with similarity — wbt_generalize_with_similarity","text":"input Name input raster image file. similarity Names input similarity images. output Name output raster file. min_size Minimum feature size, grid cells. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_generalize_with_similarity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generalize with similarity — wbt_generalize_with_similarity","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_generating_function.html","id":null,"dir":"Reference","previous_headings":"","what":"Generating function — wbt_generating_function","title":"Generating function — wbt_generating_function","text":"tool calculates generating function input DEM.","code":""},{"path":"/reference/wbt_generating_function.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generating function — wbt_generating_function","text":"","code":"wbt_generating_function(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_generating_function.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generating function — wbt_generating_function","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_generating_function.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generating function — wbt_generating_function","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_geomorphons.html","id":null,"dir":"Reference","previous_headings":"","what":"Geomorphons — wbt_geomorphons","title":"Geomorphons — wbt_geomorphons","text":"Computes geomorphon patterns.","code":""},{"path":"/reference/wbt_geomorphons.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Geomorphons — wbt_geomorphons","text":"","code":"wbt_geomorphons(   dem,   output,   search = 50,   threshold = 0,   fdist = 0,   skip = 0,   forms = TRUE,   residuals = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_geomorphons.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Geomorphons — wbt_geomorphons","text":"dem Input raster DEM file. output Output raster file. search Look distance (cells). threshold Flatness threshold classification function (degrees). fdist Distance (cells) begin reducing flatness threshold avoid problems pseudo-flat lines--sight. skip Distance (cells) begin calculating lines--sight. forms Classify geomorphons 10 common land morphologies, else output ternary pattern. residuals Convert elevation residuals linear model. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_geomorphons.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Geomorphons — wbt_geomorphons","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_greater_than.html","id":null,"dir":"Reference","previous_headings":"","what":"Greater than — wbt_greater_than","title":"Greater than — wbt_greater_than","text":"Performs greater-comparison operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_greater_than.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Greater than — wbt_greater_than","text":"","code":"wbt_greater_than(   input1,   input2,   output,   incl_equals = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_greater_than.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Greater than — wbt_greater_than","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. incl_equals Perform greater---equal-operation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_greater_than.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Greater than — wbt_greater_than","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hack_stream_order.html","id":null,"dir":"Reference","previous_headings":"","what":"Hack stream order — wbt_hack_stream_order","title":"Hack stream order — wbt_hack_stream_order","text":"Assigns Hack stream order tributary stream network.","code":""},{"path":"/reference/wbt_hack_stream_order.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hack stream order — wbt_hack_stream_order","text":"","code":"wbt_hack_stream_order(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hack_stream_order.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hack stream order — wbt_hack_stream_order","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hack_stream_order.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hack stream order — wbt_hack_stream_order","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_heat_map.html","id":null,"dir":"Reference","previous_headings":"","what":"Heat map — wbt_heat_map","title":"Heat map — wbt_heat_map","text":"Calculates heat map, kernel density estimation (KDE), input point set.","code":""},{"path":"/reference/wbt_heat_map.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Heat map — wbt_heat_map","text":"","code":"wbt_heat_map(   input,   output,   weight_field = NULL,   bandwidth = \"\",   kernel = \"quartic\",   cell_size = \"\",   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_heat_map.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Heat map — wbt_heat_map","text":"input Name input points shapefile. output Name output raster image file. weight_field Optional name attribute containing point weight. bandwidth Bandwidth (metres). kernel Kernel type; one 'uniform', 'triangular', 'epanechnikov', 'quartic', 'triweight', 'tricube', 'gaussian', 'cosine', 'logistic', 'sigmoid', 'silverman'. cell_size Optionally specified cell size output raster, metres. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_heat_map.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Heat map — wbt_heat_map","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_height_above_ground.html","id":null,"dir":"Reference","previous_headings":"","what":"Height above ground — wbt_height_above_ground","title":"Height above ground — wbt_height_above_ground","text":"Normalizes LiDAR point cloud, providing height nearest ground-classified point.","code":""},{"path":"/reference/wbt_height_above_ground.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Height above ground — wbt_height_above_ground","text":"","code":"wbt_height_above_ground(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_height_above_ground.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Height above ground — wbt_height_above_ground","text":"input Input LiDAR file (including extension). output Output lidar file (including extension). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_height_above_ground.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Height above ground — wbt_height_above_ground","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_help.html","id":null,"dir":"Reference","previous_headings":"","what":"Help description for 'WhiteboxTools' — wbt_help","title":"Help description for 'WhiteboxTools' — wbt_help","text":"Help description 'WhiteboxTools'","code":""},{"path":"/reference/wbt_help.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Help description for 'WhiteboxTools' — wbt_help","text":"","code":"wbt_help()"},{"path":"/reference/wbt_help.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Help description for 'WhiteboxTools' — wbt_help","text":"Returns help description 'WhiteboxTools' R character vector.","code":""},{"path":"/reference/wbt_help.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Help description for 'WhiteboxTools' — wbt_help","text":"","code":"if (FALSE) { wbt_help() }"},{"path":"/reference/wbt_high_pass_bilateral_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"High pass bilateral filter — wbt_high_pass_bilateral_filter","title":"High pass bilateral filter — wbt_high_pass_bilateral_filter","text":"Performs high-pass bilateral filter, differencing input image bilateral filter Tomasi Manduchi (1998).","code":""},{"path":"/reference/wbt_high_pass_bilateral_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"High pass bilateral filter — wbt_high_pass_bilateral_filter","text":"","code":"wbt_high_pass_bilateral_filter(   input,   output,   sigma_dist = 0.75,   sigma_int = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_high_pass_bilateral_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"High pass bilateral filter — wbt_high_pass_bilateral_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma_dist Standard deviation distance pixels. sigma_int Standard deviation intensity pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_high_pass_bilateral_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"High pass bilateral filter — wbt_high_pass_bilateral_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_high_pass_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"High pass filter — wbt_high_pass_filter","title":"High pass filter — wbt_high_pass_filter","text":"Performs high-pass filter input image.","code":""},{"path":"/reference/wbt_high_pass_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"High pass filter — wbt_high_pass_filter","text":"","code":"wbt_high_pass_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_high_pass_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"High pass filter — wbt_high_pass_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_high_pass_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"High pass filter — wbt_high_pass_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_high_pass_median_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"High pass median filter — wbt_high_pass_median_filter","title":"High pass median filter — wbt_high_pass_median_filter","text":"Performs high pass median filter input image.","code":""},{"path":"/reference/wbt_high_pass_median_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"High pass median filter — wbt_high_pass_median_filter","text":"","code":"wbt_high_pass_median_filter(   input,   output,   filterx = 11,   filtery = 11,   sig_digits = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_high_pass_median_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"High pass median filter — wbt_high_pass_median_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. sig_digits Number significant digits. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_high_pass_median_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"High pass median filter — wbt_high_pass_median_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_highest_position.html","id":null,"dir":"Reference","previous_headings":"","what":"Highest position — wbt_highest_position","title":"Highest position — wbt_highest_position","text":"Identifies stack position maximum value within raster stack cell--cell basis.","code":""},{"path":"/reference/wbt_highest_position.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Highest position — wbt_highest_position","text":"","code":"wbt_highest_position(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_highest_position.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Highest position — wbt_highest_position","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_highest_position.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Highest position — wbt_highest_position","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hillshade.html","id":null,"dir":"Reference","previous_headings":"","what":"Hillshade — wbt_hillshade","title":"Hillshade — wbt_hillshade","text":"Calculates hillshade raster input DEM.","code":""},{"path":"/reference/wbt_hillshade.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hillshade — wbt_hillshade","text":"","code":"wbt_hillshade(   dem,   output,   azimuth = 315,   altitude = 30,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hillshade.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hillshade — wbt_hillshade","text":"dem Input raster DEM file. output Output raster file. azimuth Illumination source azimuth degrees. altitude Illumination source altitude degrees. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hillshade.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hillshade — wbt_hillshade","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hillslopes.html","id":null,"dir":"Reference","previous_headings":"","what":"Hillslopes — wbt_hillslopes","title":"Hillslopes — wbt_hillslopes","text":"Identifies individual hillslopes draining link stream network.","code":""},{"path":"/reference/wbt_hillslopes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hillslopes — wbt_hillslopes","text":"","code":"wbt_hillslopes(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hillslopes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hillslopes — wbt_hillslopes","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hillslopes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hillslopes — wbt_hillslopes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_histogram_equalization.html","id":null,"dir":"Reference","previous_headings":"","what":"Histogram equalization — wbt_histogram_equalization","title":"Histogram equalization — wbt_histogram_equalization","text":"Performs histogram equalization contrast enhancement image.","code":""},{"path":"/reference/wbt_histogram_equalization.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Histogram equalization — wbt_histogram_equalization","text":"","code":"wbt_histogram_equalization(   input,   output,   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_histogram_equalization.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Histogram equalization — wbt_histogram_equalization","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_histogram_equalization.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Histogram equalization — wbt_histogram_equalization","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_histogram_matching.html","id":null,"dir":"Reference","previous_headings":"","what":"Histogram matching — wbt_histogram_matching","title":"Histogram matching — wbt_histogram_matching","text":"Alters statistical distribution raster image matching specified PDF.","code":""},{"path":"/reference/wbt_histogram_matching.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Histogram matching — wbt_histogram_matching","text":"","code":"wbt_histogram_matching(   input,   histo_file,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_histogram_matching.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Histogram matching — wbt_histogram_matching","text":"input Input raster file path. See wbt_file_path() details. histo_file Input reference probability distribution function (pdf) text file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_histogram_matching.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Histogram matching — wbt_histogram_matching","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_histogram_matching_two_images.html","id":null,"dir":"Reference","previous_headings":"","what":"Histogram matching two images — wbt_histogram_matching_two_images","title":"Histogram matching two images — wbt_histogram_matching_two_images","text":"Alters cumulative distribution function raster image another image.","code":""},{"path":"/reference/wbt_histogram_matching_two_images.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Histogram matching two images — wbt_histogram_matching_two_images","text":"","code":"wbt_histogram_matching_two_images(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_histogram_matching_two_images.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Histogram matching two images — wbt_histogram_matching_two_images","text":"input1 Input raster file modify. input2 Input reference raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_histogram_matching_two_images.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Histogram matching two images — wbt_histogram_matching_two_images","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hole_proportion.html","id":null,"dir":"Reference","previous_headings":"","what":"Hole proportion — wbt_hole_proportion","title":"Hole proportion — wbt_hole_proportion","text":"Calculates proportion total area polygon's holes relative area polygon's hull.","code":""},{"path":"/reference/wbt_hole_proportion.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hole proportion — wbt_hole_proportion","text":"","code":"wbt_hole_proportion(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hole_proportion.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hole proportion — wbt_hole_proportion","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hole_proportion.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hole proportion — wbt_hole_proportion","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_horizon_angle.html","id":null,"dir":"Reference","previous_headings":"","what":"Horizon angle — wbt_horizon_angle","title":"Horizon angle — wbt_horizon_angle","text":"Calculates horizon angle (maximum upwind slope) grid cell input DEM.","code":""},{"path":"/reference/wbt_horizon_angle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Horizon angle — wbt_horizon_angle","text":"","code":"wbt_horizon_angle(   dem,   output,   azimuth = 0,   max_dist = 100,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_horizon_angle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Horizon angle — wbt_horizon_angle","text":"dem Input raster DEM file. output Output raster file. azimuth Azimuth, degrees. max_dist Optional maximum search distance (unspecified none; xy units). Minimum value 5 x cell size. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_horizon_angle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Horizon angle — wbt_horizon_angle","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_horizontal_excess_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Horizontal excess curvature — wbt_horizontal_excess_curvature","title":"Horizontal excess curvature — wbt_horizontal_excess_curvature","text":"tool calculates horizontal excess curvature input DEM.","code":""},{"path":"/reference/wbt_horizontal_excess_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Horizontal excess curvature — wbt_horizontal_excess_curvature","text":"","code":"wbt_horizontal_excess_curvature(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_horizontal_excess_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Horizontal excess curvature — wbt_horizontal_excess_curvature","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_horizontal_excess_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Horizontal excess curvature — wbt_horizontal_excess_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_horton_stream_order.html","id":null,"dir":"Reference","previous_headings":"","what":"Horton stream order — wbt_horton_stream_order","title":"Horton stream order — wbt_horton_stream_order","text":"Assigns Horton stream order tributary stream network.","code":""},{"path":"/reference/wbt_horton_stream_order.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Horton stream order — wbt_horton_stream_order","text":"","code":"wbt_horton_stream_order(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_horton_stream_order.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Horton stream order — wbt_horton_stream_order","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_horton_stream_order.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Horton stream order — wbt_horton_stream_order","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hydrologic_connectivity.html","id":null,"dir":"Reference","previous_headings":"","what":"Hydrologic connectivity — wbt_hydrologic_connectivity","title":"Hydrologic connectivity — wbt_hydrologic_connectivity","text":"tool evaluates hydrologic connectivity within DEM.","code":""},{"path":"/reference/wbt_hydrologic_connectivity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hydrologic connectivity — wbt_hydrologic_connectivity","text":"","code":"wbt_hydrologic_connectivity(   dem,   output1,   output2,   exponent = 1,   threshold = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hydrologic_connectivity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hydrologic connectivity — wbt_hydrologic_connectivity","text":"dem Name input DEM raster file; must depressionless. output1 Name output downslope unsaturated length (DUL) file. output2 Name output upslope disconnected saturated area (UDSA) file. exponent Optional exponent parameter; default 1.0. threshold Optional convergence threshold parameter, grid cells; default infinity. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hydrologic_connectivity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hydrologic connectivity — wbt_hydrologic_connectivity","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hypsometric_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Hypsometric analysis — wbt_hypsometric_analysis","title":"Hypsometric analysis — wbt_hypsometric_analysis","text":"Calculates hypsometric curve one DEMs.","code":""},{"path":"/reference/wbt_hypsometric_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hypsometric analysis — wbt_hypsometric_analysis","text":"","code":"wbt_hypsometric_analysis(   inputs,   output,   watershed = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hypsometric_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hypsometric analysis — wbt_hypsometric_analysis","text":"inputs Input DEM files. output Output HTML file (default name based input file unspecified). watershed Input watershed files (optional). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hypsometric_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hypsometric analysis — wbt_hypsometric_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_hypsometrically_tinted_hillshade.html","id":null,"dir":"Reference","previous_headings":"","what":"Hypsometrically tinted hillshade — wbt_hypsometrically_tinted_hillshade","title":"Hypsometrically tinted hillshade — wbt_hypsometrically_tinted_hillshade","text":"Creates colour shaded relief image input DEM.","code":""},{"path":"/reference/wbt_hypsometrically_tinted_hillshade.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Hypsometrically tinted hillshade — wbt_hypsometrically_tinted_hillshade","text":"","code":"wbt_hypsometrically_tinted_hillshade(   dem,   output,   altitude = 45,   hs_weight = 0.5,   brightness = 0.5,   atmospheric = 0,   palette = \"atlas\",   reverse = FALSE,   zfactor = NULL,   full_mode = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_hypsometrically_tinted_hillshade.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Hypsometrically tinted hillshade — wbt_hypsometrically_tinted_hillshade","text":"dem Input raster DEM file. output Output raster file. altitude Illumination source altitude degrees. hs_weight Weight given hillshade relative relief (0.0-1.0). brightness Brightness factor (0.0-1.0). atmospheric Atmospheric effects weight (0.0-1.0). palette Options include 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'purple', 'viridis', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep'. reverse Optional flag indicating whether use reverse palette. zfactor Optional multiplier vertical horizontal units . full_mode Optional flag indicating whether use full 360-degrees illumination sources. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_hypsometrically_tinted_hillshade.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Hypsometrically tinted hillshade — wbt_hypsometrically_tinted_hillshade","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_idw_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Idw interpolation — wbt_idw_interpolation","title":"Idw interpolation — wbt_idw_interpolation","text":"Interpolates vector points raster surface using inverse-distance weighted scheme.","code":""},{"path":"/reference/wbt_idw_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Idw interpolation — wbt_idw_interpolation","text":"","code":"wbt_idw_interpolation(   input,   field,   output,   use_z = FALSE,   weight = 2,   radius = NULL,   min_points = NULL,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_idw_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Idw interpolation — wbt_idw_interpolation","text":"input Input vector Points file. field Input field name attribute table. output Output raster file. use_z Use z-coordinate instead field?. weight IDW weight value. radius Search Radius map units. min_points Minimum number points. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_idw_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Idw interpolation — wbt_idw_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ihs_to_rgb.html","id":null,"dir":"Reference","previous_headings":"","what":"Ihs to rgb — wbt_ihs_to_rgb","title":"Ihs to rgb — wbt_ihs_to_rgb","text":"Converts intensity, hue, saturation (IHS) images red, green, blue (RGB) images.","code":""},{"path":"/reference/wbt_ihs_to_rgb.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ihs to rgb — wbt_ihs_to_rgb","text":"","code":"wbt_ihs_to_rgb(   intensity,   hue,   saturation,   red = NULL,   green = NULL,   blue = NULL,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ihs_to_rgb.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ihs to rgb — wbt_ihs_to_rgb","text":"intensity Input intensity file. hue Input hue file. saturation Input saturation file. red Output red band file. Optionally specified colour-composite specified. green Output green band file. Optionally specified colour-composite specified. blue Output blue band file. Optionally specified colour-composite specified. output Output colour-composite file. used individual bands specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ihs_to_rgb.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ihs to rgb — wbt_ihs_to_rgb","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_autocorrelation.html","id":null,"dir":"Reference","previous_headings":"","what":"Image autocorrelation — wbt_image_autocorrelation","title":"Image autocorrelation — wbt_image_autocorrelation","text":"Performs Moran's analysis two input images.","code":""},{"path":"/reference/wbt_image_autocorrelation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image autocorrelation — wbt_image_autocorrelation","text":"","code":"wbt_image_autocorrelation(   inputs,   output,   contiguity = \"Rook\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_autocorrelation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image autocorrelation — wbt_image_autocorrelation","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output HTML file (default name based input file unspecified). contiguity Contiguity type. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_autocorrelation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image autocorrelation — wbt_image_autocorrelation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_correlation.html","id":null,"dir":"Reference","previous_headings":"","what":"Image correlation — wbt_image_correlation","title":"Image correlation — wbt_image_correlation","text":"Performs image correlation two input images.","code":""},{"path":"/reference/wbt_image_correlation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image correlation — wbt_image_correlation","text":"","code":"wbt_image_correlation(   inputs,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_correlation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image correlation — wbt_image_correlation","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_correlation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image correlation — wbt_image_correlation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_correlation_neighbourhood_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Image correlation neighbourhood analysis — wbt_image_correlation_neighbourhood_analysis","title":"Image correlation neighbourhood analysis — wbt_image_correlation_neighbourhood_analysis","text":"Performs image correlation two input images neighbourhood search windows.","code":""},{"path":"/reference/wbt_image_correlation_neighbourhood_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image correlation neighbourhood analysis — wbt_image_correlation_neighbourhood_analysis","text":"","code":"wbt_image_correlation_neighbourhood_analysis(   input1,   input2,   output1,   output2,   filter = 11,   stat = \"pearson\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_correlation_neighbourhood_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image correlation neighbourhood analysis — wbt_image_correlation_neighbourhood_analysis","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file path. See wbt_file_path() details. output1 Output correlation (r-value rho) raster file. output2 Output significance (p-value) raster file. filter Size filter kernel. stat Correlation type; one 'pearson' (default) 'spearman'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_correlation_neighbourhood_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image correlation neighbourhood analysis — wbt_image_correlation_neighbourhood_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Image regression — wbt_image_regression","title":"Image regression — wbt_image_regression","text":"Performs image regression analysis two input images.","code":""},{"path":"/reference/wbt_image_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image regression — wbt_image_regression","text":"","code":"wbt_image_regression(   input1,   input2,   output,   out_residuals = NULL,   standardize = FALSE,   scattergram = FALSE,   num_samples = 1000,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image regression — wbt_image_regression","text":"input1 Input raster file (independent variable, X). input2 Input raster file (dependent variable, Y). output Output HTML file regression summary report. out_residuals Output raster regression residual file. standardize Optional flag indicating whether standardize residuals map. scattergram Optional flag indicating whether output scattergram. num_samples Number samples used create scattergram. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image regression — wbt_image_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_segmentation.html","id":null,"dir":"Reference","previous_headings":"","what":"Image segmentation — wbt_image_segmentation","title":"Image segmentation — wbt_image_segmentation","text":"Performs region-growing based segmentation set multi-spectral images.","code":""},{"path":"/reference/wbt_image_segmentation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image segmentation — wbt_image_segmentation","text":"","code":"wbt_image_segmentation(   inputs,   output,   threshold = 0.5,   steps = 10,   min_area = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_segmentation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image segmentation — wbt_image_segmentation","text":"inputs Names input band images. output Name output raster file. threshold Distance threshold, z-scores. steps Number steps. min_area Minimum object area, grid cells (1-8). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_segmentation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image segmentation — wbt_image_segmentation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_slider.html","id":null,"dir":"Reference","previous_headings":"","what":"Image slider — wbt_image_slider","title":"Image slider — wbt_image_slider","text":"tool creates image slider two input images.","code":""},{"path":"/reference/wbt_image_slider.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image slider — wbt_image_slider","text":"","code":"wbt_image_slider(   input1,   input2,   output,   palette1 = \"grey\",   reverse1 = FALSE,   label1 = \"\",   palette2 = \"grey\",   reverse2 = FALSE,   label2 = \"\",   height = 600,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_slider.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image slider — wbt_image_slider","text":"input1 Name left input image file. input2 Name right input image file. output Name output HTML file (*.html). palette1 Left image palette; options 'grey', 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', 'rgb'. reverse1 Reverse left image palette?. label1 Left image label (leave blank none). palette2 Right image palette; options 'grey', 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', 'rgb'. reverse2 Reverse right image palette?. label2 Right image label (leave blank none). height Image height, pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_slider.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image slider — wbt_image_slider","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_image_stack_profile.html","id":null,"dir":"Reference","previous_headings":"","what":"Image stack profile — wbt_image_stack_profile","title":"Image stack profile — wbt_image_stack_profile","text":"Plots image stack profile (.e. signature) set points multispectral images.","code":""},{"path":"/reference/wbt_image_stack_profile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Image stack profile — wbt_image_stack_profile","text":"","code":"wbt_image_stack_profile(   inputs,   points,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_image_stack_profile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Image stack profile — wbt_image_stack_profile","text":"inputs Input multispectral image files. points Input vector points file. output Output HTML file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_image_stack_profile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Image stack profile — wbt_image_stack_profile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_impoundment_size_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Impoundment size index — wbt_impoundment_size_index","title":"Impoundment size index — wbt_impoundment_size_index","text":"Calculates impoundment size resulting damming DEM.","code":""},{"path":"/reference/wbt_impoundment_size_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Impoundment size index — wbt_impoundment_size_index","text":"","code":"wbt_impoundment_size_index(   dem,   damlength,   out_mean = NULL,   out_max = NULL,   out_volume = NULL,   out_area = NULL,   out_dam_height = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_impoundment_size_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Impoundment size index — wbt_impoundment_size_index","text":"dem Input raster DEM file. damlength Maximum length dam. 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. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_impoundment_size_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Impoundment size index — wbt_impoundment_size_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_in_place_add.html","id":null,"dir":"Reference","previous_headings":"","what":"In place add — wbt_in_place_add","title":"In place add — wbt_in_place_add","text":"Performs -place addition operation (input1 += input2).","code":""},{"path":"/reference/wbt_in_place_add.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"In place add — wbt_in_place_add","text":"","code":"wbt_in_place_add(   input1,   input2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_in_place_add.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"In place add — wbt_in_place_add","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file constant value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_in_place_add.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"In place add — wbt_in_place_add","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_in_place_divide.html","id":null,"dir":"Reference","previous_headings":"","what":"In place divide — wbt_in_place_divide","title":"In place divide — wbt_in_place_divide","text":"Performs -place division operation (input1 /= input2).","code":""},{"path":"/reference/wbt_in_place_divide.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"In place divide — wbt_in_place_divide","text":"","code":"wbt_in_place_divide(   input1,   input2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_in_place_divide.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"In place divide — wbt_in_place_divide","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file constant value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_in_place_divide.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"In place divide — wbt_in_place_divide","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_in_place_multiply.html","id":null,"dir":"Reference","previous_headings":"","what":"In place multiply — wbt_in_place_multiply","title":"In place multiply — wbt_in_place_multiply","text":"Performs -place multiplication operation (input1 *= input2).","code":""},{"path":"/reference/wbt_in_place_multiply.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"In place multiply — wbt_in_place_multiply","text":"","code":"wbt_in_place_multiply(   input1,   input2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_in_place_multiply.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"In place multiply — wbt_in_place_multiply","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file constant value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_in_place_multiply.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"In place multiply — wbt_in_place_multiply","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_in_place_subtract.html","id":null,"dir":"Reference","previous_headings":"","what":"In place subtract — wbt_in_place_subtract","title":"In place subtract — wbt_in_place_subtract","text":"Performs -place subtraction operation (input1 -= input2).","code":""},{"path":"/reference/wbt_in_place_subtract.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"In place subtract — wbt_in_place_subtract","text":"","code":"wbt_in_place_subtract(   input1,   input2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_in_place_subtract.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"In place subtract — wbt_in_place_subtract","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file constant value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_in_place_subtract.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"In place subtract — wbt_in_place_subtract","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_increment.html","id":null,"dir":"Reference","previous_headings":"","what":"Increment — wbt_increment","title":"Increment — wbt_increment","text":"Increases values grid cell input raster 1.0. (see also InPlaceAdd).","code":""},{"path":"/reference/wbt_increment.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Increment — wbt_increment","text":"","code":"wbt_increment(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_increment.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Increment — wbt_increment","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_increment.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Increment — wbt_increment","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_individual_tree_detection.html","id":null,"dir":"Reference","previous_headings":"","what":"Individual tree detection — wbt_individual_tree_detection","title":"Individual tree detection — wbt_individual_tree_detection","text":"Identifies points LiDAR point cloud associated tops individual trees.","code":""},{"path":"/reference/wbt_individual_tree_detection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Individual tree detection — wbt_individual_tree_detection","text":"","code":"wbt_individual_tree_detection(   input,   output = NULL,   min_search_radius = 1,   min_height = 0,   max_search_radius = \"\",   max_height = \"\",   only_use_veg = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_individual_tree_detection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Individual tree detection — wbt_individual_tree_detection","text":"input Name input LiDAR file. output Name output vector points file. min_search_radius Minimum search radius (m). min_height Minimum height (m). max_search_radius Maximum search radius (m). max_height Maximum height (m). only_use_veg use veg. class points?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_individual_tree_detection.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Individual tree detection — wbt_individual_tree_detection","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_init.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize 'WhiteboxTools' — wbt_init","title":"Initialize 'WhiteboxTools' — wbt_init","text":"wbt_init(): Check suitable 'WhiteboxTools' executable present. Search default path package directory set manually exe_path. wbt_options(): Get/set package options whitebox.exe_path - character. Path executable file. default value package installation directory, subdirectory \"WBT\", followed whitebox_tools.exe whitebox_tools. Set whitebox.exe_path option using wbt_init() exe_path argument whitebox.wd - character. Path WhiteboxTools working directory. Used --wd argument tools support wd specified elsewhere. whitebox.verbose - logical. standard output calls executable cat() readability? whitebox.verbose=FALSE output produced. Set value whitebox.verbose wbt_verbose() verbose argument. Default result interactive() R package options unset. whitebox.compress_rasters - logical. raster output WhiteboxTools compressed? Default: NULL uses existing WhiteboxTools settings. Set value whitebox.compress_rasters wbt_compress_rasters() compress_rasters argument. whitebox.max_procs - integer. Maximum number processes tools run parallel partially parallelize. Default: -1 uses available cores. wbt_exe_path(): Get file path 'WhiteboxTools' executable. wbt_runner_path(): Get file path 'WhiteboxTools Runner' executable. wbt_default_path(): Get default file path 'WhiteboxTools' executable. wbt_data_dir(): Get directory 'WhiteboxTools' data stored. wbt_wd(): Get set 'WhiteboxTools' working directory. Default: \"\" (unset) R working directory options set. wbt_verbose(): Check verbose options 'WhiteboxTools' wbt_compress_rasters(): Check raster compression option 'WhiteboxTools'. Default behavior based WhiteboxTools settings.json, package options (set). Raster compression settings can overridden wbt_*() function call passing compress_rasters argument directly. wbt_max_procs(): Check maximum number processes  tools run parallel partially parallelize. Default: -1 uses available cores.","code":""},{"path":"/reference/wbt_init.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize 'WhiteboxTools' — wbt_init","text":"","code":"wbt_init(   exe_path = wbt_exe_path(shell_quote = FALSE),   ...,   check_version = TRUE )  wbt_options(   exe_path = NULL,   wd = NULL,   verbose = NULL,   compress_rasters = NULL,   max_procs = NULL )  wbt_exe_path(exe_path = NULL, shell_quote = TRUE)  wbt_runner_path(shell_quote = TRUE)  wbt_default_path()  wbt_data_dir()  wbt_wd(wd = NULL)  wbt_verbose(verbose = NULL)  wbt_compress_rasters(compress_rasters = NULL)  wbt_max_procs(max_procs = NULL)"},{"path":"/reference/wbt_init.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize 'WhiteboxTools' — wbt_init","text":"exe_path Optional: User-supplied path 'WhiteboxTools' executable. Default: NULL ... additional arguments wbt_options() check_version Check version 'WhiteboxTools' installed version R package built ? Default: TRUE wd character; Default: NULL; set package option whitebox.wd set specified path (directory exists) verbose logical. Default: NULL; TRUE FALSE, set package option whitebox.verbose specified value. Tool verbosity settings can overridden wbt_*() function call passing verbose_mode argument directly. compress_rasters logical. Default: NULL; TRUE FALSE, set package option whitebox.compress_rasters specified value. max_procs Default: NULL; integer, set package option whitebox.max_procs specified value shell_quote Return shQuote() result?","code":""},{"path":"/reference/wbt_init.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize 'WhiteboxTools' — wbt_init","text":"wbt_init(): logical; TRUE binary file found exe_path wbt_options(): invisible list containing current whitebox.exe_path, whitebox.verbose, whitebox.compress_rasters, whitebox.max_procs options Returns file path 'WhiteboxTools' executable. wbt_wd(): character; working directory unset, add --wd= arguments calls using getwd(). See Details. wbt_verbose(): logical; returns result option \"whitebox.verbose_mode\", unset defaults result interactive(). wbt_compress_rasters(): logical; returns result option \"whitebox.compress_rasters\", unset defaults NA. wbt_max_procs(): integer; defaults NA_integer_","code":""},{"path":"/reference/wbt_init.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Initialize 'WhiteboxTools' — wbt_init","text":"wbt_exe_path(): Checks system environment variable R_WHITEBOX_EXE_PATH package option whitebox.exe_path. Set desired path either Sys.setenv(R_WHITEBOX_EXE_PATH = \"C:/path//whitebox_tools.exe\") options(whitebox.exe_path = \"C:/path//whitebox_tools.exe\"). default, backwards-compatible path returned wbt_default_path() wbt_runner_path(): Returns path 'WhiteboxTools Runner' including platform-specific executable (without .exe extension) wbt_default_path(): Returns path 'WhiteboxTools' executable including platform-specific executable (without .exe extension) wbt_data_dir(): Uses platform-specific user data directory tools::R_user_dir(package = \"whitebox\", = \"data\") R 4.0+. R<4 returns original default find.package(\"whitebox\"). wbt_wd(): set working directory session default output current R working directory unless otherwise specified. can change working directory time setting wd argument wbt_wd() running tool. Note set working directory, directory needs set somewhere \"replace\" old value; just dropping flag change working directory back R working directory. \"unset\" option R package can use wbt_wd(\"\") removes --wd flag commands sets working_directory value WhiteboxTools settings.json \"\".","code":""},{"path":[]},{"path":"/reference/wbt_init.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize 'WhiteboxTools' — wbt_init","text":"","code":"if (FALSE) { ## wbt_init():  # set path to binary as an argument # wbt_init(exe_path = \"not/a/valid/path/whitebox_tools.exe\") } if (FALSE) {  ## wbt_options():  # set multiple options (e.g. exe_path and verbose) with wbt_options() wbt_options(exe_path = \"not/a/valid/path/whitebox_tools.exe\", verbose = TRUE)  } if (FALSE) { wbt_exe_path() } if (FALSE) {  ## wbt_wd():  # no working directory set wbt_wd(wd = \"\")  # set WBT working directory to R working directory wbt_wd(wd = getwd()) } if (FALSE) {  ## wbt_verbose():  wbt_verbose(verbose = TRUE) } if (FALSE) {  ## wbt_compress_rasters():  wbt_compress_rasters(compress_rasters = TRUE) } if (FALSE) {  ## wbt_max_procs():  wbt_max_procs(max_procs = 2) }"},{"path":"/reference/wbt_insert_dams.html","id":null,"dir":"Reference","previous_headings":"","what":"Insert dams — wbt_insert_dams","title":"Insert dams — wbt_insert_dams","text":"Calculates impoundment size resulting damming DEM.","code":""},{"path":"/reference/wbt_insert_dams.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Insert dams — wbt_insert_dams","text":"","code":"wbt_insert_dams(   dem,   dam_pts,   output,   damlength,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_insert_dams.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Insert dams — wbt_insert_dams","text":"dem Input raster DEM file. dam_pts Input vector dam points file. output Output file. damlength Maximum length dam. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_insert_dams.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Insert dams — wbt_insert_dams","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_install_wb_extension.html","id":null,"dir":"Reference","previous_headings":"","what":"Install wb extension — wbt_install_wb_extension","title":"Install wb extension — wbt_install_wb_extension","text":"Use install Whitebox extension product.","code":""},{"path":"/reference/wbt_install_wb_extension.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install wb extension — wbt_install_wb_extension","text":"","code":"wbt_install_wb_extension(   install_extension = \"General Toolset Extension\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_install_wb_extension.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install wb extension — wbt_install_wb_extension","text":"install_extension Name extension product install. Options include: 'General Toolset Extension', 'DEM & Spatial Hydrology Extension', 'Lidar & Remote Sensing Extension', 'Agriculture Extension'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_install_wb_extension.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Install wb extension — wbt_install_wb_extension","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_integer_division.html","id":null,"dir":"Reference","previous_headings":"","what":"Integer division — wbt_integer_division","title":"Integer division — wbt_integer_division","text":"Performs integer division operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_integer_division.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Integer division — wbt_integer_division","text":"","code":"wbt_integer_division(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_integer_division.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Integer division — wbt_integer_division","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_integer_division.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Integer division — wbt_integer_division","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_integral_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Integral image — wbt_integral_image","title":"Integral image — wbt_integral_image","text":"Transforms input image (summed area table) integral image equivalent.","code":""},{"path":"/reference/wbt_integral_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Integral image — wbt_integral_image","text":"","code":"wbt_integral_image(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_integral_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Integral image — wbt_integral_image","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_integral_image.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Integral image — wbt_integral_image","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_intersect.html","id":null,"dir":"Reference","previous_headings":"","what":"Intersect — wbt_intersect","title":"Intersect — wbt_intersect","text":"Identifies parts features common two input vector layers.","code":""},{"path":"/reference/wbt_intersect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Intersect — wbt_intersect","text":"","code":"wbt_intersect(   input,   overlay,   output,   snap = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_intersect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Intersect — wbt_intersect","text":"input Input vector file path. See wbt_file_path() details. overlay Input overlay vector file. output Output vector file. snap Snap tolerance. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_intersect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Intersect — wbt_intersect","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_inverse_principal_component_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Inverse principal component analysis — wbt_inverse_principal_component_analysis","title":"Inverse principal component analysis — wbt_inverse_principal_component_analysis","text":"tool performs inverse principal component analysis series input component images.","code":""},{"path":"/reference/wbt_inverse_principal_component_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Inverse principal component analysis — wbt_inverse_principal_component_analysis","text":"","code":"wbt_inverse_principal_component_analysis(   inputs,   report,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_inverse_principal_component_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Inverse principal component analysis — wbt_inverse_principal_component_analysis","text":"inputs Name input PCA component images. report Name PCA report file (*.html). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_inverse_principal_component_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Inverse principal component analysis — wbt_inverse_principal_component_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_is_no_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Is no data — wbt_is_no_data","title":"Is no data — wbt_is_no_data","text":"Identifies NoData valued pixels image.","code":""},{"path":"/reference/wbt_is_no_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is no data — wbt_is_no_data","text":"","code":"wbt_is_no_data(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_is_no_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is no data — wbt_is_no_data","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_is_no_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Is no data — wbt_is_no_data","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_isobasins.html","id":null,"dir":"Reference","previous_headings":"","what":"Isobasins — wbt_isobasins","title":"Isobasins — wbt_isobasins","text":"Divides landscape nearly equal sized drainage basins (.e. watersheds).","code":""},{"path":"/reference/wbt_isobasins.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Isobasins — wbt_isobasins","text":"","code":"wbt_isobasins(   dem,   output,   size,   connections = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_isobasins.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Isobasins — wbt_isobasins","text":"dem Input raster DEM file. output Output raster file. size Target basin size, grid cells. connections Output upstream-downstream flow connections among basins?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_isobasins.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Isobasins — wbt_isobasins","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_jenson_snap_pour_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Jenson snap pour points — wbt_jenson_snap_pour_points","title":"Jenson snap pour points — wbt_jenson_snap_pour_points","text":"Moves outlet points used specify points interest watershedding operation nearest stream cell.","code":""},{"path":"/reference/wbt_jenson_snap_pour_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Jenson snap pour points — wbt_jenson_snap_pour_points","text":"","code":"wbt_jenson_snap_pour_points(   pour_pts,   streams,   output,   snap_dist,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_jenson_snap_pour_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Jenson snap pour points — wbt_jenson_snap_pour_points","text":"pour_pts Input vector pour points (outlet) file. streams Input raster streams file. output Output vector file. snap_dist Maximum snap distance map units. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_jenson_snap_pour_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Jenson snap pour points — wbt_jenson_snap_pour_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_join_tables.html","id":null,"dir":"Reference","previous_headings":"","what":"Join tables — wbt_join_tables","title":"Join tables — wbt_join_tables","text":"Merge vector's attribute table another table based common field.","code":""},{"path":"/reference/wbt_join_tables.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Join tables — wbt_join_tables","text":"","code":"wbt_join_tables(   input1,   pkey,   input2,   fkey,   import_field = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_join_tables.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Join tables — wbt_join_tables","text":"input1 Input primary vector file (.e. table modified). pkey Primary key field. input2 Input foreign vector file (.e. source data imported). fkey Foreign key field. import_field Imported field (fields imported specified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_join_tables.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Join tables — wbt_join_tables","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_k_means_clustering.html","id":null,"dir":"Reference","previous_headings":"","what":"K means clustering — wbt_k_means_clustering","title":"K means clustering — wbt_k_means_clustering","text":"Performs k-means clustering operation multi-spectral dataset.","code":""},{"path":"/reference/wbt_k_means_clustering.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"K means clustering — wbt_k_means_clustering","text":"","code":"wbt_k_means_clustering(   inputs,   output,   classes,   out_html = NULL,   max_iterations = 10,   class_change = 2,   initialize = \"diagonal\",   min_class_size = 10,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_k_means_clustering.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"K means clustering — wbt_k_means_clustering","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. classes Number classes. out_html Output HTML report file. max_iterations Maximum number iterations. class_change Minimum percent cells changed iterations completion. initialize initialize cluster centres?. min_class_size Minimum class size, pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_k_means_clustering.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"K means clustering — wbt_k_means_clustering","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_k_nearest_mean_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"K nearest mean filter — wbt_k_nearest_mean_filter","title":"K nearest mean filter — wbt_k_nearest_mean_filter","text":"k-nearest mean filter type edge-preserving smoothing filter.","code":""},{"path":"/reference/wbt_k_nearest_mean_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"K nearest mean filter — wbt_k_nearest_mean_filter","text":"","code":"wbt_k_nearest_mean_filter(   input,   output,   filterx = 11,   filtery = 11,   k = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_k_nearest_mean_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"K nearest mean filter — wbt_k_nearest_mean_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. k k-value pixels; number nearest-valued neighbours use. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_k_nearest_mean_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"K nearest mean filter — wbt_k_nearest_mean_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_kappa_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Kappa index — wbt_kappa_index","title":"Kappa index — wbt_kappa_index","text":"Performs kappa index agreement (KIA) analysis two categorical raster files.","code":""},{"path":"/reference/wbt_kappa_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Kappa index — wbt_kappa_index","text":"","code":"wbt_kappa_index(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_kappa_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Kappa index — wbt_kappa_index","text":"input1 Input classification raster file. input2 Input reference raster file. output Output HTML file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_kappa_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Kappa index — wbt_kappa_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_knn_classification.html","id":null,"dir":"Reference","previous_headings":"","what":"Knn classification — wbt_knn_classification","title":"Knn classification — wbt_knn_classification","text":"Performs supervised k-nearest neighbour classification using training site polygons/points predictor rasters.","code":""},{"path":"/reference/wbt_knn_classification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Knn classification — wbt_knn_classification","text":"","code":"wbt_knn_classification(   inputs,   training,   field,   scaling = \"Normalize\",   output = NULL,   k = 5,   clip = TRUE,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_knn_classification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Knn classification — wbt_knn_classification","text":"inputs Names input predictor rasters. training Name input training site polygons/points shapefile. field Name attribute containing class name data. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. output Name output raster file. k k-parameter, determines number nearest neighbours used. clip Perform training data clipping remove outlier pixels?. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_knn_classification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Knn classification — wbt_knn_classification","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_knn_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Knn regression — wbt_knn_regression","title":"Knn regression — wbt_knn_regression","text":"Performs supervised k-nearest neighbour regression using training site points predictor rasters.","code":""},{"path":"/reference/wbt_knn_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Knn regression — wbt_knn_regression","text":"","code":"wbt_knn_regression(   inputs,   training,   field,   scaling = \"Normalize\",   output = NULL,   k = 5,   weight = TRUE,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_knn_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Knn regression — wbt_knn_regression","text":"inputs Names input predictor rasters. training Name input training site points Shapefile. field Name attribute containing response variable name data. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. output Name output raster file. k k-parameter, determines number nearest neighbours used. weight Use distance weighting?. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_knn_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Knn regression — wbt_knn_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ks_test_for_normality.html","id":null,"dir":"Reference","previous_headings":"","what":"Ks test for normality — wbt_ks_test_for_normality","title":"Ks test for normality — wbt_ks_test_for_normality","text":"Evaluates whether values raster normally distributed.","code":""},{"path":"/reference/wbt_ks_test_for_normality.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ks test for normality — wbt_ks_test_for_normality","text":"","code":"wbt_ks_test_for_normality(   input,   output,   num_samples = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ks_test_for_normality.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ks test for normality — wbt_ks_test_for_normality","text":"input Input raster file path. See wbt_file_path() details. output Output HTML file. num_samples Number samples. Leave blank use whole image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ks_test_for_normality.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ks test for normality — wbt_ks_test_for_normality","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_laplacian_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Laplacian filter — wbt_laplacian_filter","title":"Laplacian filter — wbt_laplacian_filter","text":"Performs Laplacian filter image.","code":""},{"path":"/reference/wbt_laplacian_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Laplacian filter — wbt_laplacian_filter","text":"","code":"wbt_laplacian_filter(   input,   output,   variant = \"3x3(1)\",   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_laplacian_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Laplacian filter — wbt_laplacian_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. variant Optional variant value. Options include 3x3(1), 3x3(2), 3x3(3), 3x3(4), 5x5(1), 5x5(2) (default 3x3(1)). clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_laplacian_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Laplacian filter — wbt_laplacian_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_laplacian_of_gaussian_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Laplacian of gaussian filter — wbt_laplacian_of_gaussian_filter","title":"Laplacian of gaussian filter — wbt_laplacian_of_gaussian_filter","text":"Performs Laplacian--Gaussian (LoG) filter image.","code":""},{"path":"/reference/wbt_laplacian_of_gaussian_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Laplacian of gaussian filter — wbt_laplacian_of_gaussian_filter","text":"","code":"wbt_laplacian_of_gaussian_filter(   input,   output,   sigma = 0.75,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_laplacian_of_gaussian_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Laplacian of gaussian filter — wbt_laplacian_of_gaussian_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma Standard deviation pixels. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_laplacian_of_gaussian_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Laplacian of gaussian filter — wbt_laplacian_of_gaussian_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_las_to_ascii.html","id":null,"dir":"Reference","previous_headings":"","what":"Las to ascii — wbt_las_to_ascii","title":"Las to ascii — wbt_las_to_ascii","text":"Converts one LAS files ASCII text files.","code":""},{"path":"/reference/wbt_las_to_ascii.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Las to ascii — wbt_las_to_ascii","text":"","code":"wbt_las_to_ascii(   inputs,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_las_to_ascii.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Las to ascii — wbt_las_to_ascii","text":"inputs Input LiDAR files. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_las_to_ascii.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Las to ascii — wbt_las_to_ascii","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_las_to_laz.html","id":null,"dir":"Reference","previous_headings":"","what":"Las to laz — wbt_las_to_laz","title":"Las to laz — wbt_las_to_laz","text":"tool converts one LAS files LAZ format.","code":""},{"path":"/reference/wbt_las_to_laz.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Las to laz — wbt_las_to_laz","text":"","code":"wbt_las_to_laz(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_las_to_laz.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Las to laz — wbt_las_to_laz","text":"input Name input LAS files (leave blank use LAS files WorkingDirectory. output Output LAZ file (including extension). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_las_to_laz.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Las to laz — wbt_las_to_laz","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_las_to_multipoint_shapefile.html","id":null,"dir":"Reference","previous_headings":"","what":"Las to multipoint shapefile — wbt_las_to_multipoint_shapefile","title":"Las to multipoint shapefile — wbt_las_to_multipoint_shapefile","text":"Converts one LAS files MultipointZ vector Shapefiles. input parameter specified, tool grids LAS files contained within working directory.","code":""},{"path":"/reference/wbt_las_to_multipoint_shapefile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Las to multipoint shapefile — wbt_las_to_multipoint_shapefile","text":"","code":"wbt_las_to_multipoint_shapefile(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_las_to_multipoint_shapefile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Las to multipoint shapefile — wbt_las_to_multipoint_shapefile","text":"input Input LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_las_to_multipoint_shapefile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Las to multipoint shapefile — wbt_las_to_multipoint_shapefile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_las_to_shapefile.html","id":null,"dir":"Reference","previous_headings":"","what":"Las to shapefile — wbt_las_to_shapefile","title":"Las to shapefile — wbt_las_to_shapefile","text":"Converts one LAS files vector Shapefile POINT ShapeType.","code":""},{"path":"/reference/wbt_las_to_shapefile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Las to shapefile — wbt_las_to_shapefile","text":"","code":"wbt_las_to_shapefile(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_las_to_shapefile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Las to shapefile — wbt_las_to_shapefile","text":"input Input LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_las_to_shapefile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Las to shapefile — wbt_las_to_shapefile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_las_to_zlidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Las to zlidar — wbt_las_to_zlidar","title":"Las to zlidar — wbt_las_to_zlidar","text":"Converts one LAS files zlidar compressed LiDAR data format.","code":""},{"path":"/reference/wbt_las_to_zlidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Las to zlidar — wbt_las_to_zlidar","text":"","code":"wbt_las_to_zlidar(   inputs = NULL,   outdir = NULL,   compress = \"brotli\",   level = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_las_to_zlidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Las to zlidar — wbt_las_to_zlidar","text":"inputs Input LAS files. outdir Output directory zlidar files created. unspecified, assumed inputs. compress Compression method, including 'brotli' 'deflate'. level Compression level (1-9). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_las_to_zlidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Las to zlidar — wbt_las_to_zlidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_launch_runner.html","id":null,"dir":"Reference","previous_headings":"","what":"Launch 'WhiteboxTools Runner' GUI — wbt_launch_runner","title":"Launch 'WhiteboxTools Runner' GUI — wbt_launch_runner","text":"wbt_launch_runner(): Launch 'WhiteboxTools Runner' GUI wbt_runner_path()","code":""},{"path":"/reference/wbt_launch_runner.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Launch 'WhiteboxTools Runner' GUI — wbt_launch_runner","text":"","code":"wbt_launch_runner(clear_app_state = FALSE)"},{"path":"/reference/wbt_launch_runner.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Launch 'WhiteboxTools Runner' GUI — wbt_launch_runner","text":"clear_app_state Clear application state memory? Default: FALSE","code":""},{"path":"/reference/wbt_launch_runner.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Launch 'WhiteboxTools Runner' GUI — wbt_launch_runner","text":"Opens 'WhiteboxTools Runner' GUI included WhiteboxTools Open Core v2.3.0 higher.","code":""},{"path":[]},{"path":"/reference/wbt_launch_wb_runner.html","id":null,"dir":"Reference","previous_headings":"","what":"Launch wb runner — wbt_launch_wb_runner","title":"Launch wb runner — wbt_launch_wb_runner","text":"Opens Whitebox Runner application.","code":""},{"path":"/reference/wbt_launch_wb_runner.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Launch wb runner — wbt_launch_wb_runner","text":"","code":"wbt_launch_wb_runner(   clear_app_state = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_launch_wb_runner.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Launch wb runner — wbt_launch_wb_runner","text":"clear_app_state Clear application state memory?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_launch_wb_runner.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Launch wb runner — wbt_launch_wb_runner","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_layer_footprint.html","id":null,"dir":"Reference","previous_headings":"","what":"Layer footprint — wbt_layer_footprint","title":"Layer footprint — wbt_layer_footprint","text":"Creates vector polygon footprint area covered raster grid vector layer.","code":""},{"path":"/reference/wbt_layer_footprint.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Layer footprint — wbt_layer_footprint","text":"","code":"wbt_layer_footprint(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_layer_footprint.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Layer footprint — wbt_layer_footprint","text":"input Input raster vector file. output Output vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_layer_footprint.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Layer footprint — wbt_layer_footprint","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_laz_to_las.html","id":null,"dir":"Reference","previous_headings":"","what":"Laz to las — wbt_laz_to_las","title":"Laz to las — wbt_laz_to_las","text":"tool converts one LAZ files LAS format.","code":""},{"path":"/reference/wbt_laz_to_las.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Laz to las — wbt_laz_to_las","text":"","code":"wbt_laz_to_las(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_laz_to_las.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Laz to las — wbt_laz_to_las","text":"input Name input LAZ files (leave blank use LAZ files WorkingDirectory. output Output LAS file (including extension). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_laz_to_las.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Laz to las — wbt_laz_to_las","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lee_sigma_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Lee sigma filter — wbt_lee_sigma_filter","title":"Lee sigma filter — wbt_lee_sigma_filter","text":"Performs Lee (Sigma) smoothing filter image.","code":""},{"path":"/reference/wbt_lee_sigma_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lee sigma filter — wbt_lee_sigma_filter","text":"","code":"wbt_lee_sigma_filter(   input,   output,   filterx = 11,   filtery = 11,   sigma = 10,   m = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lee_sigma_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lee sigma filter — wbt_lee_sigma_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. sigma Sigma value related standard deviation distribution image speckle noise. m M-threshold value minimum allowable number pixels within intensity range. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lee_sigma_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lee sigma filter — wbt_lee_sigma_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_length_of_upstream_channels.html","id":null,"dir":"Reference","previous_headings":"","what":"Length of upstream channels — wbt_length_of_upstream_channels","title":"Length of upstream channels — wbt_length_of_upstream_channels","text":"Calculates total length channels upstream.","code":""},{"path":"/reference/wbt_length_of_upstream_channels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Length of upstream channels — wbt_length_of_upstream_channels","text":"","code":"wbt_length_of_upstream_channels(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_length_of_upstream_channels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Length of upstream channels — wbt_length_of_upstream_channels","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_length_of_upstream_channels.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Length of upstream channels — wbt_length_of_upstream_channels","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_less_than.html","id":null,"dir":"Reference","previous_headings":"","what":"Less than — wbt_less_than","title":"Less than — wbt_less_than","text":"Performs less-comparison operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_less_than.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Less than — wbt_less_than","text":"","code":"wbt_less_than(   input1,   input2,   output,   incl_equals = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_less_than.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Less than — wbt_less_than","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. incl_equals Perform less---equal-operation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_less_than.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Less than — wbt_less_than","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_license.html","id":null,"dir":"Reference","previous_headings":"","what":"License information for 'WhiteboxTools' — wbt_license","title":"License information for 'WhiteboxTools' — wbt_license","text":"License information 'WhiteboxTools'","code":""},{"path":"/reference/wbt_license.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"License information for 'WhiteboxTools' — wbt_license","text":"","code":"wbt_license()"},{"path":"/reference/wbt_license.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"License information for 'WhiteboxTools' — wbt_license","text":"Returns license information WhiteboxTools R character vector.","code":""},{"path":"/reference/wbt_license.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"License information for 'WhiteboxTools' — wbt_license","text":"","code":"if (FALSE) { wbt_license() }"},{"path":"/reference/wbt_lidar_block_maximum.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar block maximum — wbt_lidar_block_maximum","title":"Lidar block maximum — wbt_lidar_block_maximum","text":"Creates block-maximum raster input LAS file. input/output parameters specified, tool grids LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_block_maximum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar block maximum — wbt_lidar_block_maximum","text":"","code":"wbt_lidar_block_maximum(   input,   output = NULL,   resolution = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_block_maximum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar block maximum — wbt_lidar_block_maximum","text":"input Input LiDAR file. output Output file. resolution Output raster's grid resolution. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_block_maximum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar block maximum — wbt_lidar_block_maximum","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_block_minimum.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar block minimum — wbt_lidar_block_minimum","title":"Lidar block minimum — wbt_lidar_block_minimum","text":"Creates block-minimum raster input LAS file. input/output parameters specified, tool grids LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_block_minimum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar block minimum — wbt_lidar_block_minimum","text":"","code":"wbt_lidar_block_minimum(   input,   output = NULL,   resolution = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_block_minimum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar block minimum — wbt_lidar_block_minimum","text":"input Input LiDAR file. output Output file. resolution Output raster's grid resolution. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_block_minimum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar block minimum — wbt_lidar_block_minimum","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_classify_subset.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar classify subset — wbt_lidar_classify_subset","title":"Lidar classify subset — wbt_lidar_classify_subset","text":"Classifies values one LiDAR point cloud correspond points subset cloud.","code":""},{"path":"/reference/wbt_lidar_classify_subset.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar classify subset — wbt_lidar_classify_subset","text":"","code":"wbt_lidar_classify_subset(   base,   subset,   output,   subset_class,   nonsubset_class = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_classify_subset.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar classify subset — wbt_lidar_classify_subset","text":"base Input base LiDAR file. subset Input subset LiDAR file. output Output LiDAR file. subset_class Subset point class value (must 0-18; see LAS specifications). nonsubset_class Non-subset point class value (must 0-18; see LAS specifications). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_classify_subset.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar classify subset — wbt_lidar_classify_subset","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_colourize.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar colourize — wbt_lidar_colourize","title":"Lidar colourize — wbt_lidar_colourize","text":"Adds red-green-blue colour fields LiDAR (LAS) file based input image.","code":""},{"path":"/reference/wbt_lidar_colourize.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar colourize — wbt_lidar_colourize","text":"","code":"wbt_lidar_colourize(   in_lidar,   in_image,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_colourize.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar colourize — wbt_lidar_colourize","text":"in_lidar Input LiDAR file. in_image Input colour image file. output Output LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_colourize.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar colourize — wbt_lidar_colourize","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_contour.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar contour — wbt_lidar_contour","title":"Lidar contour — wbt_lidar_contour","text":"tool creates vector contour coverage input LiDAR point file.","code":""},{"path":"/reference/wbt_lidar_contour.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar contour — wbt_lidar_contour","text":"","code":"wbt_lidar_contour(   input,   output = NULL,   interval = 10,   base = 0,   smooth = 5,   parameter = \"elevation\",   returns = \"all\",   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   max_triangle_edge_length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_contour.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar contour — wbt_lidar_contour","text":"input Name input LiDAR points. output Name output vector lines file. interval Contour interval. base Base contour. smooth Smoothing filter size (num. points), e.g. 3, 5, 7, 9, 11. parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'user_data'. returns Point return types include; options '' (default), 'last', 'first'. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_contour.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar contour — wbt_lidar_contour","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_digital_surface_model.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar digital surface model — wbt_lidar_digital_surface_model","title":"Lidar digital surface model — wbt_lidar_digital_surface_model","text":"Creates top-surface digital surface model (DSM) LiDAR point cloud.","code":""},{"path":"/reference/wbt_lidar_digital_surface_model.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar digital surface model — wbt_lidar_digital_surface_model","text":"","code":"wbt_lidar_digital_surface_model(   input,   output = NULL,   resolution = 1,   radius = 0.5,   minz = NULL,   maxz = NULL,   max_triangle_edge_length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_digital_surface_model.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar digital surface model — wbt_lidar_digital_surface_model","text":"input Input LiDAR file (including extension). output Output raster file (including extension). resolution Output raster's grid resolution. radius Search Radius. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_digital_surface_model.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar digital surface model — wbt_lidar_digital_surface_model","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_eigenvalue_features.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar eigenvalue features — wbt_lidar_eigenvalue_features","title":"Lidar eigenvalue features — wbt_lidar_eigenvalue_features","text":"Calculate eigenvalue-based metrics LiDAR point cloud.","code":""},{"path":"/reference/wbt_lidar_eigenvalue_features.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar eigenvalue features — wbt_lidar_eigenvalue_features","text":"","code":"wbt_lidar_eigenvalue_features(   input,   num_neighbours = NULL,   radius = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_eigenvalue_features.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar eigenvalue features — wbt_lidar_eigenvalue_features","text":"input Name input LiDAR points. num_neighbours Number neighbours used search. radius Search distance used neighbourhood search. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_eigenvalue_features.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar eigenvalue features — wbt_lidar_eigenvalue_features","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_elevation_slice.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar elevation slice — wbt_lidar_elevation_slice","title":"Lidar elevation slice — wbt_lidar_elevation_slice","text":"Outputs points within LiDAR (LAS) point file lie specified elevation range.","code":""},{"path":"/reference/wbt_lidar_elevation_slice.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar elevation slice — wbt_lidar_elevation_slice","text":"","code":"wbt_lidar_elevation_slice(   input,   output,   minz = NULL,   maxz = NULL,   cls = FALSE,   inclassval = 2,   outclassval = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_elevation_slice.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar elevation slice — wbt_lidar_elevation_slice","text":"input 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 range retained output reclassified. inclassval Optional parameter specifying class value assigned points within slice. outclassval Optional parameter specifying class value assigned points within slice. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_elevation_slice.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar elevation slice — wbt_lidar_elevation_slice","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_ground_point_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar ground point filter — wbt_lidar_ground_point_filter","title":"Lidar ground point filter — wbt_lidar_ground_point_filter","text":"Identifies ground points within LiDAR dataset using slope-based method.","code":""},{"path":"/reference/wbt_lidar_ground_point_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar ground point filter — wbt_lidar_ground_point_filter","text":"","code":"wbt_lidar_ground_point_filter(   input,   output,   radius = 2,   min_neighbours = 0,   slope_threshold = 45,   height_threshold = 1,   classify = TRUE,   slope_norm = TRUE,   height_above_ground = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_ground_point_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar ground point filter — wbt_lidar_ground_point_filter","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. min_neighbours minimum number neighbouring points within search areas. fewer points threshold identified fixed-radius search, subsequent kNN search performed identify k number neighbours. slope_threshold Maximum inter-point slope considered -terrain point. height_threshold Inter-point height difference considered -terrain point. classify Classify points ground (2) -ground (1). slope_norm Perform initial ground slope normalization?. height_above_ground Transform output height average ground elevation?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_ground_point_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar ground point filter — wbt_lidar_ground_point_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_hex_binning.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar hex binning — wbt_lidar_hex_binning","title":"Lidar hex binning — wbt_lidar_hex_binning","text":"Hex-bins set LiDAR points.","code":""},{"path":"/reference/wbt_lidar_hex_binning.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar hex binning — wbt_lidar_hex_binning","text":"","code":"wbt_lidar_hex_binning(   input,   output,   width,   orientation = \"horizontal\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_hex_binning.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar hex binning — wbt_lidar_hex_binning","text":"input Input base file. output Output vector polygon file. width grid cell width. orientation Grid Orientation, 'horizontal' 'vertical'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_hex_binning.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar hex binning — wbt_lidar_hex_binning","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_hillshade.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar hillshade — wbt_lidar_hillshade","title":"Lidar hillshade — wbt_lidar_hillshade","text":"Calculates hillshade value points within LAS file stores data RGB field.","code":""},{"path":"/reference/wbt_lidar_hillshade.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar hillshade — wbt_lidar_hillshade","text":"","code":"wbt_lidar_hillshade(   input,   output,   azimuth = 315,   altitude = 30,   radius = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_hillshade.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar hillshade — wbt_lidar_hillshade","text":"input Input LiDAR file. output Output file. azimuth Illumination source azimuth degrees. altitude Illumination source altitude degrees. radius Search Radius. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_hillshade.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar hillshade — wbt_lidar_hillshade","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_histogram.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar histogram — wbt_lidar_histogram","title":"Lidar histogram — wbt_lidar_histogram","text":"Creates histogram LiDAR data.","code":""},{"path":"/reference/wbt_lidar_histogram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar histogram — wbt_lidar_histogram","text":"","code":"wbt_lidar_histogram(   input,   output,   parameter = \"elevation\",   clip = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_histogram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar histogram — wbt_lidar_histogram","text":"input Input LiDAR file. output Output HTML file (default name based input file unspecified). parameter Parameter; options 'elevation' (default), 'intensity', 'scan angle', 'class', 'time'. clip Amount clip distribution tails (percent). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_histogram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar histogram — wbt_lidar_histogram","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_idw_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar idw interpolation — wbt_lidar_idw_interpolation","title":"Lidar idw interpolation — wbt_lidar_idw_interpolation","text":"Interpolates LAS files using inverse-distance weighted (IDW) scheme. input/output parameters specified, tool interpolates LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_idw_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar idw interpolation — wbt_lidar_idw_interpolation","text":"","code":"wbt_lidar_idw_interpolation(   input,   output = NULL,   parameter = \"elevation\",   returns = \"all\",   resolution = 1,   weight = 1,   radius = 2.5,   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_idw_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar idw interpolation — wbt_lidar_idw_interpolation","text":"input Input LiDAR file (including extension). output Output raster file (including extension). parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'class', 'return_number', 'number_of_returns', 'scan angle', 'rgb', 'user data'. returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. weight IDW weight value. radius Search Radius. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_idw_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar idw interpolation — wbt_lidar_idw_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar info — wbt_lidar_info","title":"Lidar info — wbt_lidar_info","text":"Prints information LiDAR (LAS) dataset, including header, point return frequency, classification data information variable length records (VLRs) geokeys.","code":""},{"path":"/reference/wbt_lidar_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar info — wbt_lidar_info","text":"","code":"wbt_lidar_info(   input,   output,   density = TRUE,   vlr = TRUE,   geokeys = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar info — wbt_lidar_info","text":"input Input LiDAR file. output Output HTML file summary report. density Flag indicating whether calculate average point density nominal point spacing. vlr Flag indicating whether print variable length records (VLRs). geokeys Flag indicating whether print geokeys. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar info — wbt_lidar_info","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_join.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar join — wbt_lidar_join","title":"Lidar join — wbt_lidar_join","text":"Joins multiple LiDAR (LAS) files single LAS file.","code":""},{"path":"/reference/wbt_lidar_join.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar join — wbt_lidar_join","text":"","code":"wbt_lidar_join(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_join.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar join — wbt_lidar_join","text":"inputs Input LiDAR files. output Output LiDAR file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_join.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar join — wbt_lidar_join","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_kappa_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar kappa index — wbt_lidar_kappa_index","title":"Lidar kappa index — wbt_lidar_kappa_index","text":"Performs kappa index agreement (KIA) analysis classifications two LAS files.","code":""},{"path":"/reference/wbt_lidar_kappa_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar kappa index — wbt_lidar_kappa_index","text":"","code":"wbt_lidar_kappa_index(   input1,   input2,   output,   class_accuracy,   resolution = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_kappa_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar kappa index — wbt_lidar_kappa_index","text":"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. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_kappa_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar kappa index — wbt_lidar_kappa_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_nearest_neighbour_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar nearest neighbour gridding — wbt_lidar_nearest_neighbour_gridding","title":"Lidar nearest neighbour gridding — wbt_lidar_nearest_neighbour_gridding","text":"Grids LiDAR files using nearest-neighbour scheme. input/output parameters specified, tool grids LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_nearest_neighbour_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar nearest neighbour gridding — wbt_lidar_nearest_neighbour_gridding","text":"","code":"wbt_lidar_nearest_neighbour_gridding(   input,   output = NULL,   parameter = \"elevation\",   returns = \"all\",   resolution = 1,   radius = 2.5,   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_nearest_neighbour_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar nearest neighbour gridding — wbt_lidar_nearest_neighbour_gridding","text":"input Input LiDAR file (including extension). output Output raster file (including extension). parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'class', 'return_number', 'number_of_returns', 'scan angle', 'rgb', 'user data', 'time'. returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. radius Search Radius. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_nearest_neighbour_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar nearest neighbour gridding — wbt_lidar_nearest_neighbour_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_point_density.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar point density — wbt_lidar_point_density","title":"Lidar point density — wbt_lidar_point_density","text":"Calculates spatial pattern point density LiDAR data set. input/output parameters specified, tool grids LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_point_density.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar point density — wbt_lidar_point_density","text":"","code":"wbt_lidar_point_density(   input,   output = NULL,   returns = \"all\",   resolution = 1,   radius = 2.5,   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_point_density.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar point density — wbt_lidar_point_density","text":"input Input LiDAR file (including extension). output Output raster file (including extension). returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. radius Search radius. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_point_density.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar point density — wbt_lidar_point_density","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_point_return_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar point return analysis — wbt_lidar_point_return_analysis","title":"Lidar point return analysis — wbt_lidar_point_return_analysis","text":"tool performs quality control check return values points LiDAR file.","code":""},{"path":"/reference/wbt_lidar_point_return_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar point return analysis — wbt_lidar_point_return_analysis","text":"","code":"wbt_lidar_point_return_analysis(   input,   output = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_point_return_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar point return analysis — wbt_lidar_point_return_analysis","text":"input Name input LiDAR points. output Name output LiDAR points. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_point_return_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar point return analysis — wbt_lidar_point_return_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_point_stats.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar point stats — wbt_lidar_point_stats","title":"Lidar point stats — wbt_lidar_point_stats","text":"Creates several rasters summarizing distribution LAS point data. input/output parameters specified, tool works LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_point_stats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar point stats — wbt_lidar_point_stats","text":"","code":"wbt_lidar_point_stats(   input,   resolution = 1,   num_points = TRUE,   num_pulses = FALSE,   avg_points_per_pulse = TRUE,   z_range = FALSE,   intensity_range = FALSE,   predom_class = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_point_stats.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar point stats — wbt_lidar_point_stats","text":"input Input LiDAR file. resolution Output raster's grid resolution. num_points Flag indicating whether output number points (returns) raster. num_pulses Flag indicating whether output number pulses raster. avg_points_per_pulse Flag indicating whether output average number points (returns) per pulse raster. z_range Flag indicating whether output elevation range raster. intensity_range Flag indicating whether output intensity range raster. predom_class Flag indicating whether output predominant classification raster. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_point_stats.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar point stats — wbt_lidar_point_stats","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_ransac_planes.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar ransac planes — wbt_lidar_ransac_planes","title":"Lidar ransac planes — wbt_lidar_ransac_planes","text":"Performs RANSAC analysis identify points within LiDAR point cloud belong linear planes.","code":""},{"path":"/reference/wbt_lidar_ransac_planes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar ransac planes — wbt_lidar_ransac_planes","text":"","code":"wbt_lidar_ransac_planes(   input,   output,   radius = 2,   num_iter = 50,   num_samples = 5,   threshold = 0.35,   model_size = 8,   max_slope = 80,   classify = FALSE,   last_returns = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_ransac_planes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar ransac planes — wbt_lidar_ransac_planes","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. num_iter Number iterations. num_samples Number sample points build model. threshold Threshold used determine inlier points. model_size Acceptable model size. max_slope Maximum planar slope. classify Classify points ground (2) -ground (1). last_returns include last- -return points. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_ransac_planes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar ransac planes — wbt_lidar_ransac_planes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_rbf_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar rbf interpolation — wbt_lidar_rbf_interpolation","title":"Lidar rbf interpolation — wbt_lidar_rbf_interpolation","text":"Interpolates LAS files using radial basis function (RBF) scheme. input/output parameters specified, tool interpolates LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_rbf_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar rbf interpolation — wbt_lidar_rbf_interpolation","text":"","code":"wbt_lidar_rbf_interpolation(   input,   output = NULL,   parameter = \"elevation\",   returns = \"all\",   resolution = 1,   num_points = 20,   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   func_type = \"ThinPlateSpline\",   poly_order = \"none\",   weight = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_rbf_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar rbf interpolation — wbt_lidar_rbf_interpolation","text":"input Input LiDAR file (including extension). output Output raster file (including extension). parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'class', 'return_number', 'number_of_returns', 'scan angle', 'rgb', 'user data'. returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. num_points Number points. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. func_type Radial basis function type; options 'ThinPlateSpline' (default), 'PolyHarmonic', 'Gaussian', 'MultiQuadric', 'InverseMultiQuadric'. poly_order Polynomial order; options 'none' (default), 'constant', 'affine'. weight Weight parameter used basis function. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_rbf_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar rbf interpolation — wbt_lidar_rbf_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_remove_duplicates.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar remove duplicates — wbt_lidar_remove_duplicates","title":"Lidar remove duplicates — wbt_lidar_remove_duplicates","text":"Removes duplicate points LiDAR data set.","code":""},{"path":"/reference/wbt_lidar_remove_duplicates.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar remove duplicates — wbt_lidar_remove_duplicates","text":"","code":"wbt_lidar_remove_duplicates(   input,   output,   include_z = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_remove_duplicates.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar remove duplicates — wbt_lidar_remove_duplicates","text":"input Input LiDAR file. output Output LiDAR file. include_z Include z-values point comparison?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_remove_duplicates.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar remove duplicates — wbt_lidar_remove_duplicates","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_remove_outliers.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar remove outliers — wbt_lidar_remove_outliers","title":"Lidar remove outliers — wbt_lidar_remove_outliers","text":"Removes outliers (high low points) LiDAR point cloud.","code":""},{"path":"/reference/wbt_lidar_remove_outliers.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar remove outliers — wbt_lidar_remove_outliers","text":"","code":"wbt_lidar_remove_outliers(   input,   output,   radius = 2,   elev_diff = 50,   use_median = FALSE,   classify = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_remove_outliers.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar remove outliers — wbt_lidar_remove_outliers","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. elev_diff Max. elevation difference. use_median Optional flag indicating whether use difference median elevation rather mean. classify Classify points ground (2) -ground (1). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_remove_outliers.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar remove outliers — wbt_lidar_remove_outliers","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_rooftop_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar rooftop analysis — wbt_lidar_rooftop_analysis","title":"Lidar rooftop analysis — wbt_lidar_rooftop_analysis","text":"Identifies roof segments LiDAR point cloud.","code":""},{"path":"/reference/wbt_lidar_rooftop_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar rooftop analysis — wbt_lidar_rooftop_analysis","text":"","code":"wbt_lidar_rooftop_analysis(   buildings,   output,   input = NULL,   radius = 2,   num_iter = 50,   num_samples = 10,   threshold = 0.15,   model_size = 15,   max_slope = 65,   norm_diff = 10,   azimuth = 180,   altitude = 30,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_rooftop_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar rooftop analysis — wbt_lidar_rooftop_analysis","text":"buildings Input vector build footprint polygons file. output Output vector polygon file. input Input LiDAR file. radius Search Radius. num_iter Number iterations. num_samples Number sample points build model. threshold Threshold used determine inlier points (elevation units). model_size Acceptable model size, points. max_slope Maximum planar slope, degrees. norm_diff Maximum difference normal vectors, degrees. azimuth Illumination source azimuth, degrees. altitude Illumination source altitude degrees. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_rooftop_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar rooftop analysis — wbt_lidar_rooftop_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_segmentation.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar segmentation — wbt_lidar_segmentation","title":"Lidar segmentation — wbt_lidar_segmentation","text":"Segments LiDAR point cloud based differences orientation fitted planar surfaces point proximity.","code":""},{"path":"/reference/wbt_lidar_segmentation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar segmentation — wbt_lidar_segmentation","text":"","code":"wbt_lidar_segmentation(   input,   output,   radius = 2,   num_iter = 50,   num_samples = 10,   threshold = 0.15,   model_size = 15,   max_slope = 80,   norm_diff = 10,   maxzdiff = 1,   classes = FALSE,   ground = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_segmentation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar segmentation — wbt_lidar_segmentation","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. num_iter Number iterations. num_samples Number sample points build model. threshold Threshold used determine inlier points. model_size Acceptable model size. max_slope Maximum planar slope. norm_diff Maximum difference normal vectors, degrees. maxzdiff Maximum difference elevation (z units) neighbouring points segment. classes Segments cross class boundaries. ground Classify largest segment ground points?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_segmentation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar segmentation — wbt_lidar_segmentation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_segmentation_based_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar segmentation based filter — wbt_lidar_segmentation_based_filter","title":"Lidar segmentation based filter — wbt_lidar_segmentation_based_filter","text":"Identifies ground points within LiDAR point clouds using segmentation based approach.","code":""},{"path":"/reference/wbt_lidar_segmentation_based_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar segmentation based filter — wbt_lidar_segmentation_based_filter","text":"","code":"wbt_lidar_segmentation_based_filter(   input,   output,   radius = 5,   norm_diff = 2,   maxzdiff = 1,   classify = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_segmentation_based_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar segmentation based filter — wbt_lidar_segmentation_based_filter","text":"input Input LiDAR file. output Output file. radius Search Radius. norm_diff Maximum difference normal vectors, degrees. maxzdiff Maximum difference elevation (z units) neighbouring points segment. classify Classify points ground (2) -ground (1). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_segmentation_based_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar segmentation based filter — wbt_lidar_segmentation_based_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_shift.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar shift — wbt_lidar_shift","title":"Lidar shift — wbt_lidar_shift","text":"Shifts x,y,z coordinates LiDAR file.","code":""},{"path":"/reference/wbt_lidar_shift.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar shift — wbt_lidar_shift","text":"","code":"wbt_lidar_shift(   input,   output,   x_shift = \"\",   y_shift = \"\",   z_shift = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_shift.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar shift — wbt_lidar_shift","text":"input Name input LiDAR points. output Name output LiDAR points. x_shift x-shift value, blank none. y_shift y-shift value, blank none. z_shift z-shift value, blank none. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_shift.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar shift — wbt_lidar_shift","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_sibson_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar sibson interpolation — wbt_lidar_sibson_interpolation","title":"Lidar sibson interpolation — wbt_lidar_sibson_interpolation","text":"tool interpolates one LiDAR tiles using Sibson's natural neighbour method.","code":""},{"path":"/reference/wbt_lidar_sibson_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar sibson interpolation — wbt_lidar_sibson_interpolation","text":"","code":"wbt_lidar_sibson_interpolation(   input,   output = NULL,   parameter = \"elevation\",   returns = \"all\",   resolution = 1,   exclude_cls = NULL,   minz = NULL,   maxz = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_sibson_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar sibson interpolation — wbt_lidar_sibson_interpolation","text":"input Name input LiDAR points (leave blank use files WorkingDirectory. output Output raster file (including extension). parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'class', 'return_number', 'number_of_returns', 'scan angle', 'user_data'. returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_sibson_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar sibson interpolation — wbt_lidar_sibson_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_sort_by_time.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar sort by time — wbt_lidar_sort_by_time","title":"Lidar sort by time — wbt_lidar_sort_by_time","text":"tool sorts points LiDAR file GPS time.","code":""},{"path":"/reference/wbt_lidar_sort_by_time.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar sort by time — wbt_lidar_sort_by_time","text":"","code":"wbt_lidar_sort_by_time(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_sort_by_time.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar sort by time — wbt_lidar_sort_by_time","text":"input Name input LiDAR points. output Name output LiDAR points. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_sort_by_time.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar sort by time — wbt_lidar_sort_by_time","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_thin.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar thin — wbt_lidar_thin","title":"Lidar thin — wbt_lidar_thin","text":"Thins LiDAR point cloud, reducing point density.","code":""},{"path":"/reference/wbt_lidar_thin.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar thin — wbt_lidar_thin","text":"","code":"wbt_lidar_thin(   input,   output,   resolution = 2,   method = \"lowest\",   save_filtered = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_thin.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar thin — wbt_lidar_thin","text":"input Input LiDAR file. output Output LiDAR file. resolution size square area used evaluate nearby points LiDAR data. method Point selection method; options 'first', 'last', 'lowest' (default), 'highest', 'nearest'. save_filtered Save filtered points separate file?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_thin.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar thin — wbt_lidar_thin","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_thin_high_density.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar thin high density — wbt_lidar_thin_high_density","title":"Lidar thin high density — wbt_lidar_thin_high_density","text":"Thins points high density areas within LiDAR point cloud.","code":""},{"path":"/reference/wbt_lidar_thin_high_density.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar thin high density — wbt_lidar_thin_high_density","text":"","code":"wbt_lidar_thin_high_density(   input,   output,   density,   resolution = 1,   save_filtered = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_thin_high_density.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar thin high density — wbt_lidar_thin_high_density","text":"input Input LiDAR file. output Output LiDAR file. density Max. point density (points / m^3). resolution Output raster's grid resolution. save_filtered Save filtered points separate file?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_thin_high_density.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar thin high density — wbt_lidar_thin_high_density","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_tile.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar tile — wbt_lidar_tile","title":"Lidar tile — wbt_lidar_tile","text":"Tiles LiDAR LAS file multiple LAS files.","code":""},{"path":"/reference/wbt_lidar_tile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar tile — wbt_lidar_tile","text":"","code":"wbt_lidar_tile(   input,   width = 1000,   height = 1000,   origin_x = 0,   origin_y = 0,   min_points = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_tile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar tile — wbt_lidar_tile","text":"input Input LiDAR file. width Width tiles X dimension; default 1000.0. height Height tiles Y dimension. origin_x Origin point X coordinate tile grid. origin_y Origin point Y coordinate tile grid. min_points Minimum number points contained tile saved. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_tile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar tile — wbt_lidar_tile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_tile_footprint.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar tile footprint — wbt_lidar_tile_footprint","title":"Lidar tile footprint — wbt_lidar_tile_footprint","text":"Creates vector polygon convex hull LiDAR point cloud. input/output parameters specified, tool works LAS files contained within working directory.","code":""},{"path":"/reference/wbt_lidar_tile_footprint.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar tile footprint — wbt_lidar_tile_footprint","text":"","code":"wbt_lidar_tile_footprint(   input,   output,   hull = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_tile_footprint.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar tile footprint — wbt_lidar_tile_footprint","text":"input Input LiDAR file. output Output vector polygon file. hull Identify convex hull around points. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_tile_footprint.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar tile footprint — wbt_lidar_tile_footprint","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_tin_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar tin gridding — wbt_lidar_tin_gridding","title":"Lidar tin gridding — wbt_lidar_tin_gridding","text":"Creates raster grid based Delaunay triangular irregular network (TIN) fitted LiDAR points.","code":""},{"path":"/reference/wbt_lidar_tin_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar tin gridding — wbt_lidar_tin_gridding","text":"","code":"wbt_lidar_tin_gridding(   input,   output = NULL,   parameter = \"elevation\",   returns = \"all\",   resolution = 1,   exclude_cls = \"7,18\",   minz = NULL,   maxz = NULL,   max_triangle_edge_length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_tin_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar tin gridding — wbt_lidar_tin_gridding","text":"input Input LiDAR file (including extension). output Output raster file (including extension). parameter Interpolation parameter; options 'elevation' (default), 'intensity', 'class', 'return_number', 'number_of_returns', 'scan angle', 'rgb', 'user data'. returns Point return types include; options '' (default), 'last', 'first'. resolution Output raster's grid resolution. exclude_cls Optional exclude classes interpolation; Valid class values range 0 18, based LAS specifications. Example, --exclude_cls='3,4,5,6,7,18'. minz Optional minimum elevation inclusion interpolation. maxz Optional maximum elevation inclusion interpolation. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_tin_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar tin gridding — wbt_lidar_tin_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lidar_tophat_transform.html","id":null,"dir":"Reference","previous_headings":"","what":"Lidar tophat transform — wbt_lidar_tophat_transform","title":"Lidar tophat transform — wbt_lidar_tophat_transform","text":"Performs white top-hat transform Lidar dataset; estimate height ground, useful modelling vegetation canopy.","code":""},{"path":"/reference/wbt_lidar_tophat_transform.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lidar tophat transform — wbt_lidar_tophat_transform","text":"","code":"wbt_lidar_tophat_transform(   input,   output,   radius = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lidar_tophat_transform.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lidar tophat transform — wbt_lidar_tophat_transform","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lidar_tophat_transform.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lidar tophat transform — wbt_lidar_tophat_transform","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_line_detection_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Line detection filter — wbt_line_detection_filter","title":"Line detection filter — wbt_line_detection_filter","text":"Performs line-detection filter image.","code":""},{"path":"/reference/wbt_line_detection_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Line detection filter — wbt_line_detection_filter","text":"","code":"wbt_line_detection_filter(   input,   output,   variant = \"vertical\",   absvals = FALSE,   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_line_detection_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Line detection filter — wbt_line_detection_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. variant Optional variant value. Options include 'v' (vertical), 'h' (horizontal), '45', '135' (default 'v'). absvals Optional flag indicating whether outputs absolute values. clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_line_detection_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Line detection filter — wbt_line_detection_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_line_intersections.html","id":null,"dir":"Reference","previous_headings":"","what":"Line intersections — wbt_line_intersections","title":"Line intersections — wbt_line_intersections","text":"Identifies points features two vector line layers intersect.","code":""},{"path":"/reference/wbt_line_intersections.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Line intersections — wbt_line_intersections","text":"","code":"wbt_line_intersections(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_line_intersections.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Line intersections — wbt_line_intersections","text":"input1 Input vector polyline file. input2 Input vector polyline file. output Output vector point file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_line_intersections.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Line intersections — wbt_line_intersections","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_line_thinning.html","id":null,"dir":"Reference","previous_headings":"","what":"Line thinning — wbt_line_thinning","title":"Line thinning — wbt_line_thinning","text":"Performs line thinning Boolean raster image; intended used RemoveSpurs tool.","code":""},{"path":"/reference/wbt_line_thinning.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Line thinning — wbt_line_thinning","text":"","code":"wbt_line_thinning(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_line_thinning.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Line thinning — wbt_line_thinning","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_line_thinning.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Line thinning — wbt_line_thinning","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_linearity_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Linearity index — wbt_linearity_index","title":"Linearity index — wbt_linearity_index","text":"Calculates linearity index vector polygons.","code":""},{"path":"/reference/wbt_linearity_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Linearity index — wbt_linearity_index","text":"","code":"wbt_linearity_index(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_linearity_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Linearity index — wbt_linearity_index","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_linearity_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Linearity index — wbt_linearity_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lines_to_polygons.html","id":null,"dir":"Reference","previous_headings":"","what":"Lines to polygons — wbt_lines_to_polygons","title":"Lines to polygons — wbt_lines_to_polygons","text":"Converts vector polylines polygons.","code":""},{"path":"/reference/wbt_lines_to_polygons.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lines to polygons — wbt_lines_to_polygons","text":"","code":"wbt_lines_to_polygons(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lines_to_polygons.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lines to polygons — wbt_lines_to_polygons","text":"input Input vector line file. output Output vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lines_to_polygons.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lines to polygons — wbt_lines_to_polygons","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_list_tools.html","id":null,"dir":"Reference","previous_headings":"","what":"All available tools in 'WhiteboxTools' — wbt_list_tools","title":"All available tools in 'WhiteboxTools' — wbt_list_tools","text":"available tools 'WhiteboxTools'","code":""},{"path":"/reference/wbt_list_tools.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"All available tools in 'WhiteboxTools' — wbt_list_tools","text":"","code":"wbt_list_tools(keywords = \"''\")"},{"path":"/reference/wbt_list_tools.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"All available tools in 'WhiteboxTools' — wbt_list_tools","text":"keywords Keywords may used search available tools. Default \"''\" returns available tools.","code":""},{"path":"/reference/wbt_list_tools.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"All available tools in 'WhiteboxTools' — wbt_list_tools","text":"Return available tools WhiteboxTools contain keywords.","code":""},{"path":"/reference/wbt_list_tools.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"All available tools in 'WhiteboxTools' — wbt_list_tools","text":"","code":"if (FALSE) { wbt_list_tools(\"lidar\") }"},{"path":"/reference/wbt_list_unique_values.html","id":null,"dir":"Reference","previous_headings":"","what":"List unique values — wbt_list_unique_values","title":"List unique values — wbt_list_unique_values","text":"Lists unique values contained field within vector's attribute table.","code":""},{"path":"/reference/wbt_list_unique_values.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List unique values — wbt_list_unique_values","text":"","code":"wbt_list_unique_values(   input,   field,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_list_unique_values.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List unique values — wbt_list_unique_values","text":"input Input vector file path. See wbt_file_path() details. field Input field name attribute table. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_list_unique_values.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List unique values — wbt_list_unique_values","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_list_unique_values_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"List unique values raster — wbt_list_unique_values_raster","title":"List unique values raster — wbt_list_unique_values_raster","text":"Lists unique values contained field within vector's attribute table.","code":""},{"path":"/reference/wbt_list_unique_values_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List unique values raster — wbt_list_unique_values_raster","text":"","code":"wbt_list_unique_values_raster(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_list_unique_values_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List unique values raster — wbt_list_unique_values_raster","text":"input Input vector file path. See wbt_file_path() details. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_list_unique_values_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List unique values raster — wbt_list_unique_values_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ln.html","id":null,"dir":"Reference","previous_headings":"","what":"Ln — wbt_ln","title":"Ln — wbt_ln","text":"Returns natural logarithm values raster.","code":""},{"path":"/reference/wbt_ln.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ln — wbt_ln","text":"","code":"wbt_ln(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ln.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ln — wbt_ln","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ln.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ln — wbt_ln","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_local_hypsometric_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Local hypsometric analysis — wbt_local_hypsometric_analysis","title":"Local hypsometric analysis — wbt_local_hypsometric_analysis","text":"tool calculates local, neighbourhood-based hypsometric integral raster.","code":""},{"path":"/reference/wbt_local_hypsometric_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Local hypsometric analysis — wbt_local_hypsometric_analysis","text":"","code":"wbt_local_hypsometric_analysis(   input,   out_mag,   out_scale,   min_scale = 4,   step = 1,   num_steps = 10,   step_nonlinearity = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_local_hypsometric_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Local hypsometric analysis — wbt_local_hypsometric_analysis","text":"input Name input raster DEM file. out_mag Name openness output raster file. out_scale Name openness output raster file. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_local_hypsometric_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Local hypsometric analysis — wbt_local_hypsometric_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_local_quadratic_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Local quadratic regression — wbt_local_quadratic_regression","title":"Local quadratic regression — wbt_local_quadratic_regression","text":"implementation constrained quadratic regression algorithm using flexible window size described Wood (1996).","code":""},{"path":"/reference/wbt_local_quadratic_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Local quadratic regression — wbt_local_quadratic_regression","text":"","code":"wbt_local_quadratic_regression(   dem,   output,   filter = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_local_quadratic_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Local quadratic regression — wbt_local_quadratic_regression","text":"dem Name input DEM raster file. output Name output raster file. filter Edge length filter kernel. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_local_quadratic_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Local quadratic regression — wbt_local_quadratic_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_log10.html","id":null,"dir":"Reference","previous_headings":"","what":"Log10 — wbt_log10","title":"Log10 — wbt_log10","text":"Returns base-10 logarithm values raster.","code":""},{"path":"/reference/wbt_log10.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Log10 — wbt_log10","text":"","code":"wbt_log10(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_log10.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Log10 — wbt_log10","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_log10.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Log10 — wbt_log10","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_log2.html","id":null,"dir":"Reference","previous_headings":"","what":"Log2 — wbt_log2","title":"Log2 — wbt_log2","text":"Returns base-2 logarithm values raster.","code":""},{"path":"/reference/wbt_log2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Log2 — wbt_log2","text":"","code":"wbt_log2(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_log2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Log2 — wbt_log2","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_log2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Log2 — wbt_log2","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_logistic_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Logistic regression — wbt_logistic_regression","title":"Logistic regression — wbt_logistic_regression","text":"Performs logistic regression analysis using training site polygons/points predictor rasters.","code":""},{"path":"/reference/wbt_logistic_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Logistic regression — wbt_logistic_regression","text":"","code":"wbt_logistic_regression(   inputs,   training,   field,   scaling = \"Normalize\",   output = NULL,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_logistic_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Logistic regression — wbt_logistic_regression","text":"inputs Names input predictor rasters. training Name input training site polygons/points shapefile. field Name attribute containing class data. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. output Name output raster file. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_logistic_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Logistic regression — wbt_logistic_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_long_profile.html","id":null,"dir":"Reference","previous_headings":"","what":"Long profile — wbt_long_profile","title":"Long profile — wbt_long_profile","text":"Plots stream longitudinal profiles one rivers.","code":""},{"path":"/reference/wbt_long_profile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Long profile — wbt_long_profile","text":"","code":"wbt_long_profile(   d8_pntr,   streams,   dem,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_long_profile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Long profile — wbt_long_profile","text":"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 ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_long_profile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Long profile — wbt_long_profile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_long_profile_from_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Long profile from points — wbt_long_profile_from_points","title":"Long profile from points — wbt_long_profile_from_points","text":"Plots longitudinal profiles flow-paths initiating set vector points.","code":""},{"path":"/reference/wbt_long_profile_from_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Long profile from points — wbt_long_profile_from_points","text":"","code":"wbt_long_profile_from_points(   d8_pntr,   points,   dem,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_long_profile_from_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Long profile from points — wbt_long_profile_from_points","text":"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 ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_long_profile_from_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Long profile from points — wbt_long_profile_from_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_longest_flowpath.html","id":null,"dir":"Reference","previous_headings":"","what":"Longest flowpath — wbt_longest_flowpath","title":"Longest flowpath — wbt_longest_flowpath","text":"Delineates longest flowpaths group subbasins watersheds.","code":""},{"path":"/reference/wbt_longest_flowpath.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Longest flowpath — wbt_longest_flowpath","text":"","code":"wbt_longest_flowpath(   dem,   basins,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_longest_flowpath.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Longest flowpath — wbt_longest_flowpath","text":"dem Input raster DEM file. basins Input raster basins file. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_longest_flowpath.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Longest flowpath — wbt_longest_flowpath","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_low_points_on_headwater_divides.html","id":null,"dir":"Reference","previous_headings":"","what":"Low points on headwater divides — wbt_low_points_on_headwater_divides","title":"Low points on headwater divides — wbt_low_points_on_headwater_divides","text":"tool locates saddle points along ridges within digital elevation model (DEM).","code":""},{"path":"/reference/wbt_low_points_on_headwater_divides.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Low points on headwater divides — wbt_low_points_on_headwater_divides","text":"","code":"wbt_low_points_on_headwater_divides(   dem,   streams,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_low_points_on_headwater_divides.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Low points on headwater divides — wbt_low_points_on_headwater_divides","text":"dem Name input DEM raster file. streams Name input stream channel raster file. output Name output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_low_points_on_headwater_divides.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Low points on headwater divides — wbt_low_points_on_headwater_divides","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_lowest_position.html","id":null,"dir":"Reference","previous_headings":"","what":"Lowest position — wbt_lowest_position","title":"Lowest position — wbt_lowest_position","text":"Identifies stack position minimum value within raster stack cell--cell basis.","code":""},{"path":"/reference/wbt_lowest_position.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lowest position — wbt_lowest_position","text":"","code":"wbt_lowest_position(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_lowest_position.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lowest position — wbt_lowest_position","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_lowest_position.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lowest position — wbt_lowest_position","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_majority_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Majority filter — wbt_majority_filter","title":"Majority filter — wbt_majority_filter","text":"Assigns cell output grid frequently occurring value (mode) moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_majority_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Majority filter — wbt_majority_filter","text":"","code":"wbt_majority_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_majority_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Majority filter — wbt_majority_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_majority_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Majority filter — wbt_majority_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_map_off_terrain_objects.html","id":null,"dir":"Reference","previous_headings":"","what":"Map off terrain objects — wbt_map_off_terrain_objects","title":"Map off terrain objects — wbt_map_off_terrain_objects","text":"Maps -terrain objects digital elevation model (DEM).","code":""},{"path":"/reference/wbt_map_off_terrain_objects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Map off terrain objects — wbt_map_off_terrain_objects","text":"","code":"wbt_map_off_terrain_objects(   dem,   output,   max_slope = 40,   min_size = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_map_off_terrain_objects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Map off terrain objects — wbt_map_off_terrain_objects","text":"dem Input raster DEM file. output Output raster file. max_slope Maximum inter-cell absolute slope. min_size Minimum feature size, grid cells. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_map_off_terrain_objects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Map off terrain objects — wbt_map_off_terrain_objects","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max.html","id":null,"dir":"Reference","previous_headings":"","what":"Max — wbt_max","title":"Max — wbt_max","text":"Performs MAX operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_max.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max — wbt_max","text":"","code":"wbt_max(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max — wbt_max","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max — wbt_max","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_absolute_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Max absolute overlay — wbt_max_absolute_overlay","title":"Max absolute overlay — wbt_max_absolute_overlay","text":"Evaluates maximum absolute value grid cell stack input rasters.","code":""},{"path":"/reference/wbt_max_absolute_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max absolute overlay — wbt_max_absolute_overlay","text":"","code":"wbt_max_absolute_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_absolute_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max absolute overlay — wbt_max_absolute_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_absolute_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max absolute overlay — wbt_max_absolute_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_anisotropy_dev.html","id":null,"dir":"Reference","previous_headings":"","what":"Max anisotropy dev — wbt_max_anisotropy_dev","title":"Max anisotropy dev — wbt_max_anisotropy_dev","text":"Calculates maximum anisotropy (directionality) elevation deviation range spatial scales.","code":""},{"path":"/reference/wbt_max_anisotropy_dev.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max anisotropy dev — wbt_max_anisotropy_dev","text":"","code":"wbt_max_anisotropy_dev(   dem,   out_mag,   out_scale,   max_scale,   min_scale = 3,   step = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_anisotropy_dev.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max anisotropy dev — wbt_max_anisotropy_dev","text":"dem Input raster DEM file. out_mag Output raster DEVmax magnitude file. out_scale Output raster DEVmax scale file. max_scale Maximum search neighbourhood radius grid cells. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_anisotropy_dev.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max anisotropy dev — wbt_max_anisotropy_dev","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_anisotropy_dev_signature.html","id":null,"dir":"Reference","previous_headings":"","what":"Max anisotropy dev signature — wbt_max_anisotropy_dev_signature","title":"Max anisotropy dev signature — wbt_max_anisotropy_dev_signature","text":"Calculates anisotropy deviation mean points range spatial scales.","code":""},{"path":"/reference/wbt_max_anisotropy_dev_signature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max anisotropy dev signature — wbt_max_anisotropy_dev_signature","text":"","code":"wbt_max_anisotropy_dev_signature(   dem,   points,   output,   max_scale,   min_scale = 1,   step = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_anisotropy_dev_signature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max anisotropy dev signature — wbt_max_anisotropy_dev_signature","text":"dem Input raster DEM file. points Input vector points file. output Output HTML file. max_scale Maximum search neighbourhood radius grid cells. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_anisotropy_dev_signature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max anisotropy dev signature — wbt_max_anisotropy_dev_signature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_branch_length.html","id":null,"dir":"Reference","previous_headings":"","what":"Max branch length — wbt_max_branch_length","title":"Max branch length — wbt_max_branch_length","text":"Lindsay Seibert's (2013) branch length index used map drainage divides ridge lines.","code":""},{"path":"/reference/wbt_max_branch_length.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max branch length — wbt_max_branch_length","text":"","code":"wbt_max_branch_length(   dem,   output,   log = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_branch_length.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max branch length — wbt_max_branch_length","text":"dem Input raster DEM file. output Output raster file. log Optional flag request output log-transformed. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_branch_length.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max branch length — wbt_max_branch_length","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_difference_from_mean.html","id":null,"dir":"Reference","previous_headings":"","what":"Max difference from mean — wbt_max_difference_from_mean","title":"Max difference from mean — wbt_max_difference_from_mean","text":"Calculates maximum difference mean elevation range spatial scales.","code":""},{"path":"/reference/wbt_max_difference_from_mean.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max difference from mean — wbt_max_difference_from_mean","text":"","code":"wbt_max_difference_from_mean(   dem,   out_mag,   out_scale,   min_scale,   max_scale,   step = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_difference_from_mean.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max difference from mean — wbt_max_difference_from_mean","text":"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 grid cells. max_scale Maximum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_difference_from_mean.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max difference from mean — wbt_max_difference_from_mean","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_downslope_elev_change.html","id":null,"dir":"Reference","previous_headings":"","what":"Max downslope elev change — wbt_max_downslope_elev_change","title":"Max downslope elev change — wbt_max_downslope_elev_change","text":"Calculates maximum downslope change elevation grid cell eight downslope neighbors.","code":""},{"path":"/reference/wbt_max_downslope_elev_change.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max downslope elev change — wbt_max_downslope_elev_change","text":"","code":"wbt_max_downslope_elev_change(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_downslope_elev_change.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max downslope elev change — wbt_max_downslope_elev_change","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_downslope_elev_change.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max downslope elev change — wbt_max_downslope_elev_change","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_elev_dev_signature.html","id":null,"dir":"Reference","previous_headings":"","what":"Max elev dev signature — wbt_max_elev_dev_signature","title":"Max elev dev signature — wbt_max_elev_dev_signature","text":"Calculates maximum elevation deviation range spatial scales set points.","code":""},{"path":"/reference/wbt_max_elev_dev_signature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max elev dev signature — wbt_max_elev_dev_signature","text":"","code":"wbt_max_elev_dev_signature(   dem,   points,   output,   min_scale,   max_scale,   step = 10,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_elev_dev_signature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max elev dev signature — wbt_max_elev_dev_signature","text":"dem Input raster DEM file. points Input vector points file. output Output HTML file. min_scale Minimum search neighbourhood radius grid cells. max_scale Maximum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_elev_dev_signature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max elev dev signature — wbt_max_elev_dev_signature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_elevation_deviation.html","id":null,"dir":"Reference","previous_headings":"","what":"Max elevation deviation — wbt_max_elevation_deviation","title":"Max elevation deviation — wbt_max_elevation_deviation","text":"Calculates maximum elevation deviation range spatial scales.","code":""},{"path":"/reference/wbt_max_elevation_deviation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max elevation deviation — wbt_max_elevation_deviation","text":"","code":"wbt_max_elevation_deviation(   dem,   out_mag,   out_scale,   min_scale,   max_scale,   step = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_elevation_deviation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max elevation deviation — wbt_max_elevation_deviation","text":"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 grid cells. max_scale Maximum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_elevation_deviation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max elevation deviation — wbt_max_elevation_deviation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Max overlay — wbt_max_overlay","title":"Max overlay — wbt_max_overlay","text":"Evaluates maximum value grid cell stack input rasters.","code":""},{"path":"/reference/wbt_max_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max overlay — wbt_max_overlay","text":"","code":"wbt_max_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max overlay — wbt_max_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max overlay — wbt_max_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_upslope_elev_change.html","id":null,"dir":"Reference","previous_headings":"","what":"Max upslope elev change — wbt_max_upslope_elev_change","title":"Max upslope elev change — wbt_max_upslope_elev_change","text":"Calculates maximum upslope change elevation grid cell eight downslope neighbors.","code":""},{"path":"/reference/wbt_max_upslope_elev_change.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max upslope elev change — wbt_max_upslope_elev_change","text":"","code":"wbt_max_upslope_elev_change(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_upslope_elev_change.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max upslope elev change — wbt_max_upslope_elev_change","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_upslope_elev_change.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max upslope elev change — wbt_max_upslope_elev_change","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_upslope_flowpath_length.html","id":null,"dir":"Reference","previous_headings":"","what":"Max upslope flowpath length — wbt_max_upslope_flowpath_length","title":"Max upslope flowpath length — wbt_max_upslope_flowpath_length","text":"Measures maximum length upslope flowpaths draining grid cell.","code":""},{"path":"/reference/wbt_max_upslope_flowpath_length.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max upslope flowpath length — wbt_max_upslope_flowpath_length","text":"","code":"wbt_max_upslope_flowpath_length(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_upslope_flowpath_length.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max upslope flowpath length — wbt_max_upslope_flowpath_length","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_upslope_flowpath_length.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max upslope flowpath length — wbt_max_upslope_flowpath_length","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_max_upslope_value.html","id":null,"dir":"Reference","previous_headings":"","what":"Max upslope value — wbt_max_upslope_value","title":"Max upslope value — wbt_max_upslope_value","text":"Calculates maximum upslope value input values raster along flowpaths.","code":""},{"path":"/reference/wbt_max_upslope_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Max upslope value — wbt_max_upslope_value","text":"","code":"wbt_max_upslope_value(   dem,   values,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_max_upslope_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Max upslope value — wbt_max_upslope_value","text":"dem Input DEM; must depressionless. values Name input values raster file. output Name output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_max_upslope_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Max upslope value — wbt_max_upslope_value","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_maximal_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Maximal curvature — wbt_maximal_curvature","title":"Maximal curvature — wbt_maximal_curvature","text":"Calculates mean curvature raster input DEM.","code":""},{"path":"/reference/wbt_maximal_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Maximal curvature — wbt_maximal_curvature","text":"","code":"wbt_maximal_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_maximal_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Maximal curvature — wbt_maximal_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_maximal_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Maximal curvature — wbt_maximal_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_maximum_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Maximum filter — wbt_maximum_filter","title":"Maximum filter — wbt_maximum_filter","text":"Assigns cell output grid maximum value moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_maximum_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Maximum filter — wbt_maximum_filter","text":"","code":"wbt_maximum_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_maximum_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Maximum filter — wbt_maximum_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_maximum_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Maximum filter — wbt_maximum_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_md_inf_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Md inf flow accumulation — wbt_md_inf_flow_accumulation","title":"Md inf flow accumulation — wbt_md_inf_flow_accumulation","text":"Calculates FD8 flow accumulation raster input DEM.","code":""},{"path":"/reference/wbt_md_inf_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Md inf flow accumulation — wbt_md_inf_flow_accumulation","text":"","code":"wbt_md_inf_flow_accumulation(   dem,   output,   out_type = \"specific contributing area\",   exponent = 1.1,   threshold = NULL,   log = FALSE,   clip = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_md_inf_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Md inf flow accumulation — wbt_md_inf_flow_accumulation","text":"dem Input raster DEM file. output Output raster file. out_type Output type; one 'cells', 'specific contributing area' (default), 'catchment area'. exponent Optional exponent parameter; default 1.1. threshold Optional convergence threshold parameter, grid cells; default infinity. log Optional flag request output log-transformed. clip Optional flag request clipping display max 1 percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_md_inf_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Md inf flow accumulation — wbt_md_inf_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_mean_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Mean curvature — wbt_mean_curvature","title":"Mean curvature — wbt_mean_curvature","text":"Calculates mean curvature raster input DEM.","code":""},{"path":"/reference/wbt_mean_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Mean curvature — wbt_mean_curvature","text":"","code":"wbt_mean_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_mean_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Mean curvature — wbt_mean_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_mean_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Mean curvature — wbt_mean_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_mean_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Mean filter — wbt_mean_filter","title":"Mean filter — wbt_mean_filter","text":"Performs mean filter (low-pass filter) input image.","code":""},{"path":"/reference/wbt_mean_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Mean filter — wbt_mean_filter","text":"","code":"wbt_mean_filter(   input,   output,   filterx = 3,   filtery = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_mean_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Mean filter — wbt_mean_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_mean_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Mean filter — wbt_mean_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_median_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Median filter — wbt_median_filter","title":"Median filter — wbt_median_filter","text":"Performs median filter input image.","code":""},{"path":"/reference/wbt_median_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Median filter — wbt_median_filter","text":"","code":"wbt_median_filter(   input,   output,   filterx = 11,   filtery = 11,   sig_digits = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_median_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Median filter — wbt_median_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. sig_digits Number significant digits. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_median_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Median filter — wbt_median_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_medoid.html","id":null,"dir":"Reference","previous_headings":"","what":"Medoid — wbt_medoid","title":"Medoid — wbt_medoid","text":"Calculates medoid series vector features contained shapefile.","code":""},{"path":"/reference/wbt_medoid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Medoid — wbt_medoid","text":"","code":"wbt_medoid(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_medoid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Medoid — wbt_medoid","text":"input Input vector file path. See wbt_file_path() details. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_medoid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Medoid — wbt_medoid","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_merge_line_segments.html","id":null,"dir":"Reference","previous_headings":"","what":"Merge line segments — wbt_merge_line_segments","title":"Merge line segments — wbt_merge_line_segments","text":"Merges vector line segments larger features.","code":""},{"path":"/reference/wbt_merge_line_segments.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Merge line segments — wbt_merge_line_segments","text":"","code":"wbt_merge_line_segments(   input,   output,   snap = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_merge_line_segments.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Merge line segments — wbt_merge_line_segments","text":"input Input vector file path. See wbt_file_path() details. output Output vector file. snap Snap tolerance. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_merge_line_segments.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Merge line segments — wbt_merge_line_segments","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_merge_table_with_csv.html","id":null,"dir":"Reference","previous_headings":"","what":"Merge table with csv — wbt_merge_table_with_csv","title":"Merge table with csv — wbt_merge_table_with_csv","text":"Merge vector's attribute table table contained within CSV text file.","code":""},{"path":"/reference/wbt_merge_table_with_csv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Merge table with csv — wbt_merge_table_with_csv","text":"","code":"wbt_merge_table_with_csv(   input,   pkey,   csv,   fkey,   import_field = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_merge_table_with_csv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Merge table with csv — wbt_merge_table_with_csv","text":"input Input primary vector file (.e. table modified). pkey Primary key field. csv Input CSV file (.e. source data imported). fkey Foreign key field. import_field Imported field (fields imported specified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_merge_table_with_csv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Merge table with csv — wbt_merge_table_with_csv","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_merge_vectors.html","id":null,"dir":"Reference","previous_headings":"","what":"Merge vectors — wbt_merge_vectors","title":"Merge vectors — wbt_merge_vectors","text":"Combines two input vectors ShapeType creating single, new output vector.","code":""},{"path":"/reference/wbt_merge_vectors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Merge vectors — wbt_merge_vectors","text":"","code":"wbt_merge_vectors(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_merge_vectors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Merge vectors — wbt_merge_vectors","text":"inputs Input vector file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_merge_vectors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Merge vectors — wbt_merge_vectors","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min.html","id":null,"dir":"Reference","previous_headings":"","what":"Min — wbt_min","title":"Min — wbt_min","text":"Performs MIN operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_min.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min — wbt_min","text":"","code":"wbt_min(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min — wbt_min","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min — wbt_min","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min_absolute_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Min absolute overlay — wbt_min_absolute_overlay","title":"Min absolute overlay — wbt_min_absolute_overlay","text":"Evaluates minimum absolute value grid cell stack input rasters.","code":""},{"path":"/reference/wbt_min_absolute_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min absolute overlay — wbt_min_absolute_overlay","text":"","code":"wbt_min_absolute_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min_absolute_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min absolute overlay — wbt_min_absolute_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min_absolute_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min absolute overlay — wbt_min_absolute_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min_dist_classification.html","id":null,"dir":"Reference","previous_headings":"","what":"Min dist classification — wbt_min_dist_classification","title":"Min dist classification — wbt_min_dist_classification","text":"Performs supervised minimum-distance classification using training site polygons multi-spectral images.","code":""},{"path":"/reference/wbt_min_dist_classification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min dist classification — wbt_min_dist_classification","text":"","code":"wbt_min_dist_classification(   inputs,   polys,   field,   output,   threshold = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min_dist_classification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min dist classification — wbt_min_dist_classification","text":"inputs Names input band images. polys Name input training site polygons shapefile. field Name attribute containing class name data. output Name output raster file. threshold Distance threshold, z-scores; blank none. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min_dist_classification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min dist classification — wbt_min_dist_classification","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min_downslope_elev_change.html","id":null,"dir":"Reference","previous_headings":"","what":"Min downslope elev change — wbt_min_downslope_elev_change","title":"Min downslope elev change — wbt_min_downslope_elev_change","text":"Calculates minimum downslope change elevation grid cell eight downslope neighbors.","code":""},{"path":"/reference/wbt_min_downslope_elev_change.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min downslope elev change — wbt_min_downslope_elev_change","text":"","code":"wbt_min_downslope_elev_change(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min_downslope_elev_change.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min downslope elev change — wbt_min_downslope_elev_change","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min_downslope_elev_change.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min downslope elev change — wbt_min_downslope_elev_change","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min_max_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Min max contrast stretch — wbt_min_max_contrast_stretch","title":"Min max contrast stretch — wbt_min_max_contrast_stretch","text":"Performs min-max contrast stretch input greytone image.","code":""},{"path":"/reference/wbt_min_max_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min max contrast stretch — wbt_min_max_contrast_stretch","text":"","code":"wbt_min_max_contrast_stretch(   input,   output,   min_val,   max_val,   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min_max_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min max contrast stretch — wbt_min_max_contrast_stretch","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. min_val Lower tail clip value. max_val Upper tail clip value. num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min_max_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min max contrast stretch — wbt_min_max_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_min_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Min overlay — wbt_min_overlay","title":"Min overlay — wbt_min_overlay","text":"Evaluates minimum value grid cell stack input rasters.","code":""},{"path":"/reference/wbt_min_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Min overlay — wbt_min_overlay","text":"","code":"wbt_min_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_min_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Min overlay — wbt_min_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_min_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Min overlay — wbt_min_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimal_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimal curvature — wbt_minimal_curvature","title":"Minimal curvature — wbt_minimal_curvature","text":"Calculates mean curvature raster input DEM.","code":""},{"path":"/reference/wbt_minimal_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimal curvature — wbt_minimal_curvature","text":"","code":"wbt_minimal_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimal_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimal curvature — wbt_minimal_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimal_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimal curvature — wbt_minimal_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimum_bounding_box.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimum bounding box — wbt_minimum_bounding_box","title":"Minimum bounding box — wbt_minimum_bounding_box","text":"Creates vector minimum bounding rectangle around vector features.","code":""},{"path":"/reference/wbt_minimum_bounding_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimum bounding box — wbt_minimum_bounding_box","text":"","code":"wbt_minimum_bounding_box(   input,   output,   criterion = \"area\",   features = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimum_bounding_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimum bounding box — wbt_minimum_bounding_box","text":"input Input vector file path. See wbt_file_path() details. output Output vector polygon file. criterion Minimization criterion; options include 'area' (default), 'length', 'width', 'perimeter'. features Find minimum bounding rectangles around individual vector feature. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimum_bounding_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimum bounding box — wbt_minimum_bounding_box","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimum_bounding_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimum bounding circle — wbt_minimum_bounding_circle","title":"Minimum bounding circle — wbt_minimum_bounding_circle","text":"Delineates minimum bounding circle (.e. smallest enclosing circle) group vectors.","code":""},{"path":"/reference/wbt_minimum_bounding_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimum bounding circle — wbt_minimum_bounding_circle","text":"","code":"wbt_minimum_bounding_circle(   input,   output,   features = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimum_bounding_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimum bounding circle — wbt_minimum_bounding_circle","text":"input Input vector file path. See wbt_file_path() details. output Output vector polygon file. features Find minimum bounding circle around individual vector feature. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimum_bounding_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimum bounding circle — wbt_minimum_bounding_circle","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimum_bounding_envelope.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimum bounding envelope — wbt_minimum_bounding_envelope","title":"Minimum bounding envelope — wbt_minimum_bounding_envelope","text":"Creates vector axis-aligned minimum bounding rectangle (envelope) around vector features.","code":""},{"path":"/reference/wbt_minimum_bounding_envelope.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimum bounding envelope — wbt_minimum_bounding_envelope","text":"","code":"wbt_minimum_bounding_envelope(   input,   output,   features = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimum_bounding_envelope.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimum bounding envelope — wbt_minimum_bounding_envelope","text":"input Input vector file path. See wbt_file_path() details. output Output vector polygon file. features Find minimum bounding envelop around individual vector feature. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimum_bounding_envelope.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimum bounding envelope — wbt_minimum_bounding_envelope","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimum_convex_hull.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimum convex hull — wbt_minimum_convex_hull","title":"Minimum convex hull — wbt_minimum_convex_hull","text":"Creates vector convex polygon around vector features.","code":""},{"path":"/reference/wbt_minimum_convex_hull.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimum convex hull — wbt_minimum_convex_hull","text":"","code":"wbt_minimum_convex_hull(   input,   output,   features = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimum_convex_hull.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimum convex hull — wbt_minimum_convex_hull","text":"input Input vector file path. See wbt_file_path() details. output Output vector polygon file. features Find hulls around vector feature. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimum_convex_hull.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimum convex hull — wbt_minimum_convex_hull","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_minimum_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Minimum filter — wbt_minimum_filter","title":"Minimum filter — wbt_minimum_filter","text":"Assigns cell output grid minimum value moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_minimum_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Minimum filter — wbt_minimum_filter","text":"","code":"wbt_minimum_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_minimum_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Minimum filter — wbt_minimum_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_minimum_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Minimum filter — wbt_minimum_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_modified_k_means_clustering.html","id":null,"dir":"Reference","previous_headings":"","what":"Modified k means clustering — wbt_modified_k_means_clustering","title":"Modified k means clustering — wbt_modified_k_means_clustering","text":"Performs modified k-means clustering operation multi-spectral dataset.","code":""},{"path":"/reference/wbt_modified_k_means_clustering.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modified k means clustering — wbt_modified_k_means_clustering","text":"","code":"wbt_modified_k_means_clustering(   inputs,   output,   out_html = NULL,   start_clusters = 1000,   merge_dist = NULL,   max_iterations = 10,   class_change = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_modified_k_means_clustering.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modified k means clustering — wbt_modified_k_means_clustering","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. out_html Output HTML report file. start_clusters Initial number clusters. merge_dist Cluster merger distance. max_iterations Maximum number iterations. class_change Minimum percent cells changed iterations completion. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_modified_k_means_clustering.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Modified k means clustering — wbt_modified_k_means_clustering","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_modify_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Modify lidar — wbt_modify_lidar","title":"Modify lidar — wbt_modify_lidar","text":"Modify points within LiDAR point cloud based point properties.","code":""},{"path":"/reference/wbt_modify_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modify lidar — wbt_modify_lidar","text":"","code":"wbt_modify_lidar(   input,   output = NULL,   statement = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_modify_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modify lidar — wbt_modify_lidar","text":"input Name input LiDAR points. output Name output LiDAR points. statement Modify statement e.g. x += 5000.0. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_modify_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Modify lidar — wbt_modify_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_modify_no_data_value.html","id":null,"dir":"Reference","previous_headings":"","what":"Modify no data value — wbt_modify_no_data_value","title":"Modify no data value — wbt_modify_no_data_value","text":"Modifies nodata values raster.","code":""},{"path":"/reference/wbt_modify_no_data_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modify no data value — wbt_modify_no_data_value","text":"","code":"wbt_modify_no_data_value(   input,   new_value = \"-32768.0\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_modify_no_data_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modify no data value — wbt_modify_no_data_value","text":"input Input raster file path. See wbt_file_path() details. new_value New NoData value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_modify_no_data_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Modify no data value — wbt_modify_no_data_value","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_modulo.html","id":null,"dir":"Reference","previous_headings":"","what":"Modulo — wbt_modulo","title":"Modulo — wbt_modulo","text":"Performs modulo operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_modulo.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Modulo — wbt_modulo","text":"","code":"wbt_modulo(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_modulo.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Modulo — wbt_modulo","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_modulo.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Modulo — wbt_modulo","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_mosaic.html","id":null,"dir":"Reference","previous_headings":"","what":"Mosaic — wbt_mosaic","title":"Mosaic — wbt_mosaic","text":"Mosaics two images together.","code":""},{"path":"/reference/wbt_mosaic.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Mosaic — wbt_mosaic","text":"","code":"wbt_mosaic(   output,   inputs = NULL,   method = \"nn\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_mosaic.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Mosaic — wbt_mosaic","text":"output Output raster file. inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', 'cc' (cubic convolution). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_mosaic.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Mosaic — wbt_mosaic","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_mosaic_with_feathering.html","id":null,"dir":"Reference","previous_headings":"","what":"Mosaic with feathering — wbt_mosaic_with_feathering","title":"Mosaic with feathering — wbt_mosaic_with_feathering","text":"Mosaics two images together using feathering technique overlapping areas reduce edge-effects.","code":""},{"path":"/reference/wbt_mosaic_with_feathering.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Mosaic with feathering — wbt_mosaic_with_feathering","text":"","code":"wbt_mosaic_with_feathering(   input1,   input2,   output,   method = \"cc\",   weight = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_mosaic_with_feathering.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Mosaic with feathering — wbt_mosaic_with_feathering","text":"input1 Input raster file modify. input2 Input reference raster file. output Output raster file. method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', 'cc' (cubic convolution). weight . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_mosaic_with_feathering.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Mosaic with feathering — wbt_mosaic_with_feathering","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multi_part_to_single_part.html","id":null,"dir":"Reference","previous_headings":"","what":"Multi part to single part — wbt_multi_part_to_single_part","title":"Multi part to single part — wbt_multi_part_to_single_part","text":"Converts vector file containing multi-part features vector containing single-part features.","code":""},{"path":"/reference/wbt_multi_part_to_single_part.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multi part to single part — wbt_multi_part_to_single_part","text":"","code":"wbt_multi_part_to_single_part(   input,   output,   exclude_holes = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multi_part_to_single_part.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multi part to single part — wbt_multi_part_to_single_part","text":"input Input vector line polygon file. output Output vector line polygon file. exclude_holes Exclude hole parts feature splitting? (holes continue belong features output.). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multi_part_to_single_part.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multi part to single part — wbt_multi_part_to_single_part","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multidirectional_hillshade.html","id":null,"dir":"Reference","previous_headings":"","what":"Multidirectional hillshade — wbt_multidirectional_hillshade","title":"Multidirectional hillshade — wbt_multidirectional_hillshade","text":"Calculates multi-direction hillshade raster input DEM.","code":""},{"path":"/reference/wbt_multidirectional_hillshade.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multidirectional hillshade — wbt_multidirectional_hillshade","text":"","code":"wbt_multidirectional_hillshade(   dem,   output,   altitude = 45,   zfactor = NULL,   full_mode = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multidirectional_hillshade.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multidirectional hillshade — wbt_multidirectional_hillshade","text":"dem Input raster DEM file. output Output raster file. altitude Illumination source altitude degrees. zfactor Optional multiplier vertical horizontal units . full_mode Optional flag indicating whether use full 360-degrees illumination sources. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multidirectional_hillshade.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multidirectional hillshade — wbt_multidirectional_hillshade","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiply.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiply — wbt_multiply","title":"Multiply — wbt_multiply","text":"Performs multiplication operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_multiply.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiply — wbt_multiply","text":"","code":"wbt_multiply(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiply.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiply — wbt_multiply","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiply.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiply — wbt_multiply","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiply_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiply overlay — wbt_multiply_overlay","title":"Multiply overlay — wbt_multiply_overlay","text":"Calculates sum grid cell group raster images.","code":""},{"path":"/reference/wbt_multiply_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiply overlay — wbt_multiply_overlay","text":"","code":"wbt_multiply_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiply_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiply overlay — wbt_multiply_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiply_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiply overlay — wbt_multiply_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_curvatures.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale curvatures — wbt_multiscale_curvatures","title":"Multiscale curvatures — wbt_multiscale_curvatures","text":"tool calculates several multiscale curvatures curvature-based indices input DEM.","code":""},{"path":"/reference/wbt_multiscale_curvatures.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale curvatures — wbt_multiscale_curvatures","text":"","code":"wbt_multiscale_curvatures(   dem,   out_mag,   curv_type = \"ProfileCurv\",   out_scale = NULL,   min_scale = 0,   step = 1,   num_steps = 1,   step_nonlinearity = 1,   log = TRUE,   standardize = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_curvatures.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale curvatures — wbt_multiscale_curvatures","text":"dem Name input raster DEM file. out_mag Output raster magnitude file. curv_type Curvature type. out_scale Output raster scale file. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). log Display output values using log-scale. standardize scale standardized z-scores?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_curvatures.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale curvatures — wbt_multiscale_curvatures","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_elevation_percentile.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale elevation percentile — wbt_multiscale_elevation_percentile","title":"Multiscale elevation percentile — wbt_multiscale_elevation_percentile","text":"Calculates surface roughness range spatial scales.","code":""},{"path":"/reference/wbt_multiscale_elevation_percentile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale elevation percentile — wbt_multiscale_elevation_percentile","text":"","code":"wbt_multiscale_elevation_percentile(   dem,   out_mag,   out_scale,   sig_digits = 3,   min_scale = 4,   step = 1,   num_steps = 10,   step_nonlinearity = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_elevation_percentile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale elevation percentile — wbt_multiscale_elevation_percentile","text":"dem Input raster DEM file. out_mag Output raster roughness magnitude file. out_scale Output raster roughness scale file. sig_digits Number significant digits. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_elevation_percentile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale elevation percentile — wbt_multiscale_elevation_percentile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_roughness.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale roughness — wbt_multiscale_roughness","title":"Multiscale roughness — wbt_multiscale_roughness","text":"Calculates surface roughness range spatial scales.","code":""},{"path":"/reference/wbt_multiscale_roughness.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale roughness — wbt_multiscale_roughness","text":"","code":"wbt_multiscale_roughness(   dem,   out_mag,   out_scale,   max_scale,   min_scale = 1,   step = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_roughness.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale roughness — wbt_multiscale_roughness","text":"dem Input raster DEM file. out_mag Output raster roughness magnitude file. out_scale Output raster roughness scale file. max_scale Maximum search neighbourhood radius grid cells. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_roughness.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale roughness — wbt_multiscale_roughness","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_roughness_signature.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale roughness signature — wbt_multiscale_roughness_signature","title":"Multiscale roughness signature — wbt_multiscale_roughness_signature","text":"Calculates surface roughness points range spatial scales.","code":""},{"path":"/reference/wbt_multiscale_roughness_signature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale roughness signature — wbt_multiscale_roughness_signature","text":"","code":"wbt_multiscale_roughness_signature(   dem,   points,   output,   max_scale,   min_scale = 1,   step = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_roughness_signature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale roughness signature — wbt_multiscale_roughness_signature","text":"dem Input raster DEM file. points Input vector points file. output Output HTML file. max_scale Maximum search neighbourhood radius grid cells. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_roughness_signature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale roughness signature — wbt_multiscale_roughness_signature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale std dev normals — wbt_multiscale_std_dev_normals","title":"Multiscale std dev normals — wbt_multiscale_std_dev_normals","text":"Calculates surface roughness range spatial scales.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale std dev normals — wbt_multiscale_std_dev_normals","text":"","code":"wbt_multiscale_std_dev_normals(   dem,   out_mag,   out_scale,   min_scale = 1,   step = 1,   num_steps = 10,   step_nonlinearity = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_std_dev_normals.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale std dev normals — wbt_multiscale_std_dev_normals","text":"dem Input raster DEM file. out_mag Output raster roughness magnitude file. out_scale Output raster roughness scale file. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale std dev normals — wbt_multiscale_std_dev_normals","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals_signature.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale std dev normals signature — wbt_multiscale_std_dev_normals_signature","title":"Multiscale std dev normals signature — wbt_multiscale_std_dev_normals_signature","text":"Calculates surface roughness points range spatial scales.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals_signature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale std dev normals signature — wbt_multiscale_std_dev_normals_signature","text":"","code":"wbt_multiscale_std_dev_normals_signature(   dem,   points,   output,   min_scale = 1,   step = 1,   num_steps = 10,   step_nonlinearity = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_std_dev_normals_signature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale std dev normals signature — wbt_multiscale_std_dev_normals_signature","text":"dem Input raster DEM file. points Input vector points file. output Output HTML file. min_scale Minimum search neighbourhood radius grid cells. step Step size positive non-zero integer. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_std_dev_normals_signature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale std dev normals signature — wbt_multiscale_std_dev_normals_signature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_multiscale_topographic_position_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Multiscale topographic position image — wbt_multiscale_topographic_position_image","title":"Multiscale topographic position image — wbt_multiscale_topographic_position_image","text":"Creates multiscale topographic position image three DEVmax rasters differing spatial scale ranges.","code":""},{"path":"/reference/wbt_multiscale_topographic_position_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Multiscale topographic position image — wbt_multiscale_topographic_position_image","text":"","code":"wbt_multiscale_topographic_position_image(   local,   meso,   broad,   output,   hillshade = NULL,   lightness = 1.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_multiscale_topographic_position_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Multiscale topographic position image — wbt_multiscale_topographic_position_image","text":"local Input local-scale topographic position (DEVmax) raster file. meso Input meso-scale topographic position (DEVmax) raster file. broad Input broad-scale topographic position (DEVmax) raster file. output Output raster file. hillshade Input optional hillshade raster file. Note: multi-directional (360-degree option) hillshade tends work best application. lightness Image lightness value (default 1.2). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_multiscale_topographic_position_image.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Multiscale topographic position image — wbt_multiscale_topographic_position_image","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_narrowness_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Narrowness index — wbt_narrowness_index","title":"Narrowness index — wbt_narrowness_index","text":"Calculates narrowness raster polygons.","code":""},{"path":"/reference/wbt_narrowness_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Narrowness index — wbt_narrowness_index","text":"","code":"wbt_narrowness_index(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_narrowness_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Narrowness index — wbt_narrowness_index","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_narrowness_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Narrowness index — wbt_narrowness_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_natural_neighbour_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Natural neighbour interpolation — wbt_natural_neighbour_interpolation","title":"Natural neighbour interpolation — wbt_natural_neighbour_interpolation","text":"Creates raster grid based Sibson's natural neighbour method.","code":""},{"path":"/reference/wbt_natural_neighbour_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Natural neighbour interpolation — wbt_natural_neighbour_interpolation","text":"","code":"wbt_natural_neighbour_interpolation(   input,   output,   field = NULL,   use_z = FALSE,   cell_size = NULL,   base = NULL,   clip = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_natural_neighbour_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Natural neighbour interpolation — wbt_natural_neighbour_interpolation","text":"input Input vector points file. output Output raster file. field Input field name attribute table. use_z Use 'z' dimension Shapefile's geometry instead attribute field?. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. clip Clip data convex hull points?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_natural_neighbour_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Natural neighbour interpolation — wbt_natural_neighbour_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_nearest_neighbour_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Nearest neighbour gridding — wbt_nearest_neighbour_gridding","title":"Nearest neighbour gridding — wbt_nearest_neighbour_gridding","text":"Creates raster grid based set vector points assigns grid values using nearest neighbour.","code":""},{"path":"/reference/wbt_nearest_neighbour_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Nearest neighbour gridding — wbt_nearest_neighbour_gridding","text":"","code":"wbt_nearest_neighbour_gridding(   input,   field,   output,   use_z = FALSE,   cell_size = NULL,   base = NULL,   max_dist = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_nearest_neighbour_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Nearest neighbour gridding — wbt_nearest_neighbour_gridding","text":"input Input vector Points file. field Input field name attribute table. output Output raster file. use_z Use z-coordinate instead field?. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. max_dist Maximum search distance (optional). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_nearest_neighbour_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Nearest neighbour gridding — wbt_nearest_neighbour_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_negate.html","id":null,"dir":"Reference","previous_headings":"","what":"Negate — wbt_negate","title":"Negate — wbt_negate","text":"Changes sign values raster 0-1 values Boolean raster.","code":""},{"path":"/reference/wbt_negate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Negate — wbt_negate","text":"","code":"wbt_negate(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_negate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Negate — wbt_negate","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_negate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Negate — wbt_negate","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_new_raster_from_base.html","id":null,"dir":"Reference","previous_headings":"","what":"New raster from base — wbt_new_raster_from_base","title":"New raster from base — wbt_new_raster_from_base","text":"Creates new raster using base image.","code":""},{"path":"/reference/wbt_new_raster_from_base.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"New raster from base — wbt_new_raster_from_base","text":"","code":"wbt_new_raster_from_base(   base,   output,   value = \"nodata\",   data_type = \"float\",   cell_size = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_new_raster_from_base.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"New raster from base — wbt_new_raster_from_base","text":"base Input base raster file. output Output raster file. value Constant value fill raster ; either 'nodata' numeric value. data_type Output raster data type; options include 'double' (64-bit), 'float' (32-bit), 'integer' (signed 16-bit) (default 'float'). cell_size Optionally specified cell size output raster. used base raster specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_new_raster_from_base.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"New raster from base — wbt_new_raster_from_base","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_normal_vectors.html","id":null,"dir":"Reference","previous_headings":"","what":"Normal vectors — wbt_normal_vectors","title":"Normal vectors — wbt_normal_vectors","text":"Calculates normal vectors points within LAS file stores data (XYZ vector components) RGB field.","code":""},{"path":"/reference/wbt_normal_vectors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Normal vectors — wbt_normal_vectors","text":"","code":"wbt_normal_vectors(   input,   output,   radius = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_normal_vectors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Normal vectors — wbt_normal_vectors","text":"input Input LiDAR file. output Output LiDAR file. radius Search Radius. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_normal_vectors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Normal vectors — wbt_normal_vectors","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_normalize_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Normalize lidar — wbt_normalize_lidar","title":"Normalize lidar — wbt_normalize_lidar","text":"Normalizes LiDAR point cloud.","code":""},{"path":"/reference/wbt_normalize_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Normalize lidar — wbt_normalize_lidar","text":"","code":"wbt_normalize_lidar(   input,   output,   dtm,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_normalize_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Normalize lidar — wbt_normalize_lidar","text":"input Name input LiDAR file. output Name output LiDAR file. dtm Name input digital terrain model (DTM) raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_normalize_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Normalize lidar — wbt_normalize_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_normalized_difference_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Normalized difference index — wbt_normalized_difference_index","title":"Normalized difference index — wbt_normalized_difference_index","text":"Calculate normalized-difference index (NDI) two bands multispectral image data.","code":""},{"path":"/reference/wbt_normalized_difference_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Normalized difference index — wbt_normalized_difference_index","text":"","code":"wbt_normalized_difference_index(   input1,   input2,   output,   clip = 0,   correction = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_normalized_difference_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Normalized difference index — wbt_normalized_difference_index","text":"input1 Input image 1 (e.g. near-infrared band). input2 Input image 2 (e.g. red band). output Output raster file. clip Optional amount clip distribution tails , percent. correction Optional adjustment value (e.g. 1, 0.16 optimal soil adjusted vegetation index, OSAVI). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_normalized_difference_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Normalized difference index — wbt_normalized_difference_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_not.html","id":null,"dir":"Reference","previous_headings":"","what":"Not — wbt_not","title":"Not — wbt_not","text":"Performs logical operator two Boolean raster images.","code":""},{"path":"/reference/wbt_not.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Not — wbt_not","text":"","code":"wbt_not(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_not.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Not — wbt_not","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_not.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Not — wbt_not","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_not_equal_to.html","id":null,"dir":"Reference","previous_headings":"","what":"Not equal to — wbt_not_equal_to","title":"Not equal to — wbt_not_equal_to","text":"Performs -equal-comparison operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_not_equal_to.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Not equal to — wbt_not_equal_to","text":"","code":"wbt_not_equal_to(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_not_equal_to.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Not equal to — wbt_not_equal_to","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_not_equal_to.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Not equal to — wbt_not_equal_to","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_num_downslope_neighbours.html","id":null,"dir":"Reference","previous_headings":"","what":"Num downslope neighbours — wbt_num_downslope_neighbours","title":"Num downslope neighbours — wbt_num_downslope_neighbours","text":"Calculates number downslope neighbours grid cell DEM.","code":""},{"path":"/reference/wbt_num_downslope_neighbours.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Num downslope neighbours — wbt_num_downslope_neighbours","text":"","code":"wbt_num_downslope_neighbours(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_num_downslope_neighbours.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Num downslope neighbours — wbt_num_downslope_neighbours","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_num_downslope_neighbours.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Num downslope neighbours — wbt_num_downslope_neighbours","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_num_inflowing_neighbours.html","id":null,"dir":"Reference","previous_headings":"","what":"Num inflowing neighbours — wbt_num_inflowing_neighbours","title":"Num inflowing neighbours — wbt_num_inflowing_neighbours","text":"Computes number inflowing neighbours cell input DEM based D8 algorithm.","code":""},{"path":"/reference/wbt_num_inflowing_neighbours.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Num inflowing neighbours — wbt_num_inflowing_neighbours","text":"","code":"wbt_num_inflowing_neighbours(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_num_inflowing_neighbours.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Num inflowing neighbours — wbt_num_inflowing_neighbours","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_num_inflowing_neighbours.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Num inflowing neighbours — wbt_num_inflowing_neighbours","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_num_upslope_neighbours.html","id":null,"dir":"Reference","previous_headings":"","what":"Num upslope neighbours — wbt_num_upslope_neighbours","title":"Num upslope neighbours — wbt_num_upslope_neighbours","text":"Calculates number upslope neighbours grid cell DEM.","code":""},{"path":"/reference/wbt_num_upslope_neighbours.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Num upslope neighbours — wbt_num_upslope_neighbours","text":"","code":"wbt_num_upslope_neighbours(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_num_upslope_neighbours.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Num upslope neighbours — wbt_num_upslope_neighbours","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_num_upslope_neighbours.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Num upslope neighbours — wbt_num_upslope_neighbours","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_olympic_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Olympic filter — wbt_olympic_filter","title":"Olympic filter — wbt_olympic_filter","text":"Performs olympic smoothing filter image.","code":""},{"path":"/reference/wbt_olympic_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Olympic filter — wbt_olympic_filter","text":"","code":"wbt_olympic_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_olympic_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Olympic filter — wbt_olympic_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_olympic_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Olympic filter — wbt_olympic_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_opening.html","id":null,"dir":"Reference","previous_headings":"","what":"Opening — wbt_opening","title":"Opening — wbt_opening","text":"opening mathematical morphology operation involving dilation (max filter) erosion (min filter) set.","code":""},{"path":"/reference/wbt_opening.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Opening — wbt_opening","text":"","code":"wbt_opening(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_opening.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Opening — wbt_opening","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_opening.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Opening — wbt_opening","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_openness.html","id":null,"dir":"Reference","previous_headings":"","what":"Openness — wbt_openness","title":"Openness — wbt_openness","text":"tool calculates topographic openness index input DEM.","code":""},{"path":"/reference/wbt_openness.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Openness — wbt_openness","text":"","code":"wbt_openness(   input,   pos_output,   neg_output,   dist = 20,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_openness.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Openness — wbt_openness","text":"input Name input raster DEM file. pos_output Name positive openness output raster file. neg_output Name negative openness output raster file. dist Search distance, grid cells. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_openness.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Openness — wbt_openness","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_or.html","id":null,"dir":"Reference","previous_headings":"","what":"Or — wbt_or","title":"Or — wbt_or","text":"Performs logical operator two Boolean raster images.","code":""},{"path":"/reference/wbt_or.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Or — wbt_or","text":"","code":"wbt_or(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_or.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Or — wbt_or","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_or.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Or — wbt_or","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_paired_sample_t_test.html","id":null,"dir":"Reference","previous_headings":"","what":"Paired sample t test — wbt_paired_sample_t_test","title":"Paired sample t test — wbt_paired_sample_t_test","text":"Performs 2-sample K-S test significant differences two input rasters.","code":""},{"path":"/reference/wbt_paired_sample_t_test.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Paired sample t test — wbt_paired_sample_t_test","text":"","code":"wbt_paired_sample_t_test(   input1,   input2,   output,   num_samples = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_paired_sample_t_test.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Paired sample t test — wbt_paired_sample_t_test","text":"input1 First input raster file. input2 Second input raster file. output Output HTML file. num_samples Number samples. Leave blank use whole image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_paired_sample_t_test.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Paired sample t test — wbt_paired_sample_t_test","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_panchromatic_sharpening.html","id":null,"dir":"Reference","previous_headings":"","what":"Panchromatic sharpening — wbt_panchromatic_sharpening","title":"Panchromatic sharpening — wbt_panchromatic_sharpening","text":"Increases spatial resolution image data combining multispectral bands panchromatic data.","code":""},{"path":"/reference/wbt_panchromatic_sharpening.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Panchromatic sharpening — wbt_panchromatic_sharpening","text":"","code":"wbt_panchromatic_sharpening(   pan,   output,   red = NULL,   green = NULL,   blue = NULL,   composite = NULL,   method = \"brovey\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_panchromatic_sharpening.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Panchromatic sharpening — wbt_panchromatic_sharpening","text":"pan Input panchromatic band file. output Output colour composite file. red Input red band image file. Optionally specified colour-composite specified. green Input green band image file. Optionally specified colour-composite specified. blue Input blue band image file. Optionally specified colour-composite specified. composite Input colour-composite image file. used individual bands specified. method Options include 'brovey' (default) 'ihs'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_panchromatic_sharpening.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Panchromatic sharpening — wbt_panchromatic_sharpening","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_parallelepiped_classification.html","id":null,"dir":"Reference","previous_headings":"","what":"Parallelepiped classification — wbt_parallelepiped_classification","title":"Parallelepiped classification — wbt_parallelepiped_classification","text":"Performs supervised parallelepiped classification using training site polygons multi-spectral images.","code":""},{"path":"/reference/wbt_parallelepiped_classification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parallelepiped classification — wbt_parallelepiped_classification","text":"","code":"wbt_parallelepiped_classification(   inputs,   polys,   field,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_parallelepiped_classification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parallelepiped classification — wbt_parallelepiped_classification","text":"inputs Name input band images. polys Name input training site polygons shapefile. field Name attribute containing class name data. output Name output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_parallelepiped_classification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parallelepiped classification — wbt_parallelepiped_classification","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_patch_orientation.html","id":null,"dir":"Reference","previous_headings":"","what":"Patch orientation — wbt_patch_orientation","title":"Patch orientation — wbt_patch_orientation","text":"Calculates orientation vector polygons.","code":""},{"path":"/reference/wbt_patch_orientation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Patch orientation — wbt_patch_orientation","text":"","code":"wbt_patch_orientation(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_patch_orientation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Patch orientation — wbt_patch_orientation","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_patch_orientation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Patch orientation — wbt_patch_orientation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_pennock_landform_class.html","id":null,"dir":"Reference","previous_headings":"","what":"Pennock landform class — wbt_pennock_landform_class","title":"Pennock landform class — wbt_pennock_landform_class","text":"Classifies hillslope zones based slope, profile curvature, plan curvature.","code":""},{"path":"/reference/wbt_pennock_landform_class.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pennock landform class — wbt_pennock_landform_class","text":"","code":"wbt_pennock_landform_class(   dem,   output,   slope = 3,   prof = 0.1,   plan = 0,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_pennock_landform_class.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pennock landform class — wbt_pennock_landform_class","text":"dem Input raster DEM file. output Output raster file. slope Slope threshold value, degrees (default 3.0). prof Profile curvature threshold value (default 0.1). plan Plan curvature threshold value (default 0.0). zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_pennock_landform_class.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pennock landform class — wbt_pennock_landform_class","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percent_elev_range.html","id":null,"dir":"Reference","previous_headings":"","what":"Percent elev range — wbt_percent_elev_range","title":"Percent elev range — wbt_percent_elev_range","text":"Calculates percent elevation range DEM.","code":""},{"path":"/reference/wbt_percent_elev_range.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percent elev range — wbt_percent_elev_range","text":"","code":"wbt_percent_elev_range(   dem,   output,   filterx = 3,   filtery = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percent_elev_range.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percent elev range — wbt_percent_elev_range","text":"dem Input raster DEM file. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percent_elev_range.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percent elev range — wbt_percent_elev_range","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percent_equal_to.html","id":null,"dir":"Reference","previous_headings":"","what":"Percent equal to — wbt_percent_equal_to","title":"Percent equal to — wbt_percent_equal_to","text":"Calculates percentage raster stack cell values equal input cell--cell basis.","code":""},{"path":"/reference/wbt_percent_equal_to.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percent equal to — wbt_percent_equal_to","text":"","code":"wbt_percent_equal_to(   inputs,   comparison,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percent_equal_to.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percent equal to — wbt_percent_equal_to","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. comparison Input comparison raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percent_equal_to.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percent equal to — wbt_percent_equal_to","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percent_greater_than.html","id":null,"dir":"Reference","previous_headings":"","what":"Percent greater than — wbt_percent_greater_than","title":"Percent greater than — wbt_percent_greater_than","text":"Calculates percentage raster stack cell values greater input cell--cell basis.","code":""},{"path":"/reference/wbt_percent_greater_than.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percent greater than — wbt_percent_greater_than","text":"","code":"wbt_percent_greater_than(   inputs,   comparison,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percent_greater_than.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percent greater than — wbt_percent_greater_than","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. comparison Input comparison raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percent_greater_than.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percent greater than — wbt_percent_greater_than","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percent_less_than.html","id":null,"dir":"Reference","previous_headings":"","what":"Percent less than — wbt_percent_less_than","title":"Percent less than — wbt_percent_less_than","text":"Calculates percentage raster stack cell values less input cell--cell basis.","code":""},{"path":"/reference/wbt_percent_less_than.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percent less than — wbt_percent_less_than","text":"","code":"wbt_percent_less_than(   inputs,   comparison,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percent_less_than.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percent less than — wbt_percent_less_than","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. comparison Input comparison raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percent_less_than.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percent less than — wbt_percent_less_than","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percentage_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Percentage contrast stretch — wbt_percentage_contrast_stretch","title":"Percentage contrast stretch — wbt_percentage_contrast_stretch","text":"Performs percentage linear contrast stretch input images.","code":""},{"path":"/reference/wbt_percentage_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percentage contrast stretch — wbt_percentage_contrast_stretch","text":"","code":"wbt_percentage_contrast_stretch(   input,   output,   clip = 1,   tail = \"both\",   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percentage_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percentage contrast stretch — wbt_percentage_contrast_stretch","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. clip Optional amount clip distribution tails , percent. tail Specified tails clip; options include 'upper', 'lower', '' (default ''). num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percentage_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percentage contrast stretch — wbt_percentage_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_percentile_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Percentile filter — wbt_percentile_filter","title":"Percentile filter — wbt_percentile_filter","text":"Performs percentile filter input image.","code":""},{"path":"/reference/wbt_percentile_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Percentile filter — wbt_percentile_filter","text":"","code":"wbt_percentile_filter(   input,   output,   filterx = 11,   filtery = 11,   sig_digits = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_percentile_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Percentile filter — wbt_percentile_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. sig_digits Number significant digits. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_percentile_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Percentile filter — wbt_percentile_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_perimeter_area_ratio.html","id":null,"dir":"Reference","previous_headings":"","what":"Perimeter area ratio — wbt_perimeter_area_ratio","title":"Perimeter area ratio — wbt_perimeter_area_ratio","text":"Calculates perimeter-area ratio vector polygons.","code":""},{"path":"/reference/wbt_perimeter_area_ratio.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Perimeter area ratio — wbt_perimeter_area_ratio","text":"","code":"wbt_perimeter_area_ratio(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_perimeter_area_ratio.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Perimeter area ratio — wbt_perimeter_area_ratio","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_perimeter_area_ratio.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Perimeter area ratio — wbt_perimeter_area_ratio","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_phi_coefficient.html","id":null,"dir":"Reference","previous_headings":"","what":"Phi coefficient — wbt_phi_coefficient","title":"Phi coefficient — wbt_phi_coefficient","text":"tool performs binary classification accuracy assessment.","code":""},{"path":"/reference/wbt_phi_coefficient.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Phi coefficient — wbt_phi_coefficient","text":"","code":"wbt_phi_coefficient(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_phi_coefficient.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Phi coefficient — wbt_phi_coefficient","text":"input1 Name first input raster image file. input2 Name second input raster image file. output Name output HTML file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_phi_coefficient.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Phi coefficient — wbt_phi_coefficient","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_pick_from_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Pick from list — wbt_pick_from_list","title":"Pick from list — wbt_pick_from_list","text":"Outputs value raster stack specified position raster.","code":""},{"path":"/reference/wbt_pick_from_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pick from list — wbt_pick_from_list","text":"","code":"wbt_pick_from_list(   inputs,   pos_input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_pick_from_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pick from list — wbt_pick_from_list","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. pos_input Input position raster file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_pick_from_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pick from list — wbt_pick_from_list","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_piecewise_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Piecewise contrast stretch — wbt_piecewise_contrast_stretch","title":"Piecewise contrast stretch — wbt_piecewise_contrast_stretch","text":"Performs piecewise contrast stretch input image.","code":""},{"path":"/reference/wbt_piecewise_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Piecewise contrast stretch — wbt_piecewise_contrast_stretch","text":"","code":"wbt_piecewise_contrast_stretch(   input,   output,   FUN = \"\",   greytones = 1024,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_piecewise_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Piecewise contrast stretch — wbt_piecewise_contrast_stretch","text":"input Name input raster image file. output Name output raster image file. FUN Piecewise break-points e.g. '(50, 0.1); (150, 0.8); (255; 1.0). greytones Number greytones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_piecewise_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Piecewise contrast stretch — wbt_piecewise_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_plan_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Plan curvature — wbt_plan_curvature","title":"Plan curvature — wbt_plan_curvature","text":"Calculates plan (contour) curvature raster input DEM.","code":""},{"path":"/reference/wbt_plan_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plan curvature — wbt_plan_curvature","text":"","code":"wbt_plan_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_plan_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plan curvature — wbt_plan_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_plan_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Plan curvature — wbt_plan_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygon_area.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygon area — wbt_polygon_area","title":"Polygon area — wbt_polygon_area","text":"Calculates area vector polygons.","code":""},{"path":"/reference/wbt_polygon_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygon area — wbt_polygon_area","text":"","code":"wbt_polygon_area(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygon_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygon area — wbt_polygon_area","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygon_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygon area — wbt_polygon_area","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygon_long_axis.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygon long axis — wbt_polygon_long_axis","title":"Polygon long axis — wbt_polygon_long_axis","text":"Used map long axis polygon features.","code":""},{"path":"/reference/wbt_polygon_long_axis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygon long axis — wbt_polygon_long_axis","text":"","code":"wbt_polygon_long_axis(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygon_long_axis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygon long axis — wbt_polygon_long_axis","text":"input Input vector polygons file. output Output vector polyline file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygon_long_axis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygon long axis — wbt_polygon_long_axis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygon_perimeter.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygon perimeter — wbt_polygon_perimeter","title":"Polygon perimeter — wbt_polygon_perimeter","text":"Calculates perimeter vector polygons.","code":""},{"path":"/reference/wbt_polygon_perimeter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygon perimeter — wbt_polygon_perimeter","text":"","code":"wbt_polygon_perimeter(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygon_perimeter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygon perimeter — wbt_polygon_perimeter","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygon_perimeter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygon perimeter — wbt_polygon_perimeter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygon_short_axis.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygon short axis — wbt_polygon_short_axis","title":"Polygon short axis — wbt_polygon_short_axis","text":"Used map short axis polygon features.","code":""},{"path":"/reference/wbt_polygon_short_axis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygon short axis — wbt_polygon_short_axis","text":"","code":"wbt_polygon_short_axis(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygon_short_axis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygon short axis — wbt_polygon_short_axis","text":"input Input vector polygons file. output Output vector polyline file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygon_short_axis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygon short axis — wbt_polygon_short_axis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygonize.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygonize — wbt_polygonize","title":"Polygonize — wbt_polygonize","text":"Creates polygon layer two intersecting line features contained one input vector line files.","code":""},{"path":"/reference/wbt_polygonize.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygonize — wbt_polygonize","text":"","code":"wbt_polygonize(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygonize.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygonize — wbt_polygonize","text":"inputs Input vector polyline file. output Output vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygonize.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygonize — wbt_polygonize","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_polygons_to_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Polygons to lines — wbt_polygons_to_lines","title":"Polygons to lines — wbt_polygons_to_lines","text":"Converts vector polygons polylines.","code":""},{"path":"/reference/wbt_polygons_to_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Polygons to lines — wbt_polygons_to_lines","text":"","code":"wbt_polygons_to_lines(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_polygons_to_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Polygons to lines — wbt_polygons_to_lines","text":"input Input vector polygon file. output Output vector lines file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_polygons_to_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Polygons to lines — wbt_polygons_to_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_power.html","id":null,"dir":"Reference","previous_headings":"","what":"Power — wbt_power","title":"Power — wbt_power","text":"Raises values grid cells one rasters, constant value, values another raster constant value.","code":""},{"path":"/reference/wbt_power.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Power — wbt_power","text":"","code":"wbt_power(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_power.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Power — wbt_power","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_power.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Power — wbt_power","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_prewitt_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Prewitt filter — wbt_prewitt_filter","title":"Prewitt filter — wbt_prewitt_filter","text":"Performs Prewitt edge-detection filter image.","code":""},{"path":"/reference/wbt_prewitt_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Prewitt filter — wbt_prewitt_filter","text":"","code":"wbt_prewitt_filter(   input,   output,   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_prewitt_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Prewitt filter — wbt_prewitt_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_prewitt_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Prewitt filter — wbt_prewitt_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_principal_component_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Principal component analysis — wbt_principal_component_analysis","title":"Principal component analysis — wbt_principal_component_analysis","text":"Performs principal component analysis (PCA) multi-spectral dataset.","code":""},{"path":"/reference/wbt_principal_component_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Principal component analysis — wbt_principal_component_analysis","text":"","code":"wbt_principal_component_analysis(   inputs,   output,   num_comp = NULL,   standardized = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_principal_component_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Principal component analysis — wbt_principal_component_analysis","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output HTML report file. num_comp Number component images output; <= num. input images. standardized Perform standardized PCA?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_principal_component_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Principal component analysis — wbt_principal_component_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_print_geo_tiff_tags.html","id":null,"dir":"Reference","previous_headings":"","what":"Print geo tiff tags — wbt_print_geo_tiff_tags","title":"Print geo tiff tags — wbt_print_geo_tiff_tags","text":"Prints tags within GeoTIFF.","code":""},{"path":"/reference/wbt_print_geo_tiff_tags.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print geo tiff tags — wbt_print_geo_tiff_tags","text":"","code":"wbt_print_geo_tiff_tags(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_print_geo_tiff_tags.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print geo tiff tags — wbt_print_geo_tiff_tags","text":"input Input GeoTIFF file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_print_geo_tiff_tags.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Print geo tiff tags — wbt_print_geo_tiff_tags","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_profile.html","id":null,"dir":"Reference","previous_headings":"","what":"Profile — wbt_profile","title":"Profile — wbt_profile","text":"Plots profiles digital surface models.","code":""},{"path":"/reference/wbt_profile.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Profile — wbt_profile","text":"","code":"wbt_profile(   lines,   surface,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_profile.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Profile — wbt_profile","text":"lines Input vector line file. surface Input raster surface file. output Output HTML file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_profile.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Profile — wbt_profile","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_profile_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Profile curvature — wbt_profile_curvature","title":"Profile curvature — wbt_profile_curvature","text":"Calculates profile curvature raster input DEM.","code":""},{"path":"/reference/wbt_profile_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Profile curvature — wbt_profile_curvature","text":"","code":"wbt_profile_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_profile_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Profile curvature — wbt_profile_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_profile_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Profile curvature — wbt_profile_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_qin_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Qin flow accumulation — wbt_qin_flow_accumulation","title":"Qin flow accumulation — wbt_qin_flow_accumulation","text":"Calculates Qin et al. (2007) flow accumulation.","code":""},{"path":"/reference/wbt_qin_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Qin flow accumulation — wbt_qin_flow_accumulation","text":"","code":"wbt_qin_flow_accumulation(   dem,   output,   out_type = \"specific contributing area\",   exponent = 10,   max_slope = 45,   threshold = NULL,   log = FALSE,   clip = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_qin_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Qin flow accumulation — wbt_qin_flow_accumulation","text":"dem Name input DEM raster file; must depressionless. output Name output raster file. out_type Output type; one 'cells', 'specific contributing area' (default), 'catchment area'. exponent Optional upper-bound exponent parameter; default 10.0. max_slope Optional upper-bound slope parameter, degrees (0-90); default 45.0. threshold Optional convergence threshold parameter, grid cells; default infinity. log Log-transform output values?. clip Optional flag request clipping display max 1 percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_qin_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Qin flow accumulation — wbt_qin_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_quantiles.html","id":null,"dir":"Reference","previous_headings":"","what":"Quantiles — wbt_quantiles","title":"Quantiles — wbt_quantiles","text":"Transforms raster values quantiles.","code":""},{"path":"/reference/wbt_quantiles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Quantiles — wbt_quantiles","text":"","code":"wbt_quantiles(   input,   output,   num_quantiles = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_quantiles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Quantiles — wbt_quantiles","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. num_quantiles Number quantiles. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_quantiles.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Quantiles — wbt_quantiles","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_quinn_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Quinn flow accumulation — wbt_quinn_flow_accumulation","title":"Quinn flow accumulation — wbt_quinn_flow_accumulation","text":"Calculates Quinn et al. (1995) flow accumulation.","code":""},{"path":"/reference/wbt_quinn_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Quinn flow accumulation — wbt_quinn_flow_accumulation","text":"","code":"wbt_quinn_flow_accumulation(   dem,   output,   out_type = \"specific contributing area\",   exponent = 1,   threshold = NULL,   log = FALSE,   clip = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_quinn_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Quinn flow accumulation — wbt_quinn_flow_accumulation","text":"dem Name input DEM raster file; must depressionless. output Name output raster file. out_type Output type; one 'cells', 'specific contributing area' (default), 'catchment area'. exponent Optional exponent parameter; default 1.0. threshold Optional convergence threshold parameter, grid cells; default infinity. log Log-transform output values?. clip Optional flag request clipping display max 1 percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_quinn_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Quinn flow accumulation — wbt_quinn_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_radial_basis_function_interpolation.html","id":null,"dir":"Reference","previous_headings":"","what":"Radial basis function interpolation — wbt_radial_basis_function_interpolation","title":"Radial basis function interpolation — wbt_radial_basis_function_interpolation","text":"Interpolates vector points raster surface using radial basis function scheme.","code":""},{"path":"/reference/wbt_radial_basis_function_interpolation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Radial basis function interpolation — wbt_radial_basis_function_interpolation","text":"","code":"wbt_radial_basis_function_interpolation(   input,   field,   output,   use_z = FALSE,   radius = NULL,   min_points = NULL,   func_type = \"ThinPlateSpline\",   poly_order = \"none\",   weight = 0.1,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_radial_basis_function_interpolation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Radial basis function interpolation — wbt_radial_basis_function_interpolation","text":"input Input vector points file. field Input field name attribute table. output Output raster file. use_z Use z-coordinate instead field?. radius Search Radius (map units). min_points Minimum number points. func_type Radial basis function type; options 'ThinPlateSpline' (default), 'PolyHarmonic', 'Gaussian', 'MultiQuadric', 'InverseMultiQuadric'. poly_order Polynomial order; options 'none' (default), 'constant', 'affine'. weight Weight parameter used basis function. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_radial_basis_function_interpolation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Radial basis function interpolation — wbt_radial_basis_function_interpolation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_radius_of_gyration.html","id":null,"dir":"Reference","previous_headings":"","what":"Radius of gyration — wbt_radius_of_gyration","title":"Radius of gyration — wbt_radius_of_gyration","text":"Calculates distance cells polygon's centroid.","code":""},{"path":"/reference/wbt_radius_of_gyration.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Radius of gyration — wbt_radius_of_gyration","text":"","code":"wbt_radius_of_gyration(   input,   output,   text_output = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_radius_of_gyration.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Radius of gyration — wbt_radius_of_gyration","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. text_output Optional text output. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_radius_of_gyration.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Radius of gyration — wbt_radius_of_gyration","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raise_walls.html","id":null,"dir":"Reference","previous_headings":"","what":"Raise walls — wbt_raise_walls","title":"Raise walls — wbt_raise_walls","text":"Raises walls DEM along line around polygon, e.g. watershed.","code":""},{"path":"/reference/wbt_raise_walls.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raise walls — wbt_raise_walls","text":"","code":"wbt_raise_walls(   input,   dem,   output,   breach = NULL,   height = 100,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raise_walls.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raise walls — wbt_raise_walls","text":"input Input vector lines polygons file. dem Input raster DEM file. output Output raster file. breach Optional input vector breach lines. height Wall height. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raise_walls.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raise walls — wbt_raise_walls","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_random_field.html","id":null,"dir":"Reference","previous_headings":"","what":"Random field — wbt_random_field","title":"Random field — wbt_random_field","text":"Creates image containing random values.","code":""},{"path":"/reference/wbt_random_field.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Random field — wbt_random_field","text":"","code":"wbt_random_field(   base,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_random_field.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Random field — wbt_random_field","text":"base Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_random_field.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Random field — wbt_random_field","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_random_forest_classification.html","id":null,"dir":"Reference","previous_headings":"","what":"Random forest classification — wbt_random_forest_classification","title":"Random forest classification — wbt_random_forest_classification","text":"Performs supervised random forest classification using training site polygons/points predictor rasters.","code":""},{"path":"/reference/wbt_random_forest_classification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Random forest classification — wbt_random_forest_classification","text":"","code":"wbt_random_forest_classification(   inputs,   training,   field,   output = NULL,   split_criterion = \"Gini\",   n_trees = 500,   min_samples_leaf = 1,   min_samples_split = 2,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_random_forest_classification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Random forest classification — wbt_random_forest_classification","text":"inputs Names input predictor rasters. training Name input training site polygons/points shapefile. field Name attribute containing class data. output Name output raster file. split_criterion Split criterion use building tree. Options include 'Gini', 'Entropy', 'ClassificationError'. n_trees number trees forest. min_samples_leaf minimum number samples required leaf node. min_samples_split minimum number samples required split internal node. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_random_forest_classification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Random forest classification — wbt_random_forest_classification","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_random_forest_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Random forest regression — wbt_random_forest_regression","title":"Random forest regression — wbt_random_forest_regression","text":"Performs random forest regression analysis using training site data predictor rasters.","code":""},{"path":"/reference/wbt_random_forest_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Random forest regression — wbt_random_forest_regression","text":"","code":"wbt_random_forest_regression(   inputs,   training,   field,   output = NULL,   n_trees = 100,   min_samples_leaf = 1,   min_samples_split = 2,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_random_forest_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Random forest regression — wbt_random_forest_regression","text":"inputs Names input predictor rasters. training Name input training site points shapefile. field Name attribute containing response variable name data. output Name output raster file. parameter optional. unspecified, tool build model. specified, tool use built model predictor rasters perform spatial prediction. n_trees number trees forest. min_samples_leaf minimum number samples required leaf node. min_samples_split minimum number samples required split internal node. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_random_forest_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Random forest regression — wbt_random_forest_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_random_sample.html","id":null,"dir":"Reference","previous_headings":"","what":"Random sample — wbt_random_sample","title":"Random sample — wbt_random_sample","text":"Creates image containing randomly located sample grid cells unique IDs.","code":""},{"path":"/reference/wbt_random_sample.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Random sample — wbt_random_sample","text":"","code":"wbt_random_sample(   base,   output,   num_samples = 1000,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_random_sample.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Random sample — wbt_random_sample","text":"base Input raster file path. See wbt_file_path() details. output Output raster file. num_samples Number samples. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_random_sample.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Random sample — wbt_random_sample","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_range_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Range filter — wbt_range_filter","title":"Range filter — wbt_range_filter","text":"Assigns cell output grid range values moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_range_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Range filter — wbt_range_filter","text":"","code":"wbt_range_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_range_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Range filter — wbt_range_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_range_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Range filter — wbt_range_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_area.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster area — wbt_raster_area","title":"Raster area — wbt_raster_area","text":"Calculates area polygons classes within raster image.","code":""},{"path":"/reference/wbt_raster_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster area — wbt_raster_area","text":"","code":"wbt_raster_area(   input,   output = NULL,   out_text = FALSE,   units = \"grid cells\",   zero_back = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster area — wbt_raster_area","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. out_text like output polygon areas text?. units Area units; options include 'grid cells' 'map units'. zero_back Flag indicating whether zero values treated background. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster area — wbt_raster_area","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_calculator.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster calculator — wbt_raster_calculator","title":"Raster calculator — wbt_raster_calculator","text":"Performs complex mathematical operations one input raster images cell--cell basis.","code":""},{"path":"/reference/wbt_raster_calculator.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster calculator — wbt_raster_calculator","text":"","code":"wbt_raster_calculator(   output,   statement = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_calculator.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster calculator — wbt_raster_calculator","text":"output Name output raster file. statement Statement e.g. cos(\"raster1\") * 35.0 + \"raster2\". statement must valid Rust statement. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_calculator.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster calculator — wbt_raster_calculator","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_cell_assignment.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster cell assignment — wbt_raster_cell_assignment","title":"Raster cell assignment — wbt_raster_cell_assignment","text":"Assign row column number cells.","code":""},{"path":"/reference/wbt_raster_cell_assignment.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster cell assignment — wbt_raster_cell_assignment","text":"","code":"wbt_raster_cell_assignment(   input,   output,   assign = \"column\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_cell_assignment.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster cell assignment — wbt_raster_cell_assignment","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. assign variable like assign grid cells? Options include 'column', 'row', 'x', 'y'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_cell_assignment.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster cell assignment — wbt_raster_cell_assignment","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_histogram.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster histogram — wbt_raster_histogram","title":"Raster histogram — wbt_raster_histogram","text":"Creates histogram raster values.","code":""},{"path":"/reference/wbt_raster_histogram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster histogram — wbt_raster_histogram","text":"","code":"wbt_raster_histogram(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_histogram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster histogram — wbt_raster_histogram","text":"input Input raster file path. See wbt_file_path() details. output Output HTML file (default name based input file unspecified). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_histogram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster histogram — wbt_raster_histogram","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_perimeter.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster perimeter — wbt_raster_perimeter","title":"Raster perimeter — wbt_raster_perimeter","text":"Calculates perimeters polygons classes within raster image.","code":""},{"path":"/reference/wbt_raster_perimeter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster perimeter — wbt_raster_perimeter","text":"","code":"wbt_raster_perimeter(   input,   output = NULL,   out_text = FALSE,   units = \"grid cells\",   zero_back = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_perimeter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster perimeter — wbt_raster_perimeter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. out_text like output polygon areas text?. units Area units; options include 'grid cells' 'map units'. zero_back Flag indicating whether zero values treated background. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_perimeter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster perimeter — wbt_raster_perimeter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_streams_to_vector.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster streams to vector — wbt_raster_streams_to_vector","title":"Raster streams to vector — wbt_raster_streams_to_vector","text":"Converts raster stream file vector file.","code":""},{"path":"/reference/wbt_raster_streams_to_vector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster streams to vector — wbt_raster_streams_to_vector","text":"","code":"wbt_raster_streams_to_vector(   streams,   d8_pntr,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_streams_to_vector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster streams to vector — wbt_raster_streams_to_vector","text":"streams Input raster streams file. d8_pntr Input raster D8 pointer file. output Output vector file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_streams_to_vector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster streams to vector — wbt_raster_streams_to_vector","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_summary_stats.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster summary stats — wbt_raster_summary_stats","title":"Raster summary stats — wbt_raster_summary_stats","text":"Measures rasters min, max, average, standard deviation, num. non-nodata cells, total.","code":""},{"path":"/reference/wbt_raster_summary_stats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster summary stats — wbt_raster_summary_stats","text":"","code":"wbt_raster_summary_stats(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_summary_stats.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster summary stats — wbt_raster_summary_stats","text":"input Input raster file path. See wbt_file_path() details. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_summary_stats.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster summary stats — wbt_raster_summary_stats","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_to_vector_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster to vector lines — wbt_raster_to_vector_lines","title":"Raster to vector lines — wbt_raster_to_vector_lines","text":"Converts raster lines features vector POLYLINE shapetype.","code":""},{"path":"/reference/wbt_raster_to_vector_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster to vector lines — wbt_raster_to_vector_lines","text":"","code":"wbt_raster_to_vector_lines(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_to_vector_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster to vector lines — wbt_raster_to_vector_lines","text":"input Input raster lines file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_to_vector_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster to vector lines — wbt_raster_to_vector_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_to_vector_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster to vector points — wbt_raster_to_vector_points","title":"Raster to vector points — wbt_raster_to_vector_points","text":"Converts raster dataset vector POINT shapetype.","code":""},{"path":"/reference/wbt_raster_to_vector_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster to vector points — wbt_raster_to_vector_points","text":"","code":"wbt_raster_to_vector_points(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_to_vector_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster to vector points — wbt_raster_to_vector_points","text":"input Input raster file path. See wbt_file_path() details. output Output vector points file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_to_vector_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster to vector points — wbt_raster_to_vector_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_raster_to_vector_polygons.html","id":null,"dir":"Reference","previous_headings":"","what":"Raster to vector polygons — wbt_raster_to_vector_polygons","title":"Raster to vector polygons — wbt_raster_to_vector_polygons","text":"Converts raster dataset vector POLYGON shapetype.","code":""},{"path":"/reference/wbt_raster_to_vector_polygons.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Raster to vector polygons — wbt_raster_to_vector_polygons","text":"","code":"wbt_raster_to_vector_polygons(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_raster_to_vector_polygons.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Raster to vector polygons — wbt_raster_to_vector_polygons","text":"input Input raster file path. See wbt_file_path() details. output Output vector polygons file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_raster_to_vector_polygons.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Raster to vector polygons — wbt_raster_to_vector_polygons","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rasterize_streams.html","id":null,"dir":"Reference","previous_headings":"","what":"Rasterize streams — wbt_rasterize_streams","title":"Rasterize streams — wbt_rasterize_streams","text":"Rasterizes vector streams based Lindsay (2016) method.","code":""},{"path":"/reference/wbt_rasterize_streams.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rasterize streams — wbt_rasterize_streams","text":"","code":"wbt_rasterize_streams(   streams,   base,   output,   nodata = TRUE,   feature_id = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rasterize_streams.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rasterize streams — wbt_rasterize_streams","text":"streams Input vector streams file. base Input base raster file. output Output raster file. nodata Use NoData value background?. feature_id Use feature number output value?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rasterize_streams.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rasterize streams — wbt_rasterize_streams","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reciprocal.html","id":null,"dir":"Reference","previous_headings":"","what":"Reciprocal — wbt_reciprocal","title":"Reciprocal — wbt_reciprocal","text":"Returns reciprocal (.e. 1 / z) values raster.","code":""},{"path":"/reference/wbt_reciprocal.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reciprocal — wbt_reciprocal","text":"","code":"wbt_reciprocal(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reciprocal.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reciprocal — wbt_reciprocal","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reciprocal.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reciprocal — wbt_reciprocal","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reclass.html","id":null,"dir":"Reference","previous_headings":"","what":"Reclass — wbt_reclass","title":"Reclass — wbt_reclass","text":"Reclassifies values raster image.","code":""},{"path":"/reference/wbt_reclass.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reclass — wbt_reclass","text":"","code":"wbt_reclass(   input,   output,   reclass_vals,   assign_mode = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reclass.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reclass — wbt_reclass","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. reclass_vals Reclassification triplet values (new value; value; less ), e.g. '0.0;0.0;1.0;1.0;1.0;2.0'. assign_mode Optional Boolean flag indicating whether operate assign mode, reclass_vals values interpreted new value; old value pairs. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reclass.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reclass — wbt_reclass","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reclass_equal_interval.html","id":null,"dir":"Reference","previous_headings":"","what":"Reclass equal interval — wbt_reclass_equal_interval","title":"Reclass equal interval — wbt_reclass_equal_interval","text":"Reclassifies values raster image based equal-ranges.","code":""},{"path":"/reference/wbt_reclass_equal_interval.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reclass equal interval — wbt_reclass_equal_interval","text":"","code":"wbt_reclass_equal_interval(   input,   output,   interval = 10,   start_val = NULL,   end_val = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reclass_equal_interval.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reclass equal interval — wbt_reclass_equal_interval","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. interval Class interval size. start_val Optional starting value (default input minimum value). end_val Optional ending value (default input maximum value). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reclass_equal_interval.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reclass equal interval — wbt_reclass_equal_interval","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reclass_from_file.html","id":null,"dir":"Reference","previous_headings":"","what":"Reclass from file — wbt_reclass_from_file","title":"Reclass from file — wbt_reclass_from_file","text":"Reclassifies values raster image using reclass ranges text file.","code":""},{"path":"/reference/wbt_reclass_from_file.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reclass from file — wbt_reclass_from_file","text":"","code":"wbt_reclass_from_file(   input,   reclass_file,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reclass_from_file.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reclass from file — wbt_reclass_from_file","text":"input Input raster file path. See wbt_file_path() details. reclass_file Input text file containing reclass ranges. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reclass_from_file.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reclass from file — wbt_reclass_from_file","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reconcile_multiple_headers.html","id":null,"dir":"Reference","previous_headings":"","what":"Reconcile multiple headers — wbt_reconcile_multiple_headers","title":"Reconcile multiple headers — wbt_reconcile_multiple_headers","text":"tool adjusts crop yield values data sets collected multiple headers combines.","code":""},{"path":"/reference/wbt_reconcile_multiple_headers.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reconcile multiple headers — wbt_reconcile_multiple_headers","text":"","code":"wbt_reconcile_multiple_headers(   input,   region_field,   yield_field,   output,   radius = NULL,   min_yield = NULL,   max_yield = NULL,   mean_tonnage = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reconcile_multiple_headers.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reconcile multiple headers — wbt_reconcile_multiple_headers","text":"input Name input points shapefile. region_field Name attribute containing region data. yield_field Name attribute containing yield data. output Name output points shapefile. radius Optional search radius, metres. specify value want calculate locally normalized yield. min_yield Minimum yield value output. max_yield Maximum yield value output. mean_tonnage Use optional parameter force output certain overall average tonnage. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reconcile_multiple_headers.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reconcile multiple headers — wbt_reconcile_multiple_headers","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_recover_flightline_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Recover flightline info — wbt_recover_flightline_info","title":"Recover flightline info — wbt_recover_flightline_info","text":"Associates LiDAR points flightlines.","code":""},{"path":"/reference/wbt_recover_flightline_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Recover flightline info — wbt_recover_flightline_info","text":"","code":"wbt_recover_flightline_info(   input,   output,   max_time_diff = 5,   pt_src_id = FALSE,   user_data = FALSE,   rgb = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_recover_flightline_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Recover flightline info — wbt_recover_flightline_info","text":"input Name input LiDAR points. output Name output LiDAR points. max_time_diff Maximum -flightline time difference (seconds). pt_src_id Add flightline information point source ID. user_data Add flightline information user data. rgb Add flightline information RGB colour data. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_recover_flightline_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Recover flightline info — wbt_recover_flightline_info","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_recreate_pass_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Recreate pass lines — wbt_recreate_pass_lines","title":"Recreate pass lines — wbt_recreate_pass_lines","text":"tool can used approximate harvester pass lines yield points.","code":""},{"path":"/reference/wbt_recreate_pass_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Recreate pass lines — wbt_recreate_pass_lines","text":"","code":"wbt_recreate_pass_lines(   input,   yield_field_name,   output_lines,   output_points,   max_change_in_heading = 25,   ignore_zeros = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_recreate_pass_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Recreate pass lines — wbt_recreate_pass_lines","text":"input Name input points shapefile. yield_field_name Name attribute containing yield data. output_lines Name output pass lines shapefile. output_points Name output points shapefile. max_change_in_heading Max change heading. ignore_zeros Ignore zero-valued yield points?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_recreate_pass_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Recreate pass lines — wbt_recreate_pass_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_reinitialize_attribute_table.html","id":null,"dir":"Reference","previous_headings":"","what":"Reinitialize attribute table — wbt_reinitialize_attribute_table","title":"Reinitialize attribute table — wbt_reinitialize_attribute_table","text":"Reinitializes vector's attribute table deleting fields feature ID (FID).","code":""},{"path":"/reference/wbt_reinitialize_attribute_table.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reinitialize attribute table — wbt_reinitialize_attribute_table","text":"","code":"wbt_reinitialize_attribute_table(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_reinitialize_attribute_table.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reinitialize attribute table — wbt_reinitialize_attribute_table","text":"input Input vector file path. See wbt_file_path() details. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_reinitialize_attribute_table.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reinitialize attribute table — wbt_reinitialize_attribute_table","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_related_circumscribing_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"Related circumscribing circle — wbt_related_circumscribing_circle","title":"Related circumscribing circle — wbt_related_circumscribing_circle","text":"Calculates related circumscribing circle vector polygons.","code":""},{"path":"/reference/wbt_related_circumscribing_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Related circumscribing circle — wbt_related_circumscribing_circle","text":"","code":"wbt_related_circumscribing_circle(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_related_circumscribing_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Related circumscribing circle — wbt_related_circumscribing_circle","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_related_circumscribing_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Related circumscribing circle — wbt_related_circumscribing_circle","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_relative_aspect.html","id":null,"dir":"Reference","previous_headings":"","what":"Relative aspect — wbt_relative_aspect","title":"Relative aspect — wbt_relative_aspect","text":"Calculates relative aspect (relative user-specified direction) input DEM.","code":""},{"path":"/reference/wbt_relative_aspect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Relative aspect — wbt_relative_aspect","text":"","code":"wbt_relative_aspect(   dem,   output,   azimuth = 0,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_relative_aspect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Relative aspect — wbt_relative_aspect","text":"dem Input raster DEM file. output Output raster file. azimuth Illumination source azimuth. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_relative_aspect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Relative aspect — wbt_relative_aspect","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_relative_topographic_position.html","id":null,"dir":"Reference","previous_headings":"","what":"Relative topographic position — wbt_relative_topographic_position","title":"Relative topographic position — wbt_relative_topographic_position","text":"Calculates relative topographic position index DEM.","code":""},{"path":"/reference/wbt_relative_topographic_position.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Relative topographic position — wbt_relative_topographic_position","text":"","code":"wbt_relative_topographic_position(   dem,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_relative_topographic_position.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Relative topographic position — wbt_relative_topographic_position","text":"dem Input raster DEM file. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_relative_topographic_position.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Relative topographic position — wbt_relative_topographic_position","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_field_edge_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove field edge points — wbt_remove_field_edge_points","title":"Remove field edge points — wbt_remove_field_edge_points","text":"tool can used remove, flag, points along edges crop yield data set.","code":""},{"path":"/reference/wbt_remove_field_edge_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove field edge points — wbt_remove_field_edge_points","text":"","code":"wbt_remove_field_edge_points(   input,   output,   dist = NULL,   max_change_in_heading = 25,   flag_edges = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_field_edge_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove field edge points — wbt_remove_field_edge_points","text":"input Name input points shapefile. output Name output points shapefile. dist Average distance passes, meters. max_change_in_heading Max change heading. flag_edges remove edge points, just flag attribute table?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_field_edge_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove field edge points — wbt_remove_field_edge_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_off_terrain_objects.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove off terrain objects — wbt_remove_off_terrain_objects","title":"Remove off terrain objects — wbt_remove_off_terrain_objects","text":"Removes -terrain objects raster digital elevation model (DEM).","code":""},{"path":"/reference/wbt_remove_off_terrain_objects.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove off terrain objects — wbt_remove_off_terrain_objects","text":"","code":"wbt_remove_off_terrain_objects(   dem,   output,   filter = 11,   slope = 15,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_off_terrain_objects.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove off terrain objects — wbt_remove_off_terrain_objects","text":"dem Input raster DEM file. output Output raster file. filter Filter size (cells). slope Slope threshold value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_off_terrain_objects.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove off terrain objects — wbt_remove_off_terrain_objects","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_polygon_holes.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove polygon holes — wbt_remove_polygon_holes","title":"Remove polygon holes — wbt_remove_polygon_holes","text":"Removes holes within features vector polygon file.","code":""},{"path":"/reference/wbt_remove_polygon_holes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove polygon holes — wbt_remove_polygon_holes","text":"","code":"wbt_remove_polygon_holes(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_polygon_holes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove polygon holes — wbt_remove_polygon_holes","text":"input Input vector polygon file. output Output vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_polygon_holes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove polygon holes — wbt_remove_polygon_holes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_raster_polygon_holes.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove raster polygon holes — wbt_remove_raster_polygon_holes","title":"Remove raster polygon holes — wbt_remove_raster_polygon_holes","text":"Removes polygon holes, 'donut-holes', raster polygons.","code":""},{"path":"/reference/wbt_remove_raster_polygon_holes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove raster polygon holes — wbt_remove_raster_polygon_holes","text":"","code":"wbt_remove_raster_polygon_holes(   input,   output,   threshold = 3,   use_diagonals = TRUE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_raster_polygon_holes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove raster polygon holes — wbt_remove_raster_polygon_holes","text":"input Name input raster image file. output Name output raster file. threshold Maximum size removed holes, grid cells. Blank threshold, .e. remove holes. use_diagonals Use diagonal neighbours clumping operation. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_raster_polygon_holes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove raster polygon holes — wbt_remove_raster_polygon_holes","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_short_streams.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove short streams — wbt_remove_short_streams","title":"Remove short streams — wbt_remove_short_streams","text":"Removes short first-order streams stream network.","code":""},{"path":"/reference/wbt_remove_short_streams.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove short streams — wbt_remove_short_streams","text":"","code":"wbt_remove_short_streams(   d8_pntr,   streams,   output,   min_length,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_short_streams.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove short streams — wbt_remove_short_streams","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. min_length Minimum tributary length (map units) used network pruning. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_short_streams.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove short streams — wbt_remove_short_streams","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_remove_spurs.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove spurs — wbt_remove_spurs","title":"Remove spurs — wbt_remove_spurs","text":"Removes spurs (pruning operation) Boolean line image; intended used output LineThinning tool.","code":""},{"path":"/reference/wbt_remove_spurs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove spurs — wbt_remove_spurs","text":"","code":"wbt_remove_spurs(   input,   output,   iterations = 10,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_remove_spurs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove spurs — wbt_remove_spurs","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. iterations Maximum number iterations. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_remove_spurs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove spurs — wbt_remove_spurs","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_repair_stream_vector_topology.html","id":null,"dir":"Reference","previous_headings":"","what":"Repair stream vector topology — wbt_repair_stream_vector_topology","title":"Repair stream vector topology — wbt_repair_stream_vector_topology","text":"tool resolves topological errors inconsistencies associated digitized vector streams.","code":""},{"path":"/reference/wbt_repair_stream_vector_topology.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Repair stream vector topology — wbt_repair_stream_vector_topology","text":"","code":"wbt_repair_stream_vector_topology(   input,   output,   dist = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_repair_stream_vector_topology.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Repair stream vector topology — wbt_repair_stream_vector_topology","text":"input Name input lines vector file. output Name output lines vector file. dist Snap distance, xy units (metres). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_repair_stream_vector_topology.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Repair stream vector topology — wbt_repair_stream_vector_topology","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_resample.html","id":null,"dir":"Reference","previous_headings":"","what":"Resample — wbt_resample","title":"Resample — wbt_resample","text":"Resamples one input images destination image.","code":""},{"path":"/reference/wbt_resample.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Resample — wbt_resample","text":"","code":"wbt_resample(   inputs,   output,   cell_size = NULL,   base = NULL,   method = \"cc\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_resample.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Resample — wbt_resample","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. method Resampling method; options include 'nn' (nearest neighbour), 'bilinear', 'cc' (cubic convolution). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_resample.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Resample — wbt_resample","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rescale_value_range.html","id":null,"dir":"Reference","previous_headings":"","what":"Rescale value range — wbt_rescale_value_range","title":"Rescale value range — wbt_rescale_value_range","text":"Performs min-max contrast stretch input greytone image.","code":""},{"path":"/reference/wbt_rescale_value_range.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rescale value range — wbt_rescale_value_range","text":"","code":"wbt_rescale_value_range(   input,   output,   out_min_val,   out_max_val,   clip_min = NULL,   clip_max = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rescale_value_range.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rescale value range — wbt_rescale_value_range","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. out_min_val New minimum value output image. out_max_val New maximum value output image. clip_min Optional lower tail clip value. clip_max Optional upper tail clip value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rescale_value_range.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rescale value range — wbt_rescale_value_range","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rgb_to_ihs.html","id":null,"dir":"Reference","previous_headings":"","what":"Rgb to ihs — wbt_rgb_to_ihs","title":"Rgb to ihs — wbt_rgb_to_ihs","text":"Converts red, green, blue (RGB) images intensity, hue, saturation (IHS) images.","code":""},{"path":"/reference/wbt_rgb_to_ihs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rgb to ihs — wbt_rgb_to_ihs","text":"","code":"wbt_rgb_to_ihs(   intensity,   hue,   saturation,   red = NULL,   green = NULL,   blue = NULL,   composite = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rgb_to_ihs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rgb to ihs — wbt_rgb_to_ihs","text":"intensity Output intensity raster file. hue Output hue raster file. saturation Output saturation raster file. red Input red band image file. Optionally specified colour-composite specified. green Input green band image file. Optionally specified colour-composite specified. blue Input blue band image file. Optionally specified colour-composite specified. composite Input colour-composite image file. used individual bands specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rgb_to_ihs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rgb to ihs — wbt_rgb_to_ihs","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rho8_flow_accumulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Rho8 flow accumulation — wbt_rho8_flow_accumulation","title":"Rho8 flow accumulation — wbt_rho8_flow_accumulation","text":"Calculates Fairfield Leymarie (1991) flow accumulation.","code":""},{"path":"/reference/wbt_rho8_flow_accumulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rho8 flow accumulation — wbt_rho8_flow_accumulation","text":"","code":"wbt_rho8_flow_accumulation(   input,   output,   out_type = \"specific contributing area\",   log = FALSE,   clip = FALSE,   pntr = FALSE,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rho8_flow_accumulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rho8 flow accumulation — wbt_rho8_flow_accumulation","text":"input Input DEM Rho8 pointer file; DEM used, must depressionless. output Name output raster file. out_type Output type; one 'cells', 'specific contributing area' (default), 'catchment area'. log Log-transform output values?. clip Optional flag request clipping display max 1 percent. pntr input raster Rho8 flow pointer rather DEM?. esri_pntr input Rho8 pointer use ESRI style scheme?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rho8_flow_accumulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rho8 flow accumulation — wbt_rho8_flow_accumulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rho8_pointer.html","id":null,"dir":"Reference","previous_headings":"","what":"Rho8 pointer — wbt_rho8_pointer","title":"Rho8 pointer — wbt_rho8_pointer","text":"Calculates stochastic Rho8 flow pointer raster input DEM.","code":""},{"path":"/reference/wbt_rho8_pointer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rho8 pointer — wbt_rho8_pointer","text":"","code":"wbt_rho8_pointer(   dem,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rho8_pointer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rho8 pointer — wbt_rho8_pointer","text":"dem Input raster DEM file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rho8_pointer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rho8 pointer — wbt_rho8_pointer","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ring_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Ring curvature — wbt_ring_curvature","title":"Ring curvature — wbt_ring_curvature","text":"tool calculates ring curvature input DEM.","code":""},{"path":"/reference/wbt_ring_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ring curvature — wbt_ring_curvature","text":"","code":"wbt_ring_curvature(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ring_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ring curvature — wbt_ring_curvature","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ring_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ring curvature — wbt_ring_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_river_centerlines.html","id":null,"dir":"Reference","previous_headings":"","what":"River centerlines — wbt_river_centerlines","title":"River centerlines — wbt_river_centerlines","text":"Maps river centerlines input water raster.","code":""},{"path":"/reference/wbt_river_centerlines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"River centerlines — wbt_river_centerlines","text":"","code":"wbt_river_centerlines(   input,   output,   min_length = 3,   radius = 4,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_river_centerlines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"River centerlines — wbt_river_centerlines","text":"input Name input raster image file. output Name output vector lines file. min_length Minimum line length, grid cells. radius Search radius joining distant endnodes, grid cells. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_river_centerlines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"River centerlines — wbt_river_centerlines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_roberts_cross_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Roberts cross filter — wbt_roberts_cross_filter","title":"Roberts cross filter — wbt_roberts_cross_filter","text":"Performs Robert's cross edge-detection filter image.","code":""},{"path":"/reference/wbt_roberts_cross_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Roberts cross filter — wbt_roberts_cross_filter","text":"","code":"wbt_roberts_cross_filter(   input,   output,   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_roberts_cross_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Roberts cross filter — wbt_roberts_cross_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_roberts_cross_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Roberts cross filter — wbt_roberts_cross_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_root_mean_square_error.html","id":null,"dir":"Reference","previous_headings":"","what":"Root mean square error — wbt_root_mean_square_error","title":"Root mean square error — wbt_root_mean_square_error","text":"Calculates RMSE accuracy statistics.","code":""},{"path":"/reference/wbt_root_mean_square_error.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Root mean square error — wbt_root_mean_square_error","text":"","code":"wbt_root_mean_square_error(   input,   base,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_root_mean_square_error.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Root mean square error — wbt_root_mean_square_error","text":"input Input raster file path. See wbt_file_path() details. base Input base raster file used comparison. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_root_mean_square_error.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Root mean square error — wbt_root_mean_square_error","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_rotor.html","id":null,"dir":"Reference","previous_headings":"","what":"Rotor — wbt_rotor","title":"Rotor — wbt_rotor","text":"tool calculates rotor input DEM.","code":""},{"path":"/reference/wbt_rotor.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rotor — wbt_rotor","text":"","code":"wbt_rotor(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_rotor.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rotor — wbt_rotor","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_rotor.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rotor — wbt_rotor","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_round.html","id":null,"dir":"Reference","previous_headings":"","what":"Round — wbt_round","title":"Round — wbt_round","text":"Rounds values input raster nearest integer value.","code":""},{"path":"/reference/wbt_round.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Round — wbt_round","text":"","code":"wbt_round(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_round.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Round — wbt_round","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_round.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Round — wbt_round","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_ruggedness_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Ruggedness index — wbt_ruggedness_index","title":"Ruggedness index — wbt_ruggedness_index","text":"Calculates Riley et al.'s (1999) terrain ruggedness index input DEM.","code":""},{"path":"/reference/wbt_ruggedness_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ruggedness index — wbt_ruggedness_index","text":"","code":"wbt_ruggedness_index(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_ruggedness_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ruggedness index — wbt_ruggedness_index","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_ruggedness_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ruggedness index — wbt_ruggedness_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_run_tool.html","id":null,"dir":"Reference","previous_headings":"","what":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","title":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","text":"Runs tool specifies tool arguments. prefix \"whitebox::\" \"wbt_\" tool_name removed match definitions wbt_list_tools()","code":""},{"path":"/reference/wbt_run_tool.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","text":"","code":"wbt_run_tool(tool_name, args, verbose_mode = FALSE, command_only = FALSE)"},{"path":"/reference/wbt_run_tool.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","text":"tool_name name tool run. args Tool arguments. verbose_mode Verbose mode. Without flag, tool outputs printed. command_only Return command run system()? Default: FALSE","code":""},{"path":"/reference/wbt_run_tool.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","text":"Returns (character) output tool.","code":""},{"path":[]},{"path":"/reference/wbt_run_tool.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Run a tool in 'WhiteboxTools' by name — wbt_run_tool","text":"","code":"if (FALSE) { tool_name <- \"breach_depressions\" dem <- system.file(\"extdata\", \"DEM.tif\", package=\"whitebox\") output <- \"./output.tif\" arg1 <- paste0(\"--dem=\", dem) arg2 <- paste0(\"--output=\", output) args <- paste(arg1, arg2) wbt_run_tool(tool_name, args) }"},{"path":"/reference/wbt_rust_backtrace.html","id":null,"dir":"Reference","previous_headings":"","what":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","title":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","text":"Convenience method setting RUST_BACKTRACE options debugging","code":""},{"path":"/reference/wbt_rust_backtrace.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","text":"","code":"wbt_rust_backtrace(RUST_BACKTRACE = c(\"0\", \"1\", \"full\"))"},{"path":"/reference/wbt_rust_backtrace.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","text":"RUST_BACKTRACE One \"0\", \"1\", \"full\", Logical values converted integer character.","code":""},{"path":"/reference/wbt_rust_backtrace.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","text":"value system environment variable RUST_BACKTRACE","code":""},{"path":"/reference/wbt_rust_backtrace.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convenience method for setting RUST_BACKTRACE options for debugging — wbt_rust_backtrace","text":"","code":"if (FALSE) { wbt_rust_backtrace(TRUE) }"},{"path":"/reference/wbt_scharr_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Scharr filter — wbt_scharr_filter","title":"Scharr filter — wbt_scharr_filter","text":"Performs Scharr edge-detection filter image.","code":""},{"path":"/reference/wbt_scharr_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Scharr filter — wbt_scharr_filter","text":"","code":"wbt_scharr_filter(   input,   output,   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_scharr_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Scharr filter — wbt_scharr_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. clip Optional amount clip distribution tails , percent. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_scharr_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Scharr filter — wbt_scharr_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sediment_transport_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Sediment transport index — wbt_sediment_transport_index","title":"Sediment transport index — wbt_sediment_transport_index","text":"Calculates sediment transport index.","code":""},{"path":"/reference/wbt_sediment_transport_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sediment transport index — wbt_sediment_transport_index","text":"","code":"wbt_sediment_transport_index(   sca,   slope,   output,   sca_exponent = 0.4,   slope_exponent = 1.3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sediment_transport_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sediment transport index — wbt_sediment_transport_index","text":"sca Input raster specific contributing area (SCA) file. slope Input raster slope file. output Output raster file. sca_exponent SCA exponent value. slope_exponent Slope exponent value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sediment_transport_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sediment transport index — wbt_sediment_transport_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_select_tiles_by_polygon.html","id":null,"dir":"Reference","previous_headings":"","what":"Select tiles by polygon — wbt_select_tiles_by_polygon","title":"Select tiles by polygon — wbt_select_tiles_by_polygon","text":"Copies LiDAR tiles overlapping polygon output directory.","code":""},{"path":"/reference/wbt_select_tiles_by_polygon.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Select tiles by polygon — wbt_select_tiles_by_polygon","text":"","code":"wbt_select_tiles_by_polygon(   indir,   outdir,   polygons,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_select_tiles_by_polygon.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Select tiles by polygon — wbt_select_tiles_by_polygon","text":"indir Input LAS file source directory. outdir Output directory LAS files within polygon copied. polygons Input vector polygons file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_select_tiles_by_polygon.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Select tiles by polygon — wbt_select_tiles_by_polygon","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_set_nodata_value.html","id":null,"dir":"Reference","previous_headings":"","what":"Set nodata value — wbt_set_nodata_value","title":"Set nodata value — wbt_set_nodata_value","text":"Assign NoData value input image.","code":""},{"path":"/reference/wbt_set_nodata_value.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set nodata value — wbt_set_nodata_value","text":"","code":"wbt_set_nodata_value(   input,   output,   back_value = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_set_nodata_value.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set nodata value — wbt_set_nodata_value","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. back_value Background value set nodata. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_set_nodata_value.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set nodata value — wbt_set_nodata_value","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shadow_animation.html","id":null,"dir":"Reference","previous_headings":"","what":"Shadow animation — wbt_shadow_animation","title":"Shadow animation — wbt_shadow_animation","text":"tool creates animated GIF shadows based input DEM.","code":""},{"path":"/reference/wbt_shadow_animation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shadow animation — wbt_shadow_animation","text":"","code":"wbt_shadow_animation(   input,   output,   palette = \"atlas\",   max_dist = \"\",   date = \"21/06/2021\",   interval = 15,   location = \"43.5448/-80.2482/-4\",   height = 600,   delay = 250,   label = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shadow_animation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shadow animation — wbt_shadow_animation","text":"input Name input digital surface model (DSM) raster file. output Name output HTML file (*.html). palette DSM image palette; options 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'light_quant', 'purple', 'viridis', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', 'none'. max_dist Optional maximum search distance, xy units. Minimum value 5 x cell size. date Date format DD/MM/YYYY. interval Time interval, minutes (1-60). location Location, defined Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4). height Image height, pixels. delay GIF time delay milliseconds. label Label text (leave blank none). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shadow_animation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shadow animation — wbt_shadow_animation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shadow_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Shadow image — wbt_shadow_image","title":"Shadow image — wbt_shadow_image","text":"tool creates raster shadow areas based input DEM.","code":""},{"path":"/reference/wbt_shadow_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shadow image — wbt_shadow_image","text":"","code":"wbt_shadow_image(   input,   output,   palette = \"soft\",   max_dist = \"\",   date = \"21/06/2021\",   time = \"13:00\",   location = \"43.5448/-80.2482/-4\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shadow_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shadow image — wbt_shadow_image","text":"input Name input digital surface model (DSM) raster file. output Name output raster file. palette DSM image palette; options 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'light_quant', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', 'none'. max_dist Optional maximum search distance, xy unites. Minimum value 5 x cell size. date Date format DD/MM/YYYY. time Time format HH::MM, e.g. 03:15AM 14:30. location Location, defined Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shadow_image.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shadow image — wbt_shadow_image","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shape_complexity_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Shape complexity index — wbt_shape_complexity_index","title":"Shape complexity index — wbt_shape_complexity_index","text":"Calculates overall polygon shape complexity irregularity.","code":""},{"path":"/reference/wbt_shape_complexity_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shape complexity index — wbt_shape_complexity_index","text":"","code":"wbt_shape_complexity_index(   input,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shape_complexity_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shape complexity index — wbt_shape_complexity_index","text":"input Input vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shape_complexity_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shape complexity index — wbt_shape_complexity_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shape_complexity_index_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Shape complexity index raster — wbt_shape_complexity_index_raster","title":"Shape complexity index raster — wbt_shape_complexity_index_raster","text":"Calculates complexity raster polygons classes.","code":""},{"path":"/reference/wbt_shape_complexity_index_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shape complexity index raster — wbt_shape_complexity_index_raster","text":"","code":"wbt_shape_complexity_index_raster(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shape_complexity_index_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shape complexity index raster — wbt_shape_complexity_index_raster","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shape_complexity_index_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shape complexity index raster — wbt_shape_complexity_index_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shape_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Shape index — wbt_shape_index","title":"Shape index — wbt_shape_index","text":"tool calculates shape index input DEM.","code":""},{"path":"/reference/wbt_shape_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shape index — wbt_shape_index","text":"","code":"wbt_shape_index(   dem,   output,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shape_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shape index — wbt_shape_index","text":"dem Name input raster DEM file. output Name output raster image file. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shape_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shape index — wbt_shape_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_shreve_stream_magnitude.html","id":null,"dir":"Reference","previous_headings":"","what":"Shreve stream magnitude — wbt_shreve_stream_magnitude","title":"Shreve stream magnitude — wbt_shreve_stream_magnitude","text":"Assigns Shreve stream magnitude link stream network.","code":""},{"path":"/reference/wbt_shreve_stream_magnitude.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shreve stream magnitude — wbt_shreve_stream_magnitude","text":"","code":"wbt_shreve_stream_magnitude(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_shreve_stream_magnitude.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shreve stream magnitude — wbt_shreve_stream_magnitude","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_shreve_stream_magnitude.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shreve stream magnitude — wbt_shreve_stream_magnitude","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sigmoidal_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Sigmoidal contrast stretch — wbt_sigmoidal_contrast_stretch","title":"Sigmoidal contrast stretch — wbt_sigmoidal_contrast_stretch","text":"Performs sigmoidal contrast stretch input images.","code":""},{"path":"/reference/wbt_sigmoidal_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sigmoidal contrast stretch — wbt_sigmoidal_contrast_stretch","text":"","code":"wbt_sigmoidal_contrast_stretch(   input,   output,   cutoff = 0,   gain = 1,   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sigmoidal_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sigmoidal contrast stretch — wbt_sigmoidal_contrast_stretch","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. cutoff Cutoff value 0.0 0.95. gain Gain value. num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sigmoidal_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sigmoidal contrast stretch — wbt_sigmoidal_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sin.html","id":null,"dir":"Reference","previous_headings":"","what":"Sin — wbt_sin","title":"Sin — wbt_sin","text":"Returns sine (sin) values raster.","code":""},{"path":"/reference/wbt_sin.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sin — wbt_sin","text":"","code":"wbt_sin(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sin.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sin — wbt_sin","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sin.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sin — wbt_sin","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_single_part_to_multi_part.html","id":null,"dir":"Reference","previous_headings":"","what":"Single part to multi part — wbt_single_part_to_multi_part","title":"Single part to multi part — wbt_single_part_to_multi_part","text":"Converts vector file containing multi-part features vector containing single-part features.","code":""},{"path":"/reference/wbt_single_part_to_multi_part.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Single part to multi part — wbt_single_part_to_multi_part","text":"","code":"wbt_single_part_to_multi_part(   input,   output,   field = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_single_part_to_multi_part.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Single part to multi part — wbt_single_part_to_multi_part","text":"input Input vector line polygon file. output Output vector line polygon file. field Grouping ID field name attribute table. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_single_part_to_multi_part.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Single part to multi part — wbt_single_part_to_multi_part","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sinh.html","id":null,"dir":"Reference","previous_headings":"","what":"Sinh — wbt_sinh","title":"Sinh — wbt_sinh","text":"Returns hyperbolic sine (sinh) values raster.","code":""},{"path":"/reference/wbt_sinh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sinh — wbt_sinh","text":"","code":"wbt_sinh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sinh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sinh — wbt_sinh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sinh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sinh — wbt_sinh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sink.html","id":null,"dir":"Reference","previous_headings":"","what":"Sink — wbt_sink","title":"Sink — wbt_sink","text":"Identifies depressions DEM, giving feature unique identifier.","code":""},{"path":"/reference/wbt_sink.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sink — wbt_sink","text":"","code":"wbt_sink(   input,   output,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sink.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sink — wbt_sink","text":"input Input raster DEM file. output Output raster file. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sink.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sink — wbt_sink","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_slope.html","id":null,"dir":"Reference","previous_headings":"","what":"Slope — wbt_slope","title":"Slope — wbt_slope","text":"Calculates slope raster input DEM.","code":""},{"path":"/reference/wbt_slope.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Slope — wbt_slope","text":"","code":"wbt_slope(   dem,   output,   zfactor = NULL,   units = \"degrees\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_slope.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Slope — wbt_slope","text":"dem Input raster DEM file. output Output raster file. zfactor Optional multiplier vertical horizontal units . units Units output raster; options include 'degrees', 'radians', 'percent'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_slope.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Slope — wbt_slope","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_slope_vs_aspect_plot.html","id":null,"dir":"Reference","previous_headings":"","what":"Slope vs aspect plot — wbt_slope_vs_aspect_plot","title":"Slope vs aspect plot — wbt_slope_vs_aspect_plot","text":"tool creates slope-aspect relation plot input DEM.","code":""},{"path":"/reference/wbt_slope_vs_aspect_plot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Slope vs aspect plot — wbt_slope_vs_aspect_plot","text":"","code":"wbt_slope_vs_aspect_plot(   input,   output,   bin_size = 2,   min_slope = 0.1,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_slope_vs_aspect_plot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Slope vs aspect plot — wbt_slope_vs_aspect_plot","text":"input Name input raster image file. output Name output report file (*.html). bin_size Aspect bin size, degrees. min_slope Minimum slope, degrees. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_slope_vs_aspect_plot.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Slope vs aspect plot — wbt_slope_vs_aspect_plot","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_slope_vs_elevation_plot.html","id":null,"dir":"Reference","previous_headings":"","what":"Slope vs elevation plot — wbt_slope_vs_elevation_plot","title":"Slope vs elevation plot — wbt_slope_vs_elevation_plot","text":"Creates slope vs. elevation plot one DEMs.","code":""},{"path":"/reference/wbt_slope_vs_elevation_plot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Slope vs elevation plot — wbt_slope_vs_elevation_plot","text":"","code":"wbt_slope_vs_elevation_plot(   inputs,   output,   watershed = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_slope_vs_elevation_plot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Slope vs elevation plot — wbt_slope_vs_elevation_plot","text":"inputs Input DEM files. output Output HTML file (default name based input file unspecified). watershed Input watershed files (optional). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_slope_vs_elevation_plot.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Slope vs elevation plot — wbt_slope_vs_elevation_plot","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_smooth_vectors.html","id":null,"dir":"Reference","previous_headings":"","what":"Smooth vectors — wbt_smooth_vectors","title":"Smooth vectors — wbt_smooth_vectors","text":"Smooths vector coverage either POLYLINE POLYGON base ShapeType.","code":""},{"path":"/reference/wbt_smooth_vectors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Smooth vectors — wbt_smooth_vectors","text":"","code":"wbt_smooth_vectors(   input,   output,   filter = 3,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_smooth_vectors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Smooth vectors — wbt_smooth_vectors","text":"input Input vector POLYLINE POLYGON file. output Output vector file. filter filter size, odd integer greater equal 3; default 3. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_smooth_vectors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Smooth vectors — wbt_smooth_vectors","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_smooth_vegetation_residual.html","id":null,"dir":"Reference","previous_headings":"","what":"Smooth vegetation residual — wbt_smooth_vegetation_residual","title":"Smooth vegetation residual — wbt_smooth_vegetation_residual","text":"tool can smooth residual roughness due vegetation cover LiDAR DEMs.","code":""},{"path":"/reference/wbt_smooth_vegetation_residual.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Smooth vegetation residual — wbt_smooth_vegetation_residual","text":"","code":"wbt_smooth_vegetation_residual(   input,   output,   max_scale = 30,   dev_threshold = 1,   scale_threshold = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_smooth_vegetation_residual.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Smooth vegetation residual — wbt_smooth_vegetation_residual","text":"input Name input digital elevation model (DEM) raster file. output Name output raster file. max_scale Maximum search neighbourhood radius grid cells. dev_threshold DEVmax Threshold. scale_threshold DEVmax scale threshold. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_smooth_vegetation_residual.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Smooth vegetation residual — wbt_smooth_vegetation_residual","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_snap_pour_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Snap pour points — wbt_snap_pour_points","title":"Snap pour points — wbt_snap_pour_points","text":"Moves outlet points used specify points interest watershedding operation cell highest flow accumulation neighbourhood.","code":""},{"path":"/reference/wbt_snap_pour_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Snap pour points — wbt_snap_pour_points","text":"","code":"wbt_snap_pour_points(   pour_pts,   flow_accum,   output,   snap_dist,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_snap_pour_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Snap pour points — wbt_snap_pour_points","text":"pour_pts Input vector pour points (outlet) file. flow_accum Input raster D8 flow accumulation file. output Output vector file. snap_dist Maximum snap distance map units. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_snap_pour_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Snap pour points — wbt_snap_pour_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sobel_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Sobel filter — wbt_sobel_filter","title":"Sobel filter — wbt_sobel_filter","text":"Performs Sobel edge-detection filter image.","code":""},{"path":"/reference/wbt_sobel_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sobel filter — wbt_sobel_filter","text":"","code":"wbt_sobel_filter(   input,   output,   variant = \"3x3\",   clip = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sobel_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sobel filter — wbt_sobel_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. variant Optional variant value. Options include 3x3 5x5 (default 3x3). clip Optional amount clip distribution tails , percent (default 0.0). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sobel_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sobel filter — wbt_sobel_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sort_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Sort lidar — wbt_sort_lidar","title":"Sort lidar — wbt_sort_lidar","text":"Sorts LiDAR points based properties.","code":""},{"path":"/reference/wbt_sort_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sort lidar — wbt_sort_lidar","text":"","code":"wbt_sort_lidar(   input,   output = NULL,   criteria = \"\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sort_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sort lidar — wbt_sort_lidar","text":"input Name input LiDAR points. output Name output LiDAR points. criteria Sort criteria e.g. 'x 50.0, y 50.0, z'; criteria may include x, y, z, intensity, class, user_data, point_source_id, scan_angle. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sort_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sort lidar — wbt_sort_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_source.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize an R object containing spatial data for use by WhiteboxTools — wbt_source","title":"Initialize an R object containing spatial data for use by WhiteboxTools — wbt_source","text":"Initialize R object containing spatial data use WhiteboxTools","code":""},{"path":"/reference/wbt_source.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize an R object containing spatial data for use by WhiteboxTools — wbt_source","text":"","code":"wbt_source(   x,   dsn = NULL,   layer = NULL,   force = FALSE,   verbose = wbt_verbose(),   ... )"},{"path":"/reference/wbt_source.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize an R object containing spatial data for use by WhiteboxTools — wbt_source","text":"x terra SpatVector sf object, path file can read SpatVectorProxy dsn Data source path / file name layer Data layer force Force write vector data file? Default: FALSE (write file exist) verbose Print information data source contents? ... Additional arguments passed terra::writeVector() sf::st_write()","code":""},{"path":"/reference/wbt_source.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize an R object containing spatial data for use by WhiteboxTools — wbt_source","text":"R object attributes wbt_dsn wbt_layer set needed support reading writing R objects file WhiteboxTools.","code":""},{"path":"/reference/wbt_spherical_std_dev_of_normals.html","id":null,"dir":"Reference","previous_headings":"","what":"Spherical std dev of normals — wbt_spherical_std_dev_of_normals","title":"Spherical std dev of normals — wbt_spherical_std_dev_of_normals","text":"Calculates spherical standard deviation surface normals DEM.","code":""},{"path":"/reference/wbt_spherical_std_dev_of_normals.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Spherical std dev of normals — wbt_spherical_std_dev_of_normals","text":"","code":"wbt_spherical_std_dev_of_normals(   dem,   output,   filter = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_spherical_std_dev_of_normals.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Spherical std dev of normals — wbt_spherical_std_dev_of_normals","text":"dem Input raster DEM file. output Output raster file. filter Size filter kernel. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_spherical_std_dev_of_normals.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Spherical std dev of normals — wbt_spherical_std_dev_of_normals","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_split_colour_composite.html","id":null,"dir":"Reference","previous_headings":"","what":"Split colour composite — wbt_split_colour_composite","title":"Split colour composite — wbt_split_colour_composite","text":"Splits RGB colour composite image separate multispectral images.","code":""},{"path":"/reference/wbt_split_colour_composite.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split colour composite — wbt_split_colour_composite","text":"","code":"wbt_split_colour_composite(   input,   red = NULL,   green = NULL,   blue = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_split_colour_composite.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split colour composite — wbt_split_colour_composite","text":"input Input colour composite image file. red Output red band file. green Output green band file. blue Output blue band file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_split_colour_composite.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split colour composite — wbt_split_colour_composite","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_split_lidar.html","id":null,"dir":"Reference","previous_headings":"","what":"Split lidar — wbt_split_lidar","title":"Split lidar — wbt_split_lidar","text":"Splits LiDAR points series new files based properties.","code":""},{"path":"/reference/wbt_split_lidar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split lidar — wbt_split_lidar","text":"","code":"wbt_split_lidar(   input,   criterion = \"num_pts\",   interval = \"\",   min_pts = 5,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_split_lidar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split lidar — wbt_split_lidar","text":"input Name input LiDAR points. criterion Criterion base split input file. Options include 'num_pts, 'x', 'y', 'z', intensity, 'class', 'user_data', 'point_source_id', 'scan_angle', 'time'. interval Interval. min_pts Minimum number points output file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_split_lidar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split lidar — wbt_split_lidar","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_split_vector_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Split vector lines — wbt_split_vector_lines","title":"Split vector lines — wbt_split_vector_lines","text":"Used split vector line coverage even-lengthed segments.","code":""},{"path":"/reference/wbt_split_vector_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split vector lines — wbt_split_vector_lines","text":"","code":"wbt_split_vector_lines(   input,   output,   length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_split_vector_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split vector lines — wbt_split_vector_lines","text":"input Name input lines shapefile. output Name output lines shapefile. length Maximum segment length (m). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_split_vector_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split vector lines — wbt_split_vector_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_split_with_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Split with lines — wbt_split_with_lines","title":"Split with lines — wbt_split_with_lines","text":"Splits lines polygons one layer using lines another layer.","code":""},{"path":"/reference/wbt_split_with_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Split with lines — wbt_split_with_lines","text":"","code":"wbt_split_with_lines(   input,   split,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_split_with_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Split with lines — wbt_split_with_lines","text":"input Input vector line polygon file. split Input vector polyline file. output Output vector file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_split_with_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Split with lines — wbt_split_with_lines","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_square.html","id":null,"dir":"Reference","previous_headings":"","what":"Square — wbt_square","title":"Square — wbt_square","text":"Squares values raster.","code":""},{"path":"/reference/wbt_square.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Square — wbt_square","text":"","code":"wbt_square(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_square.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Square — wbt_square","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_square.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Square — wbt_square","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_square_root.html","id":null,"dir":"Reference","previous_headings":"","what":"Square root — wbt_square_root","title":"Square root — wbt_square_root","text":"Returns square root values raster.","code":""},{"path":"/reference/wbt_square_root.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Square root — wbt_square_root","text":"","code":"wbt_square_root(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_square_root.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Square root — wbt_square_root","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_square_root.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Square root — wbt_square_root","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_standard_deviation_contrast_stretch.html","id":null,"dir":"Reference","previous_headings":"","what":"Standard deviation contrast stretch — wbt_standard_deviation_contrast_stretch","title":"Standard deviation contrast stretch — wbt_standard_deviation_contrast_stretch","text":"Performs standard-deviation contrast stretch input images.","code":""},{"path":"/reference/wbt_standard_deviation_contrast_stretch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Standard deviation contrast stretch — wbt_standard_deviation_contrast_stretch","text":"","code":"wbt_standard_deviation_contrast_stretch(   input,   output,   stdev = 2,   num_tones = 256,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_standard_deviation_contrast_stretch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Standard deviation contrast stretch — wbt_standard_deviation_contrast_stretch","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. stdev Standard deviation clip value. num_tones Number tones output image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_standard_deviation_contrast_stretch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Standard deviation contrast stretch — wbt_standard_deviation_contrast_stretch","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_standard_deviation_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Standard deviation filter — wbt_standard_deviation_filter","title":"Standard deviation filter — wbt_standard_deviation_filter","text":"Assigns cell output grid standard deviation values moving window centred grid cell input raster.","code":""},{"path":"/reference/wbt_standard_deviation_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Standard deviation filter — wbt_standard_deviation_filter","text":"","code":"wbt_standard_deviation_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_standard_deviation_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Standard deviation filter — wbt_standard_deviation_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_standard_deviation_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Standard deviation filter — wbt_standard_deviation_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_standard_deviation_of_slope.html","id":null,"dir":"Reference","previous_headings":"","what":"Standard deviation of slope — wbt_standard_deviation_of_slope","title":"Standard deviation of slope — wbt_standard_deviation_of_slope","text":"Calculates standard deviation slope input DEM.","code":""},{"path":"/reference/wbt_standard_deviation_of_slope.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Standard deviation of slope — wbt_standard_deviation_of_slope","text":"","code":"wbt_standard_deviation_of_slope(   input,   output,   zfactor = NULL,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_standard_deviation_of_slope.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Standard deviation of slope — wbt_standard_deviation_of_slope","text":"input Input raster DEM file. output Output raster DEM file. zfactor Optional multiplier vertical horizontal units . filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_standard_deviation_of_slope.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Standard deviation of slope — wbt_standard_deviation_of_slope","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stochastic_depression_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Stochastic depression analysis — wbt_stochastic_depression_analysis","title":"Stochastic depression analysis — wbt_stochastic_depression_analysis","text":"Performs stochastic analysis depressions within DEM.","code":""},{"path":"/reference/wbt_stochastic_depression_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stochastic depression analysis — wbt_stochastic_depression_analysis","text":"","code":"wbt_stochastic_depression_analysis(   dem,   output,   rmse,   range,   iterations = 100,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stochastic_depression_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stochastic depression analysis — wbt_stochastic_depression_analysis","text":"dem Input raster DEM file. output Output file. rmse DEM's root-mean-square-error (RMSE), z units. determines error magnitude. range error field's correlation length, xy-units. iterations number iterations. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stochastic_depression_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stochastic depression analysis — wbt_stochastic_depression_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_strahler_order_basins.html","id":null,"dir":"Reference","previous_headings":"","what":"Strahler order basins — wbt_strahler_order_basins","title":"Strahler order basins — wbt_strahler_order_basins","text":"Identifies Strahler-order basins input stream network.","code":""},{"path":"/reference/wbt_strahler_order_basins.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Strahler order basins — wbt_strahler_order_basins","text":"","code":"wbt_strahler_order_basins(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_strahler_order_basins.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Strahler order basins — wbt_strahler_order_basins","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_strahler_order_basins.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Strahler order basins — wbt_strahler_order_basins","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_strahler_stream_order.html","id":null,"dir":"Reference","previous_headings":"","what":"Strahler stream order — wbt_strahler_stream_order","title":"Strahler stream order — wbt_strahler_stream_order","text":"Assigns Strahler stream order link stream network.","code":""},{"path":"/reference/wbt_strahler_stream_order.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Strahler stream order — wbt_strahler_stream_order","text":"","code":"wbt_strahler_stream_order(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_strahler_stream_order.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Strahler stream order — wbt_strahler_stream_order","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_strahler_stream_order.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Strahler stream order — wbt_strahler_stream_order","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_link_class.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream link class — wbt_stream_link_class","title":"Stream link class — wbt_stream_link_class","text":"Identifies exterior/interior links nodes stream network.","code":""},{"path":"/reference/wbt_stream_link_class.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream link class — wbt_stream_link_class","text":"","code":"wbt_stream_link_class(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_link_class.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream link class — wbt_stream_link_class","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_link_class.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream link class — wbt_stream_link_class","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_link_identifier.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream link identifier — wbt_stream_link_identifier","title":"Stream link identifier — wbt_stream_link_identifier","text":"Assigns unique identifier link stream network.","code":""},{"path":"/reference/wbt_stream_link_identifier.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream link identifier — wbt_stream_link_identifier","text":"","code":"wbt_stream_link_identifier(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_link_identifier.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream link identifier — wbt_stream_link_identifier","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_link_identifier.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream link identifier — wbt_stream_link_identifier","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_link_length.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream link length — wbt_stream_link_length","title":"Stream link length — wbt_stream_link_length","text":"Estimates length link (tributary) stream network.","code":""},{"path":"/reference/wbt_stream_link_length.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream link length — wbt_stream_link_length","text":"","code":"wbt_stream_link_length(   d8_pntr,   linkid,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_link_length.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream link length — wbt_stream_link_length","text":"d8_pntr Input raster D8 pointer file. linkid Input raster streams link ID (tributary ID) file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_link_length.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream link length — wbt_stream_link_length","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_link_slope.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream link slope — wbt_stream_link_slope","title":"Stream link slope — wbt_stream_link_slope","text":"Estimates average slope link (tributary) stream network.","code":""},{"path":"/reference/wbt_stream_link_slope.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream link slope — wbt_stream_link_slope","text":"","code":"wbt_stream_link_slope(   d8_pntr,   linkid,   dem,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_link_slope.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream link slope — wbt_stream_link_slope","text":"d8_pntr Input raster D8 pointer file. linkid Input raster streams link ID (tributary ID) file. dem Input raster DEM file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_link_slope.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream link slope — wbt_stream_link_slope","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_power_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream power index — wbt_stream_power_index","title":"Stream power index — wbt_stream_power_index","text":"Calculates relative stream power index.","code":""},{"path":"/reference/wbt_stream_power_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream power index — wbt_stream_power_index","text":"","code":"wbt_stream_power_index(   sca,   slope,   output,   exponent = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_power_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream power index — wbt_stream_power_index","text":"sca Input raster specific contributing area (SCA) file. slope Input raster slope file. output Output raster file. exponent SCA exponent value. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_power_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream power index — wbt_stream_power_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_stream_slope_continuous.html","id":null,"dir":"Reference","previous_headings":"","what":"Stream slope continuous — wbt_stream_slope_continuous","title":"Stream slope continuous — wbt_stream_slope_continuous","text":"Estimates slope grid cell stream network.","code":""},{"path":"/reference/wbt_stream_slope_continuous.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stream slope continuous — wbt_stream_slope_continuous","text":"","code":"wbt_stream_slope_continuous(   d8_pntr,   streams,   dem,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_stream_slope_continuous.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stream slope continuous — wbt_stream_slope_continuous","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. dem Input raster DEM file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_stream_slope_continuous.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stream slope continuous — wbt_stream_slope_continuous","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_subbasins.html","id":null,"dir":"Reference","previous_headings":"","what":"Subbasins — wbt_subbasins","title":"Subbasins — wbt_subbasins","text":"Identifies catchments, sub-basin, draining link stream network.","code":""},{"path":"/reference/wbt_subbasins.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Subbasins — wbt_subbasins","text":"","code":"wbt_subbasins(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_subbasins.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Subbasins — wbt_subbasins","text":"d8_pntr Input D8 pointer raster file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_subbasins.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Subbasins — wbt_subbasins","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_subtract.html","id":null,"dir":"Reference","previous_headings":"","what":"Subtract — wbt_subtract","title":"Subtract — wbt_subtract","text":"Performs differencing operation two rasters raster constant value.","code":""},{"path":"/reference/wbt_subtract.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Subtract — wbt_subtract","text":"","code":"wbt_subtract(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_subtract.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Subtract — wbt_subtract","text":"input1 Input raster file constant value. input2 Input raster file constant value. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_subtract.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Subtract — wbt_subtract","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_sum_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Sum overlay — wbt_sum_overlay","title":"Sum overlay — wbt_sum_overlay","text":"Calculates sum grid cell group raster images.","code":""},{"path":"/reference/wbt_sum_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sum overlay — wbt_sum_overlay","text":"","code":"wbt_sum_overlay(   inputs,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_sum_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sum overlay — wbt_sum_overlay","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_sum_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sum overlay — wbt_sum_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_surface_area_ratio.html","id":null,"dir":"Reference","previous_headings":"","what":"Surface area ratio — wbt_surface_area_ratio","title":"Surface area ratio — wbt_surface_area_ratio","text":"Calculates surface area ratio grid cell input DEM.","code":""},{"path":"/reference/wbt_surface_area_ratio.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Surface area ratio — wbt_surface_area_ratio","text":"","code":"wbt_surface_area_ratio(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_surface_area_ratio.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Surface area ratio — wbt_surface_area_ratio","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_surface_area_ratio.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Surface area ratio — wbt_surface_area_ratio","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_svm_classification.html","id":null,"dir":"Reference","previous_headings":"","what":"Svm classification — wbt_svm_classification","title":"Svm classification — wbt_svm_classification","text":"Performs SVM binary classification using training site polygons/points multiple input images.","code":""},{"path":"/reference/wbt_svm_classification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Svm classification — wbt_svm_classification","text":"","code":"wbt_svm_classification(   inputs,   training,   field,   scaling = \"Normalize\",   output = NULL,   c = 200,   gamma = 50,   tolerance = 0.1,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_svm_classification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Svm classification — wbt_svm_classification","text":"inputs Names input predictor rasters. training Name input training site polygons/points Shapefile. field Name attribute containing class data. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. output Name output raster file. c c-value, regularization parameter. gamma Gamma parameter used setting RBF (Gaussian) kernel function. tolerance tolerance parameter used determining stopping condition. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_svm_classification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Svm classification — wbt_svm_classification","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_svm_regression.html","id":null,"dir":"Reference","previous_headings":"","what":"Svm regression — wbt_svm_regression","title":"Svm regression — wbt_svm_regression","text":"Performs supervised SVM regression analysis using training site points predictor rasters.","code":""},{"path":"/reference/wbt_svm_regression.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Svm regression — wbt_svm_regression","text":"","code":"wbt_svm_regression(   inputs,   training,   field,   scaling = \"Normalize\",   output = NULL,   c = 50,   eps = 10,   gamma = 0.5,   test_proportion = 0.2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_svm_regression.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Svm regression — wbt_svm_regression","text":"inputs Names input predictor rasters. training Name input training site points Shapefile. field Name attribute containing class data. scaling Scaling method predictors. Options include 'None', 'Normalize', 'Standardize'. output Name output raster file. c c-value, regularization parameter. eps Epsilon epsilon-SVR model. gamma Gamma parameter used setting RBF (Gaussian) kernel function. test_proportion proportion dataset include test split; default 0.2. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_svm_regression.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Svm regression — wbt_svm_regression","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_symmetrical_difference.html","id":null,"dir":"Reference","previous_headings":"","what":"Symmetrical difference — wbt_symmetrical_difference","title":"Symmetrical difference — wbt_symmetrical_difference","text":"Outputs features occur one two vector inputs , .e. overlapping features.","code":""},{"path":"/reference/wbt_symmetrical_difference.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Symmetrical difference — wbt_symmetrical_difference","text":"","code":"wbt_symmetrical_difference(   input,   overlay,   output,   snap = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_symmetrical_difference.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Symmetrical difference — wbt_symmetrical_difference","text":"input Input vector file path. See wbt_file_path() details. overlay Input overlay vector file. output Output vector file. snap Snap tolerance. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_symmetrical_difference.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Symmetrical difference — wbt_symmetrical_difference","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tan.html","id":null,"dir":"Reference","previous_headings":"","what":"Tan — wbt_tan","title":"Tan — wbt_tan","text":"Returns tangent (tan) values raster.","code":""},{"path":"/reference/wbt_tan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tan — wbt_tan","text":"","code":"wbt_tan(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tan — wbt_tan","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tan.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tan — wbt_tan","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tangential_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Tangential curvature — wbt_tangential_curvature","title":"Tangential curvature — wbt_tangential_curvature","text":"Calculates tangential curvature raster input DEM.","code":""},{"path":"/reference/wbt_tangential_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tangential curvature — wbt_tangential_curvature","text":"","code":"wbt_tangential_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tangential_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tangential curvature — wbt_tangential_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tangential_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tangential curvature — wbt_tangential_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tanh.html","id":null,"dir":"Reference","previous_headings":"","what":"Tanh — wbt_tanh","title":"Tanh — wbt_tanh","text":"Returns hyperbolic tangent (tanh) values raster.","code":""},{"path":"/reference/wbt_tanh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tanh — wbt_tanh","text":"","code":"wbt_tanh(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tanh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tanh — wbt_tanh","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tanh.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tanh — wbt_tanh","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_thicken_raster_line.html","id":null,"dir":"Reference","previous_headings":"","what":"Thicken raster line — wbt_thicken_raster_line","title":"Thicken raster line — wbt_thicken_raster_line","text":"Thickens single-cell wide lines within raster image.","code":""},{"path":"/reference/wbt_thicken_raster_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Thicken raster line — wbt_thicken_raster_line","text":"","code":"wbt_thicken_raster_line(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_thicken_raster_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Thicken raster line — wbt_thicken_raster_line","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_thicken_raster_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Thicken raster line — wbt_thicken_raster_line","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_time_in_daylight.html","id":null,"dir":"Reference","previous_headings":"","what":"Time in daylight — wbt_time_in_daylight","title":"Time in daylight — wbt_time_in_daylight","text":"Calculates proportion time location within area shadow.","code":""},{"path":"/reference/wbt_time_in_daylight.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Time in daylight — wbt_time_in_daylight","text":"","code":"wbt_time_in_daylight(   dem,   output,   lat,   long,   az_fraction = 10,   max_dist = 100,   utc_offset = \"00:00\",   start_day = 1,   end_day = 365,   start_time = \"00:00:00\",   end_time = \"23:59:59\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_time_in_daylight.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Time in daylight — wbt_time_in_daylight","text":"dem Input raster DEM file. output Output raster file. lat Centre point latitude. long Centre point longitude. az_fraction Azimuth fraction degrees. max_dist Optional maximum search distance. Minimum value 5 x cell size. utc_offset UTC time offset, hours (e.g. -04:00, +06:00). start_day Start day year (1-365). end_day End day year (1-365). start_time Starting hour track shadows (e.g. 5, 5:00, 05:00:00). Assumes 24-hour time: HH:MM:SS. 'sunrise' also valid time. end_time Ending hour track shadows (e.g. 21, 21:00, 21:00:00). Assumes 24-hour time: HH:MM:SS. 'sunset' also valid time. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_time_in_daylight.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Time in daylight — wbt_time_in_daylight","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tin_gridding.html","id":null,"dir":"Reference","previous_headings":"","what":"Tin gridding — wbt_tin_gridding","title":"Tin gridding — wbt_tin_gridding","text":"Creates raster grid based triangular irregular network (TIN) fitted vector points.","code":""},{"path":"/reference/wbt_tin_gridding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tin gridding — wbt_tin_gridding","text":"","code":"wbt_tin_gridding(   input,   output,   field = NULL,   use_z = FALSE,   resolution = NULL,   base = NULL,   max_triangle_edge_length = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tin_gridding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tin gridding — wbt_tin_gridding","text":"input Input vector points file. output Output raster file. field Input field name attribute table. use_z Use 'z' dimension Shapefile's geometry instead attribute field?. resolution Output raster's grid resolution. base Optionally specified input base raster file. used cell size specified. max_triangle_edge_length Optional maximum triangle edge length; triangles larger size gridded. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tin_gridding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tin gridding — wbt_tin_gridding","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_to_degrees.html","id":null,"dir":"Reference","previous_headings":"","what":"To degrees — wbt_to_degrees","title":"To degrees — wbt_to_degrees","text":"Converts raster radians degrees.","code":""},{"path":"/reference/wbt_to_degrees.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"To degrees — wbt_to_degrees","text":"","code":"wbt_to_degrees(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_to_degrees.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"To degrees — wbt_to_degrees","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_to_degrees.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"To degrees — wbt_to_degrees","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_to_radians.html","id":null,"dir":"Reference","previous_headings":"","what":"To radians — wbt_to_radians","title":"To radians — wbt_to_radians","text":"Converts raster degrees radians.","code":""},{"path":"/reference/wbt_to_radians.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"To radians — wbt_to_radians","text":"","code":"wbt_to_radians(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_to_radians.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"To radians — wbt_to_radians","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_to_radians.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"To radians — wbt_to_radians","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tool_help.html","id":null,"dir":"Reference","previous_headings":"","what":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"Retrieves help description specific tool.","code":""},{"path":"/reference/wbt_tool_help.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"","code":"wbt_tool_help(tool_name = NULL)"},{"path":"/reference/wbt_tool_help.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"tool_name name tool.","code":""},{"path":"/reference/wbt_tool_help.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"Returns help description specific tool.","code":""},{"path":"/reference/wbt_tool_help.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"Leaving tool_name default NULL returns results tools, work Windows.","code":""},{"path":"/reference/wbt_tool_help.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Help description for a specific tool in 'WhiteboxTools' — wbt_tool_help","text":"","code":"if (FALSE) { wbt_tool_help(\"lidar_info\") }"},{"path":"/reference/wbt_tool_parameters.html","id":null,"dir":"Reference","previous_headings":"","what":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"Retrieves tool parameter descriptions specific tool.","code":""},{"path":"/reference/wbt_tool_parameters.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"","code":"wbt_tool_parameters(tool_name, quiet = FALSE)"},{"path":"/reference/wbt_tool_parameters.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"tool_name name tool. quiet Prevent tool output printed. Default: FALSE","code":""},{"path":"/reference/wbt_tool_parameters.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"Returns tool parameter descriptions specific tool.","code":""},{"path":"/reference/wbt_tool_parameters.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"quiet argument can set TRUE allow \"quiet\" internal use within functions.","code":""},{"path":"/reference/wbt_tool_parameters.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Tool parameter descriptions for a specific tool in 'WhiteboxTools' — wbt_tool_parameters","text":"","code":"if (FALSE) { wbt_tool_parameters(\"lidar_info\") }"},{"path":"/reference/wbt_toolbox.html","id":null,"dir":"Reference","previous_headings":"","what":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"Retrieve toolbox specific tool.","code":""},{"path":"/reference/wbt_toolbox.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"","code":"wbt_toolbox(tool_name = NULL)"},{"path":"/reference/wbt_toolbox.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"tool_name name tool.","code":""},{"path":"/reference/wbt_toolbox.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"Returns toolbox specific tool.","code":""},{"path":"/reference/wbt_toolbox.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"Leaving tool_name default NULL returns results tools, work Windows.","code":""},{"path":"/reference/wbt_toolbox.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"The toolbox for a specific tool in WhiteboxTools — wbt_toolbox","text":"","code":"if (FALSE) { wbt_toolbox(\"breach_depressions\") }"},{"path":"/reference/wbt_tophat_transform.html","id":null,"dir":"Reference","previous_headings":"","what":"Tophat transform — wbt_tophat_transform","title":"Tophat transform — wbt_tophat_transform","text":"Performs either white black top-hat transform input image.","code":""},{"path":"/reference/wbt_tophat_transform.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tophat transform — wbt_tophat_transform","text":"","code":"wbt_tophat_transform(   input,   output,   filterx = 11,   filtery = 11,   variant = \"white\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tophat_transform.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tophat transform — wbt_tophat_transform","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. variant Optional variant value. Options include 'white' 'black'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tophat_transform.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tophat transform — wbt_tophat_transform","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_topo_render.html","id":null,"dir":"Reference","previous_headings":"","what":"Topo render — wbt_topo_render","title":"Topo render — wbt_topo_render","text":"tool creates pseudo-3D rendering input DEM, purpose effective topographic visualization.","code":""},{"path":"/reference/wbt_topo_render.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Topo render — wbt_topo_render","text":"","code":"wbt_topo_render(   dem,   output,   palette = \"soft\",   rev_palette = FALSE,   az = 315,   alt = 30,   background_hgt_offset = 10,   polygon = NULL,   background_clr = \"[255, 255, 255]\",   attenuation = 0.6,   ambient_light = 0.2,   z_factor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_topo_render.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Topo render — wbt_topo_render","text":"dem Name input digital elevation model (DEM) raster file. output Name output raster file. palette Palette name; options 'atlas', 'high_relief', 'arid', 'soft', 'earthtones', 'muted', 'light_quant', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', 'imhof', 'white'. rev_palette Reverse palette?. az Light source azimuth direction (degrees, 0-360). alt Light source altitude (degrees, 0-90). background_hgt_offset Offset height background, z-units. polygon Clipping polygon vector file (optional). background_clr Background red-green-blue (RGB) red-green-blue-alpha (RGBA) colour, e.g. '[255, 255, 245]', '[255, 255, 245, 200]'. attenuation Attenuation parameter. Range 0-4. Zero means attenuation. ambient_light Ambient light parameter. Range 0.0-0.7. Zero means ambient light. z_factor Elevation multiplier, vertical exageration. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_topo_render.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Topo render — wbt_topo_render","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_topographic_position_animation.html","id":null,"dir":"Reference","previous_headings":"","what":"Topographic position animation — wbt_topographic_position_animation","title":"Topographic position animation — wbt_topographic_position_animation","text":"tool creates animated GIF multi-scale local topographic position (elevation deviation).","code":""},{"path":"/reference/wbt_topographic_position_animation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Topographic position animation — wbt_topographic_position_animation","text":"","code":"wbt_topographic_position_animation(   input,   output,   palette = \"bl_yl_rd\",   min_scale = 1,   num_steps = 100,   step_nonlinearity = 1.5,   height = 600,   delay = 250,   label = \"\",   dev_max = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_topographic_position_animation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Topographic position animation — wbt_topographic_position_animation","text":"input Name input digital elevation model (DEM) raster file. output Name output HTML file (*.html). palette Image palette; options 'bl_yl_rd', 'bl_w_rd', 'purple', 'gn_yl', 'pi_y_g', 'viridis'. min_scale Minimum search neighbourhood radius grid cells. num_steps Number steps. step_nonlinearity Step nonlinearity factor (1.0-2.0 typical). height Image height, pixels. delay GIF time delay milliseconds. label Label text (leave blank none). dev_max want use DEVmax instead DEV measuring local topographic position?. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_topographic_position_animation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Topographic position animation — wbt_topographic_position_animation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_topological_stream_order.html","id":null,"dir":"Reference","previous_headings":"","what":"Topological stream order — wbt_topological_stream_order","title":"Topological stream order — wbt_topological_stream_order","text":"Assigns link stream network topological order.","code":""},{"path":"/reference/wbt_topological_stream_order.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Topological stream order — wbt_topological_stream_order","text":"","code":"wbt_topological_stream_order(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_topological_stream_order.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Topological stream order — wbt_topological_stream_order","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_topological_stream_order.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Topological stream order — wbt_topological_stream_order","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_total_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Total curvature — wbt_total_curvature","title":"Total curvature — wbt_total_curvature","text":"Calculates total curvature raster input DEM.","code":""},{"path":"/reference/wbt_total_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Total curvature — wbt_total_curvature","text":"","code":"wbt_total_curvature(   dem,   output,   log = FALSE,   zfactor = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_total_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Total curvature — wbt_total_curvature","text":"dem Input raster DEM file. output Output raster file. log Display output values using log-scale. zfactor Optional multiplier vertical horizontal units . wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_total_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Total curvature — wbt_total_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_total_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Total filter — wbt_total_filter","title":"Total filter — wbt_total_filter","text":"Performs total filter input image.","code":""},{"path":"/reference/wbt_total_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Total filter — wbt_total_filter","text":"","code":"wbt_total_filter(   input,   output,   filterx = 11,   filtery = 11,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_total_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Total filter — wbt_total_filter","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. filterx Size filter kernel x-direction. filtery Size filter kernel y-direction. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_total_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Total filter — wbt_total_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_trace_downslope_flowpaths.html","id":null,"dir":"Reference","previous_headings":"","what":"Trace downslope flowpaths — wbt_trace_downslope_flowpaths","title":"Trace downslope flowpaths — wbt_trace_downslope_flowpaths","text":"Traces downslope flowpaths one target sites (.e. seed points).","code":""},{"path":"/reference/wbt_trace_downslope_flowpaths.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Trace downslope flowpaths — wbt_trace_downslope_flowpaths","text":"","code":"wbt_trace_downslope_flowpaths(   seed_pts,   d8_pntr,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_trace_downslope_flowpaths.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Trace downslope flowpaths — wbt_trace_downslope_flowpaths","text":"seed_pts Input vector seed points file. d8_pntr Input D8 pointer raster file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_trace_downslope_flowpaths.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Trace downslope flowpaths — wbt_trace_downslope_flowpaths","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_travelling_salesman_problem.html","id":null,"dir":"Reference","previous_headings":"","what":"Travelling salesman problem — wbt_travelling_salesman_problem","title":"Travelling salesman problem — wbt_travelling_salesman_problem","text":"Finds approximate solutions travelling salesman problems, goal identify shortest route connecting set locations.","code":""},{"path":"/reference/wbt_travelling_salesman_problem.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Travelling salesman problem — wbt_travelling_salesman_problem","text":"","code":"wbt_travelling_salesman_problem(   input,   output,   duration = 60,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_travelling_salesman_problem.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Travelling salesman problem — wbt_travelling_salesman_problem","text":"input Name input points shapefile. output Name output lines shapefile. duration Maximum duration, seconds. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_travelling_salesman_problem.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Travelling salesman problem — wbt_travelling_salesman_problem","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_trend_surface.html","id":null,"dir":"Reference","previous_headings":"","what":"Trend surface — wbt_trend_surface","title":"Trend surface — wbt_trend_surface","text":"Estimates trend surface input raster file.","code":""},{"path":"/reference/wbt_trend_surface.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Trend surface — wbt_trend_surface","text":"","code":"wbt_trend_surface(   input,   output,   order = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_trend_surface.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Trend surface — wbt_trend_surface","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. order Polynomial order (1 10). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_trend_surface.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Trend surface — wbt_trend_surface","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_trend_surface_vector_points.html","id":null,"dir":"Reference","previous_headings":"","what":"Trend surface vector points — wbt_trend_surface_vector_points","title":"Trend surface vector points — wbt_trend_surface_vector_points","text":"Estimates trend surface vector points.","code":""},{"path":"/reference/wbt_trend_surface_vector_points.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Trend surface vector points — wbt_trend_surface_vector_points","text":"","code":"wbt_trend_surface_vector_points(   input,   field,   output,   cell_size,   order = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_trend_surface_vector_points.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Trend surface vector points — wbt_trend_surface_vector_points","text":"input Input vector Points file. field Input field name attribute table. output Output raster file. cell_size Optionally specified cell size output raster. used base raster specified. order Polynomial order (1 10). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_trend_surface_vector_points.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Trend surface vector points — wbt_trend_surface_vector_points","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_tributary_identifier.html","id":null,"dir":"Reference","previous_headings":"","what":"Tributary identifier — wbt_tributary_identifier","title":"Tributary identifier — wbt_tributary_identifier","text":"Assigns unique identifier tributary stream network.","code":""},{"path":"/reference/wbt_tributary_identifier.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tributary identifier — wbt_tributary_identifier","text":"","code":"wbt_tributary_identifier(   d8_pntr,   streams,   output,   esri_pntr = FALSE,   zero_background = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_tributary_identifier.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tributary identifier — wbt_tributary_identifier","text":"d8_pntr Input raster D8 pointer file. streams Input raster streams file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. zero_background Flag indicating whether background value zero used. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_tributary_identifier.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tributary identifier — wbt_tributary_identifier","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_truncate.html","id":null,"dir":"Reference","previous_headings":"","what":"Truncate — wbt_truncate","title":"Truncate — wbt_truncate","text":"Truncates values raster desired number decimal places.","code":""},{"path":"/reference/wbt_truncate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Truncate — wbt_truncate","text":"","code":"wbt_truncate(   input,   output,   num_decimals = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_truncate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Truncate — wbt_truncate","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. num_decimals Number decimals left truncation (default zero). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_truncate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Truncate — wbt_truncate","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_turning_bands_simulation.html","id":null,"dir":"Reference","previous_headings":"","what":"Turning bands simulation — wbt_turning_bands_simulation","title":"Turning bands simulation — wbt_turning_bands_simulation","text":"Creates image containing random values based turning-bands simulation.","code":""},{"path":"/reference/wbt_turning_bands_simulation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Turning bands simulation — wbt_turning_bands_simulation","text":"","code":"wbt_turning_bands_simulation(   base,   output,   range,   iterations = 1000,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_turning_bands_simulation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Turning bands simulation — wbt_turning_bands_simulation","text":"base Input base raster file. output Output file. range field's range, xy-units, related extent spatial autocorrelation. iterations number iterations. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_turning_bands_simulation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Turning bands simulation — wbt_turning_bands_simulation","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_two_sample_ks_test.html","id":null,"dir":"Reference","previous_headings":"","what":"Two sample ks test — wbt_two_sample_ks_test","title":"Two sample ks test — wbt_two_sample_ks_test","text":"Performs 2-sample K-S test significant differences two input rasters.","code":""},{"path":"/reference/wbt_two_sample_ks_test.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Two sample ks test — wbt_two_sample_ks_test","text":"","code":"wbt_two_sample_ks_test(   input1,   input2,   output,   num_samples = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_two_sample_ks_test.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Two sample ks test — wbt_two_sample_ks_test","text":"input1 First input raster file. input2 Second input raster file. output Output HTML file. num_samples Number samples. Leave blank use whole image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_two_sample_ks_test.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Two sample ks test — wbt_two_sample_ks_test","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_union.html","id":null,"dir":"Reference","previous_headings":"","what":"Union — wbt_union","title":"Union — wbt_union","text":"Splits vector layers overlaps, creating layer containing portions input overlay layers.","code":""},{"path":"/reference/wbt_union.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Union — wbt_union","text":"","code":"wbt_union(   input,   overlay,   output,   snap = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_union.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Union — wbt_union","text":"input Input vector file path. See wbt_file_path() details. overlay Input overlay vector file. output Output vector file. snap Snap tolerance. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_union.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Union — wbt_union","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_unnest_basins.html","id":null,"dir":"Reference","previous_headings":"","what":"Unnest basins — wbt_unnest_basins","title":"Unnest basins — wbt_unnest_basins","text":"Extract whole watersheds set outlet points.","code":""},{"path":"/reference/wbt_unnest_basins.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Unnest basins — wbt_unnest_basins","text":"","code":"wbt_unnest_basins(   d8_pntr,   pour_pts,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_unnest_basins.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Unnest basins — wbt_unnest_basins","text":"d8_pntr Input D8 pointer raster file. pour_pts Input vector pour points (outlet) file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_unnest_basins.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Unnest basins — wbt_unnest_basins","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_unsharp_masking.html","id":null,"dir":"Reference","previous_headings":"","what":"Unsharp masking — wbt_unsharp_masking","title":"Unsharp masking — wbt_unsharp_masking","text":"image sharpening technique enhances edges.","code":""},{"path":"/reference/wbt_unsharp_masking.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Unsharp masking — wbt_unsharp_masking","text":"","code":"wbt_unsharp_masking(   input,   output,   sigma = 0.75,   amount = 100,   threshold = 0,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_unsharp_masking.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Unsharp masking — wbt_unsharp_masking","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. sigma Standard deviation distance pixels. amount percentage controls magnitude overshoot. threshold Controls minimal brightness change sharpened. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_unsharp_masking.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Unsharp masking — wbt_unsharp_masking","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_unsphericity.html","id":null,"dir":"Reference","previous_headings":"","what":"Unsphericity — wbt_unsphericity","title":"Unsphericity — wbt_unsphericity","text":"tool calculates unsphericity curvature input DEM.","code":""},{"path":"/reference/wbt_unsphericity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Unsphericity — wbt_unsphericity","text":"","code":"wbt_unsphericity(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_unsphericity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Unsphericity — wbt_unsphericity","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_unsphericity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Unsphericity — wbt_unsphericity","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_update_nodata_cells.html","id":null,"dir":"Reference","previous_headings":"","what":"Update nodata cells — wbt_update_nodata_cells","title":"Update nodata cells — wbt_update_nodata_cells","text":"Replaces NoData values input raster corresponding values contained second update layer.","code":""},{"path":"/reference/wbt_update_nodata_cells.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update nodata cells — wbt_update_nodata_cells","text":"","code":"wbt_update_nodata_cells(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_update_nodata_cells.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update nodata cells — wbt_update_nodata_cells","text":"input1 Input raster file 1. input2 Input raster file 2; update layer. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_update_nodata_cells.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update nodata cells — wbt_update_nodata_cells","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_upslope_depression_storage.html","id":null,"dir":"Reference","previous_headings":"","what":"Upslope depression storage — wbt_upslope_depression_storage","title":"Upslope depression storage — wbt_upslope_depression_storage","text":"Estimates average upslope depression storage depth.","code":""},{"path":"/reference/wbt_upslope_depression_storage.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upslope depression storage — wbt_upslope_depression_storage","text":"","code":"wbt_upslope_depression_storage(   dem,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_upslope_depression_storage.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upslope depression storage — wbt_upslope_depression_storage","text":"dem Input raster DEM file. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_upslope_depression_storage.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Upslope depression storage — wbt_upslope_depression_storage","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_user_defined_weights_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"User ined weights filter — wbt_user_defined_weights_filter","title":"User ined weights filter — wbt_user_defined_weights_filter","text":"Performs user-defined weights filter image.","code":""},{"path":"/reference/wbt_user_defined_weights_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"User ined weights filter — wbt_user_defined_weights_filter","text":"","code":"wbt_user_defined_weights_filter(   input,   weights,   output,   center = \"center\",   normalize = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_user_defined_weights_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"User ined weights filter — wbt_user_defined_weights_filter","text":"input Input raster file path. See wbt_file_path() details. weights Input weights file. output Output raster file. center Kernel center cell; options include 'center', 'upper-left', 'upper-right', 'lower-left', 'lower-right'. normalize Normalize kernel weights? can reduce edge effects lessen impact data gaps (nodata) suited kernel weights sum zero. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_user_defined_weights_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"User ined weights filter — wbt_user_defined_weights_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_vector_hex_binning.html","id":null,"dir":"Reference","previous_headings":"","what":"Vector hex binning — wbt_vector_hex_binning","title":"Vector hex binning — wbt_vector_hex_binning","text":"Hex-bins set vector points.","code":""},{"path":"/reference/wbt_vector_hex_binning.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vector hex binning — wbt_vector_hex_binning","text":"","code":"wbt_vector_hex_binning(   input,   output,   width,   orientation = \"horizontal\",   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vector_hex_binning.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vector hex binning — wbt_vector_hex_binning","text":"input Input base file. output Output vector polygon file. width grid cell width. orientation Grid Orientation, 'horizontal' 'vertical'. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vector_hex_binning.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vector hex binning — wbt_vector_hex_binning","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_vector_lines_to_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Vector lines to raster — wbt_vector_lines_to_raster","title":"Vector lines to raster — wbt_vector_lines_to_raster","text":"Converts vector containing polylines raster.","code":""},{"path":"/reference/wbt_vector_lines_to_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vector lines to raster — wbt_vector_lines_to_raster","text":"","code":"wbt_vector_lines_to_raster(   input,   output,   field = \"FID\",   nodata = TRUE,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vector_lines_to_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vector lines to raster — wbt_vector_lines_to_raster","text":"input Input vector lines file. output Output raster file. field Input field name attribute table. nodata Background value set NoData. Without flag, set 0.0. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vector_lines_to_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vector lines to raster — wbt_vector_lines_to_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_vector_points_to_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Vector points to raster — wbt_vector_points_to_raster","title":"Vector points to raster — wbt_vector_points_to_raster","text":"Converts vector containing points raster.","code":""},{"path":"/reference/wbt_vector_points_to_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vector points to raster — wbt_vector_points_to_raster","text":"","code":"wbt_vector_points_to_raster(   input,   output,   field = \"FID\",   assign = \"last\",   nodata = TRUE,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vector_points_to_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vector points to raster — wbt_vector_points_to_raster","text":"input Input vector Points file. output Output raster file. field Input field name attribute table. assign Assignment operation, multiple points grid cell; options include 'first', 'last' (default), 'min', 'max', 'sum', 'number'. nodata Background value set NoData. Without flag, set 0.0. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vector_points_to_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vector points to raster — wbt_vector_points_to_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_vector_polygons_to_raster.html","id":null,"dir":"Reference","previous_headings":"","what":"Vector polygons to raster — wbt_vector_polygons_to_raster","title":"Vector polygons to raster — wbt_vector_polygons_to_raster","text":"Converts vector containing polygons raster.","code":""},{"path":"/reference/wbt_vector_polygons_to_raster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vector polygons to raster — wbt_vector_polygons_to_raster","text":"","code":"wbt_vector_polygons_to_raster(   input,   output,   field = \"FID\",   nodata = TRUE,   cell_size = NULL,   base = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vector_polygons_to_raster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vector polygons to raster — wbt_vector_polygons_to_raster","text":"input Input vector polygons file. output Output raster file. field Input field name attribute table. nodata Background value set NoData. Without flag, set 0.0. cell_size Optionally specified cell size output raster. used base raster specified. base Optionally specified input base raster file. used cell size specified. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vector_polygons_to_raster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vector polygons to raster — wbt_vector_polygons_to_raster","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_vector_stream_network_analysis.html","id":null,"dir":"Reference","previous_headings":"","what":"Vector stream network analysis — wbt_vector_stream_network_analysis","title":"Vector stream network analysis — wbt_vector_stream_network_analysis","text":"tool performs common stream network analysis operations input vector stream file.","code":""},{"path":"/reference/wbt_vector_stream_network_analysis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vector stream network analysis — wbt_vector_stream_network_analysis","text":"","code":"wbt_vector_stream_network_analysis(   streams,   output,   snap = 0.1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vector_stream_network_analysis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vector stream network analysis — wbt_vector_stream_network_analysis","text":"streams Name input streams vector file. output Name output lines shapefile. snap Snap distance, xy units (metres). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vector_stream_network_analysis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vector stream network analysis — wbt_vector_stream_network_analysis","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Version information for 'WhiteboxTools' — wbt_version","title":"Version information for 'WhiteboxTools' — wbt_version","text":"Version information 'WhiteboxTools'","code":""},{"path":"/reference/wbt_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Version information for 'WhiteboxTools' — wbt_version","text":"","code":"wbt_version(extract = FALSE)"},{"path":"/reference/wbt_version.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Version information for 'WhiteboxTools' — wbt_version","text":"extract Extract semantic version number first line result? Default: FALSE","code":""},{"path":"/reference/wbt_version.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Version information for 'WhiteboxTools' — wbt_version","text":"Returns version information 'WhiteboxTools' R character vector.","code":""},{"path":"/reference/wbt_version.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Version information for 'WhiteboxTools' — wbt_version","text":"","code":"if (FALSE) { wbt_version() }"},{"path":"/reference/wbt_vertical_excess_curvature.html","id":null,"dir":"Reference","previous_headings":"","what":"Vertical excess curvature — wbt_vertical_excess_curvature","title":"Vertical excess curvature — wbt_vertical_excess_curvature","text":"tool calculates vertical excess curvature input DEM.","code":""},{"path":"/reference/wbt_vertical_excess_curvature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vertical excess curvature — wbt_vertical_excess_curvature","text":"","code":"wbt_vertical_excess_curvature(   dem,   output,   log = FALSE,   zfactor = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_vertical_excess_curvature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vertical excess curvature — wbt_vertical_excess_curvature","text":"dem Name input raster DEM file. output Name output raster image file. log Display output values using log-scale. zfactor Z conversion factor. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_vertical_excess_curvature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Vertical excess curvature — wbt_vertical_excess_curvature","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_view_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","title":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","text":"Opens web browser view source code specific tool projects source code repository.","code":""},{"path":"/reference/wbt_view_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","text":"","code":"wbt_view_code(tool_name, viewer = FALSE)"},{"path":"/reference/wbt_view_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","text":"tool_name Name tool. viewer Show source code browser? default: TRUE","code":""},{"path":"/reference/wbt_view_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","text":"Returns GitHub URL view source code tool.","code":""},{"path":"/reference/wbt_view_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Source code for a specific tool in 'WhiteboxTools' — wbt_view_code","text":"","code":"if (FALSE) { wbt_view_code(\"breach_depressions\") }"},{"path":"/reference/wbt_viewshed.html","id":null,"dir":"Reference","previous_headings":"","what":"Viewshed — wbt_viewshed","title":"Viewshed — wbt_viewshed","text":"Identifies viewshed point set points.","code":""},{"path":"/reference/wbt_viewshed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Viewshed — wbt_viewshed","text":"","code":"wbt_viewshed(   dem,   stations,   output,   height = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_viewshed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Viewshed — wbt_viewshed","text":"dem Input raster DEM file. stations Input viewing station vector file. output Output raster file. height Viewing station height, z units. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_viewshed.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Viewshed — wbt_viewshed","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_visibility_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Visibility index — wbt_visibility_index","title":"Visibility index — wbt_visibility_index","text":"Estimates relative visibility sites DEM.","code":""},{"path":"/reference/wbt_visibility_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Visibility index — wbt_visibility_index","text":"","code":"wbt_visibility_index(   dem,   output,   height = 2,   res_factor = 2,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_visibility_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Visibility index — wbt_visibility_index","text":"dem Input raster DEM file. output Output raster file. height Viewing station height, z units. res_factor resolution factor determines density measured viewsheds. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_visibility_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Visibility index — wbt_visibility_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_voronoi_diagram.html","id":null,"dir":"Reference","previous_headings":"","what":"Voronoi diagram — wbt_voronoi_diagram","title":"Voronoi diagram — wbt_voronoi_diagram","text":"Creates vector Voronoi diagram set vector points.","code":""},{"path":"/reference/wbt_voronoi_diagram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Voronoi diagram — wbt_voronoi_diagram","text":"","code":"wbt_voronoi_diagram(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_voronoi_diagram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Voronoi diagram — wbt_voronoi_diagram","text":"input Input vector points file. output Output vector polygon file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_voronoi_diagram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Voronoi diagram — wbt_voronoi_diagram","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_watershed.html","id":null,"dir":"Reference","previous_headings":"","what":"Watershed — wbt_watershed","title":"Watershed — wbt_watershed","text":"Identifies watershed, drainage basin, draining set target cells.","code":""},{"path":"/reference/wbt_watershed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Watershed — wbt_watershed","text":"","code":"wbt_watershed(   d8_pntr,   pour_pts,   output,   esri_pntr = FALSE,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_watershed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Watershed — wbt_watershed","text":"d8_pntr Input D8 pointer raster file. pour_pts Input pour points (outlet) file. output Output raster file. esri_pntr D8 pointer uses ESRI style scheme. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_watershed.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Watershed — wbt_watershed","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_weighted_overlay.html","id":null,"dir":"Reference","previous_headings":"","what":"Weighted overlay — wbt_weighted_overlay","title":"Weighted overlay — wbt_weighted_overlay","text":"Performs weighted sum multiple input rasters converting image common scale. tool performs multi-criteria evaluation (MCE).","code":""},{"path":"/reference/wbt_weighted_overlay.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Weighted overlay — wbt_weighted_overlay","text":"","code":"wbt_weighted_overlay(   factors,   weights,   output,   cost = NULL,   constraints = NULL,   scale_max = 1,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_weighted_overlay.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Weighted overlay — wbt_weighted_overlay","text":"factors Input factor raster files. weights Weight values, contained quotes separated commas semicolons. Must number factors. output Output raster file. cost Boolean array indicating factors cost factors, contained quotes separated commas semicolons. Must number factors. constraints Input constraints raster files. scale_max Suitability scale maximum value (common values 1.0, 100.0, 255.0). wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_weighted_overlay.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Weighted overlay — wbt_weighted_overlay","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_weighted_sum.html","id":null,"dir":"Reference","previous_headings":"","what":"Weighted sum — wbt_weighted_sum","title":"Weighted sum — wbt_weighted_sum","text":"Performs weighted-sum overlay multiple input raster images.","code":""},{"path":"/reference/wbt_weighted_sum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Weighted sum — wbt_weighted_sum","text":"","code":"wbt_weighted_sum(   inputs,   weights,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_weighted_sum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Weighted sum — wbt_weighted_sum","text":"inputs Input raster file paths, concatenated \",\" \";\". See wbt_file_path() details. weights Weight values, contained quotes separated commas semicolons. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_weighted_sum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Weighted sum — wbt_weighted_sum","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_wetness_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Wetness index — wbt_wetness_index","title":"Wetness index — wbt_wetness_index","text":"Calculates topographic wetness index, Ln(/ tan(slope)).","code":""},{"path":"/reference/wbt_wetness_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wetness index — wbt_wetness_index","text":"","code":"wbt_wetness_index(   sca,   slope,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_wetness_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wetness index — wbt_wetness_index","text":"sca Input raster specific contributing area (SCA) file. slope Input raster slope file (degrees). output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_wetness_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Wetness index — wbt_wetness_index","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_wilcoxon_signed_rank_test.html","id":null,"dir":"Reference","previous_headings":"","what":"Wilcoxon signed rank test — wbt_wilcoxon_signed_rank_test","title":"Wilcoxon signed rank test — wbt_wilcoxon_signed_rank_test","text":"Performs 2-sample K-S test significant differences two input rasters.","code":""},{"path":"/reference/wbt_wilcoxon_signed_rank_test.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wilcoxon signed rank test — wbt_wilcoxon_signed_rank_test","text":"","code":"wbt_wilcoxon_signed_rank_test(   input1,   input2,   output,   num_samples = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_wilcoxon_signed_rank_test.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wilcoxon signed rank test — wbt_wilcoxon_signed_rank_test","text":"input1 First input raster file. input2 Second input raster file. output Output HTML file. num_samples Number samples. Leave blank use whole image. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_wilcoxon_signed_rank_test.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Wilcoxon signed rank test — wbt_wilcoxon_signed_rank_test","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_write_function_memory_insertion.html","id":null,"dir":"Reference","previous_headings":"","what":"Write function memory insertion — wbt_write_function_memory_insertion","title":"Write function memory insertion — wbt_write_function_memory_insertion","text":"Performs write function memory insertion single-band multi-date change detection.","code":""},{"path":"/reference/wbt_write_function_memory_insertion.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Write function memory insertion — wbt_write_function_memory_insertion","text":"","code":"wbt_write_function_memory_insertion(   input1,   input2,   output,   input3 = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_write_function_memory_insertion.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Write function memory insertion — wbt_write_function_memory_insertion","text":"input1 Input raster file associated first date. input2 Input raster file associated second date. output Output raster file. input3 Optional input raster file associated third date. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_write_function_memory_insertion.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Write function memory insertion — wbt_write_function_memory_insertion","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_xor.html","id":null,"dir":"Reference","previous_headings":"","what":"Xor — wbt_xor","title":"Xor — wbt_xor","text":"Performs logical XOR operator two Boolean raster images.","code":""},{"path":"/reference/wbt_xor.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Xor — wbt_xor","text":"","code":"wbt_xor(   input1,   input2,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_xor.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Xor — wbt_xor","text":"input1 Input raster file path. See wbt_file_path() details. input2 Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_xor.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Xor — wbt_xor","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_yield_filter.html","id":null,"dir":"Reference","previous_headings":"","what":"Yield filter — wbt_yield_filter","title":"Yield filter — wbt_yield_filter","text":"Filters crop yield values point data derived combine harvester yield monitors.","code":""},{"path":"/reference/wbt_yield_filter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Yield filter — wbt_yield_filter","text":"","code":"wbt_yield_filter(   input,   yield_field,   pass_field,   output,   width = 6.096,   z_score_threshold = 2.5,   min_yield = 0,   max_yield = 99999.9,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_yield_filter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Yield filter — wbt_yield_filter","text":"input Name input points shapefile. yield_field Name attribute containing yield data. pass_field Name attribute containing pass line ID. output Name output points shapefile. width Pass swath width (m). z_score_threshold Z-score threshold value (default=2.5). min_yield Minimum yield value output. max_yield Maximum yield value output. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_yield_filter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Yield filter — wbt_yield_filter","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_yield_map.html","id":null,"dir":"Reference","previous_headings":"","what":"Yield map — wbt_yield_map","title":"Yield map — wbt_yield_map","text":"tool can used create segmented-vector polygon yield map set harvester points.","code":""},{"path":"/reference/wbt_yield_map.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Yield map — wbt_yield_map","text":"","code":"wbt_yield_map(   input,   pass_field_name,   output,   width = 6.096,   max_change_in_heading = 25,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_yield_map.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Yield map — wbt_yield_map","text":"input Name input points shapefile. pass_field_name Name attribute containing pass line ID. output Name output polygon shapefile. width Pass swath width (m). max_change_in_heading Max change heading. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_yield_map.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Yield map — wbt_yield_map","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_yield_normalization.html","id":null,"dir":"Reference","previous_headings":"","what":"Yield normalization — wbt_yield_normalization","title":"Yield normalization — wbt_yield_normalization","text":"tool can used normalize yield points field.","code":""},{"path":"/reference/wbt_yield_normalization.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Yield normalization — wbt_yield_normalization","text":"","code":"wbt_yield_normalization(   input,   yield_field,   output,   standardize = FALSE,   radius = NULL,   min_yield = 0,   max_yield = 99999.9,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_yield_normalization.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Yield normalization — wbt_yield_normalization","text":"input Name input points shapefile. yield_field Name attribute containing yield data. output Name output points shapefile. standardize yield values standardized (converted z-scores) rather normalized?. radius Optional search radius, metres. specify value want calculate locally normalized yield. min_yield Minimum yield value output. max_yield Maximum yield value output. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_yield_normalization.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Yield normalization — wbt_yield_normalization","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_z_scores.html","id":null,"dir":"Reference","previous_headings":"","what":"Z scores — wbt_z_scores","title":"Z scores — wbt_z_scores","text":"Standardizes values input raster converting z-scores.","code":""},{"path":"/reference/wbt_z_scores.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Z scores — wbt_z_scores","text":"","code":"wbt_z_scores(   input,   output,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_z_scores.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Z scores — wbt_z_scores","text":"input Input raster file path. See wbt_file_path() details. output Output raster file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_z_scores.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Z scores — wbt_z_scores","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_zlidar_to_las.html","id":null,"dir":"Reference","previous_headings":"","what":"Zlidar to las — wbt_zlidar_to_las","title":"Zlidar to las — wbt_zlidar_to_las","text":"Converts one zlidar files LAS data format.","code":""},{"path":"/reference/wbt_zlidar_to_las.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Zlidar to las — wbt_zlidar_to_las","text":"","code":"wbt_zlidar_to_las(   inputs = NULL,   outdir = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_zlidar_to_las.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Zlidar to las — wbt_zlidar_to_las","text":"inputs Input ZLidar files. outdir Output directory zlidar files created. unspecified, assumed inputs. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_zlidar_to_las.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Zlidar to las — wbt_zlidar_to_las","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbt_zonal_statistics.html","id":null,"dir":"Reference","previous_headings":"","what":"Zonal statistics — wbt_zonal_statistics","title":"Zonal statistics — wbt_zonal_statistics","text":"Extracts descriptive statistics group patches raster.","code":""},{"path":"/reference/wbt_zonal_statistics.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Zonal statistics — wbt_zonal_statistics","text":"","code":"wbt_zonal_statistics(   input,   features,   output = NULL,   stat = \"mean\",   out_table = NULL,   wd = NULL,   verbose_mode = NULL,   compress_rasters = NULL,   command_only = FALSE )"},{"path":"/reference/wbt_zonal_statistics.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Zonal statistics — wbt_zonal_statistics","text":"input Input data raster file. features Input feature definition raster file. output Output raster file. stat Statistic extract, including 'mean', 'median', 'minimum', 'maximum', 'range', 'standard deviation', 'total'. out_table Output HTML Table file. wd Changes working directory. Default: NULL use value WhiteboxTools settings, see wbt_wd() details. verbose_mode Sets verbose mode. verbose mode FALSE, tools print output messages. Default: NULL use value WhiteboxTools settings, see wbt_verbose() details. compress_rasters Sets flag used 'WhiteboxTools' determine whether use compression output rasters. Default: NULL use value WhiteboxTools settings, see wbt_compress_rasters() details. command_only Return command executed system() rather running tool. Default: FALSE.","code":""},{"path":"/reference/wbt_zonal_statistics.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Zonal statistics — wbt_zonal_statistics","text":"Returns tool text outputs.","code":""},{"path":"/reference/wbttoolparameters.html","id":null,"dir":"Reference","previous_headings":"","what":"'WhiteboxTools' Tool Parameters — wbttoolparameters","title":"'WhiteboxTools' Tool Parameters — wbttoolparameters","text":"data set data.frame containing tool parameters associated metadata","code":""},{"path":"/reference/wbttoolparameters.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"'WhiteboxTools' Tool Parameters — wbttoolparameters","text":"","code":"wbttoolparameters"},{"path":"/reference/wbttoolparameters.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"'WhiteboxTools' Tool Parameters — wbttoolparameters","text":"object class data.frame 2198 rows 13 columns.","code":""},{"path":"/reference/wbttoolparameters.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"'WhiteboxTools' Tool Parameters — wbttoolparameters","text":"WhiteboxTools","code":""},{"path":"/reference/wbttoolparameters.html","id":"variables","dir":"Reference","previous_headings":"","what":"Variables","title":"'WhiteboxTools' Tool Parameters — wbttoolparameters","text":"\"function_name\" - R function name \"tool_name\" - 'WhiteboxTools' tool name \"name\" - parameter name \"flags\" - flags used specify parameter command line; comma separated \"description\" - parameter description \"parameter_class\" - parameter type \"parameter_detail\" - parameter details; character: data type followed colon specifics, OptionList possible values, comma-separated (defined) \"default_value\" - parameter default value, \"optional\" - parameter \"optional\" flag; note combination optional parameters may required certain conditions \"label\" - labels selected subset \"flags\" used R function argument names wbt_ functions \"is_input\" - logical. Classification 'input' parameters \"is_output\" - logical. Classification 'output' parameters","code":""},{"path":[]},{"path":"/reference/wbttools.html","id":null,"dir":"Reference","previous_headings":"","what":"'WhiteboxTools' Tool List — wbttools","title":"'WhiteboxTools' Tool List — wbttools","text":"data set data.frame containing tools name associated R function name","code":""},{"path":"/reference/wbttools.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"'WhiteboxTools' Tool List — wbttools","text":"","code":"wbttools"},{"path":"/reference/wbttools.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"'WhiteboxTools' Tool List — wbttools","text":"object class data.frame 537 rows 8 columns.","code":""},{"path":"/reference/wbttools.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"'WhiteboxTools' Tool List — wbttools","text":"WhiteboxTools","code":""},{"path":"/reference/wbttools.html","id":"variables","dir":"Reference","previous_headings":"","what":"Variables","title":"'WhiteboxTools' Tool List — wbttools","text":"\"tool_name\" - 'WhiteboxTools' tool name \"function_name\" - R function name \"toolbox_name\" - 'WhiteboxTools' toolbox name \"label\" - 'WhiteboxTools' tool label \"description\" - Brief description \"github\" - Link related code 'GitHub' \"book\" - Link 'WhiteboxTools' Manual \"is_extension\" - Tool part 'General Toolset Extension' (GTE), opposed \"open core\"","code":""},{"path":[]},{"path":"/reference/whitebox-package.html","id":null,"dir":"Reference","previous_headings":"","what":"whitebox: 'WhiteboxTools' R Frontend — whitebox-package","title":"whitebox: 'WhiteboxTools' R Frontend — whitebox-package","text":"R frontend 'WhiteboxTools' library, advanced geospatial data analysis platform developed Prof. John Lindsay University Guelph's Geomorphometry Hydrogeomatics Research Group. 'WhiteboxTools' can used perform common geographical information systems (GIS) analysis operations, cost-distance analysis, distance buffering, raster reclassification. Remote sensing image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), common image transformations. 'WhiteboxTools' also contains advanced tooling spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), LiDAR data processing. Suggested citation: Lindsay (2016) doi:10.1016/j.cageo.2016.07.003 .","code":""},{"path":"/reference/whitebox-package.html","id":"package-options","dir":"Reference","previous_headings":"","what":"Package options","title":"whitebox: 'WhiteboxTools' R Frontend — whitebox-package","text":"whitebox.exe_path - character. Path executable file. default value package installation directory, subdirectory \"WBT\", followed whitebox_tools.exe whitebox_tools. Set whitebox.exe_path option using wbt_init() exe_path argument whitebox.wd - character. Path WhiteboxTools working directory. Used --wd argument tools support wd specified elsewhere. Note set working directory, directory needs reset \"replace\" old value; just dropping flag change working directory back original R working directory. \"unset\" option R package can use wbt_wd(\"\") equivalent wbt_wd(getwd()). WhiteboxTools settings package settings updated reflect directory change running next tool --wd flag dropped system calls. whitebox.verbose - logical. standard output calls executable cat() readability? Default result interactive(). Individual tools may verbose_mode setting produce single-line output FALSE. argument values left defaults defined package documentation function. whitebox.verbose=FALSE output produced. Set value whitebox.verbose wbt_verbose() verbose argument. whitebox.compress_rasters - logical. raster output WhiteboxTools compressed? Default: FALSE. Set value whitebox.compress_rasters wbt_compress_rasters() compress_rasters argument. whitebox.max_procs - integer. Maximum number processes tools run parallel partially parallelize. Default: -1 uses available cores. package options can overridden system environment variables: R_WHITEBOX_EXE_PATH, R_WHITEBOX_WD, R_WHITEBOX_VERBOSE, R_WHITEBOX_COMPRESS_RASTERS R_WHITEBOX_MAX_PROCS.","code":""},{"path":[]},{"path":"/reference/whitebox-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"whitebox: 'WhiteboxTools' R Frontend — whitebox-package","text":"Maintainer: Andrew Brown brown.andrewg@gmail.com [contributor] Authors: Qiusheng Wu giswqs@gmail.com","code":""},{"path":"/news/index.html","id":"whitebox-240","dir":"Changelog","previous_headings":"","what":"whitebox 2.4.0","title":"whitebox 2.4.0","text":"Updates WhiteboxTools v2.4.0 (https://github.com/jblindsay/whitebox-tools/releases/tag/v2.4.0) Fix new ZIP file folder structure WhiteboxTools v2.4.0+ wbt_install() / install_whitebox()","code":""},{"path":"/news/index.html","id":"whitebox-234","dir":"Changelog","previous_headings":"","what":"whitebox 2.3.4","title":"whitebox 2.3.4","text":"CRAN release: 2023-11-18 Exported wbt_file_path(), function previously used internally creating safe, expanded, quoted, paths building WhiteboxTools commands. function also supports input terra objects backed file sources supported WhiteboxTools.","code":""},{"path":"/news/index.html","id":"whitebox-233","dir":"Changelog","previous_headings":"","what":"whitebox 2.3.3","title":"whitebox 2.3.3","text":"default values compress_rasters verbose_mode set NULL better reflect derived WhiteboxTools settings.json file. See wbt_options() details. user specifies arguments wbt_*() function call flag passed command line call. Otherwise default NULL value ignored. Links corresponding option-setting functions added documentation wbt_*() tool functions.","code":""},{"path":"/news/index.html","id":"whitebox-232","dir":"Changelog","previous_headings":"","what":"whitebox 2.3.2","title":"whitebox 2.3.2","text":"Fix file paths passed optional base argument wbt_resample(); thanks @Pentaonia reporting Also fixed : wbt_vector_lines_to_raster(), wbt_vector_points_to_raster(), wbt_vector_polygons_to_raster(), wbt_block_maximum_gridding(), wbt_block_minimum_gridding(), wbt_heat_map(), wbt_idw_interpolation(), wbt_natural_neighbour_interpolation(), wbt_nearest_neighbour_gridding(), wbt_radial_basis_function_interpolation(), wbt_tin_gridding()","code":""},{"path":"/news/index.html","id":"whitebox-231","dir":"Changelog","previous_headings":"","what":"whitebox 2.3.1","title":"whitebox 2.3.1","text":"CRAN release: 2023-06-07 wbt_install() wbt_install_extension() gain optional platform argument used suffix ZIP file, allowing download alternate binaries Linux macOS (Darwin). Add wbt_runner_path() (analog wbt_exe_path() whitebox_runner GUI executable) wbt_launch_runner() simple function launch GUI. wbt_wd(\"\") now sets value working_directory WhiteboxTools settings.json file \"\" triggers background options prevent --wd flag added new working directory set. long-standing issue, resolved following https://github.com/opengeos/whiteboxR/issues/108.","code":""},{"path":"/news/index.html","id":"whitebox-230","dir":"Changelog","previous_headings":"","what":"whitebox 2.3.0","title":"whitebox 2.3.0","text":"CRAN release: 2023-03-29 Updates WhiteboxTools v2.3.0 (https://github.com/jblindsay/whitebox-tools/releases/tag/v2.3.0) Add wbt(), wbt_source(), related methods; new functionality calling tools name various R object types input. See wbt() method vignette details.","code":""},{"path":"/news/index.html","id":"whitebox-221","dir":"Changelog","previous_headings":"","what":"whitebox 2.2.1","title":"whitebox 2.2.1","text":"Adds wbt_data_dir() managing WhiteboxTools “WBT” directory installed. new default path preferred location generated tools::R_user_dir(package=\"whitebox\") R 4.0+ \"whitebox_tools\" found PATH, longer need custom setup whitebox.exe_path. path options detected automatically via Sys.(\"whitebox_tools\"). Custom options set within session environment take precedence PATH.","code":""},{"path":"/news/index.html","id":"whitebox-220","dir":"Changelog","previous_headings":"","what":"whitebox 2.2.0","title":"whitebox 2.2.0","text":"CRAN release: 2022-10-27 Updates WhiteboxTools v2.2.0 wbt_rust_backtrace(), helper method debugging Rust-related failures command-line tool, now exported wbt_run_tool(): Fix potentially length > 1 logic () statement error status messages avoid warnings/future errors download.file() method=\"wininet\" deprecated longer possible set methods try Windows download fails","code":""},{"path":"/news/index.html","id":"whitebox-215","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.5","title":"whitebox 2.1.5","text":"CRAN release: 2022-07-11 Added wbt_install_extension() wbt_activate() downloading, installing activating WhiteboxTools extensions wbt_internal_tool_name() now returns tool names CamelCase, tool names passed via command line","code":""},{"path":"/news/index.html","id":"whitebox-214","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.4","title":"whitebox 2.1.4","text":"CRAN release: 2022-05-15 Suggest {terra} instead {raster} update demo vignette accordingly; drops {rgdal} suggest Add support path expansion wd arguments passed directly tool functions; already supported methods setting working directory Updates wbttools wbttoolparameters datasets Fix argument_name='k' Remove several one two character flag aliases argument_name replace full name Add support showing warning messages regular interactive/verbose mode, thanks @alenahav reporting issue (https://github.com/opengeos/whiteboxR/issues/75) wbt_fd8_flow_accumulation() Functions take multiple files auto-quoted default; thanks François-Nicolas Robinne reporting issue (@FNRobinne; https://github.com/opengeos/whiteboxR/issues/55) wbt_mosaic() Error output now verbose, ensuring relevant tool output displayed user error regardless verbosity, platform, etc. Thanks Jeffrey W. Rozelle reporting issue (@jwilliamrozelle; https://github.com/opengeos/whiteboxR/issues/80) getting error messages unsupported raster types","code":""},{"path":"/news/index.html","id":"whitebox-213","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.3","title":"whitebox 2.1.3","text":"Generated whitebox_tools commands longer include flags default arguments stored settings.json unless specified user. Updates fix issues permissions write settings.json; thanks Henrik (@hewag1975) reporting problems Shiny Server (https://github.com/opengeos/whiteboxR/issues/67) wbt_install() / install_whitebox() now removes downloaded zip file exit thanks Christoph Stepper (@cstepper; https://github.com/opengeos/whiteboxR/issues/72) New default arguments wbt_list_tools(), wbt_time_in_daylight(), wbt_shadow_image() thanks Jens Wiesehahn (@wiesehahn; https://github.com/opengeos/whiteboxR/issues/70, https://github.com/opengeos/whiteboxR/issues/73)","code":""},{"path":"/news/index.html","id":"whitebox-212","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.2","title":"whitebox 2.1.2","text":"CRAN release: 2022-03-21 Fixes regression checking “Demo” vignette CRAN","code":""},{"path":"/news/index.html","id":"whitebox-211","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.1","title":"whitebox 2.1.1","text":"CRAN release: 2022-03-15 File path arguments tools now automatically perform path expansion (converting ~ home directory path.expand()). also works arguments contain comma semicolon delimited lists. (https://github.com/opengeos/whiteboxR/issues/62) Corrections wbttoolparameters dataset (updated classification input/output parameters) Fix wbt_lidar_tin_gridding() exclude_cls argument Add wbt_compress_rasters() set package option whitebox.compress_rasters Updated --compress_rasters parameter passed via command line. Now flag added commands regardless whether value TRUE FALSE. allows update settings.json accordingly --compress_rasters=FALSE. RE: https://github.com/jblindsay/whitebox-tools/issues/233#issuecomment-1065955783 Add wbt_max_procs() set package option whitebox.max_procs wbt_*() tool functions now take command_only argument passed wbt_run_tool(). TRUE, function returns command run system() instead running tool.","code":""},{"path":"/news/index.html","id":"whitebox-210","dir":"Changelog","previous_headings":"","what":"whitebox 2.1.0","title":"whitebox 2.1.0","text":"CRAN release: 2022-02-11 Update WhiteboxTools v2.1.0 See https://www.whiteboxgeo.com/whitebox-geospatial-news/ details","code":""},{"path":"/news/index.html","id":"whitebox-200","dir":"Changelog","previous_headings":"","what":"whitebox 2.0.0","title":"whitebox 2.0.0","text":"CRAN release: 2021-09-10 Update WhiteboxTools v2.0.0 See https://github.com/jblindsay/whitebox-tools/releases/tag/v2.0.0 details Enhancements: whitebox::install_whitebox() call wbt_init() exe_path unpacking target directory wbt_init() exe_path, wbt_wd() wd, install_whitebox() pkg_dir paths can specified shorthand ~ home directory, expanded path.expand() Unsetting working directories requires single call wbt_wd(\"\") Functions longer use match.call() unconventional/automated methods calling tools parsable tool name call result now work (#45)","code":""},{"path":"/news/index.html","id":"whitebox-151","dir":"Changelog","previous_headings":"","what":"whitebox 1.5.1","title":"whitebox 1.5.1","text":"Add package options custom EXE path verbosity Changes behavior wbt_init(); now checks EXE path Adds install_whitebox() handle downloading installing WhiteboxTools","code":""},{"path":"/news/index.html","id":"new-package-options-1-5-1","dir":"Changelog","previous_headings":"","what":"New package options","title":"whitebox 1.5.1","text":"wbt_init() can set options call custom EXE path. wbt_options() returns current option values Use system environment variable (R_WHITEBOX_EXE_PATH) package option (whitebox.exe_path) Get / set wbt_init(). Verbosity controlled (R_WHITEBOX_VERBOSE) package option (whitebox.verbose) Get / set wbt_verbose() Working directory controlled (R_WHITEBOX_WD) package option (whitebox.wd) Get / set wbt_wd() New “whitebox Demo” vignette New data wbttools wbttoolparameters data.frame built WhiteboxTools v1.5.0 wbt_tool_parameters() output full tool library See “whitebox Tool Metadata” vignette","code":""},{"path":"/news/index.html","id":"whitebox-150","dir":"Changelog","previous_headings":"","what":"whitebox 1.5.0","title":"whitebox 1.5.0","text":"Update WhiteboxTools v1.5.0 information version can found https://github.com/jblindsay/whitebox-tools/releases/tag/1.5.0 info.","code":""},{"path":"/news/index.html","id":"whitebox-140","dir":"Changelog","previous_headings":"","what":"whitebox 1.4.0","title":"whitebox 1.4.0","text":"Update WhiteboxTools v1.4.0 information version can found https://github.com/jblindsay/whitebox-tools/releases/tag/v1.4.0","code":""},{"path":"/news/index.html","id":"whitebox-131","dir":"Changelog","previous_headings":"","what":"whitebox 1.3.1","title":"whitebox 1.3.1","text":"Update WhiteboxTools v1.3.1 information version can found https://github.com/jblindsay/whitebox-tools/releases/tag/v1.3.1","code":""},{"path":"/news/index.html","id":"whitebox-130","dir":"Changelog","previous_headings":"","what":"whitebox 1.3.0","title":"whitebox 1.3.0","text":"Update WhiteboxTools v1.3.0","code":""},{"path":"/news/index.html","id":"whitebox-110","dir":"Changelog","previous_headings":"","what":"whitebox 1.1.0","title":"whitebox 1.1.0","text":"Update WhiteboxTools v1.1.0","code":""},{"path":"/news/index.html","id":"whitebox-102","dir":"Changelog","previous_headings":"","what":"whitebox 1.0.2","title":"whitebox 1.0.2","text":"Update WhiteboxTools v1.0.2","code":""},{"path":"/news/index.html","id":"whitebox-101","dir":"Changelog","previous_headings":"","what":"whitebox 1.0.1","title":"whitebox 1.0.1","text":"Prep v1.0.1","code":""},{"path":"/news/index.html","id":"whitebox-050","dir":"Changelog","previous_headings":"","what":"whitebox 0.5.0","title":"whitebox 0.5.0","text":"Fix bugs logical parameters","code":""},{"path":"/news/index.html","id":"whitebox-030","dir":"Changelog","previous_headings":"","what":"whitebox 0.3.0","title":"whitebox 0.3.0","text":"update WhiteboxTools v0.15.0","code":""},{"path":"/news/index.html","id":"whitebox-020","dir":"Changelog","previous_headings":"","what":"whitebox 0.2.0","title":"whitebox 0.2.0","text":"Change way download WBT binaries","code":""},{"path":"/news/index.html","id":"whitebox-011","dir":"Changelog","previous_headings":"","what":"whitebox 0.1.1","title":"whitebox 0.1.1","text":"Update use secure download mechanisms (https)","code":""},{"path":"/news/index.html","id":"whitebox-01","dir":"Changelog","previous_headings":"","what":"whitebox 0.1","title":"whitebox 0.1","text":"Initial release","code":""}]