Skip to main content

A Python package to super-resolve Sentinel-2 satellite imagery up to 2.5 meters.

Project description

SEN2SR

A Python package for enhancing the spatial resolution of Sentinel-2 satellite images up to 2.5 meters 🚀

PyPI License Black isort


GitHub: https://github.com/ESAOpenSR/sen2sr 🌐

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


Table of Contents

Overview

sen2sr is a Python package designed to enhance the spatial resolution of Sentinel-2 satellite images to 2.5 meters using a set of neural network models.

Model Description Run Link
Run SENSRLite A lightweight SR model optimized for running fast! Open In Colab
Run SENSR Our most accurate SR model! Open In Colab

Installation

Install the SEN2SRLite version using pip:

pip install sen2sr mlstac git+https://github.com/ESDS-Leipzig/cubo.git

For the full version, which use Mamba arquitecture, install as follows:

pip install mamba-ssm --no-build-isolation -q
pip install sen2sr mlstac git+https://github.com/ESDS-Leipzig/cubo.git

From 10m and 20m Sentinel-2 bands to 2.5m

This example demonstrates the use of the SEN2SRLite model to enhance the spatial resolution of Sentinel-2 imagery. A Sentinel-2 L2A data cube is created over a specified region and time range using the cubo library, including both 10 m and 20 m bands. The pretrained model, downloaded via mlstac, takes a single normalized sample as input and predicts a HR output. The visualization compares the original RGB composite to the super-resolved result.

import mlstac
import torch
import cubo

# Download the model
mlstac.download(
  file="https://huggingface.co/tacofoundation/sen2sr/resolve/main/SEN2SRLite/main/mlm.json",
  output_dir="model/SEN2SRLite",
)

# Load the model
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
model = mlstac.load("model/SEN2SRLite").compiled_model(device=device)
model = model.to(device)

# Create a Sentinel-2 L2A data cube for a specific location and date range
da = cubo.create(
    lat=39.49152740347753,
    lon=-0.4308725142800361,
    collection="sentinel-2-l2a",
    bands=["B02", "B03", "B04", "B05", "B06", "B07", "B08", "B8A", "B11", "B12"],
    start_date="2023-01-01",
    end_date="2023-12-31",
    edge_size=128,
    resolution=10
)

# Prepare the data to be used in the model, select just one sample 
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
original_s2_numpy = (da[11].compute().to_numpy() / 10_000).astype("float32")
X = torch.from_numpy(original_s2_numpy).float().to(device)

# Apply model
superX = model(X[None]).squeeze(0)

From 10m Sentinel-2 bands to 2.5m

This example demonstrates the use of the SEN2SRLite NonReference_RGBN_x4 model variant to enhance the spatial resolution of only the 10 m Sentinel-2 bands: red (B04), green (B03), blue (B02), and near-infrared (B08). A Sentinel-2 L2A data cube is created using the cubo library for a specific location and date range. The input is normalized and passed to a pretrained non-reference model optimized for RGB+NIR inputs.

import mlstac
import torch
import cubo

# Download the model
mlstac.download(
  file="https://huggingface.co/tacofoundation/sen2sr/resolve/main/SEN2SRLite/NonReference_RGBN_x4/mlm.json",
  output_dir="model/SEN2SRLite_RGBN",
)

# Create a Sentinel-2 L2A data cube for a specific location and date range
da = cubo.create(
    lat=39.49152740347753,
    lon=-0.4308725142800361,
    collection="sentinel-2-l2a",
    bands=["B04", "B03", "B02", "B08"],
    start_date="2023-01-01",
    end_date="2023-12-31",
    edge_size=128,
    resolution=10
)


# Prepare the data to be used in the model
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
original_s2_numpy = (da[11].compute().to_numpy() / 10_000).astype("float32")
X = torch.from_numpy(original_s2_numpy).float().to(device)
X = torch.nan_to_num(X, nan=0.0, posinf=0.0, neginf=0.0)

# Load the model
model = mlstac.load("model/SEN2SRLite_RGBN").compiled_model(device=device)

# Apply model
superX = model(X[None]).squeeze(0)

From 20m Sentinel-2 bands to 10m

This example demonstrates the use of the SEN2SRLite Reference_RSWIR_x2 model variant to enhance the spatial resolution of the 20 m Sentinel-2 bands: red-edge (B05, B06, B07), shortwave infrared (B11, B12), and near-infrared (B8A) to 10 m.

import mlstac
import torch
import cubo

# Download the model
mlstac.download(
  file="https://huggingface.co/tacofoundation/sen2sr/resolve/main/SEN2SRLite/Reference_RSWIR_x2/mlm.json",
  output_dir="model/SEN2SRLite_Reference_RSWIR_x2",
)

# Create a Sentinel-2 L2A data cube for a specific location and date range
da = cubo.create(
    lat=39.49152740347753,
    lon=-0.4308725142800361,
    collection="sentinel-2-l2a",
    bands=["B02", "B03", "B04", "B05", "B06", "B07", "B08", "B8A", "B11", "B12"],
    start_date="2023-01-01",
    end_date="2023-12-31",
    edge_size=128,
    resolution=10
)

# Prepare the data to be used in the model
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
original_s2_numpy = (da[11].compute().to_numpy() / 10_000).astype("float32")
X = torch.from_numpy(original_s2_numpy).float().to(device)

# Load the model
model = mlstac.load("model/SEN2SRLite_Reference_RSWIR_x2").compiled_model(device=device)
model = model.to(device)

# Apply model
superX = model(X[None]).squeeze(0)

Predict on large images

This example demonstrates the use of SEN2SRLite NonReference_RGBN_x4 for super-resolving large Sentinel-2 RGB+NIR images by chunking the input into smaller overlapping tiles. Although the model is trained to operate on fixed-size 128×128 patches, the sen2sr.predict_large utility automatically segments larger inputs into these tiles, applies the model to each tile independently, and then reconstructs the full image. An overlap margin (e.g., 32 pixels) is introduced between tiles to minimize edge artifacts and ensure continuity across tile boundaries.

import mlstac
import sen2sr
import torch
import cubo

# Create a Sentinel-2 L2A data cube for a specific location and date range
da = cubo.create(
    lat=39.49152740347753,
    lon=-0.4308725142800361,
    collection="sentinel-2-l2a",
    bands=["B02", "B03", "B04", "B05", "B06", "B07", "B08", "B8A", "B11", "B12"],
    start_date="2023-01-01",
    end_date="2023-12-31",
    edge_size=1024,
    resolution=10
)

# Prepare the data to be used in the model
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
original_s2_numpy = (da[11].compute().to_numpy() / 10_000).astype("float32")
X = torch.from_numpy(original_s2_numpy).float().to(device)
X = torch.nan_to_num(X, nan=0.0, posinf=0.0, neginf=0.0)

# Load the model
model = mlstac.load("model/SEN2SRLite").compiled_model(device=device)


# Apply model
superX = sen2sr.predict_large(
    model=model,
    X=X, # The input tensor
    overlap=32, # The overlap between the patches
)

Estimate the Local Attention Map

This example computes the Local Attention Map (LAM) to analyze the model's spatial sensitivity and robustness. The input image is scanned with a sliding window, and the model's attention is estimated across multiple upscaling factors. The resulting KDE map highlights regions where the model focuses more strongly, while the robustness vector quantifies the model's stability to spatial perturbations.

import mlstac
import sen2sr
import torch
import cubo

# Create a Sentinel-2 L2A data cube for a specific location and date range
da = cubo.create(
    lat=39.49152740347753,
    lon=-0.4308725142800361,
    collection="sentinel-2-l2a",
    bands=["B04", "B03", "B02", "B08"],
    start_date="2023-01-01",
    end_date="2023-12-31",
    edge_size=128,
    resolution=10
)


# Prepare the data to be used in the model
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
original_s2_numpy = (da[11].compute().to_numpy() / 10_000).astype("float32")
X = torch.from_numpy(original_s2_numpy).float().to(device)
X = torch.nan_to_num(X, nan=0.0, posinf=0.0, neginf=0.0)

# Load the model
#mlstac.download(
#  file="https://huggingface.co/tacofoundation/sen2sr/resolve/main/SEN2SRLite/NonReference_RGBN_x4/mlm.json",
#  output_dir="model/SEN2SRLite_RGBN",
#)
model = mlstac.load("model/SEN2SRLite_RGBN").compiled_model(device=device)

# Apply model
kde_map, complexity_metric, robustness_metric, robustness_vector = sen2sr.lam(
    X=X, # The input tensor
    model=model, # The SR model
    h=240, # The height of the window
    w=240, # The width of the window
    window=32, # The window size
    scales = ["2x", "3x", "4x", "5x", "6x"]
)


import matplotlib.pyplot as plt
fig, ax = plt.subplots(1, 2, figsize=(12, 6))
ax[0].imshow(kde_map)
ax[0].set_title("Kernel Density Estimation")
ax[1].plot(robustness_vector)
ax[1].set_title("Robustness Vector")
plt.show()

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

sen2sr-0.8.0.tar.gz (38.5 kB view details)

Uploaded Source

Built Distribution

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

sen2sr-0.8.0-py3-none-any.whl (41.2 kB view details)

Uploaded Python 3

File details

Details for the file sen2sr-0.8.0.tar.gz.

File metadata

  • Download URL: sen2sr-0.8.0.tar.gz
  • Upload date:
  • Size: 38.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/7.0.1 keyring/24.3.1 pkginfo/1.9.6 readme-renderer/34.0 requests-toolbelt/1.0.0 requests/2.32.3 rfc3986/1.5.0 tqdm/4.67.1 urllib3/2.3.0 CPython/3.10.12

File hashes

Hashes for sen2sr-0.8.0.tar.gz
Algorithm Hash digest
SHA256 04620347c901d62b117e10c97efd22a5a7b60474f8a09fd3012aa40445c66e51
MD5 67098e360499c97afe0fb1b6723c7934
BLAKE2b-256 d6f4bce85e4d5779f3a1be1f1e2949b2aece1f0fae932b0a07d85223b8171941

See more details on using hashes here.

File details

Details for the file sen2sr-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: sen2sr-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 41.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/7.0.1 keyring/24.3.1 pkginfo/1.9.6 readme-renderer/34.0 requests-toolbelt/1.0.0 requests/2.32.3 rfc3986/1.5.0 tqdm/4.67.1 urllib3/2.3.0 CPython/3.10.12

File hashes

Hashes for sen2sr-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62f6ee8bd5390f949d80871d2b6749dd87320d2a4c74a1546d8afc0aa35b4b87
MD5 5652675b189f62ac5b5c92a392f3f253
BLAKE2b-256 259465479b7ee8ccb3a0fb001f2f858b781adc7d7af3dc120a563320e810fb11

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