Awesome
<img src="https://github.com/datasciencecampus/awesome-campus/blob/master/ons_dsc_logo.png">Faster Economic Indicators: Detecting Trucks :truck: :articulated_lorry:
This project concerns training a supervised machine learning model to detect and count the number of trucks on roads in public and freely available satellite imagery. This was an experimental project aimed at identifying possible faster trade indicators (see technical blog post for details). However, it ultimately did not go into production - as such, this codebase represents a working prototype only and comes with no guarantees will not be supported or maintained.
The following README provides a brief overview of the project, but the primary project documentation (including an introduction to the project, installation instructions and an end-to-end walk-through) is available by building the docs.
<!-- TOC -->- Faster Economic Indicators: Detecting Trucks :truck: :articulated_lorry:
- Getting Started
- Execution Overview
- Project Structure
- Data Science Campus
- Licence
Background
In the wake of the COVID-19 pandemic in April 2020, the Office for National Statistics' Data Science Campus began exploring faster economic indicators of economic activity in UK Official Development Assistance (ODA) countries as part of its international development work. Building on previous methods we set out to provide more timely estimates of economic activity though the adoption of novel data sources, including open source satellite data.
This led to the exploration of the use of low-resolution satellite data from the European Space Agency's Sentinel-2 (S2) satellite, which is freely available and frequently captured, to monitor changes in road traffic in ODA-eligible countries (specifically in East Africa, with a focus on Kenya).
Tracking the flow of traffic at a higher granularity has the potential to unlock insights into the distribution of inland trade in countries which lack the infrastructure or funding required for road traffic monitoring using road sensors. As well as understanding domestic and international trade, this technique could also be used to estimate emissions from road transport, a critical task in tracking progress towards greenhouse gas emissions targets.
Following some positive findings from Henrik Fisser's masters project, which won an S2 hub innovation competition for detecting reductions in road traffic following lockdowns in Germany, a new method was developed to extract S2 images and estimate vehicle counts by training a supervised machine learning model. This process exploits the temporal offset in blue, green and red light from large vehicles on the motorway, which is seen as a ‘rainbow’ sequence of coloured pixels.
<p float="left"> <img src="docs/source/images/sentinel_2_truck_offset.png" alt="A diagram showing a truck moving through time and hence colour bands on the S2 sensor to form the sequence of coloured pixels." width="47%" /> <img src="docs/source/images/truck_signals.PNG" alt="Screenshot of the characteristic sequence of blue, green and red pixels in a satellite image of a road." width="47%"/> </p>Process Overview
The key stages in this project involve:
- Extraction of Sentinel 2 satellite images for a chosen location, limited to the main roads only, within some date range.
- Processing of these images - most notably chipping the full extent of each observation image into smaller tiles for computational analysis.
- Optional: Manual labelling of truck positions within some subset of images in order to generate training data. Otherwise, it is possible to use pre-supplied training data (less accurate).
- Train a supervised machine learning model. By default, this is a random forest classifier.
- Predict truck counts by applying trained model to observation images.
- Estimate cloud corrected truck counts for each date using percentage cloud coverage of each image.
It was found the methodology developed here can detect broad trends in road traffic over time (such as detecting downturns in truck counts during national lockdowns) but was not robust enough for close to realtime indicators of traffic volumes, as desired. As a result, this R&D project has not gone into production and this codebase thus represents a working prototype only. Whilst ultimately not suitable for its original intended use case, the methodology may be applicable, adaptable or expandable for other use cases and scenarios. And in making this code public, we encourage any interested party to do just that.
For details on the methodology and results of this work, see the technical blog post and see the project documentation for details on the codebase itself and how to run the project.
Getting Started
Installation
For detailed installation instructions it is recommended you explore the project documentation by building the docs.
This project has been developed in Python and consists of a series of scripts for executing the processing and analysis (including data processing, feature engineering, modelling & evaluation), with much of the supporting functionality found in modules.
Dependencies
There are a number of open source and 3rd party dependencies that are required to run this codebase.
The recommended option for Conda users is to create an environment from the environment_trucks.yml
provided.
Alternatively, dependencies can be installed using pip. In the terminal, the provided requirements.txt
can be run by:
python -m pip install -r requirements.txt
However, this is not recommended on a Windows machine as some packages
(namely Fiona
and rasterio
) are not trivial to install on Windows.
Build the docs
The required packages for building the docs should have been installed through the dependencies section above. To build the docs navigate to docs/
in the terminal and run:
make clean | make html
As noted above you should be able to access the docs now by double clicking on the docs/build/html/installation.html
file.
Pre-commit actions
This repository makes use of pre-commit hooks. If approaching this project as a developer, you can install and enable pre-commit
by running the following in your shell:
-
Install
pre-commit
:pip install pre-commit
-
Enable
pre-commit
:pre-commit install
These should then execute whenever you commit to this repository. The use of active pre-commits are encouraged when working with this codebase.
Execution Overview
In order to run through this project, the project scripts are intended to be run as follows: (It is highly recommended you follow the documentation in order to correctly run these scripts with the appropriate command line arguments in place.)
flowchart TD;
A["<b>Set-up:</b> \n(<i>create_notebook.py</i>)"] --> B["<b>Data extraction:</b> \n (<i>extract_satellite_imagery.ipynb</i>)"];
B --> C["<b>Processing:</b> \n (<i>process_images.py</i>)"];
C --> D["<b>Generate training data:</b> \n(<i>build_training_data.py</i>)"];
D --> E["<b>Train model:</b> \n (<i>train_model.py</i>)"];
C -- Use presupplied\ntraining data --> E;
E --> F["<b>Detect trucks:</b> \n (<i>predict_truck_counts.py</i>)"]
Project Structure
The code in this project is structured as follows:
📦src
┗ 📂python
┣ 📂data_processing
┃ ┣ 📜extract_gee_images.py
┃ ┣ 📜image_processing.py
┃ ┣ 📜masking.py
┃ ┗ 📜__init__.py
┣ 📂truck_detection
┃ ┣ 📜cloud_time_series.py
┃ ┣ 📜detect_trucks.py
┃ ┣ 📜feature_engineering.py
┃ ┗ 📜__init__.py
┣ 📂utils
┃ ┣ 📜column_headers.py
┃ ┣ 📜file_handling.py
┃ ┗ 📜__init__.py
┣ 📜build_training_data.py
┣ 📜config.yaml
┣ 📜create_notebook.py
┣ 📜extract_satellite_imagery.py
┣ 📜predict_truck_counts.py
┣ 📜process_images.py
┗ 📜train_model.py
create_notebook.py
: converts data extraction script into required notebook form.extract_satellite_imagery.ipynb
: this notebook contains all steps in extracting and processing sentinel-2 images from GEE. There are manual steps involved in this.process_images.py
: processes images and performing chipping functionalitybuild_training_data.py
: This is an optional step which generates training data specific to your chosen location of interest. This process requires manual labelling of data. Alternatively, pre-supplied training data is available.train_model.py
: trains a supervised ML model (by default random forest classifier).predict_truck_counts.py
: processes all images and applies model in order to predict truck counts.
A full index of the modules and their function documentation are available in the documentation pages.
Data Structure
When executing the scripts, data will be stored and processed in the following overall structure, where <location>
is the string representation of the location of interest:
📦data
┣ 📂<location>
┃ ┣ 📂final
┃ ┣ 📂processed
┃ ┃ ┣ 📂chips
┃ ┃ ┃ ┣ 📂temporal_mean_imgs
┃ ┃ ┣ 📂predictions
┃ ┃ ┣ 📂training
┃ ┗ 📂raw
┃ ┃ ┣ 📂s2_images
┃ ┃ ┗ 📜<location>.osm.pbf
┣ 📂preprepared_training_data
┃ ┣ 📜nairobi2_training_features.csv
┃ ┗ 📜nairobi_training_features.csv
Documentation Structure
This repository contains all the source code for generating the documentation material using Sphinx. This documentation code is structured as follows:
📦docs
┣ 📂build
┃ ┣ 📂doctrees
┃ ┗ 📂html
┃ ┃ ┣ 📜authors.html
┃ ┃ ┣ 📜index.html
┃ ┃ ┣ 📜installation.html
┃ ┃ ┗ 📜tutorial.html
┣ 📂source
┃ ┣ 📂images
┃ ┣ 📜authors.rst
┃ ┣ 📜conf.py
┃ ┣ 📜index.rst
┃ ┣ 📜installation.rst
┃ ┗ 📜tutorial.rst
┣ 📜make.bat
┗ 📜Makefile
Data Science Campus
The project was developed by the International Development squad within the Data Science Campus of the Office for National Statistics.
At the Data Science Campus we apply data science, and build skills, for public good across the UK and internationally. Get in touch with the Campus at datasciencecampus@ons.gov.uk.
Licence
<!-- Unless stated otherwise, the codebase is released under [the MIT Licence][mit]. -->The code, unless otherwise stated, is released under the MIT Licence.
The documentation for this work is subject to © Crown copyright and is available under the terms of the Open Government 3.0 licence.