Unsupervised image velocimetry for automated computation of river flow velocities

📖 Table of Contents

Table of Contents

1. ➤ About The Repository
2. ➤ Prerequisites
3. ➤ Repository Structure
4. ➤ How to use

📝 About The Repository

This repository contains scripts used to generate the Figures presented in the research article `Unsupervised image velocimetry for automated computation of river flow velocities'.

🍴 Prerequisites

Replicating the outputs presented in `Unsupervised image velocimetry for automated computation of river flow velocities' requires the user to download the data files from: here, the code from this GitHub repository, and to be able to run MATLAB 2019a onwards.

🌵 Repository Structure

Below is the an outline of the folder structure within this repository with descriptions provided:

.
├── code                    # folder containing scripts to work with this repository
│   ├── fig4                # scripts required to generate outputs presented in Figure 4
│   ├── fig5                # scripts required to generate outputs presented in Figure 5
│   ├── fig6                # scripts required to generate outputs presented in Figure 6	
│   ├── fig7                # scripts required to generate outputs presented in Figure 7
│   ├── fig8                # scripts required to generate outputs presented in Figure 8
│   ├── prerequisites       # additional scripts required to produce the figures
├── images                  # folder containing images 

👍 How to use

• Clone or download this repository so that it is accessible on your PC.

• Download the files from: here to your PC.

• Open MATLAB on your PC.

• To generate Figure 4, ensure all scripts in "fig4" and "prerequisites" subfolders are accesible in your MATLAB search path, execute "fig4.m", ensuring that you provide the links to the directories containing the relevant datasets (downloaded from link above).

• To generate Figure 5, ensure all scripts in "fig5" and "prerequisites" subfolders are accesible in your MATLAB search path, execute "fig5.m", ensuring that you provide the links to the directories containing the relevant datasets (downloaded from link above).

• To generate Figure 6, ensure all scripts in "fig6" and "prerequisites" subfolders are accesible in your MATLAB search path, execute "fig6.m", ensuring that you provide the links to the directories containing the relevant datasets (downloaded from link above).

• To generate Figure 7, ensure all scripts in "fig7" and "prerequisites" subfolders are accesible in your MATLAB search path, execute "fig7.m", ensuring that you provide the links to the directories containing the relevant datasets (downloaded from link above).

• To generate Figure 8, ensure all scripts in "fig8" and "prerequisites" subfolders are accesible in your MATLAB search path, execute "fig8.m", ensuring that you provide the links to the directories containing the relevant datasets (downloaded from link above).