Fix for issue #113

jblindsay · Sep 3, 2020 · e78e919 · e78e919
1 parent 8065f3c
commit e78e919
Show file tree

Hide file tree

Showing 35 changed files with 164 additions and 132 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/readme.txt b/readme.txt
@@ -56,8 +56,8 @@ for more details.
 * Release Notes: *
 ******************
 
-Version 1.X.X (XX-XX-2020)
-- Added the ShadowTime model tool for modelling the proportion of daytime that a location is in shadow.
+Version 1.4.0 (03-09-2020)
+- Added the TimeInDaylight model tool for modelling the proportion of daytime that a location is not in shadow.
 - Added the MapOffTerrainObjects tool.
 - Added the FilterRasterFeaturesByArea tool.
 - Added the LidarDigitalSurfaceModel tool.

diff --git a/src/tools/hydro_analysis/flow_accum_full_workflow.rs b/src/tools/hydro_analysis/flow_accum_full_workflow.rs
@@ -308,7 +308,7 @@ impl WhiteboxTool for FlowAccumulationFullWorkflow {
             let mut mid_lat = (input.configs.north - input.configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                z_factor = 1.0 / (113200.0 * mid_lat.cos());
+                z_factor = 1.0 / (111320.0 * mid_lat.cos());
             }
         }
 

diff --git a/src/tools/mod.rs b/src/tools/mod.rs
@@ -481,7 +481,7 @@ impl ToolManager {
         tool_names.push("RelativeTopographicPosition".to_string());
         tool_names.push("RemoveOffTerrainObjects".to_string());
         tool_names.push("RuggednessIndex".to_string());
-        tool_names.push("ShadowTime".to_string());
+        tool_names.push("TimeInDaylight".to_string());
         tool_names.push("SedimentTransportIndex".to_string());
         tool_names.push("Slope".to_string());
         tool_names.push("SlopeVsElevationPlot".to_string());
@@ -1150,7 +1150,7 @@ impl ToolManager {
             }
             "ruggednessindex" => Some(Box::new(terrain_analysis::RuggednessIndex::new())),
             // "segmentterrain" => Some(Box::new(terrain_analysis::SegmentTerrain::new())),
-            "shadowtime" => Some(Box::new(terrain_analysis::ShadowTime::new())),
+            "timeindaylight" => Some(Box::new(terrain_analysis::TimeInDaylight::new())),
             "sedimenttransportindex" => {
                 Some(Box::new(terrain_analysis::SedimentTransportIndex::new()))
             }

diff --git a/src/tools/stream_network_analysis/stream_link_id.rs b/src/tools/stream_network_analysis/stream_link_id.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
 Created: 25/06/2017
-Last Modified: 18/10/2019
+Last Modified: 03/09/2020
 License: MIT
 */
 

diff --git a/src/tools/stream_network_analysis/stream_slope_continuous.rs b/src/tools/stream_network_analysis/stream_slope_continuous.rs
@@ -288,8 +288,8 @@ impl WhiteboxTool for StreamSlopeContinuous {
             let mut mid_lat = (streams.configs.north - streams.configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                cell_size_x = cell_size_x * (113200.0 * mid_lat.cos());
-                cell_size_y = cell_size_y * (113200.0 * mid_lat.cos());
+                cell_size_x = cell_size_x * (111320.0 * mid_lat.cos());
+                cell_size_y = cell_size_y * (111320.0 * mid_lat.cos());
                 diag_cell_size = (cell_size_x * cell_size_x + cell_size_y * cell_size_y).sqrt();
             }
         }

diff --git a/src/tools/terrain_analysis/aspect.rs b/src/tools/terrain_analysis/aspect.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
 Created: 22/06/2017
-Last Modified: 30/01/2020
+Last Modified: 03/09/2020
 License: MIT
 */
 
@@ -25,7 +25,7 @@ use std::thread;
 /// DEM is in the geographic coordinate system (latitude and longitude), the following equation
 /// is used:
 ///
-/// > zfactor = 1.0 / (113200.0 x cos(mid_lat))
+/// > zfactor = 1.0 / (111320.0 x cos(mid_lat))
 ///
 /// where `mid_lat` is the latitude of the centre of the raster, in radians.
 ///
@@ -95,7 +95,7 @@ impl Aspect {
                 "Optional multiplier for when the vertical and horizontal units are not the same."
                     .to_owned(),
             parameter_type: ParameterType::Float,
-            default_value: Some("1.0".to_owned()),
+            default_value: None,
             optional: true,
         });
 
@@ -162,7 +162,7 @@ impl WhiteboxTool for Aspect {
     ) -> Result<(), Error> {
         let mut input_file = String::new();
         let mut output_file = String::new();
-        let mut z_factor = 1f64;
+        let mut z_factor = -1f64;
 
         if args.len() == 0 {
             return Err(Error::new(
@@ -238,13 +238,15 @@ impl WhiteboxTool for Aspect {
 
         let eight_grid_res = input.configs.resolution_x * 8.0;
 
-        if input.is_in_geographic_coordinates() {
+        if input.is_in_geographic_coordinates() && z_factor < 0.0 {
             // calculate a new z-conversion factor
             let mut mid_lat = (input.configs.north - input.configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                z_factor = 1.0 / (113200.0 * mid_lat.cos());
+                z_factor = 1.0 / (111320.0 * mid_lat.cos());
             }
+        } else if z_factor < 0.0 {
+            z_factor = 1.0;
         }
 
         let mut output = Raster::initialize_using_file(&output_file, &input);

diff --git a/src/tools/terrain_analysis/average_normal_vector_angular_deviation.rs b/src/tools/terrain_analysis/average_normal_vector_angular_deviation.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
 Created: 26/01/2019
-Last Modified: 02/04/2019
+Last Modified: 03/09/2020
 License: MIT
 */
 
@@ -479,7 +479,7 @@ impl WhiteboxTool for AverageNormalVectorAngularDeviation {
             let mut mid_lat = (configs.north - configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                z_factor = 1.0 / (113200.0 * mid_lat.cos());
+                z_factor = 1.0 / (111320.0 * mid_lat.cos());
             }
         }
 

diff --git a/src/tools/terrain_analysis/circular_variance_of_aspect.rs b/src/tools/terrain_analysis/circular_variance_of_aspect.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
 Created: 26/01/2019
-Last Modified: 02/04/2019
+Last Modified: 03/09/2020
 License: MIT
 */
 
@@ -481,7 +481,7 @@ impl WhiteboxTool for CircularVarianceOfAspect {
             let mut mid_lat = (configs.north - configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                z_factor = 1.0 / (113200.0 * mid_lat.cos());
+                z_factor = 1.0 / (111320.0 * mid_lat.cos());
             }
         }
 

diff --git a/src/tools/terrain_analysis/directional_relief.rs b/src/tools/terrain_analysis/directional_relief.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
 Created: 07/07/2017
-Last Modified: 30/01/2020
+Last Modified: 03/09/2020
 License: MIT
 */
 
@@ -276,7 +276,7 @@ impl WhiteboxTool for DirectionalRelief {
             let mut mid_lat = (input.configs.north - input.configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                cell_size = cell_size * (113200.0 * mid_lat.cos());
+                cell_size = cell_size * (111320.0 * mid_lat.cos());
             }
         }
 

diff --git a/src/tools/terrain_analysis/drainage_preserving_smoothing.rs b/src/tools/terrain_analysis/drainage_preserving_smoothing.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay and Anthony Francioni
 Created: 06/09/2018
-Last Modified: 22/10/2019
+Last Modified: 03/09/2020
 License: MIT
 */
 
@@ -135,7 +135,7 @@ impl DrainagePreservingSmoothing {
                 "Optional multiplier for when the vertical and horizontal units are not the same."
                     .to_owned(),
             parameter_type: ParameterType::Float,
-            default_value: Some("1.0".to_owned()),
+            default_value: None,
             optional: true,
         });
 
@@ -213,7 +213,7 @@ impl WhiteboxTool for DrainagePreservingSmoothing {
         let mut num_iter = 3;
         let mut reduction = 80f64;
         let mut dfm_threshold = 0.15;
-        let mut z_factor = 1f64;
+        let mut z_factor = -1f64;
         let mut max_z_diff = f64::INFINITY;
 
         if args.len() == 0 {
@@ -340,14 +340,16 @@ impl WhiteboxTool for DrainagePreservingSmoothing {
 
         let start = Instant::now();
 
-        if input.is_in_geographic_coordinates() {
+        if input.is_in_geographic_coordinates() && z_factor < 0.0 {
             // calculate a new z-conversion factor
             let mut mid_lat = (input.configs.north - input.configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                z_factor = 1.0 / (113200.0 * mid_lat.cos());
+                z_factor = 1.0 / (111320.0 * mid_lat.cos());
                 println!("It appears that the DEM is in geographic coordinates. The z-factor has been updated: {}.", z_factor);
             }
+        } else if z_factor < 0.0 {
+            z_factor = 1.0;
         }
 
         let rows = input.configs.rows as isize;

diff --git a/src/tools/terrain_analysis/edge_density.rs b/src/tools/terrain_analysis/edge_density.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
 Created: 27/01/2019
-Last Modified: 22/10/2019
+Last Modified: 03/09/2020
 License: MIT
 */
 
@@ -95,7 +95,7 @@ impl EdgeDensity {
                 "Optional multiplier for when the vertical and horizontal units are not the same."
                     .to_owned(),
             parameter_type: ParameterType::Float,
-            default_value: Some("1.0".to_owned()),
+            default_value: None,
             optional: true,
         });
 
@@ -170,7 +170,7 @@ impl WhiteboxTool for EdgeDensity {
         let mut output_file = String::new();
         let mut filter_size = 11usize;
         let mut max_norm_diff = 5f64;
-        let mut z_factor = 1f64;
+        let mut z_factor = -1f64;
 
         if args.len() == 0 {
             return Err(Error::new(
@@ -281,14 +281,16 @@ impl WhiteboxTool for EdgeDensity {
 
         let start = Instant::now();
 
-        if input.is_in_geographic_coordinates() {
+        if input.is_in_geographic_coordinates() && z_factor < 0.0 {
             // calculate a new z-conversion factor
             let mut mid_lat = (input.configs.north - input.configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                z_factor = 1.0 / (113200.0 * mid_lat.cos());
+                z_factor = 1.0 / (111320.0 * mid_lat.cos());
                 println!("It appears that the DEM is in geographic coordinates. The z-factor has been updated: {}.", z_factor);
             }
+        } else if z_factor < 0.0 {
+            z_factor = 1.0;
         }
 
         let rows = input.configs.rows as isize;

diff --git a/src/tools/terrain_analysis/feature_preserving_smoothing.rs b/src/tools/terrain_analysis/feature_preserving_smoothing.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
 Created: 23/11/2017
-Last Modified: 22/10/2019
+Last Modified: 03/09/2020
 License: MIT
 */
 
@@ -143,7 +143,7 @@ impl FeaturePreservingSmoothing {
                 "Optional multiplier for when the vertical and horizontal units are not the same."
                     .to_owned(),
             parameter_type: ParameterType::Float,
-            default_value: Some("1.0".to_owned()),
+            default_value: None,
             optional: true,
         });
 
@@ -219,7 +219,7 @@ impl WhiteboxTool for FeaturePreservingSmoothing {
         let mut filter_size = 11usize;
         let mut max_norm_diff = 8f32;
         let mut num_iter = 3;
-        let mut z_factor = 1f32;
+        let mut z_factor = -1f32;
         let mut max_z_diff = f32::INFINITY;
 
         if args.len() == 0 {
@@ -350,14 +350,16 @@ impl WhiteboxTool for FeaturePreservingSmoothing {
 
         let start = Instant::now();
 
-        if input_dem.is_in_geographic_coordinates() {
+        if input_dem.is_in_geographic_coordinates() && z_factor < 0.0 {
             // calculate a new z-conversion factor
             let mut mid_lat = (input_dem.configs.north - input_dem.configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                z_factor = (1.0 / (113200.0 * mid_lat.cos())) as f32;
+                z_factor = (1.0 / (111320.0 * mid_lat.cos())) as f32;
                 println!("It appears that the DEM is in geographic coordinates. The z-factor has been updated to {}.", z_factor);
             }
+        } else if z_factor < 0.0 {
+            z_factor = 1.0;
         }
 
         let input = Arc::new(input_dem.get_data_as_f32_array2d());

diff --git a/src/tools/terrain_analysis/fetch_analysis.rs b/src/tools/terrain_analysis/fetch_analysis.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
 Created: 07/07/2017
-Last Modified: 30/01/2020
+Last Modified: 03/09/2020
 License: MIT
 */
 
@@ -278,7 +278,7 @@ impl WhiteboxTool for FetchAnalysis {
             let mut mid_lat = (input.configs.north - input.configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                cell_size = cell_size * (113200.0 * mid_lat.cos());
+                cell_size = cell_size * (111320.0 * mid_lat.cos());
             }
         }
 

diff --git a/src/tools/terrain_analysis/hillshade.rs b/src/tools/terrain_analysis/hillshade.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
 Created: 22/06/2017
-Last Modified: 30/01/2020
+Last Modified: 03/09/2020
 License: MIT
 */
 
@@ -28,7 +28,7 @@ use std::thread;
 /// DEM is in the geographic coordinate system (latitude and longitude), the following equation
 /// is used:
 ///
-/// > zfactor = 1.0 / (113200.0 x cos(mid_lat))
+/// > zfactor = 1.0 / (111320.0 x cos(mid_lat))
 ///
 /// where `mid_lat` is the latitude of the centre of the raster, in radians.
 ///
@@ -105,7 +105,7 @@ impl Hillshade {
                 "Optional multiplier for when the vertical and horizontal units are not the same."
                     .to_owned(),
             parameter_type: ParameterType::Float,
-            default_value: Some("1.0".to_owned()),
+            default_value: None,
             optional: true,
         });
 
@@ -177,7 +177,7 @@ impl WhiteboxTool for Hillshade {
         let mut output_file = String::new();
         let mut azimuth = 315.0f64;
         let mut altitude = 30.0f64;
-        let mut z_factor = 1f64;
+        let mut z_factor = -1f64;
 
         if args.len() == 0 {
             return Err(Error::new(
@@ -278,13 +278,15 @@ impl WhiteboxTool for Hillshade {
         let cos_theta = altitude.cos();
         let eight_grid_res = input.configs.resolution_x * 8.0;
 
-        if input.is_in_geographic_coordinates() {
+        if input.is_in_geographic_coordinates() && z_factor < 0.0 {
             // calculate a new z-conversion factor
             let mut mid_lat = (input.configs.north - input.configs.south) / 2.0;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                z_factor = 1.0 / (113200.0 * mid_lat.cos());
+                z_factor = 1.0 / (111320.0 * mid_lat.cos());
             }
+        } else if z_factor < 0.0 {
+            z_factor = 1.0;
         }
 
         let mut configs = input.configs.clone();

diff --git a/src/tools/terrain_analysis/horizon_angle.rs b/src/tools/terrain_analysis/horizon_angle.rs
@@ -2,7 +2,7 @@
 This tool is part of the WhiteboxTools geospatial analysis library.
 Authors: Dr. John Lindsay
 Created: 07/07/2017
-Last Modified: 27/07/2020
+Last Modified: 03/09/2020
 License: MIT
 
 NOTES: The tool should have the option to output a distance raster as well.
@@ -250,9 +250,9 @@ impl WhiteboxTool for HorizonAngle {
             let mut mid_lat = ((configs.north - configs.south) / 2.0) as f32;
             if mid_lat <= 90.0 && mid_lat >= -90.0 {
                 mid_lat = mid_lat.to_radians();
-                // cell_size = cell_size * (113200.0 * mid_lat.cos());
-                cell_size_x = cell_size_x * (113200.0 * mid_lat.cos());
-                cell_size_y = cell_size_y * (113200.0 * mid_lat.cos());
+                // cell_size = cell_size * (111320.0 * mid_lat.cos());
+                cell_size_x = cell_size_x * (111320.0 * mid_lat.cos());
+                cell_size_y = cell_size_y * (111320.0 * mid_lat.cos());
             }
         }