'WhiteboxTools' R Frontend


[Up] [Top]

Documentation for package ‘whitebox’ version 0.5.0

Help Pages

A B C D E F G H I J K L M N O P Q R S T U V W X Z

-- A --

absolute_value Absolute value
adaptive_filter Adaptive filter
add Add
add_point_coordinates_to_table Add point coordinates to table
aggregate_raster Aggregate raster
and And
anova Anova
arc_cos Arc cos
arc_sin Arc sin
arc_tan Arc tan
aspect Aspect
atan2 Atan2
attribute_correlation Attribute correlation
attribute_histogram Attribute histogram
attribute_scattergram Attribute scattergram
average_flowpath_slope Average flowpath slope
average_normal_vector_angular_deviation Average normal vector angular deviation
average_overlay Average overlay
average_upslope_flowpath_length Average upslope flowpath length

-- B --

balance_contrast_enhancement Balance contrast enhancement
basins Basins
bilateral_filter Bilateral filter
block_maximum_gridding Block maximum gridding
block_minimum_gridding Block minimum gridding
boundary_shape_complexity Boundary shape complexity
breach_depressions Breach depressions
breach_single_cell_pits Breach single cell pits
buffer_raster Buffer raster

-- C --

ceil Ceil
centroid Centroid
centroid_vector Centroid vector
change_vector_analysis Change vector analysis
circular_variance_of_aspect Circular variance of aspect
classify_overlap_points Classify overlap points
clip Clip
clip_lidar_to_polygon Clip lidar to polygon
clip_raster_to_polygon Clip raster to polygon
closing Closing
clump Clump
compactness_ratio Compactness ratio
conservative_smoothing_filter Conservative smoothing filter
construct_vector_tin Construct vector tin
convert_nodata_to_zero Convert nodata to zero
convert_raster_format Convert raster format
corner_detection Corner detection
correct_vignetting Correct vignetting
cos Cos
cosh Cosh
cost_allocation Cost allocation
cost_distance Cost distance
cost_pathway Cost pathway
count_if Count if
create_colour_composite Create colour composite
create_hexagonal_vector_grid Create hexagonal vector grid
create_plane Create plane
create_rectangular_vector_grid Create rectangular vector grid
crispness_index Crispness index
cross_tabulation Cross tabulation
cumulative_distribution Cumulative distribution

-- D --

d8_flow_accumulation D8 flow accumulation
d8_mass_flux D8 mass flux
d8_pointer D8 pointer
decrement Decrement
depth_in_sink Depth in sink
dev_from_mean_elev Dev from mean elev
difference Difference
diff_from_mean_elev Diff from mean elev
diff_of_gaussian_filter Diff of gaussian filter
directional_relief Directional relief
direct_decorrelation_stretch Direct decorrelation stretch
dissolve Dissolve
distance_to_outlet Distance to outlet
diversity_filter Diversity filter
divide Divide
downslope_distance_to_stream Downslope distance to stream
downslope_flowpath_length Downslope flowpath length
downslope_index Downslope index
drainage_preserving_smoothing Drainage preserving smoothing
d_inf_flow_accumulation D inf flow accumulation
d_inf_mass_flux D inf mass flux
d_inf_pointer D inf pointer

-- E --

edge_density Edge density
edge_preserving_mean_filter Edge preserving mean filter
edge_proportion Edge proportion
elevation_above_stream Elevation above stream
elevation_above_stream_euclidean Elevation above stream euclidean
elev_above_pit Elev above pit
elev_percentile Elev percentile
elev_relative_to_min_max Elev relative to min max
elev_relative_to_watershed_min_max Elev relative to watershed min max
eliminate_coincident_points Eliminate coincident points
elongation_ratio Elongation ratio
emboss_filter Emboss filter
equal_to Equal to
erase Erase
erase_polygon_from_lidar Erase polygon from lidar
erase_polygon_from_raster Erase polygon from raster
euclidean_allocation Euclidean allocation
euclidean_distance Euclidean distance
exp Exp
exp2 Exp2
export_table_to_csv Export table to csv
extend_vector_lines Extend vector lines
extract_nodes Extract nodes
extract_raster_statistics Extract raster statistics
extract_raster_values_at_points Extract raster values at points
extract_streams Extract streams
extract_valleys Extract valleys

-- F --

farthest_channel_head Farthest channel head
fast_almost_gaussian_filter Fast almost gaussian filter
fd8_flow_accumulation Fd8 flow accumulation
fd8_pointer Fd8 pointer
feature_preserving_denoise Feature preserving denoise
fetch_analysis Fetch analysis
fill_burn Fill burn
fill_depressions Fill depressions
fill_missing_data Fill missing data
fill_single_cell_pits Fill single cell pits
filter_lidar_scan_angles Filter lidar scan angles
find_flightline_edge_points Find flightline edge points
find_lowest_or_highest_points Find lowest or highest points
find_main_stem Find main stem
find_no_flow_cells Find no flow cells
find_parallel_flow Find parallel flow
find_patch_or_class_edge_cells Find patch or class edge cells
find_ridges Find ridges
flatten_lakes Flatten lakes
flightline_overlap Flightline overlap
flip_image Flip image
flood_order Flood order
floor Floor
flow_accumulation_full_workflow Flow accumulation full workflow
flow_length_diff Flow length diff

-- G --

gamma_correction Gamma correction
gaussian_contrast_stretch Gaussian contrast stretch
gaussian_filter Gaussian filter
greater_than Greater than

-- H --

hack_stream_order Hack stream order
highest_position Highest position
high_pass_filter High pass filter
high_pass_median_filter High pass median filter
hillshade Hillshade
hillslopes Hillslopes
histogram_equalization Histogram equalization
histogram_matching Histogram matching
histogram_matching_two_images Histogram matching two images
hole_proportion Hole proportion
horizon_angle Horizon angle
horton_stream_order Horton stream order
hypsometric_analysis Hypsometric analysis

-- I --

idw_interpolation Idw interpolation
ihs_to_rgb Ihs to rgb
image_autocorrelation Image autocorrelation
image_correlation Image correlation
image_regression Image regression
image_stack_profile Image stack profile
impoundment_index Impoundment index
impoundment_size_index Impoundment size index
increment Increment
integer_division Integer division
integral_image Integral image
intersect Intersect
in_place_add In place add
in_place_divide In place divide
in_place_multiply In place multiply
in_place_subtract In place subtract
isobasins Isobasins
is_no_data Is no data

-- J --

jenson_snap_pour_points Jenson snap pour points
join_tables Join tables

-- K --

kappa_index Kappa index
ks_test_for_normality Ks test for normality
k_means_clustering K means clustering
k_nearest_mean_filter K nearest mean filter

-- L --

laplacian_filter Laplacian filter
laplacian_of_gaussian_filter Laplacian of gaussian filter
las_to_ascii Las to ascii
las_to_multipoint_shapefile Las to multipoint shapefile
las_to_shapefile Las to shapefile
layer_footprint Layer footprint
lee_filter Lee filter
length_of_upstream_channels Length of upstream channels
less_than Less than
lidar_block_maximum Lidar block maximum
lidar_block_minimum Lidar block minimum
lidar_classify_subset Lidar classify subset
lidar_colourize Lidar colourize
lidar_construct_vector_tin Lidar construct vector tin
lidar_elevation_slice Lidar elevation slice
lidar_ground_point_filter Lidar ground point filter
lidar_hex_binning Lidar hex binning
lidar_hillshade Lidar hillshade
lidar_histogram Lidar histogram
lidar_idw_interpolation Lidar idw interpolation
lidar_info Lidar info
lidar_join Lidar join
lidar_kappa_index Lidar kappa index
lidar_nearest_neighbour_gridding Lidar nearest neighbour gridding
lidar_point_density Lidar point density
lidar_point_stats Lidar point stats
lidar_remove_duplicates Lidar remove duplicates
lidar_remove_outliers Lidar remove outliers
lidar_segmentation Lidar segmentation
lidar_segmentation_based_filter Lidar segmentation based filter
lidar_thin Lidar thin
lidar_thin_high_density Lidar thin high density
lidar_tile Lidar tile
lidar_tile_footprint Lidar tile footprint
lidar_tin_gridding Lidar tin gridding
lidar_tophat_transform Lidar tophat transform
linearity_index Linearity index
lines_to_polygons Lines to polygons
line_detection_filter Line detection filter
line_intersections Line intersections
line_thinning Line thinning
list_unique_values List unique values
ln Ln
log10 Log10
log2 Log2
longest_flowpath Longest flowpath
long_profile Long profile
long_profile_from_points Long profile from points
lowest_position Lowest position

-- M --

majority_filter Majority filter
max Max
maximum_filter Maximum filter
max_absolute_overlay Max absolute overlay
max_anisotropy_dev Max anisotropy dev
max_anisotropy_dev_signature Max anisotropy dev signature
max_branch_length Max branch length
max_difference_from_mean Max difference from mean
max_downslope_elev_change Max downslope elev change
max_elevation_deviation Max elevation deviation
max_elev_dev_signature Max elev dev signature
max_overlay Max overlay
max_upslope_flowpath_length Max upslope flowpath length
mean_filter Mean filter
median_filter Median filter
medoid Medoid
merge_line_segments Merge line segments
merge_table_with_csv Merge table with csv
merge_vectors Merge vectors
min Min
minimum_bounding_box Minimum bounding box
minimum_bounding_circle Minimum bounding circle
minimum_bounding_envelope Minimum bounding envelope
minimum_convex_hull Minimum convex hull
minimum_filter Minimum filter
min_absolute_overlay Min absolute overlay
min_downslope_elev_change Min downslope elev change
min_max_contrast_stretch Min max contrast stretch
min_overlay Min overlay
modified_k_means_clustering Modified k means clustering
modulo Modulo
mosaic Mosaic
mosaic_with_feathering Mosaic with feathering
multiply Multiply
multiscale_roughness Multiscale roughness
multiscale_roughness_signature Multiscale roughness signature
multiscale_topographic_position_image Multiscale topographic position image
multi_part_to_single_part Multi part to single part

-- N --

narrowness_index Narrowness index
nearest_neighbour_gridding Nearest neighbour gridding
negate Negate
new_raster_from_base New raster from base
normalized_difference_index Normalized difference index
normalized_difference_vegetation_index Normalized difference vegetation index
normal_vectors Normal vectors
not Not
not_equal_to Not equal to
num_downslope_neighbours Num downslope neighbours
num_inflowing_neighbours Num inflowing neighbours
num_upslope_neighbours Num upslope neighbours

-- O --

olympic_filter Olympic filter
opening Opening
or Or

-- P --

panchromatic_sharpening Panchromatic sharpening
patch_orientation Patch orientation
pennock_landform_class Pennock landform class
percentage_contrast_stretch Percentage contrast stretch
percentile_filter Percentile filter
percent_elev_range Percent elev range
percent_equal_to Percent equal to
percent_greater_than Percent greater than
percent_less_than Percent less than
perimeter_area_ratio Perimeter area ratio
pick_from_list Pick from list
plan_curvature Plan curvature
polygonize Polygonize
polygons_to_lines Polygons to lines
polygon_area Polygon area
polygon_long_axis Polygon long axis
polygon_perimeter Polygon perimeter
polygon_short_axis Polygon short axis
power Power
prewitt_filter Prewitt filter
principal_component_analysis Principal component analysis
print_geo_tiff_tags Print geo tiff tags
profile Profile
profile_curvature Profile curvature

-- Q --

quantiles Quantiles

-- R --

radius_of_gyration Radius of gyration
raise_walls Raise walls
random_field Random field
random_sample Random sample
range_filter Range filter
rasterize_streams Rasterize streams
raster_area Raster area
raster_cell_assignment Raster cell assignment
raster_histogram Raster histogram
raster_streams_to_vector Raster streams to vector
raster_summary_stats Raster summary stats
raster_to_vector_lines Raster to vector lines
raster_to_vector_points Raster to vector points
reciprocal Reciprocal
reclass Reclass
reclass_equal_interval Reclass equal interval
reclass_from_file Reclass from file
reinitialize_attribute_table Reinitialize attribute table
related_circumscribing_circle Related circumscribing circle
relative_aspect Relative aspect
relative_stream_power_index Relative stream power index
relative_topographic_position Relative topographic position
remove_off_terrain_objects Remove off terrain objects
remove_polygon_holes Remove polygon holes
remove_short_streams Remove short streams
remove_spurs Remove spurs
resample Resample
rescale_value_range Rescale value range
rgb_to_ihs Rgb to ihs
rho8_pointer Rho8 pointer
roberts_cross_filter Roberts cross filter
root_mean_square_error Root mean square error
round Round
ruggedness_index Ruggedness index

-- S --

scharr_filter Scharr filter
sediment_transport_index Sediment transport index
select_tiles_by_polygon Select tiles by polygon
set_nodata_value Set nodata value
shape_complexity_index Shape complexity index
shape_complexity_index_raster Shape complexity index raster
shreve_stream_magnitude Shreve stream magnitude
sigmoidal_contrast_stretch Sigmoidal contrast stretch
sin Sin
single_part_to_multi_part Single part to multi part
sinh Sinh
sink Sink
slope Slope
slope_vs_elevation_plot Slope vs elevation plot
smooth_vectors Smooth vectors
snap_pour_points Snap pour points
sobel_filter Sobel filter
spherical_std_dev_of_normals Spherical std dev of normals
split_colour_composite Split colour composite
split_with_lines Split with lines
square Square
square_root Square root
standard_deviation_contrast_stretch Standard deviation contrast stretch
standard_deviation_filter Standard deviation filter
standard_deviation_of_slope Standard deviation of slope
stochastic_depression_analysis Stochastic depression analysis
strahler_order_basins Strahler order basins
strahler_stream_order Strahler stream order
stream_link_class Stream link class
stream_link_identifier Stream link identifier
stream_link_length Stream link length
stream_link_slope Stream link slope
stream_slope_continuous Stream slope continuous
subbasins Subbasins
subtract Subtract
sum_overlay Sum overlay
surface_area_ratio Surface area ratio
symmetrical_difference Symmetrical difference

-- T --

tan Tan
tangential_curvature Tangential curvature
tanh Tanh
thicken_raster_line Thicken raster line
tin_gridding Tin gridding
tophat_transform Tophat transform
topological_stream_order Topological stream order
total_curvature Total curvature
total_filter Total filter
to_degrees To degrees
to_radians To radians
trace_downslope_flowpaths Trace downslope flowpaths
trend_surface Trend surface
trend_surface_vector_points Trend surface vector points
tributary_identifier Tributary identifier
truncate Truncate
turning_bands_simulation Turning bands simulation

-- U --

union Union
unnest_basins Unnest basins
unsharp_masking Unsharp masking
user_defined_weights_filter User ined weights filter

-- V --

vector_hex_binning Vector hex binning
vector_lines_to_raster Vector lines to raster
vector_points_to_raster Vector points to raster
vector_polygons_to_raster Vector polygons to raster
viewshed Viewshed
visibility_index Visibility index
voronoi_diagram Voronoi diagram

-- W --

watershed Watershed
wbt_exe_path File path of the WhiteboxTools executable.
wbt_help Help description for WhiteboxTools.
wbt_init Initialize whitebox
wbt_license License information for WhiteboxTools.
wbt_list_tools All available tools in WhiteboxTools.
wbt_run_tool Run a tool.
wbt_toolbox The toolbox for a specific tool.
wbt_tool_help Help description for a specific tool.
wbt_tool_parameters Tool parameter descriptions for a specific tool.
wbt_version Version information for WhiteboxTools.
wbt_view_code Source code for a specific tool.
weighted_overlay Weighted overlay
weighted_sum Weighted sum
wetness_index Wetness index
write_function_memory_insertion Write function memory insertion

-- X --

xor Xor

-- Z --

z_scores Z scores