Skip to main content

Spherical mercator and XYZ tile utilities

Project description

https://travis-ci.org/mapbox/mercantile.svg https://coveralls.io/repos/github/mapbox/mercantile/badge.svg?branch=master

Spherical mercator coordinate and tile utilities

The mercantile module provides ul(xtile, ytile, zoom) and bounds(xtile, ytile, zoom) functions that respectively return the upper left corner and bounding longitudes and latitudes for XYZ tiles, a xy(lng, lat) function that returns spherical mercator x and y coordinates, a tile(lng, lat, zoom) function that returns the tile containing a given point, and quadkey conversion functions quadkey(xtile, ytile, zoom) and quadkey_to_tile(quadkey) for translating between quadkey and tile coordinates.

>>> import mercantile
>>> mercantile.ul(486, 332, 10)
LngLat(lng=-9.140625, lat=53.33087298301705)
>>> mercantile.bounds(486, 332, 10)
LngLatBbox(west=-9.140625, south=53.12040528310657, east=-8.7890625, north=53.33087298301705)
>>> mercantile.xy(*mercantile.ul(486, 332, 10))
(-1017529.7205322663, 7044436.526761846)
>> mercantile.xy_bounds(486, 332, 10)
Bbox(left=-1017529.7205322663, bottom=7005300.768279833, right=-978393.962050256, top=7044436.526761846)
>>> mercantile.tile(*mercantile.ul(486, 332, 10) + (10,))
Tile(x=486, y=332, z=10)
>>> mercantile.quadkey(486, 332, 10)
'0313102310'
>>> mercantile.quadkey_to_tile('0313102310')
Tile(x=486, y=332, z=10)

Also in mercantile are functions to traverse the tile stack.

>>> mercantile.parent(486, 332, 10)
Tile(x=243, y=166, z=9)
>>> mercantile.children(mercantile.parent(486, 332, 10))
[Tile(x=486, y=332, z=10), Tile(x=487, y=332, z=10), Tile(x=487, y=333, z=10), Tile(x=486, y=333, z=10)]

Named tuples are used to represent tiles, coordinates, and bounding boxes.

Mercantile CLI

Mercantile’s command line interface, named “mercantile”, has commands for getting the shapes of Web Mercator tiles as GeoJSON and getting the tiles that intersect with a GeoJSON bounding box.

$ mercantile
Usage: mercantile [OPTIONS] COMMAND [ARGS]...

  Command line interface for the Mercantile Python package.

Options:
  -v, --verbose  Increase verbosity.
  -q, --quiet    Decrease verbosity.
  --help         Show this message and exit.

Commands:
  children  Write the children of the tile.
  parent    Write the parent tile.
  quadkey   Convert to/from quadkeys.
  shapes    Write the shapes of tiles as GeoJSON.
  tiles     List tiles that overlap or contain a lng/lat point, bounding box,
            or GeoJSON objects.

See docs/cli.rst for more about the mercantile program.

See Also

supermercado is another python lib with added tile logic functionality (union tile shapes, find edge tiles, and find tile intersections for complex geometries).

node-sphericalmercator provides many of the same features for Node.

tilebelt has some of the GeoJSON features as mercantile and a few more (tile parents, quadkey).

Project details


Download files

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

Source Distribution

mercantile-0.11.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distributions

mercantile-0.11.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

mercantile-0.11.0-py2-none-any.whl (11.1 kB view details)

Uploaded Python 2

File details

Details for the file mercantile-0.11.0.tar.gz.

File metadata

  • Download URL: mercantile-0.11.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mercantile-0.11.0.tar.gz
Algorithm Hash digest
SHA256 67a8d01cb16d596c2e36ddcb0b6104e2c795a2e72c274f037a3bacb5cda72816
MD5 6f238c4ddfdb71a6effa42f85bc8bd66
BLAKE2b-256 9acc338fcdf5b12bfb0b7e26d703fb78cd23e04b2828ac0803a3a8ff89fa78fa

See more details on using hashes here.

File details

Details for the file mercantile-0.11.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mercantile-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c941bbfa04ee9dc0c6bf41f8527f93cecb4b7582922bb47978e0b1aa7a91cffc
MD5 5968eb76d4cc8f9f62881b4bede81289
BLAKE2b-256 3a76a15ebaafbc8e1af4d0eec22d089b4d907a8f530356d0f260d93b11ec39fb

See more details on using hashes here.

File details

Details for the file mercantile-0.11.0-py2-none-any.whl.

File metadata

File hashes

Hashes for mercantile-0.11.0-py2-none-any.whl
Algorithm Hash digest
SHA256 fe5408aab3ca00d855c55faf5ff90da68eb64957bf761ec66ab04848ac9851a4
MD5 897eb1cf4b4b3c4f8bf750e6eaef1848
BLAKE2b-256 b6815366f19aad9638543475beb13377946f3d1773be088380ca67158b117e8b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page