pivLib
==========

Convenience tools for PIV analysis. Core PIV functions are imported from the `OpenPIV <https://github.com/OpenPIV/openpiv-python>`_ project. The tools here are designed to (i) streamline the PIV analysis process, (ii) provide additional convenience for PIV data processing (e.g. :py:func:`apply_mask`) and file handling (e.g. :py:class:`compact_PIV`).

.. currentmodule:: myimagelib.pivLib

.. autosummary::
    :toctree: generated
    
    PIV
    apply_mask
    read_piv
    to_matrix
    compact_PIV