BERATools 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

beratools/tools/line_footprint_relative.py

@@ -1,64 +1,73 @@
-# ---------------------------------------------------------------------------
-#    Copyright (C) 2021  Applied Geospatial Research Group
-#
-#    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU General Public License as published by
-#    the Free Software Foundation, version 3.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU General Public License for more details.
-#
-#    You should have received a copy of the GNU General Public License
-#    along with this program.  If not, see <https://gnu.org/licenses/gpl-3.0>.
-#
-# ---------------------------------------------------------------------------
-#
-# line_footprint_relative.py
-# Script Author: Maverick Fong
-# Date: 2023-May
-# Use open sources python library for produce dynamic footprint
-# from dynamic canopy and cost raster with lines and CHM input.
-# Prerequisite:  Line feature class must have the attribute Fields: "OLnFID" adn CHM raster
-# line_footprint_relative.py
-# This script is part of the BERA toolset
-# Webpage: https://github.com/
-#
-# Purpose: Creates dynamic footprint polygons for each input line based on a least
-# cost corridor method and individual line thresholds.
-#
-# ---------------------------------------------------------------------------
-from beratools.tools.line_footprint_functions import *
-from beratools.tools.canopy_threshold_relative import *
-
-if __name__ == '__main__':
-    start_time = time.time()
-    print('Dynamic CC and Footprint processing started')
-    print('Current time: {}'.format(time.strftime("%d %b %Y %H:%M:%S", time.localtime())))
-
-    parser = argparse.ArgumentParser()
-    parser.add_argument('-i', '--input', type=json.loads)
-    parser.add_argument('-p', '--processes')
-    parser.add_argument('-v', '--verbose')
-    args = parser.parse_args()
-    args.input['full_step'] = True
-    del args.input['out_footprint']
-    del args.input['out_centerline']
-    del args.input['exp_shk_cell']
-    del args.input['max_ln_width']
-
-    verbose = True if args.verbose == 'True' else False
-    dy_cl_line = main_canopy_threshold_relative(print, **args.input, processes=int(args.processes), verbose=verbose)
-    args = parser.parse_args()
-    args.input['full_step'] = True
-    args.input["in_line"] = dy_cl_line
-    del args.input['off_ln_dist']
-    del args.input['canopy_percentile']
-    verbose = True if args.verbose == 'True' else False
-    main_line_footprint_relative(print, **args.input, processes=int(args.processes), verbose=verbose)
-
-    print('%{}'.format(100))
-    print('Dynamic CC and Footprint processes finished')
-    print('Current time: {}'.format(time.strftime("%d %b %Y %H:%M:%S", time.localtime())))
-    print('Total processing time (seconds): {}'.format(round(time.time() - start_time, 3)))
+# ---------------------------------------------------------------------------
+#    Copyright (C) 2021  Applied Geospatial Research Group
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, version 3.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <https://gnu.org/licenses/gpl-3.0>.
+#
+# ---------------------------------------------------------------------------
+#
+# line_footprint_relative.py
+# Script Author: Maverick Fong
+# Date: 2023-May
+# Use open sources python library for produce dynamic footprint
+# from dynamic canopy and cost raster with lines and CHM input.
+# Prerequisite:  Line feature class must have the attribute Fields: "OLnFID" adn CHM raster
+# line_footprint_relative.py
+# This script is part of the BERA toolset
+# Webpage: https://github.com/
+#
+# Purpose: Creates dynamic footprint polygons for each input line based on a least
+# cost corridor method and individual line thresholds.
+#
+# ---------------------------------------------------------------------------
+import sys
+from pathlib import Path
+from inspect import getsourcefile
+
+if __name__ == "__main__":
+    current_file = Path(getsourcefile(lambda: 0)).resolve()
+    btool_dir = current_file.parents[2]
+    sys.path.insert(0, btool_dir.as_posix())
+
+from beratools.tools.line_footprint_functions import *
+from beratools.tools.canopy_threshold_relative import *
+
+if __name__ == '__main__':
+    start_time = time.time()
+    print('Dynamic CC and Footprint processing started')
+    print('Current time: {}'.format(time.strftime("%d %b %Y %H:%M:%S", time.localtime())))
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-i', '--input', type=json.loads)
+    parser.add_argument('-p', '--processes')
+    parser.add_argument('-v', '--verbose')
+    args = parser.parse_args()
+    args.input['full_step'] = True
+    del args.input['out_footprint']
+    del args.input['out_centerline']
+    del args.input['exp_shk_cell']
+    del args.input['max_ln_width']
+
+    verbose = True if args.verbose == 'True' else False
+    dy_cl_line = main_canopy_threshold_relative(print, **args.input, processes=int(args.processes), verbose=verbose)
+    args = parser.parse_args()
+    args.input['full_step'] = True
+    args.input["in_line"] = dy_cl_line
+    del args.input['off_ln_dist']
+    del args.input['canopy_percentile']
+    verbose = True if args.verbose == 'True' else False
+    main_line_footprint_relative(print, **args.input, processes=int(args.processes), verbose=verbose)
+
+    print('%{}'.format(100))
+    print('Dynamic CC and Footprint processes finished')
+    print('Current time: {}'.format(time.strftime("%d %b %Y %H:%M:%S", time.localtime())))
+    print('Total processing time (seconds): {}'.format(round(time.time() - start_time, 3)))

beratools/tools/line_grouping.py

@@ -0,0 +1,45 @@
+"""
+Copyright (C) 2025 Applied Geospatial Research Group.
+
+This script is licensed under the GNU General Public License v3.0.
+See <https://gnu.org/licenses/gpl-3.0> for full license details.
+
+Author: Richard Zeng
+
+Description:
+    This script is part of the BERA Tools.
+    Webpage: https://github.com/appliedgrg/beratools
+
+    The purpose of this script is to provide main interface for line grouping tool.
+"""
+import logging
+import time
+
+import geopandas as gpd
+
+import beratools.tools.common as bt_common
+from beratools.core.algo_line_grouping import LineGrouping
+from beratools.core.logger import Logger
+
+
+def line_grouping(
+    callback, in_line, out_line, processes, verbose, in_layer=None, out_layer=None
+):
+    print("line_grouping started")
+    in_line_gdf = gpd.read_file(in_line, layer=in_layer)
+    lg = LineGrouping(in_line_gdf)
+    lg.run_grouping()
+    lg.lines.to_file(out_line, layer=out_layer)
+
+log = Logger("line_grouping", file_level=logging.INFO)
+logger = log.get_logger()
+print = log.print
+
+if __name__ == "__main__":
+    in_args, in_verbose = bt_common.check_arguments()
+    start_time = time.time()
+    line_grouping(
+        print, **in_args.input, processes=int(in_args.processes), verbose=in_verbose
+    )
+
+    print("Elapsed time: {}".format(time.time() - start_time))