Fixed a minor bug with the VectorPolygonsToRaster tool

Fixed a minor bug with the VectorPolygonsToRaster tool

Author: jblindsay

.DS_Store

@@ -1,7 +1,7 @@
 
 [package]
 name = "whitebox_tools"
-version = "1.0.0"
+version = "1.0.1"
 authors = ["John Lindsay <jlindsay@uoguelph.ca>"]
 description = "A library for analyzing geospatial data."
 keywords = ["geospatial", "GIS", "remote sensing", "geomatics", "image processing", "lidar", "spatial analysis"]

Cargo.toml

@@ -56,6 +56,9 @@ for more details.
 * Release Notes: *
 ******************
 
+Version 1.0.1 (XX-XX-2019)
+- Fixed a minor bug with the VectorPolygonToRaster tool.
+
 Version 1.0.0 (29-09-2019)
 - Added support for reading and writing the BigTIFF format. This has resulted in numerous changes
   throughout the codebase as a result of significant modification of ByteOrderReader and addition

readme.txt

@@ -453,9 +453,9 @@ impl WhiteboxTool for VectorPolygonsToRaster {
                             ending_col = columns - 1;
                         }
 
-                        for r in starting_row..ending_row {
+                        for r in starting_row..=ending_row {
                             y = output.get_y_from_row(r);
-                            for c in starting_col..ending_col {
+                            for c in starting_col..=ending_col {
                                 x = output.get_x_from_column(c);
                                 if point_in_poly(
                                     &Point2D { x: x, y: y },
@@ -467,7 +467,7 @@ impl WhiteboxTool for VectorPolygonsToRaster {
                             }
                             if verbose {
                                 progress = (100.0_f64 * r as f64
-                                    / (ending_row - starting_row) as f64)
+                                    / (ending_row - starting_row + 1) as f64)
                                     as usize;
                                 if progress != old_progress {
                                     println!(
@@ -540,9 +540,9 @@ impl WhiteboxTool for VectorPolygonsToRaster {
                             ending_col = columns - 1;
                         }
 
-                        for r in starting_row..ending_row {
+                        for r in starting_row..=ending_row {
                             y = output.get_y_from_row(r);
-                            for c in starting_col..ending_col {
+                            for c in starting_col..=ending_col {
                                 x = output.get_x_from_column(c);
                                 if point_in_poly(
                                     &Point2D { x: x, y: y },
@@ -556,7 +556,7 @@ impl WhiteboxTool for VectorPolygonsToRaster {
                             }
                             if verbose {
                                 progress = (100.0_f64 * r as f64
-                                    / (ending_row - starting_row) as f64)
+                                    / (ending_row - starting_row + 1) as f64)
                                     as usize;
                                 if progress != old_progress {
                                     println!(

src/tools/data_tools/vector_polygons_to_raster.rs

@@ -48,7 +48,7 @@ use std::thread;
 /// elevation models. Water resources research, 33(2), 309-319.
 /// 
 /// # See Also
-/// `BreachDepressions`, `FillDepressions`
+/// `DInfPointer`, `BreachDepressions`, `FillDepressions`
 pub struct DInfFlowAccumulation {
     name: String,
     description: String,

src/tools/hydro_analysis/dinf_flow_accum.rs

@@ -1,7 +1,7 @@
 /*
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
-Created: June 26, 2017
+Created: 26/06/2017
 Last Modified: 12/10/2018
 License: MIT
 */
@@ -18,6 +18,27 @@ use std::sync::mpsc;
 use std::sync::Arc;
 use std::thread;
 
+/// This tool is used to generate a flow pointer grid (i.e. flow direction) using the D-infinity 
+/// (Tarboton, 1997) algorithm. Dinf is a multiple-flow-direction (MFD) method because the flow 
+/// entering each grid cell is routed one or two downslope neighbours, i.e. flow divergence is permitted. 
+/// The user must specify the name of a digital elevation model (DEM; `--dem`) that has been hydrologically 
+/// corrected to remove all spurious depressions and flat areas (`BreachDepressions`, `FillDepressions`). 
+/// DEM pre-processing is usually achieved using the `BreachDepressions` or `FillDepressions` tool1. Flow 
+/// directions are specified in the output flow-pointer grid (`--output`) as azimuth degrees measured from 
+/// north, i.e. any value between 0 and 360 degrees is possible. A pointer value of -1 is used to designate 
+/// a grid cell with no flow-pointer. This occurs when a grid cell has no downslope neighbour, i.e. a pit 
+/// cell or topographic depression. Like aspect grids, Dinf flow-pointer grids are best visualized using 
+/// a circular greyscale palette.
+/// 
+/// Grid cells possessing the NoData value in the input DEM are assigned the NoData value in the output 
+/// image. The output raster is of the float data type and continuous data scale.
+/// 
+/// # Reference
+/// Tarboton, D. G. (1997). A new method for the determination of flow directions and upslope areas in 
+/// grid digital elevation models. Water resources research, 33(2), 309-319.
+/// 
+/// # See Also
+/// `DInfFlowAccumulation`, `BreachDepressions`, `FillDepressions`
 pub struct DInfPointer {
     name: String,
     description: String,

src/tools/hydro_analysis/dinf_pointer.rs

@@ -1,7 +1,7 @@
 /*
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
-Created: July 8, 2017
+Created: 08/07/2017
 Last Modified: 29/10/2018
 License: MIT
 */
@@ -14,6 +14,29 @@ use std::f64;
 use std::io::{Error, ErrorKind};
 use std::path;
 
+/// This tool can be used to calculate the downslope flowpath length from each grid cell in a raster to 
+/// an outlet cell either at the edge of the grid or at the outlet point of a watershed. The user must 
+/// specify the name of a flow pointer grid (`--d8_pntr`) derived using the D8 flow algorithm (`D8Pointer`). 
+/// This grid should be derived from a digital elevation model (DEM) that has been pre-processed to remove 
+/// artifact topographic depressions and flat areas (`BreachDepressions`, `FillDepressions`). The user may also 
+/// optionally provide watershed (`--watersheds`) and weights (`--weights`) images. The optional watershed 
+/// image can be used to define one or more irregular-shaped watershed boundaries. Flowpath lengths are 
+/// measured within each watershed in the watershed image (each defined by a unique identifying number) as 
+/// the flowpath length to the watershed's outlet cell.
+/// 
+/// The optional weight image is multiplied by the flow-length through each grid cell. This can be useful 
+/// when there is a need to convert the units of the output image. For example, the default unit of 
+/// flowpath lengths is the same as the input image(s). Thus, if the input image has X-Y coordinates 
+/// measured in metres, the output image will likely contain very large values. A weight image containing 
+/// a value of 0.001 for each grid cell will effectively convert the output flowpath lengths into kilometres. 
+/// The weight image can also be used to convert the flowpath distances into travel times by multiplying the 
+/// flow distance through a grid cell by the average velocity.
+/// 
+/// NoData valued grid cells in any of the input images will be assigned NoData values in the output image. 
+/// The output raster is of the float data type and continuous data scale.
+/// 
+/// # See Also
+/// `D8Pointer`, `ElevationAboveStream`, `BreachDepressions`, `FillDepressions`, `Watershed`
 pub struct DownslopeFlowpathLength {
     name: String,
     description: String,

src/tools/hydro_analysis/downslope_flowpath_length.rs

@@ -1,7 +1,7 @@
 /*
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
-Created: June 25, 2017
+Created: 25/06/2017
 Last Modified: 12/10/2018
 License: MIT
 */
@@ -18,6 +18,16 @@ use std::sync::mpsc;
 use std::sync::Arc;
 use std::thread;
 
+/// This tool calculates the number of inflowing neighbours for each grid cell in a raster file. The user 
+/// must specify the names of an input digital elevation model (DEM) file (`--dem`) and the output raster 
+/// file (`--output`). The tool calculates the D8 pointer file internally in order to identify inflowing
+/// neighbouring cells. 
+/// 
+/// Grid cells in the input DEM that contain the NoData value will be assigned the NoData value in the 
+/// output image. The output image is of the integer data type and continuous data scale.
+/// 
+/// # See Also
+/// `NumDownslopeNeighbours`, `NumUpslopeNeighbours`
 pub struct NumInflowingNeighbours {
     name: String,
     description: String,

src/tools/hydro_analysis/num_inflowing_neighbours.rs

@@ -1,7 +1,7 @@
 /*
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
-Created: July 16, 2017
+Created: 16/07/2017
 Last Modified: 12/10/2018
 License: MIT
 */
@@ -18,6 +18,33 @@ use std::sync::mpsc;
 use std::sync::Arc;
 use std::thread;
 
+/// This tool is used to generate a flow pointer grid (i.e. flow direction) using the stochastic 
+/// Rho8 (J. Fairfield and P. Leymarie, 1991) algorithm. Like the D8 flow algorithm (`D8Pointer`), 
+/// Rho8 is a single-flow-direction (SFD) method because the flow entering each grid cell is routed 
+/// to only one downslope neighbour, i.e. flow divergence is not permitted. The user must specify the 
+/// name of a digital elevation model (DEM) file (`--dem`) that has been hydrologically corrected to 
+/// remove all spurious depressions and flat areas (`BreachDepressions`, `FillDepressions`). 
+/// 
+/// By default, the Rho8 flow pointers use the following clockwise, base-2 numeric index convention:
+/// 
+/// | .  |  .  |  . |
+/// |:--:|:---:|:--:|
+/// | 64 | 128 | 1  |
+/// | 32 |  0  | 2  |
+/// | 16 |  8  | 4  |
+/// 
+/// Notice that grid cells that have no lower neighbours are assigned a flow direction of zero. In a DEM that has been 
+/// pre-processed to remove all depressions and flat areas, this condition will only occur along the edges of the grid.
+/// If the pointer file contains ESRI flow direction values instead, the `--esri_pntr` parameter must be specified.
+/// 
+/// Grid cells possessing the NoData value in the input DEM are assigned the NoData value in the output image.
+/// 
+/// # References
+/// Fairfield, J., & Leymarie, P. (1991). Drainage networks from grid digital elevation models. Water 
+/// Resources Research, 27(5), 709-717.
+/// 
+/// # See Also
+/// `D8Pointer`, `FD8Pointer`, `DInfPointer`, `BreachDepressions`, `FillDepressions`
 pub struct Rho8Pointer {
     name: String,
     description: String,