BERATools 0.1.0__py3-none-any.whl

beratools/tools/line_footprint_relative.py

@@ -0,0 +1,75 @@
+# ---------------------------------------------------------------------------
+#    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/tool_template.py

@@ -0,0 +1,72 @@
+"""
+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: AUTHOR NAME
+
+Description:
+    This script is tool template for the BERA Tools. The tool showcases
+    how to create a new tool for the BERA Tools framework. It is a
+    starting point for developers to implement their own tools. 
+    It uses the GeoPandas to read and write geospatial data, 
+    and the multiprocessing library to process the geospatial data.
+
+    To integrate with GUI, work in the gui/assets/beratools.json is needed.
+    Please see developer's guide for more details.
+
+    Webpage: https://github.com/appliedgrg/beratools
+
+    The purpose of this script is to provide template for tool.
+"""
+
+import time
+
+import geopandas as gpd
+import pandas as pd
+
+import beratools.tools.common as bt_common
+from beratools.core.tool_base import execute_multiprocessing
+
+
+def tool_name(in_feature, in_layer, buffer_dist, out_feature, out_layer, processes, verbose):
+    """
+    Define tool entry point.
+
+    Args:
+        in_feature: input feature
+        in_layer: layer name
+        buffer_dist: buffer for input lines
+        out_feature: output feature
+        out_layer: layer name
+        processes: number of processes to use
+        verbose: verbosity level
+
+    These arguments are defined in beratools.json file. Whenever possible,
+    use execute_multiprocessing to run tasks in parallel to speedup.
+
+    """
+    buffer_dist = float(buffer_dist)
+    gdf = gpd.read_file(in_feature, layer=in_layer)
+    gdf_list = [(gdf.iloc[[i]], buffer_dist) for i in range(len(gdf))]
+
+    results = execute_multiprocessing(buffer_worker, gdf_list, "tool_template", processes, verbose=verbose)
+
+    buffered_gdf = gpd.GeoDataFrame(pd.concat(results, ignore_index=True), crs=gdf.crs)
+    buffered_gdf.to_file(out_feature, layer=out_layer)
+
+
+# task executed in a worker process
+def buffer_worker(in_args):
+    buffered = in_args[0].copy()
+    buffer_dist = in_args[1]
+    buffered["geometry"] = buffered.geometry.buffer(buffer_dist)
+    return buffered
+
+
+if __name__ == "__main__":
+    start_time = time.time()
+    in_args, in_verbose = bt_common.check_arguments()
+    tool_name(**in_args.input, processes=int(in_args.processes), verbose=in_verbose)
+    print("Elapsed time: {}".format(time.time() - start_time))

beratools/tools/vertex_optimization.py

@@ -0,0 +1,57 @@
+"""
+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 the public interface for vertex optimization.
+"""
+
+import time
+
+import beratools.core.algo_vertex_optimization as bt_vo
+import beratools.tools.common as bt_common
+
+
+def vertex_optimization(
+    in_line,
+    in_raster,
+    search_distance,
+    line_radius,
+    out_line,
+    processes,
+    verbose,
+    in_layer=None,
+    out_layer=None,
+):
+    if not bt_common.compare_crs(bt_common.vector_crs(in_line), bt_common.raster_crs(in_raster)):
+        return
+
+    vg = bt_vo.VertexGrouping(
+        in_line,
+        in_raster,
+        search_distance,
+        line_radius,
+        out_line,
+        processes,
+        verbose,
+        in_layer,
+        out_layer,
+    )
+    vg.create_all_vertex_groups()
+    vg.compute()
+    vg.update_all_lines()
+    vg.save_all_layers(out_line)
+
+
+if __name__ == "__main__":
+    in_args, in_verbose = bt_common.check_arguments()
+    start_time = time.time()
+    vertex_optimization(**in_args.input, processes=int(in_args.processes), verbose=in_verbose)
+    print("Elapsed time: {}".format(time.time() - start_time))

beratools-0.1.0.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: BERATools
+Version: 0.1.0
+Summary: An advanced forest line feature analysis platform
+Project-URL: Homepage, https://github.com/appliedgrg/beratools
+Author-email: AppliedGRG <appliedgrg@gmail.com>, Richard Zeng <richardqzeng@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2023, AppliedGRG
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+License-File: LICENSE
+Keywords: BERA,Line
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: bera-centerlines
+Requires-Dist: gdal; platform_system != 'Windows'
+Requires-Dist: geopandas
+Requires-Dist: pyogrio>=0.9.0
+Requires-Dist: pyqt5
+Requires-Dist: rasterio
+Requires-Dist: scikit-image>=0.24.0
+Requires-Dist: tqdm
+Requires-Dist: xarray-spatial
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: isort; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: tox; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+# BERA Tools
+<div align="center">
+BERA Tools is successor of [Forest Line Mapper](https://github.com/appliedgrg/flm). It is a toolset for enhanced delineation and attribution of linear disturbances in forests.
+
+[![GitHub Workflow Status (Build)](https://img.shields.io/github/actions/workflow/status/appliedgrg/bera-tools/python-tests.yml?branch=develop&style=for-the-badge)](https://github.com/appliedgrg/bera-tools/actions/workflows/python-tests.yml)
+[![Read the Docs](https://img.shields.io/readthedocs/bera-tools?style=for-the-badge&logo=readthedocs&logoColor=white)](https://bera-tools.readthedocs.io/en/latest/)
+<br>
+[![Conda Version](https://img.shields.io/conda/v/AppliedGRG/beratools?style=for-the-badge&logo=anaconda&color=green)](https://anaconda.org/AppliedGRG/beratools)
+[![Python - Version](https://img.shields.io/badge/PYTHON-3.9+-blue?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/downloads/release/python-390/)
+<br>
+[![License: MIT](https://img.shields.io/github/license/appliedgrg/bera-tools?style=for-the-badge&color=blue)](https://github.com/appliedgrg/bera-tools/blob/main/LICENSE)
+
+</div>
+<!--![Banner](docs/files/images/BERALogo.png)-->
+
+## [Quick Start](https://appliedgrg.github.io/beratools)
+
+BERA Tools is built upon open-source Python libraries. Anaconda is used to manage runtime environments.
+
+Installation Steps:
+
+- Install Miniconda. Download Miniconda from [Miniconda](https://docs.anaconda.com/miniconda/) and install on your machine.
+- Launch **Anaconda Prompt**. Run the following command to create a new environment. **BERA Tools** will be installed in the new environment at the same time. Download the file [conda_environment.yml](https://github.com/RichardQZeng/BTools/blob/main/conda_environment.yml) first.
+
+   ```bash
+   $ conda env create -f conda_environment.yml
+   ```
+
+   Wait until the installation is done.
+- Activate the **bera** environment and launch BERA Tools:
+
+  ```bash
+  $ conda activate bera
+  $ beratools
+  ```
+
+
+## User Guide
+
+Check the online [User Guide](https://appliedgrg.github.io/beratools/) for more information.
+
+## Technical Documentation
+
+BERA Tools provides a series of tools for forest lines processing. Please refer to the technical documentation for programming APIs and algorithm details.
+
+[Technical Documentation](https://appliedgrg.github.io/beratools/)
+
+## Development and Testing
+
+To install test dependencies:
+```bash
+pip install .[test]
+```
+
+To install development tools (e.g., ruff):
+```bash
+pip install .[dev]
+```
+
+You can combine extras:
+```bash
+pip install .[test,dev]
+```
+
+## Contribution Guide
+
+We welcome contributions! Please see our [Contribution Guide](contribution_guide.md) for details.
+
+## Credits
+
+This tool is part of the [**Boreal Ecosystem Recovery and Assessment (BERA)**](http://www.beraproject.org/) Project, and is being actively developed by the [**Applied Geospatial Research Group**](https://www.appliedgrg.ca/).
+
+![Logos](docs/files/images/BERALogo.png)
+*Copyright (C) 2025  Applied Geospatial Research Group*

beratools-0.1.0.dist-info/RECORD

@@ -0,0 +1,44 @@
+beratools/__init__.py,sha256=Wrqbh2TWZM7l1fl1h8GtlovAqm8xombgExwybbr3A6Q,87
+beratools/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+beratools/core/algo_centerline.py,sha256=4zMNcJUCAE8cbJ7za2apJrpSaT33xSM2J9LWkwt4ITY,15701
+beratools/core/algo_common.py,sha256=yIBVfFqTPN3DqtyQKIOoLh94EmzIlzyaSyA0htelAZs,14825
+beratools/core/algo_cost.py,sha256=JFNdy9U4B2-AgUR_o-zKABEINqU8GJLFJIAxFOm05Zw,5934
+beratools/core/algo_dijkstra.py,sha256=xnVv8PI3dQ2hOrKlZPsk8B9_eNfv2YbQoBmOT_J_138,15055
+beratools/core/algo_footprint_rel.py,sha256=EPcxWikhIuuSpgtSk54IqaOwiJ2JQpXBV5_3CPmn0Mo,25209
+beratools/core/algo_line_grouping.py,sha256=k2uuxcL9wd0Ag4oNJLDC-X2nd-b9qjkM6rWdmk_1Ovc,32811
+beratools/core/algo_merge_lines.py,sha256=JWQjBLy9InjVkFfC5zeroor7GxY0CV29hKlxNB8Ufu4,8412
+beratools/core/algo_split_with_lines.py,sha256=raRYlbskf7xaO2qUH3bJU_GGhQBEXBJYMRU2goPb6_o,10905
+beratools/core/algo_vertex_optimization.py,sha256=u22ha9J4wUXyiVGwIIZYtIOnmwi7vRM1nx-8d0YNtUI,15340
+beratools/core/constants.py,sha256=KuLkHN1tNLswpVQmHHDtEtwX_1YKRF5cFsLNLXBK1uQ,1164
+beratools/core/logger.py,sha256=55nhQV3Jjjf3GD-v6hfd-LKc8YyH4Wpe53ImQhLGwfM,2803
+beratools/core/tool_base.py,sha256=nT22-CD6_lH8ZaTKKZNcO0_Ddbf2zxDS5CGEV1xpRts,3925
+beratools/gui/__init__.py,sha256=zYIIWtPF73iVlXdH9euMUQ4DH7f-jg5yLgjn3qCQ36o,151
+beratools/gui/bt_data.py,sha256=4V1pr_uO35_FOFT4BgxWObh4UDKY4TxWAO-7bX7_Tdw,17287
+beratools/gui/bt_gui_main.py,sha256=LK5Vly6OZMjpofjjCKCrI6962CxAUvNen99UeqJyGhE,24979
+beratools/gui/main.py,sha256=YHKAn0-NOtEksqFpTE2tAbPNFTeJZaTQ3dmrEdq8_Ko,645
+beratools/gui/tool_widgets.py,sha256=4XKbyHhhkyJMATUGJghyG8cbM4nNnOfb7x_5v7PhEW8,27504
+beratools/gui/assets/BERALogo.png,sha256=hnGLSL7Jv2ljDn6Z8ad5ekzH9k1PEuq7xe7Hh8bXZkE,6660
+beratools/gui/assets/beratools.json,sha256=bx75-vtq2yHdAeF3o-Vj8htdIExUpG80N4GcjzO2iJk,24617
+beratools/gui/assets/closed.gif,sha256=T9BBGl286-FdSRYbWVt68HwPRF0geWoowtBzeYsk_bI,592
+beratools/gui/assets/closed.png,sha256=FRSAh3wzASowFUEt88zHhk1BQmwRbjoCs50Ff8KpJNQ,311
+beratools/gui/assets/gui.json,sha256=kRD3Ozim9IotcY8P3fapgs4qqj5vebQHLxmss_SOJdY,329
+beratools/gui/assets/open.gif,sha256=o8LL1OaDNkQ0Gcc9dO-1f1UZFAQ3ALc4svtqiUuWJPY,1062
+beratools/gui/assets/open.png,sha256=v0OOwfTNGMmtdFbffCbxdYLaNZeRC9Cy5whAwi71oVw,524
+beratools/gui/assets/tool.gif,sha256=2KGcUI_b-qFdrJJhgbx9pMZ8pExX7zH8nYvweRiQs6U,555
+beratools/gui/assets/tool.png,sha256=35Txwum2l_aKeazF_I97ZaZAKHsrKQCGG-LZxEIFyZw,714
+beratools/tools/__init__.py,sha256=lii4UkW4D105ZHpuoLi0REiZ_SA6le8T109Rl2qwkaU,129
+beratools/tools/canopy_threshold_relative.py,sha256=pjja8uh4h1JFU5007GlNs5J5oDT2E-TjrcOww57jR0Y,29671
+beratools/tools/centerline.py,sha256=S5UtGxi1bE7JTbMQ7QylhNoQ-Jtp4-sAbldtGMBGBbo,3973
+beratools/tools/check_seed_line.py,sha256=ZEVF6TlGH3ke48O-b-I5RrwOhMExEUpoH-xGunAiL2k,1555
+beratools/tools/common.py,sha256=iSq6JtLq07WScdQQsNODIczyHVAcVKmflok_vopQA0o,20587
+beratools/tools/line_footprint_absolute.py,sha256=CeuN0M49itKLjQXrFGAfBbZFXX-rLQpV4qcgYikWmW8,6202
+beratools/tools/line_footprint_fixed.py,sha256=YjWwmznf2Pc2N0iGAhbNEr7CZgReTEpEWsSHKoQrX1k,17410
+beratools/tools/line_footprint_functions.py,sha256=KQXLcK8lBHETs0ecbJSwZVpaMTt19LOv0PuuLwskFPQ,31536
+beratools/tools/line_footprint_relative.py,sha256=wA4IQUN9vXAbQJideImkl12odNUqjAU7-kqJAhF0kcM,3192
+beratools/tools/tool_template.py,sha256=VU87tfGv5N6Jgfm-KMJlIbWdupiLOLY8XDhM9uC4gzo,2410
+beratools/tools/vertex_optimization.py,sha256=m56YPrBeTrQYp5xCiENV2eKYoSurQW4ybYyRVvQ9M3g,1402
+beratools-0.1.0.dist-info/METADATA,sha256=V42rMTSQDNWgezk_UYdaKzUR6oDN-B_S3ah10tpmJJI,5654
+beratools-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+beratools-0.1.0.dist-info/entry_points.txt,sha256=ph47-gzMqhlWmHogQd9HTl4l8dWQUV8FhSOL2FaRrIM,53
+beratools-0.1.0.dist-info/licenses/LICENSE,sha256=IZ1f9V4p0qV6UciLtuKE9nyPJIm6gQiWRBtG0ETDdfY,1069
+beratools-0.1.0.dist-info/RECORD,,

beratools-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

beratools-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+BERATools = beratools.gui:gui_main

beratools-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023, AppliedGRG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+