voronoiq 0.1.0__tar.gz

voronoiq-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Your Name
+
+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.

voronoiq-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+recursive-include voronoiq *.py
+recursive-include tests *.py

voronoiq-0.1.0/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: voronoiq
+Version: 0.1.0
+Summary: Weighted Voronoi Diagrams — multiplicative, additive and power (Laguerre) modes
+Author-email: Emerson Marreiros <ec2763@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/emerson-marreiros/voronoiq
+Project-URL: Repository, https://github.com/emerson-marreiros/voronoiq
+Project-URL: Issues, https://github.com/emerson-marreiros/voronoiq/issues
+Keywords: voronoi,weighted voronoi,computational geometry,diagram,laguerre
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.23
+Requires-Dist: matplotlib>=3.5
+Provides-Extra: full
+Requires-Dist: scipy>=1.9; extra == "full"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: scipy>=1.9; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# voronoiq — Weighted Voronoi Diagrams for Python
+
+A lightweight, dependency-light Python library for constructing and
+visualising **weighted Voronoi diagrams**, including:
+
+| Mode | Distance function | Effect of larger weight |
+|---|---|---|
+| `"multiplicative"` | `dist(p,g) / w(g)` | larger region |
+| `"additive"` | `dist(p,g) − w(g)` | larger region |
+| `"power"` | `dist(p,g)² − w(g)²` | larger region (power diagram) |
+
+---
+
+## Installation
+
+```bash
+pip install numpy scipy matplotlib
+# clone / copy voronoiq/ into your project
+```
+
+Dependencies: **numpy**, **scipy** (optional, for boundary_pixels),
+**matplotlib** (for visualisation).
+
+---
+
+## Quick start
+
+```python
+import numpy as np
+from voronoiq import WeightedVoronoi
+
+pts = np.array([[0.2, 0.3],
+                [0.7, 0.6],
+                [0.5, 0.1],
+                [0.1, 0.9]])
+w   = np.array([1.0, 2.5, 0.5, 1.8])
+
+wv = WeightedVoronoi(pts, w, mode="multiplicative", resolution=512)
+wv.compute()
+wv.plot()          # shows an interactive matplotlib figure
+wv.to_png("out.png")
+```
+
+---
+
+## API reference
+
+### `WeightedVoronoi(points, weights, **kwargs)`
+
+| Parameter | Default | Description |
+|---|---|---|
+| `points` | — | `(N, 2)` generator coordinates |
+| `weights` | — | `(N,)` generator weights |
+| `mode` | `"multiplicative"` | distance metric |
+| `resolution` | `512` | pixels along longer axis |
+| `domain` | auto (bounding box + 5 %) | `((xmin,xmax),(ymin,ymax))` |
+| `palette` | `"tab20"` | matplotlib colormap name |
+| `show_generators` | `True` | draw seed points |
+| `show_weights` | `False` | annotate weights |
+| `show_boundaries` | `True` | draw cell edges |
+
+#### Methods
+
+```python
+wv.compute()                     # rasterise the diagram (required first)
+
+wv.plot(**kwargs)                # returns (fig, ax)
+wv.plot_distance_field()         # heat-map of min weighted distance
+wv.plot_comparison()             # side-by-side of all 3 modes
+
+wv.owner(x, y)                   # generator index owning (x, y)
+wv.region_of(x, y)               # VoronoiRegion containing (x, y)
+wv.nearest_generators(x, y, k=3) # k nearest generators by weighted dist
+
+wv.to_png("out.png", dpi=150)
+wv.to_svg("out.svg")
+wv.to_csv("out.csv")             # index, x, y, weight, area, centroid
+wv.to_label_array()              # (H, W) int ndarray — copy
+```
+
+#### Key attributes (after `compute()`)
+
+| Attribute | Type | Description |
+|---|---|---|
+| `label_grid` | `(H, W) int32` | generator index per pixel |
+| `dist_grid` | `(H, W) float64` | minimum weighted distance per pixel |
+| `regions` | `list[VoronoiRegion]` | one object per generator |
+
+---
+
+### `VoronoiRegion`
+
+```python
+r = wv.regions[0]
+
+r.index          # int — generator index
+r.generator      # (2,) float — (x, y)
+r.weight         # float
+r.pixel_mask     # (H, W) bool
+r.color          # (R, G, B) tuple
+
+r.area           # int — number of pixels
+r.centroid       # (2,) float — mean (x, y) of mask pixels
+r.boundary_pixels # (K, 2) row/col indices of boundary pixels
+```
+
+---
+
+### `voronoiq.generators`
+
+```python
+from voronoiq.generators import (
+    random_generators,           # uniform random
+    grid_generators,             # regular grid with optional jitter
+    poisson_disk_generators,     # Bridson blue-noise sampling
+)
+
+pts, w = random_generators(n=20, weight_range=(0.5, 2.0), seed=42)
+pts, w = grid_generators(nx=6, ny=6, jitter=0.04, seed=0)
+pts, w = poisson_disk_generators(min_dist=0.1, seed=7)
+```
+
+All functions return `(points, weights)` tuples ready for
+`WeightedVoronoi`.
+
+---
+
+### `voronoiq.metrics`
+
+```python
+from voronoiq.metrics import (
+    multiplicative_weighted_distance,  # scalar
+    additive_weighted_distance,
+    power_distance,
+    batch_multiplicative,              # vectorised over generators
+    batch_additive,
+    batch_power,
+)
+```
+
+---
+
+## Examples
+
+### Comparison of all three modes
+
+```python
+wv = WeightedVoronoi(pts, w, mode="multiplicative", resolution=400)
+wv.compute()
+fig, axes = wv.plot_comparison(figsize=(18, 6))
+```
+
+### Distance field heat-map
+
+```python
+wv.plot_distance_field(cmap="plasma")
+```
+
+### Querying which region owns a point
+
+```python
+idx = wv.owner(0.5, 0.5)
+region = wv.region_of(0.5, 0.5)
+print(region)
+# VoronoiRegion(index=1, generator=(0.700, 0.600), weight=2.500, area=14832 px)
+```
+
+### Exporting
+
+```python
+wv.to_png("voronoi.png", dpi=200)
+wv.to_svg("voronoi.svg")
+wv.to_csv("voronoi.csv")
+```
+
+---
+
+## Project structure
+
+```
+voronoiq/
+├── __init__.py      # public API
+├── diagram.py       # WeightedVoronoi class
+├── region.py        # VoronoiRegion dataclass
+├── generators.py    # random / grid / Poisson-disk seed generators
+└── metrics.py       # distance functions + registry
+tests/
+└── test_voronoiq.py # full test suite (pytest)
+README.md
+```
+
+---
+
+## License
+
+MIT

voronoiq-0.1.0/README.md

@@ -0,0 +1,196 @@
+# voronoiq — Weighted Voronoi Diagrams for Python
+
+A lightweight, dependency-light Python library for constructing and
+visualising **weighted Voronoi diagrams**, including:
+
+| Mode | Distance function | Effect of larger weight |
+|---|---|---|
+| `"multiplicative"` | `dist(p,g) / w(g)` | larger region |
+| `"additive"` | `dist(p,g) − w(g)` | larger region |
+| `"power"` | `dist(p,g)² − w(g)²` | larger region (power diagram) |
+
+---
+
+## Installation
+
+```bash
+pip install numpy scipy matplotlib
+# clone / copy voronoiq/ into your project
+```
+
+Dependencies: **numpy**, **scipy** (optional, for boundary_pixels),
+**matplotlib** (for visualisation).
+
+---
+
+## Quick start
+
+```python
+import numpy as np
+from voronoiq import WeightedVoronoi
+
+pts = np.array([[0.2, 0.3],
+                [0.7, 0.6],
+                [0.5, 0.1],
+                [0.1, 0.9]])
+w   = np.array([1.0, 2.5, 0.5, 1.8])
+
+wv = WeightedVoronoi(pts, w, mode="multiplicative", resolution=512)
+wv.compute()
+wv.plot()          # shows an interactive matplotlib figure
+wv.to_png("out.png")
+```
+
+---
+
+## API reference
+
+### `WeightedVoronoi(points, weights, **kwargs)`
+
+| Parameter | Default | Description |
+|---|---|---|
+| `points` | — | `(N, 2)` generator coordinates |
+| `weights` | — | `(N,)` generator weights |
+| `mode` | `"multiplicative"` | distance metric |
+| `resolution` | `512` | pixels along longer axis |
+| `domain` | auto (bounding box + 5 %) | `((xmin,xmax),(ymin,ymax))` |
+| `palette` | `"tab20"` | matplotlib colormap name |
+| `show_generators` | `True` | draw seed points |
+| `show_weights` | `False` | annotate weights |
+| `show_boundaries` | `True` | draw cell edges |
+
+#### Methods
+
+```python
+wv.compute()                     # rasterise the diagram (required first)
+
+wv.plot(**kwargs)                # returns (fig, ax)
+wv.plot_distance_field()         # heat-map of min weighted distance
+wv.plot_comparison()             # side-by-side of all 3 modes
+
+wv.owner(x, y)                   # generator index owning (x, y)
+wv.region_of(x, y)               # VoronoiRegion containing (x, y)
+wv.nearest_generators(x, y, k=3) # k nearest generators by weighted dist
+
+wv.to_png("out.png", dpi=150)
+wv.to_svg("out.svg")
+wv.to_csv("out.csv")             # index, x, y, weight, area, centroid
+wv.to_label_array()              # (H, W) int ndarray — copy
+```
+
+#### Key attributes (after `compute()`)
+
+| Attribute | Type | Description |
+|---|---|---|
+| `label_grid` | `(H, W) int32` | generator index per pixel |
+| `dist_grid` | `(H, W) float64` | minimum weighted distance per pixel |
+| `regions` | `list[VoronoiRegion]` | one object per generator |
+
+---
+
+### `VoronoiRegion`
+
+```python
+r = wv.regions[0]
+
+r.index          # int — generator index
+r.generator      # (2,) float — (x, y)
+r.weight         # float
+r.pixel_mask     # (H, W) bool
+r.color          # (R, G, B) tuple
+
+r.area           # int — number of pixels
+r.centroid       # (2,) float — mean (x, y) of mask pixels
+r.boundary_pixels # (K, 2) row/col indices of boundary pixels
+```
+
+---
+
+### `voronoiq.generators`
+
+```python
+from voronoiq.generators import (
+    random_generators,           # uniform random
+    grid_generators,             # regular grid with optional jitter
+    poisson_disk_generators,     # Bridson blue-noise sampling
+)
+
+pts, w = random_generators(n=20, weight_range=(0.5, 2.0), seed=42)
+pts, w = grid_generators(nx=6, ny=6, jitter=0.04, seed=0)
+pts, w = poisson_disk_generators(min_dist=0.1, seed=7)
+```
+
+All functions return `(points, weights)` tuples ready for
+`WeightedVoronoi`.
+
+---
+
+### `voronoiq.metrics`
+
+```python
+from voronoiq.metrics import (
+    multiplicative_weighted_distance,  # scalar
+    additive_weighted_distance,
+    power_distance,
+    batch_multiplicative,              # vectorised over generators
+    batch_additive,
+    batch_power,
+)
+```
+
+---
+
+## Examples
+
+### Comparison of all three modes
+
+```python
+wv = WeightedVoronoi(pts, w, mode="multiplicative", resolution=400)
+wv.compute()
+fig, axes = wv.plot_comparison(figsize=(18, 6))
+```
+
+### Distance field heat-map
+
+```python
+wv.plot_distance_field(cmap="plasma")
+```
+
+### Querying which region owns a point
+
+```python
+idx = wv.owner(0.5, 0.5)
+region = wv.region_of(0.5, 0.5)
+print(region)
+# VoronoiRegion(index=1, generator=(0.700, 0.600), weight=2.500, area=14832 px)
+```
+
+### Exporting
+
+```python
+wv.to_png("voronoi.png", dpi=200)
+wv.to_svg("voronoi.svg")
+wv.to_csv("voronoi.csv")
+```
+
+---
+
+## Project structure
+
+```
+voronoiq/
+├── __init__.py      # public API
+├── diagram.py       # WeightedVoronoi class
+├── region.py        # VoronoiRegion dataclass
+├── generators.py    # random / grid / Poisson-disk seed generators
+└── metrics.py       # distance functions + registry
+tests/
+└── test_voronoiq.py # full test suite (pytest)
+README.md
+```
+
+---
+
+## License
+
+MIT

voronoiq-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "voronoiq"
+version = "0.1.0"
+description = "Weighted Voronoi Diagrams — multiplicative, additive and power (Laguerre) modes"
+readme = "README.md"
+license = { text = "MIT" }
+authors = [
+  { name = "Emerson Marreiros", email = "ec2763@gmail.com" }
+]
+keywords = ["voronoi", "weighted voronoi", "computational geometry", "diagram", "laguerre"]
+classifiers = [
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Operating System :: OS Independent",
+  "Topic :: Scientific/Engineering :: Visualization",
+  "Topic :: Scientific/Engineering :: Mathematics",
+]
+requires-python = ">=3.10"
+dependencies = [
+  "numpy>=1.23",
+  "matplotlib>=3.5",
+]
+
+[project.optional-dependencies]
+full = ["scipy>=1.9"]
+dev  = [
+  "pytest>=7.0",
+  "scipy>=1.9",
+  "build",
+  "twine",
+]
+
+[project.urls]
+Homepage   = "https://github.com/emerson-marreiros/voronoiq"
+Repository = "https://github.com/emerson-marreiros/voronoiq"
+Issues     = "https://github.com/emerson-marreiros/voronoiq/issues"
+
+[tool.setuptools.packages.find]
+include = ["voronoiq*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+env = ["MPLBACKEND=Agg"]   # remove esta linha se não instalar pytest-env

voronoiq-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

voronoiq-0.1.0/tests/conftest.py

@@ -0,0 +1,5 @@
+# tests/conftest.py
+# Force the non-interactive Agg backend before any test imports matplotlib.
+# This avoids TclError / display issues in CI and headless environments.
+import matplotlib
+matplotlib.use("Agg")