Merge pull request #34 from giswqs/v2.1

Updated to WBT v2.1

Author: giswqs

WBT/PRE/WhiteboxTools.py

@@ -13,6 +13,7 @@
 import os
 import re
 import shutil
+import sys
 import whitebox
 import urllib.request
 from zipfile import ZipFile
@@ -96,7 +97,8 @@ def generate_tool_template(tool):
     lines.append("class {}(object):\n".format(tool["name"]))
     lines.append("    def __init__(self):\n")
     lines.append('        self.label = "{}"\n'.format(tool["label"]))
-    lines.append('        self.description = "{}"\n'.format(tool["description"]))
+    lines.append('        self.description = "{}"\n'.format(
+        tool["description"]))
     lines.append('        self.category = "{}"\n\n'.format(tool["category"]))
     lines.append("    def getParameterInfo(self):\n")
     # Loop through parameters
@@ -120,7 +122,7 @@ def generate_tool_template(tool):
     lines.append("                    param.clearMessage()\n")
     lines.append("        return\n\n")
     lines.append("    def execute(self, parameters, messages):\n")
-    # Access parameters throught parameters[x].valueAsText
+    # Access parameters through parameters[x].valueAsText
     lines.append(define_execute(tool["parameters"]))
     # redirect standard output to tool dialogue
     lines.append("        old_stdout = sys.stdout\n")
@@ -130,7 +132,8 @@ def generate_tool_template(tool):
     # line = '        wbt.{}({})\n'.format(to_snakecase(tool['name']), ', '.join(tool['parameters']).replace(", class,", ", cls,"))
     line = "        wbt.{}({})\n".format(
         to_snakecase(tool["name"]),
-        ", ".join(tool_params).replace(", class=class,", ", cls=cls,").replace("input=input", "i=i"),
+        ", ".join(tool_params).replace(", class=class,",
+                                       ", cls=cls,").replace("input=input", "i=i"),
     )
 
     # Deal with name conflict with reserved Python functions (and, or, not)
@@ -176,7 +179,8 @@ def define_tool_params(params):
         if data_type["data_type"] == '"DERasterDataset"' and direction == "Output":
             data_type["data_type"] = '"DEFile"'
             data_type["data_filter"] = '["tif"]'
-            parameter_type = "Required"  # if a filter is used, the parameter must be changed to required.
+            # if a filter is used, the parameter must be changed to required.
+            parameter_type = "Required"
         elif data_type["data_type"] == '"DERasterDataset"' and direction == "Input":
             data_type["data_type"] = '"GPRasterLayer"'
         elif data_type["data_type"] == '"DEShapefile"' and direction == "Input":
@@ -193,14 +197,18 @@ def define_tool_params(params):
         lines.append("        {} = arcpy.Parameter(\n".format(param))
         lines.append('            displayName="{}",\n'.format(items["name"]))
         lines.append('            name="{}",\n'.format(param))
-        lines.append("            datatype={},\n".format(data_type["data_type"]))
-        lines.append('            parameterType="{}",\n'.format(parameter_type))
+        lines.append("            datatype={},\n".format(
+            data_type["data_type"]))
+        lines.append(
+            '            parameterType="{}",\n'.format(parameter_type))
         lines.append('            direction="{}")\n'.format(direction))
 
         if data_type["multi_value"]:
             lines.append("        {}.multiValue = True\n".format(param))
 
         if len(data_type["dependency_field"]) > 0:
+            if data_type["dependency_field"] == "input":
+                data_type["dependency_field"] = "i"
             lines.append(
                 "        {}.parameterDependencies = [{}.name]\n".format(
                     param, data_type["dependency_field"]
@@ -209,7 +217,8 @@ def define_tool_params(params):
 
         if data_type["data_filter"] != "[]":
             if data_type["filter_type"] == '"ValueList"':
-                lines.append('        {}.filter.type = "ValueList"\n'.format(param))
+                lines.append(
+                    '        {}.filter.type = "ValueList"\n'.format(param))
 
             if (
                 data_type["data_filter"]
@@ -231,7 +240,8 @@ def define_tool_params(params):
                     items["default_value"] = True
 
                 lines.append(
-                    "        {}.value = '{}'\n\n".format(param, items["default_value"])
+                    "        {}.value = '{}'\n\n".format(
+                        param, items["default_value"])
                 )
         else:
             lines.append("\n")
@@ -281,7 +291,8 @@ def define_execute(params):
             param = "i"
 
         # deal with multi-value inputs
-        lines.append("        {} = parameters[{}].valueAsText\n".format(param, index))
+        lines.append(
+            "        {} = parameters[{}].valueAsText\n".format(param, index))
         if data_type["multi_value"]:
             lines.append("        if {} is not None:\n".format(param))
             lines.append('            items = {}.split(";")\n'.format(param))
@@ -290,22 +301,27 @@ def define_execute(params):
             lines.append(
                 "                items_path.append(arcpy.Describe(item).catalogPath)\n"
             )
-            lines.append('            {} = ";".join(items_path)\n'.format(param))
+            lines.append(
+                '            {} = ";".join(items_path)\n'.format(param))
 
         if param_type in inputRasVec:
             #     lines.append('        desc = arcpy.Describe({})\n'.format(param))
             #     lines.append('        {} = desc.catalogPath\n'.format(param))
             # if param_type == "Optional":
             lines.append("        if {} is not None:\n".format(param))
-            lines.append("            desc = arcpy.Describe({})\n".format(param))
+            lines.append(
+                "            desc = arcpy.Describe({})\n".format(param))
             lines.append("            {} = desc.catalogPath\n".format(param))
         elif param_type == {"ExistingFileOrFloat": "Raster"}:
             lines.append("        if {} is not None:\n".format(param))
             lines.append("            try:\n")
-            lines.append("                {} = str(float({}))\n".format(param, param))
+            lines.append(
+                "                {} = str(float({}))\n".format(param, param))
             lines.append("            except:\n")
-            lines.append("                desc = arcpy.Describe({})\n".format(param))
-            lines.append("                {} = desc.catalogPath\n".format(param))
+            lines.append(
+                "                desc = arcpy.Describe({})\n".format(param))
+            lines.append(
+                "                {} = desc.catalogPath\n".format(param))
 
             # lines.append('        if ({} is not None) and {}.isnumeric() == False:\n'.format(param, param))
 
@@ -438,7 +454,7 @@ def get_github_tag(tool_name, category):
 
 def get_book_url(tool_name, category):
     """
-    Get link to WhiteboxTools User Mannual
+    Get link to WhiteboxTools User Manual
     """
     prefix = "https://www.whiteboxgeo.com/manual/wbt_book/available_tools"
     url = "{}/{}.html#{}".format(prefix, category, tool_name)
@@ -451,7 +467,8 @@ def get_book_tag(tool_name, category):
     """
     prefix = "https://www.whiteboxgeo.com/manual/wbt_book/available_tools"
     url = "{}/{}.html#{}".format(prefix, category, tool_name)
-    html_tag = "<a href='{}' target='_blank'>WhiteboxTools User Manual</a>".format(url)
+    html_tag = "<a href='{}' target='_blank'>WhiteboxTools User Manual</a>".format(
+        url)
     return html_tag
 
 
@@ -531,8 +548,31 @@ def get_book_tag(tool_name, category):
 with open(wbt_py) as f:
     lines = f.readlines()
     for line in lines:
+        if line.strip() == "import urllib.request":
+            line = ""
+        if line.strip() == "from subprocess import CalledProcessError, Popen, PIPE, STDOUT":
+            line = """
+from subprocess import CalledProcessError, Popen, PIPE, STDOUT
+if sys.version_info.major == 2:
+    import urllib2 as urlopen
+else:
+    import urllib.request as urlopen
+            """
         if 'f"={toolname}"' in line:
             line = '                args.append("={}".format(toolname))'
+        if 'f"Warning: Unrecognized extension ext_name {ext_name}' in line:
+            line = '                    print("Warning: Unrecognized extension ext_name {}. Installing the GTE instead...".format(ext_name))\n'
+        if line.strip() == "for entry in os.scandir(f'./{unzipped_dir_name}'):":
+            line = "            for entry in os.scandir('./{}'.format(unzipped_dir_name)):\n"
+        if line.strip() == "new_path = entry.path.replace(f'{unzipped_dir_name}', 'plugins')":
+            line = "                new_path = entry.path.replace('{}'.format(unzipped_dir_name), 'plugins')\n"
+        if line.strip() == "if os.path.exists(f'./{unzipped_dir_name}'):":
+            line = "            if os.path.exists('./{}'.format(unzipped_dir_name)):\n"
+        if line.strip() == "shutil.rmtree(f'./{unzipped_dir_name}')":
+            line = "                shutil.rmtree('./{}'.format(unzipped_dir_name))\n"
+        if "urllib.request" in line:
+            line = line.replace("urllib.request", "urlopen")
+
         outlines.append(line)
 
 with open(wbt_py, "w") as f:

WBT/PRE/automation.py

@@ -11,6 +11,7 @@
 tool_labels = []
 
 tool_labels.append("Absolute Value")
+tool_labels.append("Accumulation Curvature")
 tool_labels.append("Adaptive Filter")
 tool_labels.append("Add")
 tool_labels.append("Add Point Coordinates To Table")
@@ -84,18 +85,21 @@
 tool_labels.append("Cross Tabulation")
 tool_labels.append("Csv Points To Vector")
 tool_labels.append("Cumulative Distribution")
+tool_labels.append("Curvedness")
 tool_labels.append("D Inf Flow Accumulation")
 tool_labels.append("D Inf Mass Flux")
 tool_labels.append("D Inf Pointer")
 tool_labels.append("D8 Flow Accumulation")
 tool_labels.append("D8 Mass Flux")
 tool_labels.append("D8 Pointer")
+tool_labels.append("Dbscan")
 tool_labels.append("Decrement")
 tool_labels.append("Depth In Sink")
 tool_labels.append("Dev From Mean Elev")
 tool_labels.append("Diff From Mean Elev")
 tool_labels.append("Diff Of Gaussian Filter")
 tool_labels.append("Difference")
+tool_labels.append("Difference Curvature")
 tool_labels.append("Direct Decorrelation Stretch")
 tool_labels.append("Directional Relief")
 tool_labels.append("Dissolve")
@@ -167,7 +171,13 @@
 tool_labels.append("Flow Length Diff")
 tool_labels.append("Gamma Correction")
 tool_labels.append("Gaussian Contrast Stretch")
+tool_labels.append("Gaussian Curvature")
 tool_labels.append("Gaussian Filter")
+tool_labels.append("Gaussian Scale Space")
+tool_labels.append("Generalize Classified Raster")
+tool_labels.append("Generalize With Similarity")
+tool_labels.append("Generating Function")
+tool_labels.append("Geomorphons")
 tool_labels.append("Greater Than")
 tool_labels.append("Hack Stream Order")
 tool_labels.append("Height Above Ground")
@@ -181,6 +191,7 @@
 tool_labels.append("Histogram Matching Two Images")
 tool_labels.append("Hole Proportion")
 tool_labels.append("Horizon Angle")
+tool_labels.append("Horizontal Excess Curvature")
 tool_labels.append("Horton Stream Order")
 tool_labels.append("Hydrologic Connectivity")
 tool_labels.append("Hypsometric Analysis")
@@ -212,6 +223,8 @@
 tool_labels.append("K Means Clustering")
 tool_labels.append("K Nearest Mean Filter")
 tool_labels.append("Kappa Index")
+tool_labels.append("Knn Classification")
+tool_labels.append("Knn Regression")
 tool_labels.append("Ks Test For Normality")
 tool_labels.append("Laplacian Filter")
 tool_labels.append("Laplacian Of Gaussian Filter")
@@ -251,6 +264,7 @@
 tool_labels.append("Lidar Rooftop Analysis")
 tool_labels.append("Lidar Segmentation")
 tool_labels.append("Lidar Segmentation Based Filter")
+tool_labels.append("Lidar Shift")
 tool_labels.append("Lidar Sibson Interpolation")
 tool_labels.append("Lidar Sort By Time")
 tool_labels.append("Lidar Thin")
@@ -266,8 +280,11 @@
 tool_labels.append("Lines To Polygons")
 tool_labels.append("List Unique Values")
 tool_labels.append("Ln")
+tool_labels.append("Local Hypsometric Analysis")
+tool_labels.append("Local Quadratic Regression")
 tool_labels.append("Log10")
 tool_labels.append("Log2")
+tool_labels.append("Logistic Regression")
 tool_labels.append("Long Profile")
 tool_labels.append("Long Profile From Points")
 tool_labels.append("Longest Flowpath")
@@ -285,9 +302,12 @@
 tool_labels.append("Max Elev Dev Signature")
 tool_labels.append("Max Elevation Deviation")
 tool_labels.append("Max Overlay")
+tool_labels.append("Max Upslope Elev Change")
 tool_labels.append("Max Upslope Flowpath Length")
+tool_labels.append("Maximal Curvature")
 tool_labels.append("Maximum Filter")
 tool_labels.append("Md Inf Flow Accumulation")
+tool_labels.append("Mean Curvature")
 tool_labels.append("Mean Filter")
 tool_labels.append("Median Filter")
 tool_labels.append("Medoid")
@@ -300,6 +320,7 @@
 tool_labels.append("Min Downslope Elev Change")
 tool_labels.append("Min Max Contrast Stretch")
 tool_labels.append("Min Overlay")
+tool_labels.append("Minimal Curvature")
 tool_labels.append("Minimum Bounding Box")
 tool_labels.append("Minimum Bounding Circle")
 tool_labels.append("Minimum Bounding Envelope")
@@ -369,6 +390,8 @@
 tool_labels.append("Radius Of Gyration")
 tool_labels.append("Raise Walls")
 tool_labels.append("Random Field")
+tool_labels.append("Random Forest Classification")
+tool_labels.append("Random Forest Regression")
 tool_labels.append("Random Sample")
 tool_labels.append("Range Filter")
 tool_labels.append("Raster Area")
@@ -403,8 +426,10 @@
 tool_labels.append("Rgb To Ihs")
 tool_labels.append("Rho8 Flow Accumulation")
 tool_labels.append("Rho8 Pointer")
+tool_labels.append("Ring Curvature")
 tool_labels.append("Roberts Cross Filter")
 tool_labels.append("Root Mean Square Error")
+tool_labels.append("Rotor")
 tool_labels.append("Round")
 tool_labels.append("Ruggedness Index")
 tool_labels.append("Scharr Filter")
@@ -415,13 +440,15 @@
 tool_labels.append("Shadow Image")
 tool_labels.append("Shape Complexity Index")
 tool_labels.append("Shape Complexity Index Raster")
+tool_labels.append("Shape Index")
 tool_labels.append("Shreve Stream Magnitude")
 tool_labels.append("Sigmoidal Contrast Stretch")
 tool_labels.append("Sin")
 tool_labels.append("Single Part To Multi Part")
 tool_labels.append("Sinh")
 tool_labels.append("Sink")
 tool_labels.append("Slope")
+tool_labels.append("Slope Vs Aspect Plot")
 tool_labels.append("Slope Vs Elevation Plot")
 tool_labels.append("Smooth Vectors")
 tool_labels.append("Smooth Vegetation Residual")
@@ -449,6 +476,8 @@
 tool_labels.append("Subtract")
 tool_labels.append("Sum Overlay")
 tool_labels.append("Surface Area Ratio")
+tool_labels.append("Svm Classification")
+tool_labels.append("Svm Regression")
 tool_labels.append("Symmetrical Difference")
 tool_labels.append("Tan")
 tool_labels.append("Tangential Curvature")
@@ -473,6 +502,7 @@
 tool_labels.append("Union")
 tool_labels.append("Unnest Basins")
 tool_labels.append("Unsharp Masking")
+tool_labels.append("Unsphericity")
 tool_labels.append("Update Nodata Cells")
 tool_labels.append("Upslope Depression Storage")
 tool_labels.append("User Defined Weights Filter")
@@ -481,6 +511,7 @@
 tool_labels.append("Vector Points To Raster")
 tool_labels.append("Vector Polygons To Raster")
 tool_labels.append("Vector Stream Network Analysis")
+tool_labels.append("Vertical Excess Curvature")
 tool_labels.append("Viewshed")
 tool_labels.append("Visibility Index")
 tool_labels.append("Voronoi Diagram")

WBT/PRE/file_header.py

@@ -1,7 +1,7 @@
 {
     "tool_name": "ConditionalEvaluation",
     "exe": "conditional_evaluation",
-    "short_description": "This tool performs a conditional evaluaton (if-then-else) operation on a raster.",
+    "short_description": "This tool performs a conditional evaluation (if-then-else) operation on a raster.",
     "toolbox": "Math and Stats Tools",
     "license": "MIT",
     "example": ".*EXE_NAME -r=ConditionalEvaluation -i=DEM.tif --statement='value > 2500.0' --true=2500.0 --false=DEM.tif --output=onlyLowPlaces.tif",

WBT/plugins/conditional_evaluation.exe

@@ -4,7 +4,7 @@
     "short_description": "This tool evaluates hydrologic connectivity within a DEM",
     "toolbox": "Geomorphometric Analysis",
     "license": "MIT",
-    "example": ".*EXE_NAME -r=ExposureTowardsWindFlux -i=input.tif -s=streams.tif -o=new.tif",
+    "example": ".*EXE_NAME -r=ExposureTowardsWindFlux -dem=input.tif -o=exposure.tif --azimuth=35.0 --max_dist=500.0",
     "parameters": [
         {
             "name": "Input DEM Raster",