Geoprocessing utility for working with vector data


License
MIT
Install
pip install vectorio==2.0.5

Documentation

Vector IO - Geoprocessing utility for working with vector data.

Requirements

  • python3.7
  • gdal >= 2.2
  • rar
  • unrar

Description

This project is a tool for working with vectorial data based on GDAL. This tool is an envelope about gdal and aims to work with different types of vector data quickly, intelligently, and simply. The vectorIO provide the support for (read and write) geojson, wkt and Shapefile, support for quickly switching between different spatial data types, and provides a exception handler for warnings from gdal.

Installation

Docker

Creating a image and instantiate the container:

# access the directory where is the Dockerfile
docker image build -t vectorio-env:001 . # build the image
# vectorio-env:001 - can be any name with the version of the your preference
docker container run -it vectorio-env:001 # instantiate a new container

Ubuntu 18.04

  • Rar
apt-get install rar unrar
  • Gdal

Installing gdal on ubuntu

  • Gdal for python
gdalinfo --version
pip3 install gdal==<gdal_version>

Features

Read and Write Geojson

Working with geojson data and geojson file. By default, the datasource is created as WGS84.

  • Preparing the data
from vectorio.vector import Geojson
data = '{"type": "FeatureCollection","features": [{"type": "Feature","properties": {},"geometry": {"type": "Polygon","coordinates": [[[-44.89013671875,-6.577303118123875],[-46.29638671874999,-7.460517719883772],[-44.4287109375,-7.318881730366743],[-44.89013671875,-6.577303118123875]]]}}]}'
gjs = Geojson()
  • Read all data
ds = gjs.datasource(data)
gjs.collection(ds)
  • Reading and iterating over each feature
ds = gjs.datasource(data)
for item in gjs.items(ds):
    print(item)
  • Creating a new geojson file
ds = gjs.datasource(data)
gjs.write(ds, 'data.geojson')
  • Reading from geojson file
from vectorio.vector import GeoFile
gf_gjs = GeoFile(gjs)
ds = gf_gjs.datasource('data.geojson')
gf_gjs.collection(ds)

Read and write WKT

Working with wkt data and wkt file. Is supported geometry collection and single geometries. By default, the datasource is created as WGS84.

The wkt object has some parameters:

WKT(as_geometry_collection=True, srid=4326)
  • as_geometry_collection: return a geometry collection same when the data is a single geometry by method collection.

  • srid: Initial SRID for WKT.

  • Preparing the data

from vectorio.vector import WKT
data = "GEOMETRYCOLLECTION(POINT(-48.740641051554974 -9.249606262178954), LINESTRING(-50.278726989054974 -11.023166202413554,-48.608805114054974 -10.375450023701761))"
wkt = WKT()
  • Read all data
ds = wkt.datasource(data)
wkt.collection(ds)
  • Reading and iterating over each geometry
ds = wkt.datasource(data)
for item in wkt.items(ds):
    print(item)
  • Creating a new wkt file
ds = wkt.datasource(data)
wkt.write(ds, 'data.wkt')
  • Reading from wkt file
from vectorio.vector import GeoFile
gf_wkt = GeoFile(wkt)
ds = gf_wkt.datasource('data.wkt')
gf_wkt.collection(ds)

Read and write Shapefile

Working with read and write shapefile. Is supported shapefiles compressed as .zip and .rar. By default, the datasource is created as based on projection present on .prj file. obs: read and write of the .rar files is available only for linux OS. Only the ShapefileAsRar class has this restriction. The other classes are available for any OS.

  • Preparing the data
from vectorio.vector import Shapefile
shape = Shapefile()
  • Read all data from .shp file
ds = shape.datasource('data.shp')
shape.collection(ds)
  • Reading and iterating over each feature from .shp file
ds = shape.datasource('data.shp')
for item in shape.items(ds):
    print(item)
  • Creating a new shapefile (Are be created the files .shp, .shx, .dbf, .prj)
ds = shape.datasource('data.shp')
shape.write(ds, 'out.shp')
# >>> out.shp
Read and write Shapefile compressed

By default the algorithm will search recusivly the files .shp, .shx, .dbf, .prj inside of the compressed file. The algorithm will search the first file of the each extension, case the compressed file contains 2 (or more) .shp files, or 2 (or more) .prj file, will be obtained the first .shp file and the first .prj file.

  • Processing from zip
from vectorio.vector import Shapefile, ShapefileAsZip
shape = ShapefileAsZip(Shapefile())
ds = shape.datasource('data.zip') # creating a datasource
shape.collection(ds)  # read all data

for item in shape.items(ds):  # iterating over each item
    print(item)

shape.write(ds, 'out.zip') # Creating a shapefile compressed as .zip
# >>> out.zip
  • Processing from .rar (available only for linux OS)
from vectorio.vector import Shapefile, ShapefileAsRar
shape = ShapefileAsRar(Shapefile())
ds = shape.datasource('data.rar') # creating a datasource
shape.collection(ds)  # read all data

for item in shape.items(ds):  # iterating over each item
    print(item)

shape.write(ds, 'out.rar') # Creating a shapefile compressed as .rar
# >>> out.rar

Reprojecting a Vector

The spatial reprojection works with same geography type thats implements the interface IVector. If the input srid (in_srid) are be ommited, will used the srid from geometry.

  • Reprojecting a shapefile
from vectorio.vector import Shapefile, ShapefileAsZip, VectorReprojected
shape = VectorReprojected(
    ShapefileAsZip(Shapefile()), in_srid=31982, out_srid=4674
)
ds = shape.datasource('data_utm22.zip')

shape.collection(ds)  # read all data

for item in shape.items(ds):  # iterating by each feature
    print(item)

shape.write(ds, 'data_reprojected.zip')  # creating a new shapefile
  • Reprojecting a WKT

By default the wkt is in WGS84 spatial reference.

from vectorio.vector import WKT, VectorReprojected
wkt = VectorReprojected(WKT(), out_srid=31982)
ds = wkt.datasource('POLYGON((-49.698036566343376 -9.951372897703846,-51.148231878843376 -11.591810720955946,-48.467567816343376 -11.763953408065282,-49.698036566343376 -9.951372897703846))')

wkt.collection(ds)  # read all data

for item in wkt.items(ds):  # iterating by each geometry
    print(item)

wkt.write(ds, 'data-reprojected.wkt')  # creating a new wkt file
  • Reprojecting a Geojson

By default the geojson is in WGS84 spatial reference.

from vectorio.vector import Geojson, VectorReprojected
gjs = VectorReprojected(Geojson(), out_srid=31982)
ds = gjs.datasource('{"type": "FeatureCollection","features": [{"type": "Feature","properties": {},"geometry": {"type": "Polygon","coordinates": [[[-45.992889404296875,-9.654907854199012],[-46.12884521484374,-9.72259300616733],[-45.96954345703125,-9.738835407948073],[-45.992889404296875,-9.654907854199012]]]}}]}')

gjs.collection(ds)  # read all data

for item in gjs.items(ds):  # iterating by each feature
    print(item)

gjs.write(ds, 'data-reprojected.geojson')  # creating a new geojson file

Quickly Switching Between Geographic Data

For execution of the Quick switch must be used the VectorComposite present on package vectorio.vector.

VectorComposite(input_vector_obj, ouput_vector_obj)
Quick switch from geojson to wkt
  • Preparing data
from vectorio.vector import Geojson, WKT, VectorComposite
data = '{"type": "FeatureCollection","features": [{"type": "Feature","properties": {},"geometry": {"type": "Polygon","coordinates": [[[-44.89013671875,-6.577303118123875],[-46.29638671874999,-7.460517719883772],[-44.4287109375,-7.318881730366743],[-44.89013671875,-6.577303118123875]]]}}]}'
vector = VectorComposite(Geojson(), WKT())
  • Reading all geometry from geojson as wkt
vector.collection(data)
  • Iterating over all geometries as wkt
for geom_wkt in vector.items(data):
    print(geom_wkt)
  • Creating a wkt file
vector.write(data, 'output.wkt')
Quick switch from wkt to shapefile as zip
from vectorio.vector import Shapefile, ShapefileAsZip, WKT, VectorComposite
data = 'MULTIPOLYGON (((40 40, 20 45, 45 30, 40 40)), ((20 35, 10 30, 10 10, 30 5, 45 20, 20 35), (30 20, 20 15, 20 25, 30 20)))'
vector = VectorComposite(WKT(), ShapefileAsZip(Shapefile()))
  • Reading all geometry from wkt
vector.collection(data)
  • Iterating over all geometries
for geom in vector.items(data):
    print(geom)
  • Creating a shapefile as zip
vector.write(data, 'output.zip')

Raise Exception for Warnings From Gdal

For use the exception from gdal warnings should use the decorator gdal_warning_as_exception presents on vectorio.gdal package. This decorator will throw the error when the IsValid() method from geometry() method will be used.

from vectorio.gdal import gdal_warning_as_exception
from vectorio.vector import WKT

self_intersect_polygon = 'POLYGON((-54.24438490181399 -5.466896872158672,-54.84863294868899 -5.882330540835073,-54.09057630806399 -5.8714019542356475,-54.83764662056399 -5.379399666352095,-54.24438490181399 -5.466896872158672))'

@gdal_warning_as_exception
def possible_error():
    wkt = WKT()
    ds = wkt.datasource(self_intersect_polygon)
    lyr = ds.GetLayer(0)
    feat = lyr.GetFeature(0)
    feat.geometry().IsValid()

possible_error()
# >>> GDALSelfIntersectionGeometry: Self-intersection at or near point -54.469636435829948 -5.6217621987992636
Possibles exceptions
  • GDALSelfIntersectionGeometry: Exception throwed when a polygon contains a self intersection.
  • GDALBadClosedPolygon: Exception throwed when a polygon not correctly close.
  • GDALUnknownException: Exception throwed when occurs a unknown error.

Obs: All the exceptions are available on package vectorio.exceptions