Metadata-Version: 2.4
Name: pivimage
Version: 0.7.4
Summary: Small library reading images and providing PIV-specific utilities.
Home-page: https://github.com/matthiasprobst/pivimage
Author: Matthias Probst
Author-email: matthias.probst@kit.edu
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: appdirs>=1.4.4
Requires-Dist: numpy
Requires-Dist: pco_tools>=1.0.0
Requires-Dist: opencv-python>=4.5.3.56
Requires-Dist: importlib-metadata>=5.0.0
Requires-Dist: matplotlib
Provides-Extra: test
Requires-Dist: pivtestdata>=0.4.0; extra == "test"
Requires-Dist: pytest>=7.1.2; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: xarray; extra == "test"
Provides-Extra: complete
Requires-Dist: pivtestdata>=0.4.0; extra == "complete"
Requires-Dist: pytest>=7.1.2; extra == "complete"
Requires-Dist: pytest-cov; extra == "complete"
Requires-Dist: xarray; extra == "complete"
Dynamic: license-file

# Pivimage

![Tests](https://github.com/matthiasprobst/pivimage/actions/workflows/tests.yml/badge.svg)
[![codecov](https://codecov.io/github/matthiasprobst/pivimage/graph/badge.svg?token=7H1BZ7NM1T)](https://codecov.io/github/matthiasprobst/pivimage)

`pivimage` is a lightweight Python library for Particle Image Velocimetry (PIV) image handling during pre-processing.
It focuses on practical operations you usually need before correlation or analysis.

## What It Provides

- image loading for common formats (including `.b16`)
- helpers for single-frame and double-frame PIV recordings
- common image transforms (`normalize`, `rot90`, `rot180`, `flip*`, masking)
- quick plotting utilities for images and histograms

## Installation

```bash
pip install pivimage
```

## Quick Start

```python
import pivimage

img = pivimage.PIVImage("frame_0001.tif")
img_norm = img.normalize()
img_rot = img_norm.rot90()

pair = pivimage.PIVImagePair("frame_a.tif", "frame_b.tif")
pair.plot()
```

## Example Notebook

<a target="_blank" href="https://colab.research.google.com/github/matthiasprobst/pivimage/blob/main/examples/Getting%20started.ipynb">
  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>

## Development and Tests

```bash
pip install -r requirements-dev.txt
pytest
pytest --cov --cov-report=html
```
