Module eoreader.products.optical

Optical products.

Optical data

Implemented optical satellites

Satellites Class Product Types Use archive Default Resolution
Sentinel-2 S2Product L1C & L2A Yes 20m
Sentinel-2 Theia S2TheiaProduct L2A Yes 20m
Sentinel-3 SLSTR S3Product RBT No 300m
Sentinel-3 OLCI S3Product EFR No 500m
Landsat-8 OLCI L8Product Level 1 Collection 1: No, Collection 2: Yes 30m
Landsat-7 ETM L7Product Level 1 Collection 1: No, Collection 2: Yes 30m
Landsat-5 TM L5Product Level 1 Collection 1: No, Collection 2: Yes 30m
Landsat-4 TM L4Product Level 1 Collection 1: No, Collection 2: Yes 30m
Landsat-5 MSS L5Product Level 1 Collection 1: No, Collection 2: Yes 60m
Landsat-4 MSS L4Product Level 1 Collection 1: No, Collection 2: Yes 60m
Landsat-3 MSS L3Product Level 1 Collection 1: No, Collection 2: Yes 60m
Landsat-2 MSS L2Product Level 1 Collection 1: No, Collection 2: Yes 60m
Landsat-1 MSS L1Product Level 1 Collection 1: No, Collection 2: Yes 60m

Satellites products that cannot be used as archived have to be extracted before use.

Optical bands

The following bands are available in EOReader, but may not be available for all sensors.

Satellite bands

These bands are mainly based on Sentinel-2 bands with some additions:

  • CA: Coastal Aerosol
  • BLUE
  • GREEN
  • RED
  • VRE_1: Vegetation Red Edge 1
  • VRE_2: Vegetation Red Edge 2
  • VRE_3: Vegetation Red Edge 3
  • NIR: Near Infrared
  • NARROW_NIR: Narrow Near Infrared (band 8A for Sentinel-2)
  • WP: Water vapour
  • SWIR_CIRRUS
  • SWIR_1
  • SWIR_2
  • PAN: Panchromatic
  • TIR_1: Thermal Infrared 1
  • TIR_2: Thermal Infrared 2

See here for more information.

Index

  • AFRI_1_6
  • AFRI_2_1
  • AWEInsh
  • AWEIsh
  • BAI
  • BSI
  • CIG
  • DSWI
  • GLI
  • GNDVI
  • MNDWI
  • NBR
  • NDGRI
  • NDMI
  • NDRE2
  • NDRE3
  • NDVI
  • NDWI
  • RDI
  • RGI
  • RI
  • SRSWIR
  • TCBRI
  • TCGRE
  • TCWET
  • WI

See here for more information.

Cloud bands

Maximum 5 cloud bands are available, according to the files provided in the data. All the bands are rasterized and orthorectified if needed (for Sentinel-2 or 3 data for example), ready to be stacked.

  • RAW_CLOUDS: Raw Cloud file as provided (the only changes are the orthorectification and rasterization). Can provide other flags, or cloud probability.
  • CLOUDS: Cloud presence (1) or absence (0).
  • CIRRUS: Cirrus presence (1) or absence (0).
  • SHADOWS: Shadows presence (1) or absence (0).
  • ALL_CLOUDS: Cloud OR Cirrus OR Shadows presence (1) or absence (0). Do not take into account missing bands ( ie. for Landsat MSS sensors, ALL_CLOUDS == CLOUDS)

See here for more information.

DEM bands

These bands need a valid worldwide DEM path positioned thanks to the environment variable EOREADER_SAR_DEFAULT_RES

  • DEM
  • SLOPE
  • HILLSHADE

See here for more information.

Specifications

Optical band mapping between sensors

Bands (names) Coastal aerosol Blue Green Red Vegetation red edge Vegetation red edge Vegetation red edge NIR Narrow NIR Water vapor SWIR – Cirrus SWIR SWIR Panchromatic Thermal IR Thermal IR
**Band
alias** CA BLUE GREEN RED VRE_1 VRE_2 VRE_3 NIR NARROW_NIR WP SWIR_CIRRUS SWIR_1 SWIR_2 PAN TIR_1 TIR_2
Sentinel-2 1 (60m) 2 (10m) 3 (10m) 4 (10m) 5 (20m) 6 (20m) 7 (20m) **
8** (10m) 8A (20m) 9 (60m) 10 (60m) 11 (20m) 12 (20m)
Sentinel-2 Theia Not available 2 (10m) 3 (10m) 4 (10m) 5 (20m) 6 (20m) 7 (20m) **
8** (10m) 8A (20m) Not available 10 (60m) 11 (20m) 12 (20m)
Sentinel-3 OLCI* 2 (300m) 3 (300m) 6 (300m) 8 (300m) 11 (300m) 12 (300m) **
16** (300m) 17 (300m) 17 (300m) 20 (300m)
Sentinel-3 SLSTR* 1 (500m) 2 (500m) 3 (500m) 3 (500m) 4 (500m) **
5** (500m) 6 (500m) 8 (1km) 9 (1km)
Landsat OLCI (8) 1 (30m) 2 (30m) 3 (30m) 4 (30m) 5 (30m) 5 (30m) **
9** (30m) 6 (30m) 7 (30m) 8 (15m) 10 (100m) 11 (100m)
Landsat ETM (7) 1 (30m) 2 (30m) 3 (30m) 4 (30m) 4 (30m) **
5** (30m) 7 (30m) 8 (15m) 6 (60m) 6 (60m)
Landsat TM (5-4) 1 (30m) 2 (30m) 3 (30m) 4(30m) 4 (30m) **
5** (30m) 7 (30m) 6 (120m) 6 (120m)
Landsat MSS (5-4) 1 (60m) 2 (60m) 3 (60m) 3 (60m) 3 (60m) 4 (60m) **
4** (60m)
Landsat MSS (1-3) 4 (60m) 5 (60m) 6 (60m) 6 (60m) 6 (60m) 7 (60m) **
7** (60m) 8 (240m)
only for Landsat-3
8 (240m)
only for Landsat-3

* Not all bands of this satellite are used in EOReader

Cloud bands specifications

Maximum 5 cloud bands are available, according to the files provided in the data. All the bands are rasterized and orthorectified if needed (for Sentinel-2 or 3 data for example), ready to be stacked.

The only difference with the other bands is that the cloud bands are provided in uint8 and have a nodata equal to 255.

  • CloudsBandNames.RAW_CLOUDS: Raw Cloud file as provided (the only changes are the orthorectification and rasterization). Can provide other flags, or cloud probability.
  • CloudsBandNames.CLOUDS: Cloud presence (1) or absence (0). If clouds are provided in probabilities, their presence is determined according to Landsat definition (proba> 67%)
  • CloudsBandNames.CIRRUS: Cirrus presence (1) or absence (0). If clouds are provided in probabilities, their presence is determined according to Landsat definition (proba> 67%)
  • CloudsBandNames.SHADOWS: Shadows presence (1) or absence (0). If clouds are provided in probabilities, their presence is determined according to Landsat definition (proba> 67%)
  • CloudsBandNames.ALL_CLOUDS: Cloud OR Cirrus OR Shadows presence (1) or absence (0). Do not take into account missing bands (ie. for Landsat MSS sensors, ALL_CLOUDS == CLOUDS)
Satellites Clouds Bands
Sentinel-2 RAW_CLOUDS, CLOUDS, CIRRUS, ALL_CLOUDS
Sentinel-2 Theia RAW_CLOUDS, CLOUDS, SHADOWS, CIRRUS, ALL_CLOUDS
Sentinel-3 OLCI No cloud file available for S3-OLCI data
Sentinel-3 SLSTR RAW_CLOUDS, CLOUDS, CIRRUS, ALL_CLOUDS
Landsat-8 RAW_CLOUDS, CLOUDS, SHADOWS, CIRRUS, ALL_CLOUDS
Landsat-7 RAW_CLOUDS, CLOUDS, SHADOWS, ALL_CLOUDS
Landsat-5 TM RAW_CLOUDS, CLOUDS, SHADOWS, ALL_CLOUDS
Landsat-4 TM RAW_CLOUDS, CLOUDS, SHADOWS, ALL_CLOUDS
Landsat-5 MSS RAW_CLOUDS, CLOUDS, ALL_CLOUDS
Landsat-4 MSS RAW_CLOUDS, CLOUDS, ALL_CLOUDS
Landsat-3 RAW_CLOUDS, CLOUDS, ALL_CLOUDS
Landsat-2 RAW_CLOUDS, CLOUDS, ALL_CLOUDS
Landsat-1 RAW_CLOUDS, CLOUDS, ALL_CLOUDS

DEM bands specifications

Optical satellites can all load DemBandNames.DEM, DemBandNames.SLOPE and DemBandNames.HILLSHADE bands. The SLOPE and HILLSHADE bands are computed with the gdaldem tool.

Use the environment variable EOREADER_SAR_DEFAULT_RES to position your worldwide DEM.

Available index

Index Needed bands Accepted satellites
AFRI_1_6() NIR, SWIR_1 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
AFRI_2_1() NIR, SWIR_2 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
AWEInsh() BLUE, GREEN, NIR, SWIR_1, SWIR_2 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
AWEIsh() GREEN, NIR, SWIR_1, SWIR_2 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
BAI() RED, NIR All optical satellites
BSI() BLUE, RED, NIR, SWIR_1 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
CIG() GREEN, NIR All optical satellites
DSWI() GREEN, RED, NIR, SWIR_1 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
GLI() GREEN, RED, BLUE Sentinel-2, Sentinel-3 OLCI, Landsat OLCI, (E)TM
GNDVI() GREEN, NIR All optical satellites
MNDWI() GREEN, SWIR_1 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
NBR() NNIR, SWIR_2 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
NDGRI() GREEN, RED All optical satellites
NDMI() NIR, SWIR_1 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
NDRE2() NIR, VRE_1 Sentinel-2, Sentinel-3 OLCI, Landsat MSS
NDRE3() NIR, VRE_2 Sentinel-2, Sentinel-3 OLCI, Landsat MSS
NDVI() RED, NIR All optical satellites
NDWI() GREEN, NIR All optical satellites
RDI() NNIR, SWIR_2 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
RGI() GREEN, RED All optical satellites
RI() GREEN, VRE_1 Sentinel-2, Sentinel-3 OLCI, Landsat MSS
SRSWIR() SWIR_1, SWIR_2 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
TCBRI() BLUE, GREEN, RED, NIR, SWIR_1, SWIR_2 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
TCGRE() BLUE, GREEN, RED, NIR, SWIR_1, SWIR_2 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
TCWET() BLUE, GREEN, RED, NIR, SWIR_1, SWIR_2 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM
WI() GREEN, RED, NIR, SWIR_1, SWIR_2 Sentinel-2, Sentinel-3 SLSTR, Landsat OLCI, (E)TM

Default SNAP resolution

You can override default SNAP resolution (in meters) when orthorecifying SAR and S3 bands by setting the following environment variables:

  • EOREADER_S3_DEFAULT_RES (500m for SLSTR and 300m for OLCI data by default)

Documentary Sources

Optical data

Landsat

Sentinel-2

Sentinel-2 Theia

Sentinel-3

PlanetScope

Band mapping

Index

Expand source code
# -*- coding: utf-8 -*-
# Copyright 2021, SERTIT-ICube - France, https://sertit.unistra.fr/
# This file is part of eoreader project
#     https://github.com/sertit/eoreader
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Optical products.

.. include:: ../../../documentation/optical_detailed.md
"""

Sub-modules

eoreader.products.optical.l1_product

Landsat-1 products

eoreader.products.optical.l2_product

Landsat-2 products

eoreader.products.optical.l3_product

Landsat-3 products

eoreader.products.optical.l4_product

Landsat-4 products

eoreader.products.optical.l5_product

Landsat-5 products

eoreader.products.optical.l7_product

Landsat-7 products

eoreader.products.optical.l8_product

Landsat-8 products

eoreader.products.optical.landsat_product

Landsat products

eoreader.products.optical.optical_product

Super class for optical products

eoreader.products.optical.s2_product

Sentinel-2 products

eoreader.products.optical.s2_theia_product

Sentinel-2 Theia products See here for more information.

eoreader.products.optical.s3_product

Sentinel-3 products