Navigation Menu

Skip to content

karimbahgat/Shapy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation for # Shapy

v0.1

Author: Karim Bahgat

Year: 2014

Description:

A lightweight and portable pure-Python version of Shapely for geometry processing.

Introduction:

As the name suggests, Shapy is a pure-Python version of Shapely. It is used for geometrical and geographical problem-solving.

Based on and modelled precisely after Shapely, so should be easy to use by those familiar with Shapely...

Also some functionality that's not available in Shapely.

Dependencies:

Absolutely no dependencies, though it probably won't work on Python3 yet.

Usage:

The package is not yet complete. Currently the supported features are:

  • All shapely geometries can be created (Point,MultiPoint,LineString,MultiLineString,Polygon,MultiPolygon)
  • All geometries have the basic shapely attributes with correct values:
    • .geom_type, .bounds, .area, .length
    • all geometries also have the .geo_interface geojson attribute
  • Easily visualize all geometries with the .view() method. Note: The coordinate converter has some quirks so might not show the shape correctly or at all.
  • Easily make geometries from real shapefiles by passing any object that has the geo_interface to the geoj2geom(object) function.
  • Point geometries can use the .distance() method to any other geometry.
  • The intersect(), union(), difference(), symmetric_difference() methods can be used by Polygon and MultiPolygon geometries, but currently only with other Polygon or MultiPolygon geometries.
  • The buffer() method can be used by Polygons and MultiPolygons.

Docs are not yet completed, but just follow the shapely usage and names and you should be alright.

There's still a few things left to add, so it would be great if others could contribute some of the remaining functionality.

Functions and Classes

shapy.LineString(...) --> class object

  • no documentation for this class

    • .buffer(...):

    • no documentation for this method

    • .view(...):

    Draws and pops up a window with the shape.

    • imagesize is an optional two-tuple of the pixel size of the viewimage in the form of (pixelwidth,pixelheight). Default is 400 by 400.

shapy.LinearRing(...) --> class object

  • no documentation for this class

shapy.MultiLineString(...) --> class object

  • no documentation for this class

    • .buffer(...):

    NOTE: Fails for multilines!

    • .view(...):

    Draws and pops up a window with the shape.

    • imagesize is an optional two-tuple of the pixel size of the viewimage in the form of (pixelwidth,pixelheight). Default is 400 by 400.

shapy.MultiPoint(...) --> class object

  • no documentation for this class

    • .buffer(...):

    • no documentation for this method

    • .view(...):

    Draws and pops up a window with the shape.

    • imagesize is an optional two-tuple of the pixel size of the viewimage in the form of (pixelwidth,pixelheight). Default is 400 by 400.

shapy.MultiPolygon(...) --> class object

  • no documentation for this class

    • .buffer(...):

    • no documentation for this method

    • .difference(...):

    • no documentation for this method

    • .intersect(...):

    • no documentation for this method

    • .symmetric_difference(...):

    • no documentation for this method

    • .union(...):

    • no documentation for this method

    • .view(...):

    Draws and pops up a window with the shape.

    • imagesize is an optional two-tuple of the pixel size of the viewimage in the form of (pixelwidth,pixelheight). Default is 400 by 400.

shapy.Point(...) --> class object

  • no documentation for this class

    • .buffer(...):

    • no documentation for this method

    • .distance(...):

    • no documentation for this method

    • .view(...):

    Draws and pops up a window with the shape.

    • imagesize is an optional two-tuple of the pixel size of the viewimage in the form of (pixelwidth,pixelheight). Default is 400 by 400.

shapy.Polygon(...) --> class object

  • no documentation for this class

    • .buffer(...):

    • no documentation for this method

    • .clean(...):

    • no documentation for this method

    • .contains(...):

    • no documentation for this method

    • .difference(...):

    • no documentation for this method

    • .distance(...):

    • no documentation for this method

    • .intersect(...):

    • no documentation for this method

    • .simplify(...):

    • no documentation for this method

    • .symmetric_difference(...):

    • no documentation for this method

    • .union(...):

    • no documentation for this method

    • .view(...):

    Draws and pops up a window with the shape.

    • imagesize is an optional two-tuple of the pixel size of the viewimage in the form of (pixelwidth,pixelheight). Default is 400 by 400.

    • .within(...):

    • no documentation for this method

shapy.RunTestSuite(...):

  • no documentation for this function

shapy.buffertesting(...):

  • no documentation for this function

shapy.distancetesting(...):

  • no documentation for this function

shapy.geoj2geom(...):

Takes any object that has the geo_interface attribute and creates and returns a ready-to-use geometry instance.

shapy.typetesting(...):

  • no documentation for this function

shapy.uniontesting(...):

  • no documentation for this function

About

A lightweight pure-Python version of Shapely for working with geographical shapes.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages