An image processing framework created for Ex-FAB NSF BioFoundry that aims to streamline the development of image processing pipelines for images analysis of phenotypes.
Project description
PhenoTypic: A Python Framework for Bio-Image Analysis
A modular image processing framework developed at the NSF Ex-FAB BioFoundry, focused on arrayed colony phenotyping on solid media.
Links:
Overview
PhenoTypic provides a modular toolkit designed to simplify and accelerate the development of reusable bio-image analysis pipelines. PhenoTypic provides bio-image analysis tools built-in, but has a streamlined development method to integrate new tools.
Installation
uv (recommended)
See more on installing uv
Regular Install (recommended when deploying on a cluster)
uv pip install phenotypic
Interactive / GUI Install (napari viewer, Panel dashboards, Jupyter)
uv pip install "phenotypic[gui]"
Pip
Regular Install
pip install phenotypic
Interactive / GUI Install
pip install "phenotypic[gui]"
Note: may not always be the latest version. Install from repo when latest update is needed
Manual Installation (For latest updates)
git clone https://github.com/exfab/PhenoTypic.git
cd PhenoTypic
uv sync
Dev Installation
For extending PhenoTypic.
git clone https://github.com/exfab/PhenoTypic.git
cd PhenoTypic
uv sync --group dev
GPU-Accelerated Detection (SAM2, micro-sam)
PhenoTypic ships optional deep-learning detectors backed by Meta's Segment Anything Model 2 and micro-sam.
-
SAM2 is available on PyPI and ships in the
torchextra:uv pip install "phenotypic[torch]" # Linux/macOS only
-
micro-sam is only published on conda-forge (not PyPI), so it is not bundled with any
phenotypicextra. If you needMicroSamDetector, see the "Enabling micro_sam" section of the GPU Detection Setup guide for a user-sidepixi.tomlthat installsphenotypicandmicro_samtogether in a single environment.MicroSamDetectorremains importable withoutmicro_saminstalled; theImportErroris deferred to the firstapply()call.
See GPU Detection Setup for model downloads and SLURM deployment instructions.
Optional Installation
To extract metadata from raw images, PhenoTypic uses the PyExifTool module. This
requires an external software called
ExifTool. You can install ExifTool here: https://exiftool.org/install.html. If you don't
use it, some metadata from raw
files may not be able to be imported. Read more
here: https://pypi.org/project/PyExifTool/#pyexiftool-dependencies
Module Overview
| Module | Description |
|---|---|
phenotypic.analysis |
Tools for downstream analysis of the data from phenotypic in various ways such as growth modeling or statistical filtering |
phenotypic.correction |
Different methods to improve the data quality of an image such as rotation to improve grid finding |
phenotypic.data |
Sample images to experiment your workflow with |
phenotypic.detect |
A suite of operations to automatically detect objects in your images |
phenotypic.enhance |
Preprocessing tools that alter a copy of your image and can improve the results of the detection algorithms |
phenotypic.grid |
Modules that rely on grid and object information to function |
phenotypic.measure |
The various measurements PhenoTypic is capable of extracting from objects |
phenotypic.nn |
GPU-accelerated detectors (SAM2, micro-sam) with checkpoint management — see setup guide |
phenotypic.refine |
Different tools to edit the detected objects such as morphology, relabeling, joining, or removing |
phenotypic.prefab |
Various premade image processing pipelines that are in use at ExFAB |
Sponsors
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file phenotypic-0.14.0b3.tar.gz.
File metadata
- Download URL: phenotypic-0.14.0b3.tar.gz
- Upload date:
- Size: 3.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e21ca09f16a8fbadb9999929fe78b7d9ad1a00ee2a29fc480027408b059700ec
|
|
| MD5 |
4ca963b55000d0be3d8a133d1ee0117b
|
|
| BLAKE2b-256 |
73f55fab9e617d739babb83cefd6e6355315ee60f8c82086e990e373a3220f51
|
File details
Details for the file phenotypic-0.14.0b3-py3-none-any.whl.
File metadata
- Download URL: phenotypic-0.14.0b3-py3-none-any.whl
- Upload date:
- Size: 3.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
61314094e74409fd32176554efce172d2022c0480ea30ef66cfdec294fa1495a
|
|
| MD5 |
4f33d12f86eb39bd00afcb83d10cbf92
|
|
| BLAKE2b-256 |
2d1b3972a43e0b08ce05258d4839b7b04090ec6a3b72b17bd747529efc82e465
|