Skip to main content

A Python package to create cloud-free monthly composites by fusing Landsat and Sentinel-2 data.

Project description

A Python package for managing Sentinel-2 satellite data cubes 🚀

PyPI License Black isort


GitHub: https://github.com/IPL-UV/satcube 🌐

PyPI: https://pypi.org/project/satcube/ 🛠️


Overview 📊

satcube is a Python package designed for efficient management, processing, and analysis of Sentinel-2 satellite image cubes. It allows for downloading, cloud masking, gap filling, and super-resolving Sentinel-2 imagery, as well as creating monthly composites and performing interpolation.

Key Features

  • Satellite image download: Retrieve Sentinel-2 images from Earth Engine efficiently. 🛰️
  • Cloud masking: Automatically remove clouds from Sentinel-2 images. ☁️
  • Gap filling: Fill missing data using methods like linear interpolation and histogram matching. 🧩
  • Super-resolution: Apply super-resolution models to enhance image quality. 🔍
  • Monthly composites: Aggregate images into monthly composites with various statistical methods. 📅
  • Temporal smoothing: Smooth reflectance values across time using interpolation techniques. 📈

Installation ⚙️

Install the latest version from PyPI:

pip install satcube

How to use 🛠️

Basic usage: working with sentinel-2 data 🌍

Load libraries

import ee
import satcube

Authenticate and initialize earth engine

ee.Authenticate()
ee.Initialize(project="ee-csaybar-real")

Download model weights

outpath = satcube.download_weights(path="weights")

Create a satellite dataCube

datacube = satcube.SatCube(
    coordinates=(-77.68598590138802,-8.888223962022263),
    sensor=satcube.Sentinel2(weight_path=outpath, edge_size=384),
    output_dir="wendy01",
    max_workers=12,
    device="cuda",
)

Query and process sentinel-2 data 🛰️

Query the sentinel-2 image collection

# Query the Sentinel-2 image collection
table_query = datacube.metadata_s2()

# Filter images based on cloud cover and remove duplicates
table_query_subset = table_query[table_query["cs_cdf"] > 0.30]
table_query_subset = table_query_subset.drop_duplicates(subset="img_date")
mgrs_tile_max = table_query_subset["mgrs_title"].value_counts().idxmax()
table_query_subset = table_query_subset[table_query_subset["mgrs_title"] == mgrs_tile_max]

Download sentinel-2 images

table_download = datacube.download_s2_image(table_query_subset)

Cloud masking

# Remove clouds from the images
table_nocloud = datacube.cloudmasking_s2(table_download)
table_nocloud = table_nocloud[table_nocloud["cloud_cover"] < 0.75]
table_nocloud.reset_index(drop=True, inplace=True)

Gap filling

# Fill missing data in the images
table_nogaps = datacube.gapfilling_s2(table_nocloud)
table_nogaps = table_nogaps[table_nogaps["match_error"] < 0.1]

Monthly composites and image smoothing 📅

Create monthly composites

# Generate monthly composites
table_composites = datacube.monthly_composites_s2(
    table_nogaps, agg_method="median", date_range=("2016-01-01", "2024-07-31")
)

Interpolate missing data

# Interpolate missing months if necessary
table_interpolate = datacube.interpolate_s2(table=table_composites)

Smooth reflectance values

# Smooth reflectance values across time
table_smooth = datacube.smooth_s2(table=table_interpolate)

Super-resolution and visualization 📐

Super-resolution

# Apply super-resolution to the image cube
# table_final = datacube.super_s2(table_smooth)

Display images

# Display the images from the data cube
datacube.display_images(table=table_smooth)

Create a GIF

# !apt-get install imagemagick
import os
os.system("convert -delay 20 -loop 0 wendy01/z_s2_07_smoothed_png/temp_07*.png animation.gif")

from IPython.display import Image
Image(filename='animation.gif', width=500)

Smooth reflectance values

# Smooth reflectance values across time
table_smooth = datacube.smooth_s2(table=table_interpolate)

Supported features and filters

  • Cloud masking: Efficient removal of clouds from satellite images.
  • Resampling methods: Various methods for resampling and aligning imagery.
  • Super-resolution: ONNX-based models for improving image resolution.

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

satcube-0.1.10.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

satcube-0.1.10-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

Details for the file satcube-0.1.10.tar.gz.

File metadata

  • Download URL: satcube-0.1.10.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/6.11.0-24-generic

File hashes

Hashes for satcube-0.1.10.tar.gz
Algorithm Hash digest
SHA256 6a711d10b58a8a1eb3dc1fd5ccfa0c6568ce153a93a72714acee5e88cce58a56
MD5 dbd3b83e7804541de87f4d233e1c8cb9
BLAKE2b-256 d953d84acd0b71bb2229fb55cf6d8060e8f270bfa6b02fd5ec1b73566816b171

See more details on using hashes here.

File details

Details for the file satcube-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: satcube-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 21.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/6.11.0-24-generic

File hashes

Hashes for satcube-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 c799c15bf8a053ec9221dcf4c9ccc64b5022cefc0b6466add887f5550ac47c11
MD5 32c16f791a0c79d14b58082d898eb94a
BLAKE2b-256 632c7cb2cf3bf059e83d2b1272758f49b44d57ac2f526af56283b73795c6f4a5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page