Skip to main content

rio-pansharpen

Project description

https://img.shields.io/pypi/v/rio-pansharpen.svg https://circleci.com/gh/mapbox/rio-pansharpen.svg?style=shield&circle

pansharpens Landsat 8 scenes.

What is pansharpening?

Pansharpening is a process of using the spatial information in the high-resolution grayscale band (panchromatic, or pan-band) and color information in the multispectral bands to create a single high-resolution color image.

P pan-pixel cluster + M single multispectral pixel = M pan-sharpened pixel

Find more examples and information in the Mapbox pansharpening blog post.

Install

We highly recommend installing in a virtualenv. Once activated,

pip install -U pip
pip install rio-pansharpen

Or install from source

git checkout https://github.com/mapbox/rio-pansharpen.git
cd rio-pansharpen
pip install -U pip
pip install -r requirements.txt
pip install -e .

Python API

pansharpen.worker

The worker module pansharpens Landsat 8. Visit the USGS Landsat page page for more information on Landsat 8 band designations.

1. worker.pansharpen

The worker.pansharpen function accepts the following as inputs:

  • numpy 3D array with shape == (3, vis_height, vis_width)

  • affine transform defining the georeferencing of the vis array

  • numpy 2D array with shape == (pan_height, pan_width)

  • affine transform defining the georeferencing of the pan array

  • pansharpening method

and outputs:

  • numpy 3D array with shape == (3, pan_height, pan_width)

>>> from pansharpen import worker
>>> from pansharpen.methods import Brovey
...
>>> pansharpened = worker.pansharpen(vis, vis_transform, pan, pan_transform,
                       pan_dtype, r_crs, dst_crs, weight,
                       method="Brovey", src_nodata=0)

2. worker.calculate_landsat_pansharpen

>>> from pansharpen import worker
>>> from pansharpen.utils import _calc_windows
>>> import riomucho
...
>>> worker.calculate_landsat_pansharpen(src_paths, dst_path, dst_dtype,
        weight, verbosity, jobs, half_window,
        customwindow)

CLI

pansharpen

Usage: rio pansharpen [OPTIONS] [SRC_PATHS]... DST_PATH

  Pansharpens a landsat scene. Input is a panchromatic band (B8), plus 3 color
  bands (B4, B3, B2)

     rio pansharpen B8.tif B4.tif B3.tif B2.tif out.tif

  Or with shell expansion

     rio pansharpen LC80410332015283LGN00_B{8,4,3,2}.tif out.tif

Options:
  --dst-dtype [uint16|uint8]
  -w, --weight FLOAT          Weight of blue band [default = 0.2]
  -v, --verbosity
  -j, --jobs INTEGER          Number of processes [default = 1]
  --half-window               Use a half window assuming pan in aligned with
                              rgb bands, default: False
  -c, --customwindow INTEGER  Specify blocksize for custom windows >
                              150[default=src_blockswindows]
  --help                      Show this message and exit.
  --help                 Show this message and exit.

Comparison of Different Pansharpening Methods

We’ve implemented the Weighted Brovey Transform for pansharpening, which is appropriate for data like Landsat where the panchromatic band is relatively similar in resolution to the color bands.

For more information on other pansharpening methods such as IHS, PCA, P+XS, Wavelet, VWP, Wavelet with Canny Edge Detector etc, please read our notes here.

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

rio-pansharpen-0.2.0.tar.gz (6.6 kB view details)

Uploaded Source

File details

Details for the file rio-pansharpen-0.2.0.tar.gz.

File metadata

File hashes

Hashes for rio-pansharpen-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e9e9cf3515e0302e0842a30888c0ed9b026cb97a616df6e463286a937372f25a
MD5 530d6b53eab95720bb9df3a73b7e6a27
BLAKE2b-256 ac2c403daf21023a61a8a2a4993f04377707074c4492dc5ee893698b594dfad2

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