smoothify 0.3.1__tar.gz → 0.3.2__tar.gz

{smoothify-0.3.1 → smoothify-0.3.2}/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [0.3.2] - 2026-06-30
+
+### Changed
+- Area preservation is faster with no change to output. The buffer-distance search now seeds from the Steiner area expansion `A(d) ≈ A₀ + L·d + π·d²` — solving that quadratic for the initial offset instead of using a linear estimate — and refines with Newton's method using the measured boundary length as the derivative (the rate of area change of an outward offset equals its perimeter), so it no longer brackets the root before solving. This cuts buffer operations per ring from roughly 5–6 to 1–2. On `examples/Water.gpkg` the full single-core pipeline is ~1.3x faster at the default 5 iterations (5.1s → 3.8s), with the speedup scaling up with iteration count and the polygon share of the workload (down to ~1.0x on hole-dominated inputs). Output is unchanged within the area tolerance (per-polygon symmetric difference ≤ 0.005%, area-preservation accuracy identical). Awkward shapes where Newton stalls (pinch-offs or topology changes near the root) fall back to the previous bracketed Brent's-method search, so robustness is unchanged.
+
 ## [0.3.1] - 2026-06-15
 
 ### Fixed

{smoothify-0.3.1 → smoothify-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smoothify
-Version: 0.3.1
+Version: 0.3.2
 Summary: Transform pixelated geometries from raster data into smooth natural looking features
 Author-email: Nick Wright <nicholas.wright@dpird.wa.gov.au>
 License-Expression: MIT

{smoothify-0.3.1 → smoothify-0.3.2}/smoothify/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.3.1'
-__version_tuple__ = version_tuple = (0, 3, 1)
+__version__ = version = '0.3.2'
+__version_tuple__ = version_tuple = (0, 3, 2)
 
-__commit_id__ = commit_id = 'ga092a4c6c'
+__commit_id__ = commit_id = 'gb2e33b7b2'

{smoothify-0.3.1 → smoothify-0.3.2}/smoothify/smoothify_core.py

@@ -1,3 +1,4 @@
+import math
 from typing import cast
 
 import numpy as np
@@ -193,16 +194,30 @@ def _generate_starting_point_variants(
         )
 
 
+# Most rings land within tolerance in one or two Newton steps; allow a few
+# more for awkward shapes before handing off to the bracketed fallback.
+_AREA_NEWTON_MAX_STEPS = 6
+
+
 def _preserve_area_with_buffer(
     polygon: Polygon,
     target_area: float,
     tolerance: float = 1e-6,
 ) -> Polygon:
-    """Restore original polygon area after smoothing via iterative buffering.
+    """Restore original polygon area after smoothing via buffering.
 
-    Smoothing operations can slightly change polygon area. This function uses
-    Brent's method (root-finding algorithm) to find the optimal buffer distance
-    that restores the original area within the specified tolerance."""
+    Smoothing slightly changes polygon area; this finds the buffer distance that
+    restores the original area to within ``tolerance``.
+
+    The buffered area follows the Steiner expansion ``A(d) ~= A0 + L*d + pi*d^2``
+    (``L`` = perimeter), so we seed the search by solving that quadratic instead
+    of the cruder linear estimate, then refine with Newton's method. The area
+    swept by an outward offset changes at a rate equal to the boundary length
+    (the coarea identity), so each buffered candidate yields a near-exact
+    derivative for free and no bracketing is needed -- typically one or two
+    buffers per ring instead of the half-dozen a bracketed root-find spends.
+    Awkward shapes (pinch-offs, topology changes near the root) fall back to the
+    robust Brent's-method search."""
 
     if polygon.is_empty:
         return polygon
@@ -211,8 +226,63 @@ def _preserve_area_with_buffer(
     if abs(current_area - target_area) <= tolerance:
         return polygon
 
-    # Approximate buffer distance needed (assuming circular shape)
     perimeter = polygon.length
+    if perimeter <= 0:
+        return polygon
+
+    # Seed from the Steiner quadratic pi*d^2 + L*d + (A0 - target) = 0, taking
+    # the root nearest zero. When the parabola never reaches the target (a deep
+    # shrink past its vertex) fall back to the first-order estimate and let
+    # Newton walk in.
+    area_gap = current_area - target_area
+    discriminant = perimeter * perimeter - 4.0 * math.pi * area_gap
+    if discriminant >= 0:
+        distance = (-perimeter + math.sqrt(discriminant)) / (2.0 * math.pi)
+    else:
+        distance = -area_gap / perimeter
+
+    best_result: Polygon | None = None
+    best_error = float("inf")
+    for _ in range(_AREA_NEWTON_MAX_STEPS):
+        candidate = polygon.buffer(distance)
+        candidate_area = candidate.area
+        error = abs(candidate_area - target_area)
+        if error < best_error:
+            best_result, best_error = candidate, error
+        if error <= tolerance:
+            return candidate
+        # dA/dd == boundary length of the current candidate (coarea identity).
+        slope = candidate.length
+        if slope <= 0:
+            break
+        next_distance = distance - (candidate_area - target_area) / slope
+        if not math.isfinite(next_distance):
+            break
+        distance = next_distance
+
+    # Newton stalled before reaching tolerance: defer to the bracketed search,
+    # but keep whichever result is actually closer to the target.
+    fallback = _preserve_area_brentq(
+        polygon, target_area, tolerance, current_area, perimeter
+    )
+    if fallback is not None and abs(fallback.area - target_area) < best_error:
+        return fallback
+    return best_result if best_result is not None else polygon
+
+
+def _preserve_area_brentq(
+    polygon: Polygon,
+    target_area: float,
+    tolerance: float,
+    current_area: float,
+    perimeter: float,
+) -> Polygon | None:
+    """Bracketed Brent's-method area restoration (robust fallback).
+
+    Slower than the Newton path (it brackets the root before solving) but does
+    not rely on a good initial estimate, so it covers shapes where Newton
+    stalls. Returns ``None`` only if no usable buffer could be produced."""
+
     initial_guess = (target_area - current_area) / perimeter if perimeter > 0 else 0
 
     # Cache evaluations: brentq re-evaluates the bracket endpoints, and

{smoothify-0.3.1 → smoothify-0.3.2}/smoothify.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smoothify
-Version: 0.3.1
+Version: 0.3.2
 Summary: Transform pixelated geometries from raster data into smooth natural looking features
 Author-email: Nick Wright <nicholas.wright@dpird.wa.gov.au>
 License-Expression: MIT

{smoothify-0.3.1 → smoothify-0.3.2}/smoothify.egg-info/SOURCES.txt

@@ -43,6 +43,8 @@ smoothify.egg-info/PKG-INFO
 smoothify.egg-info/SOURCES.txt
 smoothify.egg-info/dependency_links.txt
 smoothify.egg-info/requires.txt
+smoothify.egg-info/scm_file_list.json
+smoothify.egg-info/scm_version.json
 smoothify.egg-info/top_level.txt
 tests/README.md
 tests/__init__.py

smoothify-0.3.2/smoothify.egg-info/scm_file_list.json

@@ -0,0 +1,68 @@
+{
+  "files": [
+    "RELEASING.md",
+    ".pre-commit-config.yaml",
+    "README.md",
+    ".python-version",
+    "LICENSE",
+    "pyproject.toml",
+    "CHANGELOG.md",
+    ".gitignore",
+    "pytest.ini",
+    "scripts/fuzz_run.py",
+    "scripts/fuzz_visualize.py",
+    ".vscode/settings.json",
+    "smoothify/geometry_ops.py",
+    "smoothify/py.typed",
+    "smoothify/__init__.py",
+    "smoothify/smoothify_core.py",
+    "smoothify/coordinator.py",
+    "images/example_2_linestring.png",
+    "images/generate_pipeline_graphic.py",
+    "images/generate_example_images.ipynb",
+    "images/pipeline_steps.png",
+    "images/smoothify_hero.png",
+    "images/generate_readme_image.ipynb",
+    "images/example_4_merging.png",
+    "images/example_3_iterations.png",
+    "images/smoothify_logo.png",
+    "images/example_1_polygon.png",
+    "fuzz/__init__.py",
+    "fuzz/oracle.py",
+    "fuzz/runner.py",
+    "fuzz/generators.py",
+    "tests/test_smoothify_core.py",
+    "tests/test_area_tolerance.py",
+    "tests/README.md",
+    "tests/__init__.py",
+    "tests/test_edge_cases_coverage.py",
+    "tests/test_water_quality_sweep.py",
+    "tests/test_congruence_dedup.py",
+    "tests/test_geometry_types.py",
+    "tests/test_convexity_artifacts.py",
+    "tests/visual_tests.ipynb",
+    "tests/test_corner_rounding.py",
+    "tests/test_fuzz.py",
+    "tests/test_merge_holes.py",
+    "tests/test_invalid_polygon.py",
+    "tests/conftest.py",
+    "tests/test_all_geometry_types.py",
+    "tests/test_chaikin.py",
+    "tests/test_smoothify_api.py",
+    "tests/test_auto_segment_length.py",
+    "tests/test_real_world_data.py",
+    "tests/test_synthetic_blob_fuzz.py",
+    "tests/test_self_intersecting_variant.py",
+    "tests/test_data/convex_pixel_rectangle.gpkg",
+    "tests/test_data/naip_owm_water_bodies.geojson",
+    "benchmarks/bench_water.py",
+    "examples/real_world_water_example.ipynb",
+    "examples/merge_holes_examples.ipynb",
+    "examples/Water_Smoothed.gpkg",
+    "examples/Water.gpkg",
+    "examples/usage_examples.ipynb",
+    "examples/smoothify_vs_shapely_comparison.ipynb",
+    ".github/workflows/ci.yml",
+    ".github/workflows/publish.yml"
+  ]
+}

smoothify-0.3.2/smoothify.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.3.2",
+  "distance": 0,
+  "node": "gb2e33b7b2668f231572f65e1e723aef9cf567171",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-06-30"
+}

{smoothify-0.3.1 → smoothify-0.3.2}/tests/test_smoothify_core.py

@@ -2,10 +2,13 @@
 
 import pytest
 from shapely.geometry import LineString, Polygon
+from shapely.geometry.base import BaseGeometry
 
+from smoothify import smoothify_core
 from smoothify.smoothify_core import (
     _generate_starting_point_variants,
     _join_adjacent,
+    _preserve_area_brentq,
     _preserve_area_with_buffer,
     _rotate_polygon_start,
     _smoothify_geometry,
@@ -89,6 +92,104 @@ class TestPreserveAreaWithBuffer:
         assert abs(preserved.area - target_area) < 1e-3
         assert preserved.area < large_polygon.area
 
+    def test_preserve_area_empty(self):
+        """Empty input is returned unchanged."""
+        empty = Polygon()
+        assert _preserve_area_with_buffer(empty, target_area=10.0).is_empty
+
+    def test_preserve_area_concave_shape(self):
+        """Newton path reaches tolerance on a concave (non-convex) polygon."""
+        # L-shape: the pi*d^2 Steiner seed assumes total turning of 2*pi, which
+        # a reflex corner violates, so this exercises the Newton correction.
+        l_shape = Polygon([(0, 0), (10, 0), (10, 4), (4, 4), (4, 10), (0, 10)])
+        for target in (l_shape.area * 1.05, l_shape.area * 0.95):
+            preserved = _preserve_area_with_buffer(
+                l_shape, target_area=target, tolerance=1e-4
+            )
+            assert abs(preserved.area - target) < 1e-4
+
+    def test_preserve_area_uses_few_buffers(self):
+        """The Newton solve should reach tolerance in far fewer buffers than the
+        bracketed fallback would (guards the optimisation against regressions)."""
+        polygon = Polygon([(0, 0), (10, 0), (10, 10), (0, 10)])
+        calls = {"n": 0}
+        original_buffer = BaseGeometry.buffer
+
+        def counting_buffer(self, *args, **kwargs):
+            calls["n"] += 1
+            return original_buffer(self, *args, **kwargs)
+
+        BaseGeometry.buffer = counting_buffer
+        try:
+            preserved = _preserve_area_with_buffer(
+                polygon, target_area=polygon.area * 1.1, tolerance=1e-4
+            )
+        finally:
+            BaseGeometry.buffer = original_buffer
+
+        assert abs(preserved.area - polygon.area * 1.1) < 1e-4
+        assert calls["n"] <= 4
+
+    def test_preserve_area_falls_back_to_brentq(self, monkeypatch):
+        """When Newton is denied any steps the function must still reach
+        tolerance via the bracketed Brent's-method fallback."""
+        monkeypatch.setattr(smoothify_core, "_AREA_NEWTON_MAX_STEPS", 0)
+        polygon = Polygon([(0, 0), (10, 0), (10, 10), (0, 10)])
+        for target in (polygon.area * 1.1, polygon.area * 0.9):
+            preserved = _preserve_area_with_buffer(
+                polygon, target_area=target, tolerance=1e-3
+            )
+            assert abs(preserved.area - target) < 1e-3
+
+    def test_newton_and_brentq_agree(self):
+        """The Newton path and the bracketed fallback land on the same area."""
+        polygon = Polygon([(0, 0), (8, 0), (8, 8), (0, 8)])
+        target = polygon.area * 1.07
+        newton = _preserve_area_with_buffer(polygon, target_area=target, tolerance=1e-4)
+        brentq = _preserve_area_brentq(
+            polygon,
+            target_area=target,
+            tolerance=1e-4,
+            current_area=polygon.area,
+            perimeter=polygon.length,
+        )
+        assert brentq is not None
+        assert abs(newton.area - target) < 1e-4
+        assert abs(brentq.area - target) < 1e-4
+        assert abs(newton.area - brentq.area) < 1e-3
+
+
+class TestPreserveAreaBrentq:
+    """Test suite for the bracketed Brent's-method fallback."""
+
+    def test_brentq_grows_polygon(self):
+        """Fallback expands a polygon to a larger target area."""
+        polygon = Polygon([(0, 0), (5, 0), (5, 5), (0, 5)])
+        result = _preserve_area_brentq(
+            polygon,
+            target_area=100.0,
+            tolerance=1e-3,
+            current_area=polygon.area,
+            perimeter=polygon.length,
+        )
+        assert result is not None
+        assert abs(result.area - 100.0) < 1e-3
+        assert result.area > polygon.area
+
+    def test_brentq_shrinks_polygon(self):
+        """Fallback shrinks a polygon to a smaller target area."""
+        polygon = Polygon([(0, 0), (20, 0), (20, 20), (0, 20)])
+        result = _preserve_area_brentq(
+            polygon,
+            target_area=100.0,
+            tolerance=1e-3,
+            current_area=polygon.area,
+            perimeter=polygon.length,
+        )
+        assert result is not None
+        assert abs(result.area - 100.0) < 1e-3
+        assert result.area < polygon.area
+
 
 class TestJoinAdjacent:
     """Test suite for joining adjacent geometries."""