.. lavaflow documentation master file, created by
   sphinx-quickstart on Wed Nov  2 16:41:59 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to lavaflow's documentation!
====================================

This module package contains all of the code required for free surface velocity
tracking.

Free surface velocity tracking
------------------------------

Something.

The examples below document how a pipeline can be configured to perform sparse
optical flow or dense optical flow, and give an overview of how the parameters
affect the image processing, tracking, and velocity estimation algorithms used.

The majority of classes and functions in the module have been documented .

.. toctree::
   :maxdepth: 2
   :caption: Examples

   sparse
   dense

.. toctree::
   :maxdepth: 2
   :caption: API

   lavaflow
   lavaflow.pipes
   lavaflow.utils