Merge pull request #25 from giswqs/develop

Prep for v1.5.0

Author: giswqs

README.md

@@ -16,11 +16,12 @@ This repository is related to the **ArcGIS Python Toolbox for WhiteboxTools**, w
 ![Note](https://i.imgur.com/Ic8BA7C.png) **Important Note:** This toolbox only supports **ArcGIS Pro and ArcGIS 10.6 or newer**. Don't waste your time trying it on ArcGIS 10.5 or older versions. 
 
 * Authors: Dr. John Lindsay (<https://jblindsay.github.io/ghrg/index.html>)
-* Contributors: Dr. Qiusheng Wu (<https://wetlands.io> | <https://LidarBlog.com>)
+* Contributors: Dr. Qiusheng Wu (<https://wetlands.io> | <https://blog.gishub.com>)
 * WhiteboxTools: <https://github.com/jblindsay/whitebox-tools>
 * User Manual: <https://jblindsay.github.io/wbt_book>
 * WhiteboxTools-ArcGIS: <https://github.com/giswqs/WhiteboxTools-ArcGIS>
 * WhiteboxTools-Python: <https://github.com/giswqs/whitebox>
+* WhiteboxTools-Jupyter: <https://github.com/giswqs/whiteboxgui>
 * WhiteboxTools-R: <https://github.com/giswqs/whiteboxR>
 * Free software: [MIT license](https://opensource.org/licenses/MIT)
 
@@ -72,7 +73,7 @@ Open any tool within the toolbox and start using it. Check out the [WhiteboxTool
 
 ## Available Tools
 
-The **[WhiteboxTools](https://github.com/jblindsay/whitebox-tools)** library currently contains **440** tools, which are each grouped based on their main function into one of the following categories: Data Tools, GIS Analysis, Hydrological Analysis, Image Analysis, LiDAR Analysis, Mathematical and Statistical Analysis, Stream Network Analysis, and Terrain Analysis. For a listing of available tools, complete with documentation and usage details, please see the [WhiteboxTools User Manual](https://jblindsay.github.io/wbt_book/available_tools/index.html).
+The **[WhiteboxTools](https://github.com/jblindsay/whitebox-tools)** library currently contains **468** tools, which are each grouped based on their main function into one of the following categories: Data Tools, GIS Analysis, Hydrological Analysis, Image Analysis, LiDAR Analysis, Mathematical and Statistical Analysis, Stream Network Analysis, and Terrain Analysis. For a listing of available tools, complete with documentation and usage details, please see the [WhiteboxTools User Manual](https://jblindsay.github.io/wbt_book/available_tools/index.html).
 
 ## Supported Data Formats
 

WBT/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2017-2020 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.
+The MIT License (MIT)
+
+Copyright (c) 2017-2020 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.

WBT/PRE/WhiteboxTools.py

@@ -13,10 +13,8 @@
 import os 
 import re
 import shutil
-import sys
 import ast
 import whitebox
-import tarfile
 import urllib.request
 from zipfile import ZipFile
 
@@ -71,17 +69,48 @@ def get_tool_params(tool_name):
     '''
     out_str = wbt.tool_parameters(tool_name)
     start_index = out_str.index('[') + 1
-    end_index = len(out_str.strip()) - 2
+    if "EXE_NAME" in out_str:
+        end_index = out_str.rfind("]") 
+    else:
+        end_index = len(out_str.strip()) - 2
     params = out_str[start_index : end_index]
-
-    sub_params = params.split('{"name"')
+    if "EXE_NAME" in out_str:
+        sub_params = params.split('{"default_value"')
+    else:
+        sub_params = params.split('{"name"')
     param_list = []
 
     for param in sub_params:
         param = param.strip()
         if len(param) > 0:
-            item = '"name"' + param
-            item = item[ : item.rfind("}")].strip()
+            if "EXE_NAME" in out_str:
+                if not param.endswith('},'):
+                    item = '"default_value"' + param[:-1] + ','
+                else:
+                    item = '"default_value"' + param[:-2] + ','
+                name_start = item.find('"name"')
+                name_end = item.find(",", name_start) + 1
+                name = item[name_start: name_end]
+                flags_start = item.find('"flags"')
+                flags_end = item.find('],', flags_start) + 2
+                flags = item[flags_start: flags_end]
+                desc_start = item.find('"description"')
+                desc_end = item.find('",', desc_start) + 2
+                desc = item[desc_start: desc_end]
+                ptype_start = item.find('"parameter_type"')
+                ptype_end = len(item) + 1
+                ptype = item[ptype_start: ptype_end]
+                default_start = item.find('"default_value"')
+                default_end = item.find(',', default_start) + 1
+                default = item[default_start: default_end]
+                optional_start = item.find('"optional"')
+                optional_end = item.find(',', optional_start) + 1
+                optional = item[optional_start: optional_end]
+                item = name + flags + desc + ptype + default + optional
+            else:
+                item = '"name"' + param
+                item = item[ : item.rfind("}")].strip()
+
             param_list.append(item)
 
     params_dict = {}
@@ -121,7 +150,11 @@ def get_tool_params(tool_name):
         param_dict['description'] = desc
 
         param_type = item[index_parameter_type - 1 : index_default_value - 2].replace('"parameter_type":', '')
-        param_type = ast.literal_eval(param_type)
+        try:
+            param_type = ast.literal_eval(param_type)
+        except:
+            pass
+
         param_dict['parameter_type'] = param_type
 
         default_value = item[index_default_value - 1 : index_optional - 2].replace('"default_value":', '')
@@ -396,8 +429,11 @@ def get_data_type(param):
 
     vector_filters = {
         'Point': '["Point"]',
+        'Points': '["Point"]',
         'Line': '["Polyline"]',
+        'Lines': '["Polyline"]',
         'Polygon': '["Polygon"]',
+        'Polygons': '["Polygon"]',
         'LineOrPolygon': '["Polyline", "Polygon"]',
         'Any': '[]'
     }
@@ -464,6 +500,11 @@ def get_github_tag(tool_name, category):
     # prefix = "https://github.com/jblindsay/whitebox-tools/blob/master/src/tools"
     # url = "{}/{}/{}.rs".format(prefix, category, tool_name)
     url = wbt.view_code(tool_name).strip()
+    # print(tool_name)
+    # if tool_name == "split_vector_lines":
+    #     print(url)
+    if "RUST_BACKTRACE" in url:
+        url = "https://github.com/jblindsay/whitebox-tools/tree/master/whitebox-tools-app/src/tools"
     html_tag = "<a href='{}' target='_blank'>GitHub</a>".format(url)
     return html_tag
 
@@ -506,7 +547,7 @@ def get_book_tag(tool_name, category):
 
 if not os.path.exists(wbt_win_zip):
     print("Downloading WhiteboxTools binary ...")
-    url = "https://jblindsay.github.io/ghrg/WhiteboxTools/WhiteboxTools_win_amd64.zip"
+    url = "https://www.whiteboxgeo.com/WBT_Windows/WhiteboxTools_win_amd64.zip"
     urllib.request.urlretrieve(url, wbt_win_zip)   # Download WhiteboxTools
 else:
     print("WhiteboxTools binary already exists.")
@@ -528,6 +569,7 @@ def get_book_tag(tool_name, category):
     "# Image Processing Tools #": "Image Processing Tools",
     "# LiDAR Tools #": "LiDAR Tools",
     "# Math and Stats Tools #": "Math and Stats Tools",
+    "# Precision Agriculture #": "Precision Agriculture",
     "# Stream Network Analysis #": "Stream Network Analysis"
 }
 
@@ -539,6 +581,7 @@ def get_book_tag(tool_name, category):
     "Image Processing Tools": "image_analysis",
     "LiDAR Tools": "lidar_analysis",
     "Math and Stats Tools": "math_stat_analysis",
+    "Precision Agriculture": "precision_agriculture",
     "Stream Network Analysis": "stream_network_analysis"
 }
 
@@ -550,6 +593,7 @@ def get_book_tag(tool_name, category):
     "Image Processing Tools": "image_processing_tools",
     "LiDAR Tools": "lidar_tools",
     "Math and Stats Tools": "mathand_stats_tools",
+    "Precision Agriculture": "precision_agriculture",
     "Stream Network Analysis": "stream_network_analysis"
 }
 
@@ -581,6 +625,7 @@ def get_book_tag(tool_name, category):
                 tool_labels.append(func_label)
                 func_desc = lines[index+1].replace('"""', '').strip()
 
+        
                 github_tag = get_github_tag(func_title, github_cls[category])
                 book_tag = get_book_tag(func_name, book_cls[category])
                 full_desc = "{} View detailed help documentation on {} and source code on {}.".format(func_desc, book_tag, github_tag)

WBT/PRE/automation.py

@@ -25,6 +25,7 @@
 tool_labels.append("Artanh")
 tool_labels.append("Ascii To Las")
 tool_labels.append("Aspect")
+tool_labels.append("Assess Route")
 tool_labels.append("Atan2")
 tool_labels.append("Attribute Correlation")
 tool_labels.append("Attribute Correlation Neighbourhood Analysis")
@@ -45,6 +46,7 @@
 tool_labels.append("Breach Single Cell Pits")
 tool_labels.append("Buffer Raster")
 tool_labels.append("Burn Streams At Roads")
+tool_labels.append("Canny Edge Detection")
 tool_labels.append("Ceil")
 tool_labels.append("Centroid")
 tool_labels.append("Centroid Vector")
@@ -113,13 +115,15 @@
 tool_labels.append("Elevation Above Stream Euclidean")
 tool_labels.append("Eliminate Coincident Points")
 tool_labels.append("Elongation Ratio")
+tool_labels.append("Embankment Mapping")
 tool_labels.append("Emboss Filter")
 tool_labels.append("Equal To")
 tool_labels.append("Erase")
 tool_labels.append("Erase Polygon From Lidar")
 tool_labels.append("Erase Polygon From Raster")
 tool_labels.append("Euclidean Allocation")
 tool_labels.append("Euclidean Distance")
+tool_labels.append("Evaluate Training Sites")
 tool_labels.append("Exp")
 tool_labels.append("Exp2")
 tool_labels.append("Export Table To Csv")
@@ -182,6 +186,8 @@
 tool_labels.append("Image Correlation")
 tool_labels.append("Image Correlation Neighbourhood Analysis")
 tool_labels.append("Image Regression")
+tool_labels.append("Image Segmentation")
+tool_labels.append("Image Slider")
 tool_labels.append("Image Stack Profile")
 tool_labels.append("Impoundment Size Index")
 tool_labels.append("In Place Add")
@@ -193,6 +199,7 @@
 tool_labels.append("Integer Division")
 tool_labels.append("Integral Image")
 tool_labels.append("Intersect")
+tool_labels.append("Inverse Principal Component Analysis")
 tool_labels.append("Is No Data")
 tool_labels.append("Isobasins")
 tool_labels.append("Jenson Snap Pour Points")
@@ -235,6 +242,8 @@
 tool_labels.append("Lidar Rooftop Analysis")
 tool_labels.append("Lidar Segmentation")
 tool_labels.append("Lidar Segmentation Based Filter")
+tool_labels.append("Lidar Sibson Interpolation")
+tool_labels.append("Lidar Sort By Time")
 tool_labels.append("Lidar Thin")
 tool_labels.append("Lidar Thin High Density")
 tool_labels.append("Lidar Tile")
@@ -253,6 +262,7 @@
 tool_labels.append("Long Profile")
 tool_labels.append("Long Profile From Points")
 tool_labels.append("Longest Flowpath")
+tool_labels.append("Low Points On Headwater Divides")
 tool_labels.append("Lowest Position")
 tool_labels.append("Majority Filter")
 tool_labels.append("Map Off Terrain Objects")
@@ -277,6 +287,7 @@
 tool_labels.append("Merge Vectors")
 tool_labels.append("Min")
 tool_labels.append("Min Absolute Overlay")
+tool_labels.append("Min Dist Classification")
 tool_labels.append("Min Downslope Elev Change")
 tool_labels.append("Min Max Contrast Stretch")
 tool_labels.append("Min Overlay")
@@ -313,9 +324,11 @@
 tool_labels.append("Num Upslope Neighbours")
 tool_labels.append("Olympic Filter")
 tool_labels.append("Opening")
+tool_labels.append("Openness")
 tool_labels.append("Or")
 tool_labels.append("Paired Sample T Test")
 tool_labels.append("Panchromatic Sharpening")
+tool_labels.append("Parallelepiped Classification")
 tool_labels.append("Patch Orientation")
 tool_labels.append("Pennock Landform Class")
 tool_labels.append("Percent Elev Range")
@@ -325,6 +338,7 @@
 tool_labels.append("Percentage Contrast Stretch")
 tool_labels.append("Percentile Filter")
 tool_labels.append("Perimeter Area Ratio")
+tool_labels.append("Phi Coefficient")
 tool_labels.append("Pick From List")
 tool_labels.append("Plan Curvature")
 tool_labels.append("Polygon Area")
@@ -360,6 +374,7 @@
 tool_labels.append("Reclass")
 tool_labels.append("Reclass Equal Interval")
 tool_labels.append("Reclass From File")
+tool_labels.append("Recreate Pass Lines")
 tool_labels.append("Reinitialize Attribute Table")
 tool_labels.append("Related Circumscribing Circle")
 tool_labels.append("Relative Aspect")
@@ -380,6 +395,7 @@
 tool_labels.append("Sediment Transport Index")
 tool_labels.append("Select Tiles By Polygon")
 tool_labels.append("Set Nodata Value")
+tool_labels.append("Shadow Animation")
 tool_labels.append("Shape Complexity Index")
 tool_labels.append("Shape Complexity Index Raster")
 tool_labels.append("Shreve Stream Magnitude")
@@ -391,10 +407,12 @@
 tool_labels.append("Slope")
 tool_labels.append("Slope Vs Elevation Plot")
 tool_labels.append("Smooth Vectors")
+tool_labels.append("Smooth Vegetation Residual")
 tool_labels.append("Snap Pour Points")
 tool_labels.append("Sobel Filter")
 tool_labels.append("Spherical Std Dev Of Normals")
 tool_labels.append("Split Colour Composite")
+tool_labels.append("Split Vector Lines")
 tool_labels.append("Split With Lines")
 tool_labels.append("Square")
 tool_labels.append("Square Root")
@@ -424,6 +442,7 @@
 tool_labels.append("To Degrees")
 tool_labels.append("To Radians")
 tool_labels.append("Tophat Transform")
+tool_labels.append("Topographic Position Animation")
 tool_labels.append("Topological Stream Order")
 tool_labels.append("Total Curvature")
 tool_labels.append("Total Filter")
@@ -454,6 +473,8 @@
 tool_labels.append("Wilcoxon Signed Rank Test")
 tool_labels.append("Write Function Memory Insertion")
 tool_labels.append("Xor")
+tool_labels.append("Yield Filter")
+tool_labels.append("Yield Map")
 tool_labels.append("Z Scores")
 tool_labels.append("Zlidar To Las")
 tool_labels.append("Zonal Statistics")

WBT/PRE/file_header.py

@@ -1,6 +1,6 @@
-The WhiteboxTools User Manual is now available online at:
-
-https://jblindsay.github.io/wbt_book/index.html
-
-Please see the manual for details on usage and for descriptions of available tools. 
+The WhiteboxTools User Manual is now available online at:
+
+https://jblindsay.github.io/wbt_book/index.html
+
+Please see the manual for details on usage and for descriptions of available tools. 
 The PDF version of the User Manual is no longer distributed along with the software.