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.10.0.tar.gz (8.3 kB view details)

Uploaded Source

Built Distributions

mercantile-0.10.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

mercantile-0.10.0-py2-none-any.whl (11.0 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for mercantile-0.10.0.tar.gz
Algorithm Hash digest
SHA256 4b6bdba8ed134092d6f9f040b3e4d979db3791ba6c3de94412d53c3dc2f7a8d5
MD5 39051fd6827dd4f451f730fd0e4a92aa
BLAKE2b-256 5003ace5be81fc0348deab9bb34b48b3d2c988c43b155502c8280e611d330f46

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mercantile-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f6df72abe8ceca73889b09b2bd6f263cc427f9beecfefba7a127974d6cc79bdf
MD5 bcc75894e8e8c0f879a32b9404910179
BLAKE2b-256 eb6d0f4bb89cd6eb56d51a497ef2edc485844505bf20a5fd6d412d5fdef66c38

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mercantile-0.10.0-py2-none-any.whl
Algorithm Hash digest
SHA256 19e9fcc37f1c391e588c6fe0ba27a01eee000cffab6b8c49604d8e643815488d
MD5 2a1775e0e3f27d7603e874f4e8418814
BLAKE2b-256 52feaf988c7903d453dd0c8a6622074d31bf3b19ba7faede9ea677ebd40189ca

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