Skip to content

exfab/PhenoTypic

Repository files navigation

Phenotypic Logo

PhenoTypic: A Python Framework for Bio-Image Analysis

Development Status

A modular image processing framework developed at the NSF Ex-FAB BioFoundry, focused on arrayed colony phenotyping on solid media.


Links:

docs

exfab

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 add phenotypic

Interactive / GUI Install (napari viewer, Panel dashboards, Jupyter)

uv add "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 pip install -e .

Dev Installation

For extending PhenoTypic.

git clone https://github.com/exfab/PhenoTypic.git
cd PhenoTypic
uv sync --group dev

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.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

Phenotypic Logo

About

An image processing framework created for Ex-FAB NSF BioFoundry that aims to streamline the development of image processing tools for phenotype image analysis.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages