Welcome to Geoformat

Introduction

Geoformat is GDAL / OGR overlayer wiht MIT licence. The library aim is to simplify loading and OGR 'DataSource' and 'Layer' manipulations. Until now this library is in Alpha mode. This means that for the moment the structure of this library is not full oriented object compatible.

Installation

$ pip install geoformat

Feature structure

The feature is de basic object that contains information. This information is of two types:

attributes : alphanumeric data that describes feature
geometry : type and coordinates that describe geometrically the feature

attributes

geometry

There are seven types of geometries that we can group into 3 categories.

basics

type	sample data	geoformat
Point	underground station	{ "type": "Point", "coordinates": [-115.81, 37.24], 'bbox': (-115.81, 37.24, -115.81, 37.24) }
LineString	a road	{ "type": "LineString", "coordinates": [[8.919, 44.4074], [8.923, 44.4075]], 'bbox': (8.919, 44.4074, 8.923, 44.4075) }
Polygon	an island	{ "type": "Polygon", "coordinates": [[[2.38, 57.322], [23.194, -20.28], [-120.43, 19.15], [2.38, 57.322]], [[-5.21, 23.51], [15.21, -10.81], [-20.51, 1.51], [-5.21, 23.51]]], 'bbox': (-120.43, -20.28, 23.194, 57.322) }

type

representation

sample data

geoformat

Point

underground station

{
  "type": "Point",
  "coordinates": [-115.81, 37.24],
  'bbox': (-115.81, 37.24, -115.81, 37.24)
}

LineString

a road

{
  "type": "LineString",
  "coordinates": [[8.919, 44.4074], [8.923, 44.4075]],
  'bbox': (8.919, 44.4074, 8.923, 44.4075)
}

Polygon

an island

{
  "type": "Polygon",
  "coordinates": [[[2.38, 57.322], [23.194, -20.28], [-120.43, 19.15], [2.38, 57.322]], [[-5.21, 23.51], [15.21, -10.81], [-20.51, 1.51], [-5.21, 23.51]]],
  'bbox': (-120.43, -20.28, 23.194, 57.322)
}

composed

type	sample data	geoformat
MultiPoint	exits from same underground station	{ "type": "MultiPoint", "coordinates": [ [-155.52, 19.61], [-156.22, 20.74], [-157.97, 21.46] ], "bbox": (-157.97, 19.61, -155.52, 21.46) }
MultiLineString	a river with several tributaries	{ "type": "MultiLineString", "coordinates": [ [[3.75, 9.25], [-130.95, 1.52]], [[23.15, -34.25], [-1.35, -4.65], [3.45, 77.95]] ], "bbox": (-130.95, -34.25, 23.15, 77.95) }
MultiPolygon	a country with an island	{ "type": "MultiPolygon", "coordinates": [ [[[3.78, 9.28], [-130.91, 1.52], [35.12, 72.234], [3.78, 9.28]]], [[[23.18, -34.29], [-1.31, -4.61], [3.41, 77.91], [23.18, -34.29]]] ], "bbox": (-130.91, -34.29, 35.12, 77.91) }

type

representation

sample data

geoformat

MultiPoint

exits from same underground station

{
  "type": "MultiPoint",
  "coordinates": [
    [-155.52, 19.61],
    [-156.22, 20.74],
    [-157.97, 21.46]
  ],
  "bbox": (-157.97, 19.61, -155.52, 21.46)
}

MultiLineString

a river with several tributaries

{
  "type": "MultiLineString",
  "coordinates": [
    [[3.75, 9.25], [-130.95, 1.52]],
    [[23.15, -34.25], [-1.35, -4.65], [3.45, 77.95]]
  ],
  "bbox": (-130.95, -34.25, 23.15, 77.95)
}

MultiPolygon

a country with an island

{
  "type": "MultiPolygon",
  "coordinates": [
    [[[3.78, 9.28], [-130.91, 1.52], [35.12, 72.234], [3.78, 9.28]]],
    [[[23.18, -34.29], [-1.31, -4.61], [3.41, 77.91], [23.18, -34.29]]]
  ],
  "bbox": (-130.91, -34.29, 35.12, 77.91)
}

sets

type	representation	sample data	geoformat
GeometryCollection		a mix of all examples above	{ "type": 'GeometryCollection', "geometries": [ { "type": "Point", "coordinates": [-115.81, 37.24], 'bbox': (-115.81, 37.24, -115.81, 37.24) }, { "type": "LineString", "coordinates": [[8.919, 44.4074], [8.923, 44.4075]], 'bbox': (8.919, 44.4074, 8.923, 44.4075) }, { "type": "Polygon", "coordinates": [[[2.38, 57.322], [23.194, -20.28], [-120.43, 19.15], [2.38, 57.322]], [[-5.21, 23.51], [15.21, -10.81], [-20.51, 1.51], [-5.21, 23.51]]], 'bbox': (-120.43, -20.28, 23.194, 57.322) }, { 'type': 'MultiPoint', 'coordinates': [[-155.52, 19.61], [-156.22, 20.74], [-157.97, 21.46]], 'bbox': (-157.97, 19.61, -155.52, 21.46) }, { "type": 'MultiLineString', "coordinates": [[[3.75, 9.25], [-130.95, 1.52]], [[23.15, -34.25], [-1.35, -4.65], [3.45, 77.95]]], 'bbox': (-130.95, -34.25, 23.15, 77.95) }, { 'type': 'MultiPolygon', 'coordinates': [[[[3.78, 9.28], [-130.91, 1.52], [35.12, 72.234], [3.78, 9.28]]], [[[23.18, -34.29], [-1.31, -4.61], [3.41, 77.91], [23.18, -34.29]]]], 'bbox': (-130.91, -34.29, 35.12, 77.91) } ], 'bbox': (-157.97, -34.29, 35.12, 77.95) }

type

representation

sample data

geoformat

GeometryCollection

a mix of all examples above

{
  "type": 'GeometryCollection',
  "geometries": [
    {
      "type": "Point",
      "coordinates": [-115.81, 37.24],
      'bbox': (-115.81, 37.24, -115.81, 37.24)
    },
    {
      "type": "LineString",
      "coordinates": [[8.919, 44.4074], [8.923, 44.4075]],
      'bbox': (8.919, 44.4074, 8.923, 44.4075)
    },
    {
      "type": "Polygon",
      "coordinates": [[[2.38, 57.322], [23.194, -20.28], [-120.43, 19.15], [2.38, 57.322]], [[-5.21, 23.51], [15.21, -10.81], [-20.51, 1.51], [-5.21, 23.51]]],
      'bbox': (-120.43, -20.28, 23.194, 57.322)
    }, 
    {
      'type': 'MultiPoint',
      'coordinates': [[-155.52, 19.61], [-156.22, 20.74], [-157.97, 21.46]],
      'bbox': (-157.97, 19.61, -155.52, 21.46)
    },
    {
      "type": 'MultiLineString',
      "coordinates": [[[3.75, 9.25], [-130.95, 1.52]], [[23.15, -34.25], [-1.35, -4.65], [3.45, 77.95]]],
      'bbox': (-130.95, -34.25, 23.15, 77.95)
    },
    {
      'type': 'MultiPolygon', 
      'coordinates': [[[[3.78, 9.28], [-130.91, 1.52], [35.12, 72.234], [3.78, 9.28]]], [[[23.18, -34.29], [-1.31, -4.61], [3.41, 77.91], [23.18, -34.29]]]],
      'bbox': (-130.91, -34.29, 35.12, 77.91)
    }
  ],
  'bbox': (-157.97, -34.29, 35.12, 77.95)
}

Geolayer structure

Strucutre of Geoformat

Geolayer metadata

'metadata' key in geolayer root structure is used to inform the structure of the geolayer.

If geolayer contains attribute data "fields" key must be filled in. If geolayer contains geometries data "geometry_ref" key must be filled in.

Field type

Each field in geolayer must be filed in "metadata" => "fields" structure.

Is informed : - field name - field type : you have to give code of field type (see table below) - field width - field precision - field index

Code	Name
0	Integer
1	Boolean
2	Real
3	RealList
4	String
5	StringList
6	WideString
7	WideStringList
8	Binary
9	Date
10	DateList
11	DateTime
12	Integer64
13	Integer64List

Geometry type

Each geometrie in geolayer must be filed in "metadata" => "geometry_ref" structure.

Is informed - type : each geometries type code present in geolayer (see table below) - crs : coordinate reference systeme in WKT format or EPSG

Code	Name
0	Unknown
1	Point
2	LineString
3	Polygon
4	MultiPoint
5	MultiLinestring
6	MultiPolygon
7	GeometryCollection
100	None

Examples

Open a geocontainer

A container is an equivalent to folder or a database containing one or several geolayer.

import geoformat

commune_path = 'data/FRANCE_IGN/COMMUNE_2016_MPO_L93.shp'
gare_path = 'data/FRANCE_IGN/GARES_PT_L93.shp'

layer_list = [commune_path, gare_path]

geocontainer = geoformat.ogr_layers_to_geocontainer(layer_list)

print(geocontainer['layers'].keys())

# >>>dict_keys(['COMMUNE_2016_MPO_L93', 'GARES_PT_L93'])

Open a geolayer

A geolayer is an equivalent to a file or a table in database containing one or several features with attibutes and/or geometry.

import geoformat

departement_path = 'data/FRANCE_IGN/DEPARTEMENT_2016_L93.shp'

geolayer = geoformat.ogr_layer_to_geolayer(departement_path)

print(len(geolayer['features']))

# >>>96

Print data geolayer

Sometime it can be uselful to print in terminal geolayer's attributes.

import geoformat

region_path = 'data/FRANCE_IGN/REGION_2016_L93.shp'

geolayer = geoformat.ogr_layer_to_geolayer(region_path)

print(geoformat.print_features_data_table(geolayer)):

    
### >>>
+--------+----------+-------------------------------------+------------+------------+
| i_feat | CODE_REG | NOM_REG                             | POPULATION | SUPERFICIE |
+========+==========+=====================================+============+============+
| 0      | 76       | LANGUEDOC-ROUSSILLON-MIDI-PYRENEES  | 5683878    | 7243041    |
| 1      | 75       | AQUITAINE-LIMOUSIN-POITOU-CHARENTES | 5844177    | 8466821    |
| 2      | 84       | AUVERGNE-RHONE-ALPES                | 7757595    | 7014795    |
| 3      | 32       | NORD-PAS-DE-CALAIS-PICARDIE         | 5987883    | 3187435    |
| 4      | 44       | ALSACE-CHAMPAGNE-ARDENNE-LORRAINE   | 5552388    | 5732928    |
| 5      | 93       | PROVENCE-ALPES-COTE D'AZUR          | 4953675    | 3155736    |
| 6      | 27       | BOURGOGNE-FRANCHE-COMTE             | 2819783    | 4746283    |
| 7      | 52       | PAYS DE LA LOIRE                    | 3660852    | 2997777    |
| 8      | 28       | NORMANDIE                           | 3328364    | 2728511    |
| 9      | 11       | ILE-DE-FRANCE                       | 11959807   | 1205191    |
| 10     | 24       | CENTRE-VAL DE LOIRE                 | 2570548    | 3905914    |
| 11     | 53       | BRETAGNE                            | 3258707    | 2702269    |
| 12     | 94       | CORSE                               | 320208     | 875982     |
+--------+----------+-------------------------------------+------------+------------+

Change geolayer coordinate reference system [CRS]

It can be usefull to change the projection for a layer. In this example we will transform a geolayer in projection Lambert93 [EPSG:2154] to coordinates system WGS84 [EPSG:4326].

import geoformat

region_path = 'data/FRANCE_IGN/REGION_2016_L93.shp'

geolayer = geoformat.ogr_layer_to_geolayer(region_path)

geolayer = geoformat.reproject_geolayer(geolayer, out_crs=4326)

print(geolayer['metadata']['geometry_ref']['crs'])

# >>>4326

Write geolayer in a OGR compatible GIS file

You can obviously convert a geolayer in a compatible OGR file format. In this case ye put a geolayer in 'ESRi SHAPEFILE' format and we create a new file in 'GEOJSON' (we add a reprojection because geojson should be in WGS84 coordinates system).

import geoformat

gares_shp_path = 'data/FRANCE_IGN/GARES_L93.shp'
gares_geojson_path =  'data/FRANCE_IGN/GARES_L93.geojson'

geolayer = geoformat.ogr_layer_to_geolayer(gares_shp_path)

geolayer = geoformat.reproject_geolayer(geolayer, out_crs=4326)

geoformat.geolayer_to_ogr_layer(geolayer, gares_geojson_path, 'GEOJSON')

Write a container in OGR compatible dataSource

Like geolayer you can write a geoformat container in a folder or a GRG compatible datasource. Here we have a geocontainer with a lot of layers and we want to save all of this in an other folder (but it can be also a 'POSTGRESQL' database).

import geoformat

# INPUT
commune_path = 'data/FRANCE_IGN/COMMUNE_2016_MPO_L93.shp'
gare_path = 'data/FRANCE_IGN/GARES_PT_L93.shp'

# OUTPUT
output_folder = 'data/'

layer_list = [commune_path, gare_path]

geocontainer = geoformat.ogr_layers_to_geocontainer(layer_list)

geoformat.geocontainer_to_ogr_format(geocontainer, output_folder, 'kml')

Development Status
- 3 - Alpha
Intended Audience
- Developers
- Science/Research
License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language
Topic
- Scientific/Engineering :: GIS

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geoformat-20210122.tar.gz (71.4 kB view details)

Uploaded Jan 22, 2021 Source

File details

Details for the file geoformat-20210122.tar.gz.

File metadata

Download URL: geoformat-20210122.tar.gz
Upload date: Jan 22, 2021
Size: 71.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.5

File hashes

Hashes for geoformat-20210122.tar.gz
Algorithm	Hash digest
SHA256	`4f12beca8d28b6ad8eb55174202d4c16d442749b85fc6f24dbc79a11859d56dd`
MD5	`213877794fbec322066491d7615ab660`
BLAKE2b-256	`2dc0d8f38bd1fb2496da0f786d650577554106f8cef08ce16b7dd9ed2c60bf44`