ORByT - Optical River Bathymetry Toolkit

The Optical River Bathymetry Toolkit is an application to facilitate mapping water depth in river channels from passive optical image data.

The Optical River Bathymetry Toolkit, ORByT, is an application to facilitate mapping water depth in river channels from passive optical image data. ORByT provides an integrated workflow for image processing, depth retrieval, and export of results.

To begin using ORByT, download the file ORByT.zip from this repository. The zip archive contains the current version of the ORByT installer and documentation in two PDF files: a set of slides with background on the Optimal Band Ratio Analysis (OBRA) technique implemented within OBRA and a tutorial illustrating how to use the software.

The Documentation folder in this repository includes the following training materials:

1. A written user's guide - ORByTtutorialV1.1.pdf
2. A lecture with background on the spectrally based depth retrieval techniques implemented within the software - OBRAprimer.pdf
3. A zip file containing a video tutorial - ORByTvideoTutorial.zip
4. A zip file containing a recording of the background lecture - ORByTbackgroundLecture.zip
5. A MATLAB data file with the output from a complete ORByT session as described in the tutorial - ORByTsession.mat

Please note that both videos include closed captions that can be searched to take the user to specific topics of interest. To view the captions in Smart Player, you must launch the video from the HTML file, not the MP4 video file itself. For example, use ORByTvideoTutorial.html, not ORByTvideoTutorial.mp4.

The Source code folder in this repository contains the MATLAB source code used to develop ORByT. The software was produced using MATLAB's App Designer and the main file DepthMap.mlapp contains most of the functions invoked through the graphical user interface. Additional helper functions include envi2matlab.m, readEnviHeader.m, regrPlot.m, and univStats.m. The app was also exported as an m file: DepthMap_exported.m. The current, compiled version of the app can be downloaded and installed using ORByT_install.exe. The file MATLAB.txt contains information on prerequisites for deployment.

The Digital Object Identifier (DOI) for this software is: https://doi.org/10.5066/P9GXRJ3K