Skip to main content

Fast and direct raster I/O for use with Numpy and SciPy

Project description

Rasterio reads and writes geospatial raster data.

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

Geographic information systems use GeoTIFF and other formats to organize and store gridded, or raster, datasets. Rasterio reads and writes these formats and provides a Python API based on N-D arrays.

Rasterio supports Python 2.7 and 3.3-3.6 on Linux and Mac OS X.

Read the documentation for more details: https://mapbox.github.io/rasterio/.

Example

Here’s an example of some basic features that Rasterio provides. Three bands are read from an image and averaged to produce something like a panchromatic band. This new band is then written to a new single band TIFF.

import numpy as np
import rasterio

# Read raster bands directly to Numpy arrays.
#
with rasterio.open('tests/data/RGB.byte.tif') as src:
    r, g, b = src.read()

# Combine arrays in place. Expecting that the sum will
# temporarily exceed the 8-bit integer range, initialize it as
# a 64-bit float (the numpy default) array. Adding other
# arrays to it in-place converts those arrays "up" and
# preserves the type of the total array.
total = np.zeros(r.shape)
for band in r, g, b:
    total += band
total /= 3

# Write the product as a raster band to a new 8-bit file. For
# the new file's profile, we start with the meta attributes of
# the source file, but then change the band count to 1, set the
# dtype to uint8, and specify LZW compression.
profile = src.profile
profile.update(dtype=rasterio.uint8, count=1, compress='lzw')

with rasterio.open('example-total.tif', 'w', **profile) as dst:
    dst.write(total.astype(rasterio.uint8), 1)

The output:

http://farm6.staticflickr.com/5501/11393054644_74f54484d9_z_d.jpg

API Overview

Rasterio gives access to properties of a geospatial raster file.

with rasterio.open('tests/data/RGB.byte.tif') as src:
    print(src.width, src.height)
    print(src.crs)
    print(src.transform)
    print(src.count)
    print(src.indexes)

# Printed:
# (791, 718)
# {u'units': u'm', u'no_defs': True, u'ellps': u'WGS84', u'proj': u'utm', u'zone': 18}
# Affine(300.0379266750948, 0.0, 101985.0,
#        0.0, -300.041782729805, 2826915.0)
# 3
# [1, 2, 3]

A rasterio dataset also provides methods for getting extended array slices given georeferenced coordinates.

with rasterio.open('tests/data/RGB.byte.tif') as src:
    print src.window(**src.window_bounds(((100, 200), (100, 200))))

# Printed:
# ((100, 200), (100, 200))

Rasterio CLI

Rasterio’s command line interface, named “rio”, is documented at cli.rst. Its rio insp command opens the hood of any raster dataset so you can poke around using Python.

$ rio insp tests/data/RGB.byte.tif
Rasterio 0.10 Interactive Inspector (Python 3.4.1)
Type "src.meta", "src.read(1)", or "help(src)" for more information.
>>> src.name
'tests/data/RGB.byte.tif'
>>> src.closed
False
>>> src.shape
(718, 791)
>>> src.crs
{'init': 'epsg:32618'}
>>> b, g, r = src.read()
>>> b
masked_array(data =
 [[-- -- -- ..., -- -- --]
 [-- -- -- ..., -- -- --]
 [-- -- -- ..., -- -- --]
 ...,
 [-- -- -- ..., -- -- --]
 [-- -- -- ..., -- -- --]
 [-- -- -- ..., -- -- --]],
             mask =
 [[ True  True  True ...,  True  True  True]
 [ True  True  True ...,  True  True  True]
 [ True  True  True ...,  True  True  True]
 ...,
 [ True  True  True ...,  True  True  True]
 [ True  True  True ...,  True  True  True]
 [ True  True  True ...,  True  True  True]],
       fill_value = 0)

>>> np.nanmin(b), np.nanmax(b), np.nanmean(b)
(0, 255, 29.94772668847656)

Rio Plugins

Rio provides the ability to create subcommands using plugins. See cli.rst for more information on building plugins.

See the plugin registry for a list of available plugins.

Installation

Please install Rasterio in a virtual environment so that its requirements don’t tamper with your system’s Python.

Dependencies

Rasterio has a C library dependency: GDAL >=1.9. GDAL itself depends on some other libraries provided by most major operating systems and also depends on the non standard GEOS and PROJ4 libraries. How to meet these requirement will be explained below.

Rasterio’s Python dependencies are listed in its requirements.txt file.

Development also requires (see requirements-dev.txt) Cython and other packages.

Binary Distributions

Use a binary distributions that directly or indirectly provide GDAL if possible.

Linux

Rasterio distributions are available from UbuntuGIS and Anaconda’s conda-forge channel.

Manylinux1 distributions may be available in the future.

OS X

Binary distributions with GDAL, GEOS, and PROJ4 libraries included are available for OS X versions 10.7+ starting with Rasterio version 0.17. To install, run pip install rasterio. These binary wheels are preferred by newer versions of pip.

If you don’t want these wheels and want to install from a source distribution, run pip install rasterio --no-binary rasterio instead.

The included GDAL library is fairly minimal, providing only the format drivers that ship with GDAL and are enabled by default. To get access to more formats, you must build from a source distribution (see below).

Windows

Binary wheels for rasterio and GDAL are created by Christoph Gohlke and are available from his website.

To install rasterio, simply download both binaries for your system (rasterio and GDAL) and run something like this from the downloads folder:

$ pip install -U pip
$ pip install GDAL-2.0.2-cp27-none-win32.whl
$ pip install rasterio-0.34.0-cp27-cp27m-win32.whl

Source Distributions

Rasterio is a Python C extension and to build you’ll need a working compiler (XCode on OS X etc). You’ll also need Numpy preinstalled; the Numpy headers are required to run the rasterio setup script. Numpy has to be installed (via the indicated requirements file) before rasterio can be installed. See rasterio’s Travis configuration for more guidance.

Linux

The following commands are adapted from Rasterio’s Travis-CI configuration.

$ sudo add-apt-repository ppa:ubuntugis/ppa
$ sudo apt-get update
$ sudo apt-get install gdal-bin libgdal-dev
$ pip install -U pip
$ pip install rasterio

Adapt them as necessary for your Linux system.

OS X

For a Homebrew based Python environment, do the following.

$ brew upgrade
$ brew install gdal
$ pip install -U pip
$ pip install --no-use-wheel rasterio

Alternatively, you can install GDAL binaries from kyngchaos. You will then need to add the installed location /Library/Frameworks/GDAL.framework/Programs to your system path.

Windows

You can download a binary distribution of GDAL from here. You will also need to download the compiled libraries and headers (include files).

When building from source on Windows, it is important to know that setup.py cannot rely on gdal-config, which is only present on UNIX systems, to discover the locations of header files and libraries that rasterio needs to compile its C extensions. On Windows, these paths need to be provided by the user. You will need to find the include files and the library files for gdal and use setup.py as follows.

$ python setup.py build_ext -I<path to gdal include files> -lgdal_i -L<path to gdal library>
$ python setup.py install

We have had success compiling code using the same version of Microsoft’s Visual Studio used to compile the targeted version of Python (more info on versions used here.).

Note: The GDAL dll (gdal111.dll) and gdal-data directory need to be in your Windows PATH otherwise rasterio will fail to work.

Development and Testing

See CONTRIBUTING.rst.

Documentation

See docs/.

License

See LICENSE.txt.

Authors

See AUTHORS.txt.

Changes

See CHANGES.txt.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

rasterio-1.0a9.tar.gz (1.4 MB view details)

Uploaded Source

Built Distributions

rasterio-1.0a9-cp36-cp36m-manylinux1_x86_64.whl (50.6 MB view details)

Uploaded CPython 3.6m

rasterio-1.0a9-cp36-cp36m-macosx_10_6_intel.whl (21.8 MB view details)

Uploaded CPython 3.6m macOS 10.6+ intel

rasterio-1.0a9-cp35-cp35m-manylinux1_x86_64.whl (50.5 MB view details)

Uploaded CPython 3.5m

rasterio-1.0a9-cp35-cp35m-macosx_10_6_intel.whl (21.8 MB view details)

Uploaded CPython 3.5m macOS 10.6+ intel

rasterio-1.0a9-cp34-cp34m-manylinux1_x86_64.whl (50.6 MB view details)

Uploaded CPython 3.4m

rasterio-1.0a9-cp34-cp34m-macosx_10_6_intel.whl (21.9 MB view details)

Uploaded CPython 3.4m macOS 10.6+ intel

rasterio-1.0a9-cp27-cp27mu-manylinux1_x86_64.whl (50.3 MB view details)

Uploaded CPython 2.7mu

rasterio-1.0a9-cp27-cp27m-manylinux1_x86_64.whl (50.3 MB view details)

Uploaded CPython 2.7m

rasterio-1.0a9-cp27-cp27m-macosx_10_6_intel.whl (21.9 MB view details)

Uploaded CPython 2.7m macOS 10.6+ intel

File details

Details for the file rasterio-1.0a9.tar.gz.

File metadata

  • Download URL: rasterio-1.0a9.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for rasterio-1.0a9.tar.gz
Algorithm Hash digest
SHA256 dd91520d55f4238f71ebeadf0ff2e8f23021ca4ff2ff9826ae2cbdf90b109d55
MD5 29e6c27232eac0c6fe116358434a26d3
BLAKE2b-256 ef90766dcdc2b60400774fcc5037231aa61c29c17eacb184a61b317dbe65d68c

See more details on using hashes here.

File details

Details for the file rasterio-1.0a9-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0a9-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 72a6900f8942de7cc88457b541d0fc7698c7b66628a9d1e34b2c95470d5a9109
MD5 ac2d229d9bfabe9a74b54b0a74b9284e
BLAKE2b-256 78d7abc9fc759edf204e42f1c6d93cb01d5f159ae9aa58fb5e3b9996c79e01a4

See more details on using hashes here.

File details

Details for the file rasterio-1.0a9-cp36-cp36m-macosx_10_6_intel.whl.

File metadata

File hashes

Hashes for rasterio-1.0a9-cp36-cp36m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 f114bb1c2e77083ce8f77beef597478f5ff8b16f2a40d93ff603e6ca4c81fa24
MD5 51428074bb7d5eccd5c3aea45fc64788
BLAKE2b-256 dd625f1ef218f86675e8f578ad08b3867b1f0a554b8e9c71b7f42f135751a517

See more details on using hashes here.

File details

Details for the file rasterio-1.0a9-cp35-cp35m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0a9-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 5aacd0326fbdb6988c67f9ea343a0376b8a73907d7e3ac22982b98657f8a866a
MD5 3ed31b6454b5a20f4f9b39c7df0721d6
BLAKE2b-256 c221e392f2fdfd89ac1c7a4951133dd68ef9b54e2f45985841a5ea915ee95544

See more details on using hashes here.

File details

Details for the file rasterio-1.0a9-cp35-cp35m-macosx_10_6_intel.whl.

File metadata

File hashes

Hashes for rasterio-1.0a9-cp35-cp35m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 c6c15b3912be21547e519f717af02a204f37e509e19f8c98b96e5774906fc4c3
MD5 cbcadb518dd87cfbf609398579d672f2
BLAKE2b-256 5c8ab987c69835902f54e34023c45705e752a7269cdad018bcf3728db763585f

See more details on using hashes here.

File details

Details for the file rasterio-1.0a9-cp34-cp34m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0a9-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 f40ca707d9d072d6bef1b5173259cd7293c0f2f6bae9ac504407721891e04bcc
MD5 3ead978ee48147e622359183a6621531
BLAKE2b-256 d6d2293d32429a00562c5fe2bd3955dcd0cd49a4951c75c6982318c334b483fa

See more details on using hashes here.

File details

Details for the file rasterio-1.0a9-cp34-cp34m-macosx_10_6_intel.whl.

File metadata

File hashes

Hashes for rasterio-1.0a9-cp34-cp34m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 f6ed2e9ba120c723e1f4b20eac40a4fc3e416157aaf324753e934ecd7fe4c5a9
MD5 c8cc445e1ab1af16452c9f0b171e88b7
BLAKE2b-256 10cdb8d697bdfe9016e1d571233fbb567458838e07023e597464ba37c6a65a45

See more details on using hashes here.

File details

Details for the file rasterio-1.0a9-cp27-cp27mu-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0a9-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 5e9d2598961f578d6fc095c81778834746425d97ee5d4076b80c84c980a704e1
MD5 f5d63a5c425da9a7d94cee5e7d0450eb
BLAKE2b-256 a3e11828567e1d7df6f782799bb35b12f669e7e25cde6e8504d85c758d60bb4f

See more details on using hashes here.

File details

Details for the file rasterio-1.0a9-cp27-cp27m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0a9-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 488d0f18460430f71424cd341da5b3c40667b1fa6c45c4eb79cc6970c65ac196
MD5 5e6806f691fe69e29d5724e061522628
BLAKE2b-256 87deef7a151ea37d769bcf1ab8532055109c808551c6091ff1ea8fee5161d98a

See more details on using hashes here.

File details

Details for the file rasterio-1.0a9-cp27-cp27m-macosx_10_6_intel.whl.

File metadata

File hashes

Hashes for rasterio-1.0a9-cp27-cp27m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 035f72581c7320831dd7c5eb2a38d7cc1a22fa1a37e6a5693c97260925a2e81d
MD5 410ef2289d7a0056643467e894923896
BLAKE2b-256 ace15a7d21d412b6f6199d62be29ae1920120cbb661111d07939264df484a293

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