Merge pull request #19 from giswqs/develop

Update to use WBT backend v1.3.1

Author: giswqs

.github/workflows/py-check.yaml

@@ -0,0 +1,39 @@
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+name: py-check
+jobs:
+  py-check:
+    runs-on: ${{ matrix.config.os }}
+    name: ${{ matrix.config.os }} (${{ matrix.config.py }})
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: windows-latest, py: '3.7'}
+          - {os: macOS-latest,   py: '3.7'}
+          - {os: ubuntu-latest,  py: '3.6'}
+          - {os: ubuntu-latest,  py: '3.7'}
+          - {os: ubuntu-latest,  py: '3.8'}
+
+    env:
+      SDKROOT: /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk
+    steps:
+      - name: CHECKOUT CODE
+        uses: actions/checkout@v2
+      - name: SETUP PYTHON
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.config.py }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install --user -r requirements_dev.txt
+      - name: WBT-TEST
+        run: |
+          python -m unittest discover tests/

.github/workflows/pypi-publish.yml

@@ -0,0 +1,31 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERS }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

README.rst

@@ -182,7 +182,7 @@ When using ``import whitebox``, if you get an error that says ``No module named
 
 Available Tools
 ---------------
-The 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`_.
+The library currently contains **443** 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`_.
 
 
 Supported Data Formats

requirements_dev.txt

@@ -1,11 +1,10 @@
-pip==9.0.1
-bumpversion==0.5.3
-wheel==0.30.0
-watchdog==0.8.3
-flake8==3.5.0
-tox==2.9.1
-coverage==4.5.1
-Sphinx==1.7.1
-twine==1.10.0
-
-
+pip
+bump2version
+wheel
+watchdog
+flake8
+tox
+coverage
+Sphinx
+twine
+Click

whitebox/wb_runner.py

@@ -101,12 +101,12 @@ def select_file(self):
                 ftypes = [('All files', '*.*')]
                 if 'RasterAndVector' in self.file_type:
                     ftypes = [("Shapefiles", "*.shp"), ('Raster files', ('*.dep', '*.tif',
-                                                '*.tiff', '*.flt',
+                                                '*.tiff', '*.bil', '*.flt',
                                                 '*.sdat', '*.rdc',
                                                 '*.asc'))]
                 elif 'Raster' in self.file_type:
                     ftypes = [('Raster files', ('*.dep', '*.tif',
-                                                '*.tiff', '*.flt',
+                                                '*.tiff', '*.bil', '*.flt',
                                                 '*.sdat', '*.rdc',
                                                 '*.asc'))]
                 elif 'Lidar' in self.file_type:
@@ -255,12 +255,12 @@ def select_file(self):
             ftypes = [('All files', '*.*')]
             if 'RasterAndVector' in self.file_type:
                     ftypes = [("Shapefiles", "*.shp"), ('Raster files', ('*.dep', '*.tif',
-                                                '*.tiff', '*.flt',
+                                                '*.tiff', '*.bil', '*.flt',
                                                 '*.sdat', '*.rdc',
                                                 '*.asc'))]
             elif 'Raster' in self.file_type:
                 ftypes = [('Raster files', ('*.dep', '*.tif',
-                                            '*.tiff', '*.flt',
+                                            '*.tiff', '*.bil', '*.flt',
                                             '*.sdat', '*.rdc',
                                             '*.asc'))]
             elif 'Lidar' in self.file_type:
@@ -410,12 +410,12 @@ def select_file(self):
             ftypes = [('All files', '*.*')]
             if 'RasterAndVector' in self.file_type:
                     ftypes = [("Shapefiles", "*.shp"), ('Raster files', ('*.dep', '*.tif',
-                                                '*.tiff', '*.flt',
+                                                '*.tiff', '*.bil', '*.flt',
                                                 '*.sdat', '*.rdc',
                                                 '*.asc'))]
             elif 'Raster' in self.file_type:
                 ftypes = [('Raster files', ('*.dep', '*.tif',
-                                            '*.tiff', '*.flt',
+                                            '*.tiff', '*.bil', '*.flt',
                                             '*.sdat', '*.rdc',
                                             '*.asc'))]
             elif 'Lidar' in self.file_type:

whitebox/whitebox_example.py

@@ -35,7 +35,8 @@ def main():
         if os.path.isfile(wbt_win_bin) or os.path.isfile(wbt_linux_bin):
             wbt.set_whitebox_dir(root_dir)
         else:
-            wbt.set_whitebox_dir(root_dir + "/target/release/")  # or simply wbt.exe_path = ...
+            # or simply wbt.exe_path = ...
+            wbt.set_whitebox_dir(root_dir + "/target/release/")
 
         # Set the working directory. This is the path to the folder containing the data,
         # i.e. files sent to tools as input/output parameters. You don't need to set
@@ -130,7 +131,7 @@ def my_callback(out_str):
             print("Elapsed time: {0}{1}".format(elapsed_time, units))
             my_callback.prev_line_progress = False
         else:
-            if callback.prev_line_progress:
+            if my_callback.prev_line_progress:
                 print('\n{0}'.format(out_str))
                 my_callback.prev_line_progress = False
             else:

whitebox/whitebox_tools.py

@@ -504,6 +504,7 @@ def list_tools(self, keywords=[]):
 
 
 
+    
 
 
     ##############
@@ -2764,6 +2765,36 @@ def hypsometric_analysis(self, inputs, output, watershed=None, callback=None):
         args.append("--output='{}'".format(output))
         return self.run_tool('hypsometric_analysis', args, callback) # returns 1 if error
 
+    def hypsometrically_tinted_hillshade(self, dem, output, altitude=45.0, hs_weight=0.5, brightness=0.5, atmospheric=0.0, palette="atlas", reverse=False, zfactor=1.0, full_mode=False, callback=None):
+        """Creates an colour shaded relief image from an input DEM.
+
+        Keyword arguments:
+
+        dem -- Input raster DEM file. 
+        output -- Output raster file. 
+        altitude -- Illumination source altitude in degrees. 
+        hs_weight -- Weight given to hillshade relative to relief (0.0-1.0). 
+        brightness -- Brightness factor (0.0-1.0). 
+        atmospheric -- Atmospheric effects weight (0.0-1.0). 
+        palette -- Options include 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', and 'deep. 
+        reverse -- Optional flag indicating whether to use reverse the palette. 
+        zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. 
+        full_mode -- Optional flag indicating whether to use full 360-degrees of illumination sources. 
+        callback -- Custom function for handling tool text outputs.
+        """
+        args = []
+        args.append("--dem='{}'".format(dem))
+        args.append("--output='{}'".format(output))
+        args.append("--altitude={}".format(altitude))
+        args.append("--hs_weight={}".format(hs_weight))
+        args.append("--brightness={}".format(brightness))
+        args.append("--atmospheric={}".format(atmospheric))
+        args.append("--palette={}".format(palette))
+        if reverse: args.append("--reverse")
+        args.append("--zfactor={}".format(zfactor))
+        if full_mode: args.append("--full_mode")
+        return self.run_tool('hypsometrically_tinted_hillshade', args, callback) # returns 1 if error
+
     def max_anisotropy_dev(self, dem, out_mag, out_scale, max_scale, min_scale=3, step=2, callback=None):
         """Calculates the maximum anisotropy (directionality) in elevation deviation over a range of spatial scales.
 
@@ -2918,6 +2949,26 @@ def min_downslope_elev_change(self, dem, output, callback=None):
         args.append("--output='{}'".format(output))
         return self.run_tool('min_downslope_elev_change', args, callback) # returns 1 if error
 
+    def multidirectional_hillshade(self, dem, output, altitude=45.0, zfactor=1.0, full_mode=False, callback=None):
+        """Calculates a multi-direction hillshade raster from an input DEM.
+
+        Keyword arguments:
+
+        dem -- Input raster DEM file. 
+        output -- Output raster file. 
+        altitude -- Illumination source altitude in degrees. 
+        zfactor -- Optional multiplier for when the vertical and horizontal units are not the same. 
+        full_mode -- Optional flag indicating whether to use full 360-degrees of illumination sources. 
+        callback -- Custom function for handling tool text outputs.
+        """
+        args = []
+        args.append("--dem='{}'".format(dem))
+        args.append("--output='{}'".format(output))
+        args.append("--altitude={}".format(altitude))
+        args.append("--zfactor={}".format(zfactor))
+        if full_mode: args.append("--full_mode")
+        return self.run_tool('multidirectional_hillshade', args, callback) # returns 1 if error
+
     def multiscale_elevation_percentile(self, dem, out_mag, out_scale, sig_digits=3, min_scale=4, step=1, num_steps=10, step_nonlinearity=1.0, callback=None):
         """Calculates surface roughness over a range of spatial scales.
 
@@ -6248,6 +6299,40 @@ def lidar_remove_outliers(self, i, output, radius=2.0, elev_diff=50.0, use_media
         if classify: args.append("--classify")
         return self.run_tool('lidar_remove_outliers', args, callback) # returns 1 if error
 
+    def lidar_rooftop_analysis(self, buildings, output, i=None, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=65.0, norm_diff=10.0, azimuth=180.0, altitude=30.0, callback=None):
+        """Identifies roof segments in a LiDAR point cloud.
+
+        Keyword arguments:
+
+        i -- Input LiDAR file. 
+        buildings -- Input vector build footprint polygons file. 
+        output -- Output vector polygon file. 
+        radius -- Search Radius. 
+        num_iter -- Number of iterations. 
+        num_samples -- Number of sample points on which to build the model. 
+        threshold -- Threshold used to determine inlier points. 
+        model_size -- Acceptable model size. 
+        max_slope -- Maximum planar slope. 
+        norm_diff -- Maximum difference in normal vectors, in degrees. 
+        azimuth -- Illumination source azimuth in degrees. 
+        altitude -- Illumination source altitude in degrees. 
+        callback -- Custom function for handling tool text outputs.
+        """
+        args = []
+        if i is not None: args.append("--input='{}'".format(i))
+        args.append("--buildings='{}'".format(buildings))
+        args.append("--output='{}'".format(output))
+        args.append("--radius={}".format(radius))
+        args.append("--num_iter={}".format(num_iter))
+        args.append("--num_samples={}".format(num_samples))
+        args.append("--threshold={}".format(threshold))
+        args.append("--model_size={}".format(model_size))
+        args.append("--max_slope={}".format(max_slope))
+        args.append("--norm_diff={}".format(norm_diff))
+        args.append("--azimuth={}".format(azimuth))
+        args.append("--altitude={}".format(altitude))
+        return self.run_tool('lidar_rooftop_analysis', args, callback) # returns 1 if error
+
     def lidar_segmentation(self, i, output, radius=2.0, num_iter=50, num_samples=10, threshold=0.15, model_size=15, max_slope=80.0, norm_diff=10.0, maxzdiff=1.0, classes=False, ground=False, callback=None):
         """Segments a LiDAR point cloud based on differences in the orientation of fitted planar surfaces and point proximity.