Skip to main content

Spherical mercator and XYZ tile utilities

Project description

Spherical mercator coordinate and tile utilities

The mercantile module provides ul(xtile, ytile, zoom) and bounds(xtile, ytile, zoom) functions that return longitudes and latitudes for XYZ tiles, and a xy(lon, lat) function that returns spherical mercator x and y coordinates.

>>> import mercantile
>>> mercantile.ul(486, 332, 10)
(-9.140625, 53.33087298301705)
>>> mercantile.bounds(486, 332, 10)
(-9.140625, 53.12040528310657, -8.7890625, 53.33087298301705)
>>> mercantile.xy(*mercantile.ul(486, 332, 10))
(-1017529.7205322663, 7044436.526761846)

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 --help
Usage: mercantile [OPTIONS] COMMAND [ARGS]...

  Mercantile command line interface.

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

Commands:
  shapes  Write the shapes of tiles as GeoJSON.
  tiles   List tiles intersecting a lng/lat bounding box.

shapes

The shapes command writes Mercator tile shapes to several forms of GeoJSON.

$ echo "[106, 193, 9]" | mercantile shapes --indent 2 --precision 6
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          [
            [
              -105.46875,
              39.909736
            ],
            [
              -105.46875,
              40.446947
            ],
            [
              -104.765625,
              40.446947
            ],
            [
              -104.765625,
              39.909736
            ],
            [
              -105.46875,
              39.909736
            ]
          ]
        ],
        "type": "Polygon"
      },
      "id": "(106, 193, 9)",
      "properties": {
        "title": "XYZ tile (106, 193, 9)"
      },
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}

tiles

The tiles command writes descriptions of tiles intersecting with a geographic bounding box.

$ echo "[-104.99, 39.99, -105, 40]" | mercantile tiles 14
[3413, 6202, 14]
[3413, 6203, 14]

The commands can be piped together to do this:

$ echo "[-104.99, 39.99, -105, 40]" \
> | mercantile tiles 14 \
> | mercantile shapes --indent 2 --precision 6
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          [
            [
              -105.007324,
              39.993956
            ],
            [
              -105.007324,
              40.010787
            ],
            [
              -104.985352,
              40.010787
            ],
            [
              -104.985352,
              39.993956
            ],
            [
              -105.007324,
              39.993956
            ]
          ]
        ],
        "type": "Polygon"
      },
      "id": "(3413, 6202, 14)",
      "properties": {
        "title": "XYZ tile (3413, 6202, 14)"
      },
      "type": "Feature"
    },
    {
      "geometry": {
        "coordinates": [
          [
            [
              -105.007324,
              39.97712
            ],
            [
              -105.007324,
              39.993956
            ],
            [
              -104.985352,
              39.993956
            ],
            [
              -104.985352,
              39.97712
            ],
            [
              -105.007324,
              39.97712
            ]
          ]
        ],
        "type": "Polygon"
      },
      "id": "(3413, 6203, 14)",
      "properties": {
        "title": "XYZ tile (3413, 6203, 14)"
      },
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}

If you have geojsonio-cli installed, you can shoot this GeoJSON straight to geojson.io for lightning-fast visualization and editing.

$ echo "[-104.99, 39.99, -105, 40]" \
> | mercantile tiles 14 \
> | mercantile shapes --compact \
> | geojsonio

See Also

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

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.4.tar.gz (6.9 kB view hashes)

Uploaded Source

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