Status: under development.
v0.4.0is the last release of the original API (Manager+settings.yml). Version 0.5 is a redesign and will break that API. The documentation is incomplete and will be written as the new interface stabilises.
agglpy is a tool for primary particle and agglomerate detection on digital microscopic (SEM/TEM) images. It combines several digital image processing and particle classification algorithms (including image filtering, edge/shape detection, and Hough transform, DFS and Union-Find) to describe the structure of each individual agglomerate.
agglpy detects spherical primary particles and its agglomerates in several steps:
- Input image preprocessing,
- Edge detection and binarization,
- Primary particle detection using the Hough Circle Transform (HCT),
- (Optional) Manual correction of missed and incorrectly detected primary particles,
- Primary particle connectivity determination,
- Grouping of connected particles into agglomerates.
See docs/methodology.md for the full description of the method.
See docs/index.md.
Not yet on PyPI or conda-forge (planned). To use the legacy version v0.4.0:
pip install git+https://github.com/00apm/agglpy@v0.4.0
or create its conda environment from
environment-v0.4.0.yml (conda env create -f environment-v0.4.0.yml).
See pyproject.toml. A full description is to be written.
A citation file (CITATION.cff) and a DOI will be added. Until then, please cite the repository URL:
https://github.com/00apm/agglpy