Metadata-Version: 2.1
Name: geopolygonize
Version: 0.1.2
Summary: Convert geographic rasters into simplified polygons
Project-URL: Documentation, https://github.com/rainflame/geopolygonize#readme
Project-URL: Issues, https://github.com/rainflame/geopolygonize/issues
Project-URL: Source, https://github.com/rainflame/geopolygonize
Author-email: Sydney Zheng <slzheng@alumni.cmu.edu>, Christian Broms <christian@rainflame.com>
License-Expression: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.9
Requires-Dist: geopandas>=0.14.1
Requires-Dist: matplotlib>=3.8.2
Requires-Dist: numpy>=1.26.2
Requires-Dist: rasterio>=1.0.0
Requires-Dist: rtree>=1.1.0
Requires-Dist: scipy>=1.11.0
Requires-Dist: shapely>=2.0.0
Requires-Dist: tqdm>=4.66.1
Description-Content-Type: text/markdown

# Geopolygonize

Convert geographic rasters into simplified polygons. Given an input raster file, this tool produces a shapefile representation of the raster that simplifies out pixelation. It also maintains shapes' relations to one another such that the output is guaranteed to have no gaps.

#### Algorithm

Most existing methods for polygon simplification such as the [Douglas–Peucker simplification algorithm](https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm) or [concave hulls](http://lin-ear-th-inking.blogspot.com/2022/04/outer-and-inner-concave-polygon-hulls.html) operate on a single polygon at a time. This presents a problem when run on a collection of polygons that fit together perfectly–simplifying each polygon separately will introduce unpredictable gaps. Our algorithm takes an approach similar to [TopoJSON](https://github.com/topojson/topojson). It identifies the boundaries shared between polygons, simplifies those boundaries, then assigns the simplified boundaries back to the polygons. This results in simplified polygons that fit perfectly together without any gaps.

## Install

```
pip install geopolygonize
```

## Quickstart

To convert a raster to simplified polygons, run:

```
geopolygonize --input-file="data/input.tif" --output-file="data/output.shp"
```

## CLI Options

### `--min-blob-size`

Optional raster preprocessing step to remove pixels that are not connected to neighboring pixels with the same value. This value dictates the minimum number of pixels of the same value each must be connected to in order to be kept. Pixels in blobs smaller than this value will be removed and filled with the most common pixel value surrounding it.

### `--tile-size`

The polygonization process can be run in parallel to speed up the computation. To prepare to process in parallel, the raster is cut into square tiles of this number of pixels.

### `--workers`

Number of workers that should be spawned to process tiles in parallel.

## Development

Install the requirements:

```
pip install -r requirements.txt
```

\# TODO: API docs
