geoai-py 0.5.3__py2.py3-none-any.whl → 0.5.4__py2.py3-none-any.whl

geoai/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = """Qiusheng Wu"""
 __email__ = "giswqs@gmail.com"
-__version__ = "0.5.3"
+__version__ = "0.5.4"
 
 
 import os

geoai/utils.py

@@ -6249,3 +6249,99 @@ def download_model_from_hf(model_path, repo_id=None):
         print(f"Error downloading model from Hugging Face: {e}")
         print("Please specify a local model path or ensure internet connectivity.")
         raise
+
+
+def regularize(
+    data: Union[gpd.GeoDataFrame, str],
+    parallel_threshold: float = 1.0,
+    target_crs: Optional[Union[str, "pyproj.CRS"]] = None,
+    simplify: bool = True,
+    simplify_tolerance: float = 0.5,
+    allow_45_degree: bool = True,
+    diagonal_threshold_reduction: float = 15,
+    allow_circles: bool = True,
+    circle_threshold: float = 0.9,
+    num_cores: int = 1,
+    include_metadata: bool = False,
+    output_path: Optional[str] = None,
+    **kwargs,
+) -> gpd.GeoDataFrame:
+    """Regularizes polygon geometries in a GeoDataFrame by aligning edges.
+
+    Aligns edges to be parallel or perpendicular (optionally also 45 degrees)
+    to their main direction. Handles reprojection, initial simplification,
+    regularization, geometry cleanup, and parallel processing.
+
+    This function is a wrapper around the `regularize_geodataframe` function
+    from the `buildingregulariser` package. Credits to the original author
+    Nick Wright. Check out the repo at https://github.com/DPIRD-DMA/Building-Regulariser.
+
+    Args:
+        data (Union[gpd.GeoDataFrame, str]): Input GeoDataFrame with polygon or multipolygon geometries,
+            or a file path to the GeoDataFrame.
+        parallel_threshold (float, optional): Distance threshold for merging nearly parallel adjacent edges
+            during regularization. Defaults to 1.0.
+        target_crs (Optional[Union[str, "pyproj.CRS"]], optional): Target Coordinate Reference System for
+            processing. If None, uses the input GeoDataFrame's CRS. Processing is more reliable in a
+            projected CRS. Defaults to None.
+        simplify (bool, optional): If True, applies initial simplification to the geometry before
+            regularization. Defaults to True.
+        simplify_tolerance (float, optional): Tolerance for the initial simplification step (if `simplify`
+            is True). Also used for geometry cleanup steps. Defaults to 0.5.
+        allow_45_degree (bool, optional): If True, allows edges to be oriented at 45-degree angles relative
+            to the main direction during regularization. Defaults to True.
+        diagonal_threshold_reduction (float, optional): Reduction factor in degrees to reduce the likelihood
+            of diagonal edges being created. Larger values reduce the likelihood of diagonal edges.
+            Defaults to 15.
+        allow_circles (bool, optional): If True, attempts to detect polygons that are nearly circular and
+            replaces them with perfect circles. Defaults to True.
+        circle_threshold (float, optional): Intersection over Union (IoU) threshold used for circle detection
+            (if `allow_circles` is True). Value between 0 and 1. Defaults to 0.9.
+        num_cores (int, optional): Number of CPU cores to use for parallel processing. If 1, processing is
+            done sequentially. Defaults to 1.
+        include_metadata (bool, optional): If True, includes metadata about the regularization process in the
+            output GeoDataFrame. Defaults to False.
+        output_path (Optional[str], optional): Path to save the output GeoDataFrame. If None, the output is
+            not saved. Defaults to None.
+        **kwargs: Additional keyword arguments to pass to the `to_file` method when saving the output.
+
+    Returns:
+        gpd.GeoDataFrame: A new GeoDataFrame with regularized polygon geometries. Original attributes are
+        preserved. Geometries that failed processing might be dropped.
+
+    Raises:
+        ValueError: If the input data is not a GeoDataFrame or a file path, or if the input GeoDataFrame is empty.
+    """
+    try:
+        from buildingregulariser import regularize_geodataframe
+    except ImportError:
+        install_package("buildingregulariser")
+        from buildingregulariser import regularize_geodataframe
+
+    if isinstance(data, str):
+        data = gpd.read_file(data)
+    elif not isinstance(data, gpd.GeoDataFrame):
+        raise ValueError("Input data must be a GeoDataFrame or a file path.")
+
+    # Check if the input data is empty
+    if data.empty:
+        raise ValueError("Input GeoDataFrame is empty.")
+
+    gdf = regularize_geodataframe(
+        data,
+        parallel_threshold=parallel_threshold,
+        target_crs=target_crs,
+        simplify=simplify,
+        simplify_tolerance=simplify_tolerance,
+        allow_45_degree=allow_45_degree,
+        diagonal_threshold_reduction=diagonal_threshold_reduction,
+        allow_circles=allow_circles,
+        circle_threshold=circle_threshold,
+        num_cores=num_cores,
+        include_metadata=include_metadata,
+    )
+
+    if output_path:
+        gdf.to_file(output_path, **kwargs)
+
+    return gdf

{geoai_py-0.5.3.dist-info → geoai_py-0.5.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geoai-py
-Version: 0.5.3
+Version: 0.5.4
 Summary: A Python package for using Artificial Intelligence (AI) with geospatial data
 Author-email: Qiusheng Wu <giswqs@gmail.com>
 License: MIT License
@@ -9,15 +9,15 @@ Keywords: geoai
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.9
 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.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: albumentations
+Requires-Dist: buildingregulariser
 Requires-Dist: contextily
 Requires-Dist: geopandas
 Requires-Dist: huggingface_hub

{geoai_py-0.5.3.dist-info → geoai_py-0.5.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-geoai/__init__.py,sha256=jStw8KmV7u2Lunpz5zvB0hetngAXZHlFLKos0kVaVH8,3765
+geoai/__init__.py,sha256=_SUkF87skch6o0kWnBmcY5ki_cjE1uSsIVM_ByCU6eA,3765
 geoai/classify.py,sha256=_e-193QzAx3pIxUflPIsIs1qZevQx5ADu7i3bOL1G70,35055
 geoai/download.py,sha256=lJ1GsJOZsKc2i6_dQyPV-XXIXmlADOpmSBo-wha4DEU,40892
 geoai/extract.py,sha256=GocJufMmrwEWxNBL1J91EXXHL8AKcO8m_lmtUF5AKPw,119102
@@ -7,10 +7,10 @@ geoai/hf.py,sha256=mLKGxEAS5eHkxZLwuLpYc1o7e3-7QIXdBv-QUY-RkFk,17072
 geoai/segment.py,sha256=g3YW17ftr--CKq6VB32TJEPY8owGQ7uQ0sg_tUT2ooE,13681
 geoai/segmentation.py,sha256=AtPzCvguHAEeuyXafa4bzMFATvltEYcah1B8ZMfkM_s,11373
 geoai/train.py,sha256=mQXat2yuddT-2rME4xnX_m3SkY23E_-zdxLnBIKxw8o,44091
-geoai/utils.py,sha256=5BZTL9QlJGEs9uw5w6i_aZ4s8SH_FGvb6ZFlIyEHEZI,239703
-geoai_py-0.5.3.dist-info/licenses/LICENSE,sha256=vN2L5U7cZ6ZkOHFmc8WiGlsogWsZc5dllMeNxnKVOZg,1070
-geoai_py-0.5.3.dist-info/METADATA,sha256=PWPPZoHB-5IHNgWz7vL1jq3skgeKCmgNSmQjdLo6klA,6637
-geoai_py-0.5.3.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
-geoai_py-0.5.3.dist-info/entry_points.txt,sha256=uGp3Az3HURIsRHP9v-ys0hIbUuBBNUfXv6VbYHIXeg4,41
-geoai_py-0.5.3.dist-info/top_level.txt,sha256=1YkCUWu-ii-0qIex7kbwAvfei-gos9ycyDyUCJPNWHY,6
-geoai_py-0.5.3.dist-info/RECORD,,
+geoai/utils.py,sha256=075-CoiYIYs7ZgtWOnyw5pBaQIeWuBW49JwTYfOBHDI,244386
+geoai_py-0.5.4.dist-info/licenses/LICENSE,sha256=vN2L5U7cZ6ZkOHFmc8WiGlsogWsZc5dllMeNxnKVOZg,1070
+geoai_py-0.5.4.dist-info/METADATA,sha256=aCOkYuGkhV6Iuzv5o5RvJNhAMApwANK9aJqmgPWG6y4,6623
+geoai_py-0.5.4.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
+geoai_py-0.5.4.dist-info/entry_points.txt,sha256=uGp3Az3HURIsRHP9v-ys0hIbUuBBNUfXv6VbYHIXeg4,41
+geoai_py-0.5.4.dist-info/top_level.txt,sha256=1YkCUWu-ii-0qIex7kbwAvfei-gos9ycyDyUCJPNWHY,6
+geoai_py-0.5.4.dist-info/RECORD,,