Skip to main content

Sentinel Hub's cloud detector for Sentinel-2 imagery

Project description

Package version Conda version Supported Python versions Build Status Overall downloads Last month downloads Code coverage

Sentinel Hub's cloud detector for Sentinel-2 imagery

NOTE: s2cloudless masks are now available as a precomputed layer within Sentinel Hub. Check the announcement blog post and technical documentation.

The s2cloudless Python package provides automated cloud detection in Sentinel-2 imagery. The classification is based on a single-scene pixel-based cloud detector developed by Sentinel Hub's research team and is described in more detail in this blog.

The s2cloudless algorithm was part of an international collaborative effort aimed at intercomparing cloud detection algorithms. The s2cloudless algorithm was validated together with 9 other algorithms on 4 different test datasets and in all cases found to be on the Pareto front. See the paper

Installation

The package requires a Python version >= 3.8. The package is available on the PyPI package manager and can be installed with

$ pip install s2cloudless

To install the package manually, clone the repository and

$ pip install .

One of s2cloudless dependencies is lightgbm package. If having problems during installation, please check the LightGBM installation guide.

Before installing s2cloudless on Windows, it is recommended to install package shapely from Unofficial Windows wheels repository

Input: Sentinel-2 scenes

The inputs to the cloud detector are Sentinel-2 images. In particular, the cloud detector requires the following 10 Sentinel-2 band reflectances: B01, B02, B04, B05, B08, B8A, B09, B10, B11, B12, which are obtained from raw reflectance values in the following way: B_i/10000. From product baseline 04.00 onward additional harmonization factors have to be applied to data according to instructions from ESA.

You don't need to worry about any of this, if you are using Sentinel-2 data obtained from Sentinel Hub Process API. By default, the data is already harmonized according to documentation. The API is supported in Python with sentinelhub-py package and used within s2cloudless.CloudMaskRequest class.

Examples

A Jupyter notebook on how to use the cloud detector to produce cloud mask or cloud probability map can be found in the examples folder.

License

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

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

s2cloudless-1.7.3.tar.gz (4.8 MB view details)

Uploaded Source

Built Distribution

s2cloudless-1.7.3-py3-none-any.whl (4.8 MB view details)

Uploaded Python 3

File details

Details for the file s2cloudless-1.7.3.tar.gz.

File metadata

  • Download URL: s2cloudless-1.7.3.tar.gz
  • Upload date:
  • Size: 4.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.18

File hashes

Hashes for s2cloudless-1.7.3.tar.gz
Algorithm Hash digest
SHA256 6538894722b7e64d6f79595fa9f4b47ac98523bd323e4a9d918e2920cd438801
MD5 31aab065e09986dd6cb099ca12af8b4d
BLAKE2b-256 d8058b562bdb705637fc8967e18b3a595ea48b2d8eb6bdec50c9c8d3ea182ca8

See more details on using hashes here.

File details

Details for the file s2cloudless-1.7.3-py3-none-any.whl.

File metadata

  • Download URL: s2cloudless-1.7.3-py3-none-any.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.18

File hashes

Hashes for s2cloudless-1.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bd8ea8f21df724e77ed48592bfce1c49f4093aebe3561f88c9a276cd14c934bf
MD5 a8b237fe25a9efc401a8e0a48e2cabf0
BLAKE2b-256 a5ed1971cd2cd4d1e08940a209308bc1a142618cb7dc84586af7fad69c0db4d9

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