# Generating GeoMAD composites¶

Keywords data used; sentinel-2, data used; landsat 8, index:data used; MADs, data methods; geomedian, analysis; composites, dask, data methods; resample, data methods; groupby

## Contexte¶

Individual remote sensing images can be affected by noisy data, including clouds, cloud shadows, and haze. To produce cleaner images that can be compared more easily across time, we can create “summary” images or “composites” that combine multiple images into one image to reveal the median or “typical” appearance of the landscape for a certain time period.

One approach is to create a geomedian. A geomedian is based on a high-dimensional statistic called the “geometric median” (Small 1990), which effectively trades a temporal stack of poor quality observations for a single high-quality pixel composite with reduced spatial noise (Roberts et al. 2017). In contrast to a standard median, a geomedian maintains the relationship between spectral bands. This allows us to conduct further analysis on the composite images just as we would on the original satellite images (e.g by allowing the calculation of common band indices, like NDVI).

DE Africa’s GEoMAD product (Geomedian and Median Absolute Deviations), in addition to containing geomedians of the surface relfectance bands, GeoMAD also includes three Median Absolute Deviation (MAD) layers. These are higher-order statistical measurements on variation relative to the geomedian. These layers can be used on their own or together with geomedian to gain insights about the land surface and understand its change over time.

All the data of the selected timeframe has to be loaded to compute a composite, so geomedians can be computationally intensive to calculate, especially over large areas or long timescales. To assist with such analyses, DE Africa hosts a number of pre-calculated geoMAD products:

This reduces the time and resource needed to calculate the geomedian if you are conducting analysis over an annual timescale. Instructions on how to use the geomedian from the Sentinel-2 GeoMAD can be found in the Datasets/GeoMAD.ipynb notebook.

For analysis on other timescales, such as investigating change over seasons, it is not possible to use the annual geomedian product. In those cases, it can be useful to calculate GeoMAD for that specific time period.

## Description¶

In this notebook we will take of time series of noisy satellite images and calculate a GeoMAD composite which is largely free of clouds and other noisy data.

GeoMAD computations are expensive in terms of memory, data bandwidth, and CPU usage. The ODC has a useful function, geomedian_with_mads that allows dask to perform the computation in parallel across many threads to speed things up. In this notebook a local dask cluster is used, but the same approach should work using a larger, distributed dask cluster.

## Getting started¶

To run this analysis, run all the cells in the notebook, starting with the « Load packages » cell.

### Load packages¶

[1]:

%matplotlib inline

import datacube
import numpy as np
import matplotlib.pyplot as plt
from odc.algo import geomedian_with_mads
from deafrica_tools.plotting import rgb
from deafrica_tools.datahandling import load_ard
from deafrica_tools.dask import create_local_dask_cluster

/usr/local/lib/python3.8/dist-packages/geopandas/_compat.py:111: UserWarning: The Shapely GEOS version (3.8.0-CAPI-1.13.1 ) is incompatible with the GEOS version PyGEOS was compiled with (3.10.1-CAPI-1.16.0). Conversions between both will be slow.
warnings.warn(


### Set up a dask cluster¶

This will help keep our memory use down and conduct the analysis in parallel. If you’d like to view the dask dashboard, click on the hyperlink that prints below the cell. You can use the dashboard to monitor the progress of calculations.

[2]:

create_local_dask_cluster()


### Cluster

• Workers: 1
• Cores: 4
• Memory: 28.14 GB

### Connect to the datacube¶

[3]:

dc = datacube.Datacube(app='Generating_geomedian_composites')


## Load Sentinel-2 from the datacube¶

Here we are loading in a timeseries of cloud-masked Sentinel-2 satellite images through the datacube API using the load_ard function. This will provide us with some data to work with. To limit computation and memory this example uses only three optical bands (red, green, blue).

[4]:

# Set up centre of area of interest, and area to buffer coordinates by
lat, lon = -31.535, 18.2702
buffer = 0.035

# Create a reusable query
query = {
'x': (lon-buffer, lon+buffer),
'y': (lat+buffer, lat-buffer),
'time': ('2019-01', '2019-12'),
'measurements': ['green',
'red',
'blue'],
'resolution': (-10, 10),
'group_by': 'solar_day',
'output_crs': 'EPSG:6933'
}


Compared to the typical use of load_ard which by default returns data with floating point numbers containing NaN (i.e. float32), in this example we will set the dtype to 'native'. This will keep our data in its original integer data type (i.e. Int16), with nodata values marked with -999. Doing this will halve the amount of memory our data takes up, which can be extremely valuable when conducting large-scale analyses.

[5]:

# Load available data
ds = load_ard(dc=dc,
products=['s2_l2a'],
dask_chunks={'x':1000, 'y':1000},
mask_filters=(['opening',5], ['dilation',5]), #improve cloud mask
dtype='native',
**query)

# Print output data
print(ds)

Using pixel quality parameters for Sentinel 2
Finding datasets
s2_l2a
Applying morphological filters to pq mask (['opening', 5], ['dilation', 5])
Applying pixel quality/cloud mask
Returning 72 time steps as a dask array
<xarray.Dataset>
Dimensions:      (time: 72, y: 765, x: 676)
Coordinates:
* time         (time) datetime64[ns] 2019-01-04T08:59:00 ... 2019-12-30T08:...
* y            (y) float64 -3.824e+06 -3.824e+06 ... -3.831e+06 -3.831e+06
* x            (x) float64 1.759e+06 1.759e+06 ... 1.766e+06 1.766e+06
spatial_ref  int32 6933
Data variables:
green        (time, y, x) uint16 dask.array<chunksize=(1, 765, 676), meta=np.ndarray>
red          (time, y, x) uint16 dask.array<chunksize=(1, 765, 676), meta=np.ndarray>
blue         (time, y, x) uint16 dask.array<chunksize=(1, 765, 676), meta=np.ndarray>
Attributes:
crs:           EPSG:6933
grid_mapping:  spatial_ref


## Plot timesteps in true colour¶

To visualise the data, use the pre-loaded rgb utility function to plot a true colour image for a series of timesteps. Black areas indicate where clouds or other invalid pixels in the image have been set to -999 to indicate no data.

The code below will plot three timesteps of the time series we just loaded.

[6]:

# Set the timesteps to visualise
timesteps = [1, 5, 7]

# Generate RGB plots at each timestep
rgb(ds, index=timesteps)


## Generate a geomedian¶

As you can see above, most satellite images will have at least some areas masked out due to clouds or other interference between the satellite and the ground. Running the geomedian_with_mads function will generate a geomedian composite by combining all the observations in our xarray.Dataset into a single, complete (or near complete) image representing the geometric median of the time period.

Note: Because our data was lazily loaded with dask, the geomedian algorithm itself will not be triggered until we call the .compute() method in the next step.

[7]:

# geomedian = int_geomedian(ds)
geomedian = geomedian_with_mads(ds,
compute_mads=False,
compute_count=False)


### Run the computation¶

The .compute() method will trigger the computation of the geomedian algorithm above. This will take about a few minutes to run; view the dask dashboard to check the progress.

[8]:

%%time
geomedian = geomedian.compute()

CPU times: user 4.37 s, sys: 339 ms, total: 4.71 s
Wall time: 1min 56s


If we print our result, you will see that the time dimension has now been removed and we are left with a single image that represents the geometric median of all the satellite images in our initial time series:

[9]:

geomedian

[9]:

<xarray.Dataset>
Dimensions:  (y: 765, x: 676)
Coordinates:
* y        (y) float64 -3.824e+06 -3.824e+06 ... -3.831e+06 -3.831e+06
* x        (x) float64 1.759e+06 1.759e+06 1.759e+06 ... 1.766e+06 1.766e+06
Data variables:
green    (y, x) uint16 1425 1471 1510 1525 1456 ... 1881 1846 1859 1851 1821
red      (y, x) uint16 2219 2265 2335 2352 2230 ... 3178 3145 3154 3112 3059
blue     (y, x) uint16 811 843 864 876 827 786 ... 1125 1109 1113 1109 1100
Attributes:
units:         1
nodata:        0
crs:           EPSG:6933
grid_mapping:  spatial_ref

### Plot the geomedian composite¶

Plotting the result, we can see that the geomedian image is much more complete than any of the individual images. We can also use this data in downstream analysis as the relationships between the spectral bands are maintained by the geometric median statistic.

[10]:

# Plot the result
rgb(geomedian, size=8)


## Generate median absolute deviations¶

In addition to running a geomedian composite, which will return the median observations for each band, we can also compute the variation that each pixel undergoes during the time series. The geomedian_with_mads function returns three measures of variability: the spectral median absolute deviation (smad), the Euclidian median absolute deviation (emad), and the bray-curtis median absolute deviation (bcmad).

To compute the three measures of variability simply pass compute_mads=True to the geomedian_with_mads function. This function also supports returning the count, which returns the number of clear observations for each pixel.

[11]:

geomads = geomedian_with_mads(ds,
compute_mads=True,
compute_count=True)

geomads = geomads.compute()
print(geomads)

<xarray.Dataset>
Dimensions:  (y: 765, x: 676)
Coordinates:
* y        (y) float64 -3.824e+06 -3.824e+06 ... -3.831e+06 -3.831e+06
* x        (x) float64 1.759e+06 1.759e+06 1.759e+06 ... 1.766e+06 1.766e+06
Data variables:
green    (y, x) uint16 1425 1471 1510 1525 1456 ... 1881 1846 1859 1851 1821
red      (y, x) uint16 2219 2265 2335 2352 2230 ... 3178 3145 3154 3112 3059
blue     (y, x) uint16 811 843 864 876 827 786 ... 1125 1109 1113 1109 1100
smad     (y, x) float32 0.0002015 0.0001259 ... 0.0001583 0.0001578
emad     (y, x) float32 370.7 378.3 371.5 372.2 ... 287.2 224.4 256.9 321.8
bcmad    (y, x) float32 0.06463 0.06477 0.06227 ... 0.03043 0.03468 0.04292
count    (y, x) uint16 48 48 48 48 47 47 47 47 ... 44 44 44 45 45 45 45 45
Attributes:
units:         1
nodata:        0
crs:           EPSG:6933
grid_mapping:  spatial_ref


### Plot median absolute deviations and clear count¶

[12]:

fig,ax=plt.subplots(1,4, sharey=True, figsize=(20,5))
geomads['smad'].plot(ax=ax[0], cmap='plasma', robust=True)
geomads['emad'].plot(ax=ax[1], cmap='magma', robust=True)
geomads['bcmad'].plot(ax=ax[2], cmap='cividis', robust=True)
geomads['count'].plot(ax=ax[3], cmap='viridis', robust=True)
ax[0].set_title('SMAD')
ax[1].set_title('EMAD')
ax[2].set_title('BCMAD')
ax[3].set_title('Clear Count');


### Running GeoMADs on grouped or resampled timeseries¶

In the notebook Generating composites, built in functions such as mean and median are run on timeseries data that has been resampled or grouped.
We can use the same techniques with the geomedian function.

#### Resampling¶

First we will split the timeseries into the desired groups. Resampling can be used to create a new set of times at regular intervals:

• grouped = da_scaled.resample(time=1M)

• 'nD' - number of days (e.g. '7D' for seven days)

• 'nM' - number of months (e.g. '6M' for six months)

• 'nY' - number of years (e.g. '2Y' for two years)

#### Group By¶

Grouping works by looking at part of the date, but ignoring other parts. For instance, 'time.month' would group together all January data together, no matter what year it is from.

• grouped = da_scaled.groupby('time.month')

• 'time.day' - groups by the day of the month (1-31)

• 'time.dayofyear' - groups by the day of the year (1-365)

• 'time.week' - groups by week (1-52)

• 'time.month' - groups by the month (1-12)

• 'time.season' - groups into 3-month seasons:

• 'DJF' December, Jaunary, February

• 'MAM' March, April, May

• 'JJA' June, July, August

• 'SON' September, October, November

• 'time.year' - groups by the year

Here we will resample into three two-monthly groups ('2M'), with the group starting at the start of the month (represented by the 'S' at the end).

[13]:

grouped = ds.resample(time='2MS')
grouped

[13]:

DatasetResample, grouped over '__resample_dim__'
6 groups with labels 2019-01-01, ..., 2019-11-01.


Now we will apply the geomedian_with_mads function to each resampled group using the map method.

Instead of calling geomedian_with_mads(ds) on the entire array, we pass the geomedian_with_mads function to map to apply it separately to each resampled group.

[14]:

geomedian_grouped = grouped.map(geomedian_with_mads)


We can now trigger the computation, and watch progress using the dask dashboard.

[15]:

geomedian_grouped = geomedian_grouped.compute()


We can plot the output geomedians, and see the change in the landscape over the year:

[16]:

rgb(geomedian_grouped, col='time', col_wrap=3)


## Advanced: GeoMADs on Landsat data¶

Below we calculate GeoMADs using Landsat 8. For the GeoMAD to match Sentinel-2, we need to take one extra step. Landsat surface relfetance data is scaled from 0 to 1, while Sentinel-2 data is scaled from 0-10,000. For the two datasets to match, we need to multiply the Landsat bands by 10,000 (this will make the geoMADs produced in this notebook match the gm_ls8_annual dataset available in the datacube). The bands bcmad and smad do not need to be mulitplied by 10,000.

[17]:

# Load available data for Landsat 8
ds = load_ard(dc=dc,
x=(lon-buffer, lon+buffer),
y=(lat+buffer, lat-buffer),
time=('2019-01', '2019-12'),
measurements=['green','red','blue'],
products=['ls8_sr'],
dask_chunks={'x':1000, 'y':1000},
mask_filters=(['opening',3], ['dilation',3]), #improve cloud mask
resolution=(-30,30),
group_by='solar_day',
output_crs='EPSG:6933'
)

# Print output data
print(ds)

Using pixel quality parameters for USGS Collection 2
Finding datasets
ls8_sr
Applying morphological filters to pq mask (['opening', 3], ['dilation', 3])
Applying pixel quality/cloud mask
Re-scaling Landsat C2 data
Returning 23 time steps as a dask array
<xarray.Dataset>
Dimensions:      (time: 23, y: 256, x: 226)
Coordinates:
* time         (time) datetime64[ns] 2019-01-08T08:40:51.853294 ... 2019-12...
* y            (y) float64 -3.824e+06 -3.824e+06 ... -3.831e+06 -3.831e+06
* x            (x) float64 1.759e+06 1.759e+06 ... 1.766e+06 1.766e+06
spatial_ref  int32 6933
Data variables:
green        (time, y, x) float32 dask.array<chunksize=(1, 256, 226), meta=np.ndarray>
red          (time, y, x) float32 dask.array<chunksize=(1, 256, 226), meta=np.ndarray>
blue         (time, y, x) float32 dask.array<chunksize=(1, 256, 226), meta=np.ndarray>
Attributes:
crs:           EPSG:6933
grid_mapping:  spatial_ref


### Calculate GeoMADs on the Landsat data¶

[18]:

geomads = geomedian_with_mads(ds, compute_mads=True, compute_count=True).compute()
print(geomads)

<xarray.Dataset>
Dimensions:  (y: 256, x: 226)
Coordinates:
* y        (y) float64 -3.824e+06 -3.824e+06 ... -3.831e+06 -3.831e+06
* x        (x) float64 1.759e+06 1.759e+06 1.76e+06 ... 1.766e+06 1.766e+06
Data variables:
green    (y, x) float32 0.1419 0.1439 0.1352 0.1399 ... 0.1597 0.1509 0.1506
red      (y, x) float32 0.2158 0.2185 0.2056 0.2149 ... 0.2627 0.2512 0.2384
blue     (y, x) float32 0.07643 0.07741 0.07278 ... 0.0825 0.07558 0.07652
smad     (y, x) float32 1.876e-05 3.31e-05 3.873e-05 ... 0.0002149 0.0003207
emad     (y, x) float32 0.03394 0.02931 0.03076 ... 0.01675 0.02122 0.01753
bcmad    (y, x) float32 0.05951 0.0552 0.05722 ... 0.02686 0.03528 0.03135
count    (y, x) uint16 15 15 14 14 14 14 14 14 ... 14 14 14 14 14 14 14 14
Attributes:
crs:           EPSG:6933
grid_mapping:  spatial_ref


### Multiply bands by 10,000 to match Sentinel-2¶

[19]:

exclude = ['bcmad', 'smad', 'count']

for band in geomads.data_vars:
if band not in exclude:
geomads[band] = geomads[band]*10000


### Plot the Landsat GeoMAD¶

[20]:

fig,ax=plt.subplots(1,5, sharey=True, figsize=(22,5))
rgb(geomads, ax=ax[0])
geomads['smad'].plot(ax=ax[1], cmap='plasma', robust=True)
geomads['emad'].plot(ax=ax[2], cmap='magma', robust=True)
geomads['bcmad'].plot(ax=ax[3], cmap='cividis', robust=True)
geomads['count'].plot(ax=ax[4], cmap='viridis', robust=True)
ax[0].set_title('Geomedian')
ax[1].set_title('SMAD')
ax[2].set_title('EMAD')
ax[3].set_title('BCMAD')
ax[4].set_title('Clear Count');


## Additional information¶

License: The code in this notebook is licensed under the Apache License, Version 2.0. Digital Earth Africa data is licensed under the Creative Commons by Attribution 4.0 license.

Contact: If you need assistance, please post a question on the Open Data Cube Slack channel or on the GIS Stack Exchange using the open-data-cube tag (you can view previously asked questions here). If you would like to report an issue with this notebook, you can file one on Github.

Compatible datacube version:

[21]:

print(datacube.__version__)

1.8.7


Last Tested:

[22]:

from datetime import datetime
datetime.today().strftime('%Y-%m-%d')

[22]:

'2022-06-21'