Metadata-Version: 2.1
Name: feret
Version: 0.1.2
Summary: Calculate Feret diameter.
Home-page: https://github.com/matthiasnwt/feret
License: MIT
Keywords: feret,maxferet,diameter,maximum
Author: matthiasnwt
Author-email: 62239991+matthiasnwt@users.noreply.github.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: matplotlib (>=3.5.1,<4.0.0)
Requires-Dist: numpy (>=1.22.3,<2.0.0)
Requires-Dist: scipy (>=1.8.0,<2.0.0)
Project-URL: Repository, https://github.com/matthiasnwt/feret
Description-Content-Type: text/markdown

# Feret

This python module can calculate the maximum and minimum Feret Diameter of a binary image. For a detailed explanation see this [wikipedia page](https://en.wikipedia.org/wiki/Feret_diameter).

At this early development stage, it can only calculate the maximum and minimum Feret Diameter but feature releases will offer the Feret diameter 90° to maximum and minimum. The module will also not return the angle of the diameters. Many things will come in the future.

The module can be used as followed:

```python
import feret
import tifffile as tif

img = tif.imread('example.tif')

res = feret.calc(img)

print(res.maxferet, res.minferet)
```


