Metadata-Version: 2.1
Name: centerline
Version: 0.6.3
Summary: Calculate the centerline of a polygon
Home-page: https://github.com/fitodic/centerline
Author: Filip Todic
Author-email: todic.filip@gmail.com
License: MIT License
Download-URL: https://pypi.org/project/centerline/
Description: Centerline
        ==========
        
        .. image:: https://travis-ci.org/fitodic/centerline.svg?branch=master
            :target: https://travis-ci.org/fitodic/centerline
            :alt: Build
        
        .. image:: https://readthedocs.org/projects/centerline/badge/?version=latest
            :target: http://centerline.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://coveralls.io/repos/github/fitodic/centerline/badge.svg?branch=master
            :target: https://coveralls.io/github/fitodic/centerline?branch=master
            :alt: Coverage
        
        .. image:: https://img.shields.io/pypi/v/centerline.svg
            :target: https://pypi.python.org/pypi/centerline
            :alt: Version
        
        .. image:: https://pepy.tech/badge/centerline
            :target: https://pepy.tech/project/centerline
            :alt: Downloads
        
        .. figure::  docs/images/example.png
           :align:   center
        
        Roads, rivers and similar linear structures are often represented by
        long and complex polygons. Since one of the most important attributes of
        a linear structure is its length, extracting that attribute from a
        polygon can prove to be more or less difficult.
        
        This library tries to solve this problem by creating the the polygon's
        centerline using the `Voronoi diagram
        <https://en.wikipedia.org/wiki/Voronoi_diagram>`_. For more info on how
        to use this package, see the
        `official documentation <http://centerline.readthedocs.io/>`_.
        
        
        Features
        ^^^^^^^^
        
        * A command-line script for creating centerlines from a vector source file and saving them into a destination vector file: ``create_centerlines``
        
        .. code:: bash
        
            $ create_centerlines input.shp output.geojson
        
        
        * The ``Centerline`` class that allows integration into your own workflow.
        
        
        .. code:: python
        
            >>> from shapely.geometry import Polygon
            >>> from centerline.geometry import Centerline
        
            >>> polygon = Polygon([[0, 0], [0, 4], [4, 4], [4, 0]])
            >>> attributes = {"id": 1, "name": "polygon", "valid": True}
        
            >>> centerline = Centerline(polygon, **attributes)
            >>> centerline.id == 1
            True
            >>> centerline.name
            'polygon'
            >>> centerline.geoms
            <shapely.geometry.base.GeometrySequence object at 0x7f7d24116210>
        
Keywords: polygon,centerline,Voronoi
Platform: POSIX
Platform: Microsoft
Platform: MacOS
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Visualization
Provides-Extra: dev
Provides-Extra: gdal
Provides-Extra: lint
Provides-Extra: test
Provides-Extra: docs
