Napari plugin and CLI for quantifying cell shape and protein distribution on micropatterned substrates.
Project description
Fungiform
A napari plugin and CLI for quantifying cell shape and protein distribution on micropatterned substrates. Designed for multi-channel fluorescence confocal images of cells grown on mushroom-shaped fibronectin micropatterns.
Fungiform aligns a canonical pattern template to each image via normalised cross-correlation, warps head / stem / stem-tip sub-regions into image coordinates, segments cells in the cell-border channel, and reports a rich per-cell table of region-based protein intensities, stem-axis geometry, head-region protrusions, and nuclear / cytoplasmic ratios.
Installation
pip install napari-fungiform
Or from source:
git clone https://github.com/lxfhfut/Fungiform.git
cd Fungiform
pip install -e .
Python ≥ 3.10 required.
Quick start
Napari plugin
napari
Then open Plugins → Fungiform. The widget has two sections:
- Single Input — point at a single 4-channel TIFF (merged layout) or a
folder containing per-channel siblings
*_C0.tif … *_C3.tif(split layout). - Batch — point at a folder of images; outputs go to
<folder>/results/by default.
CLI
fungiform --dir ./my_images --out ./results
Common flags:
| Flag | Default | Effect |
|---|---|---|
--split-channels |
off | Inputs are split per channel (*_C0..C3.tif) |
--channel-cell |
1 | 1-indexed cell-border channel (e.g. WGA) |
--channel-protein |
2 | Protein-of-interest channel |
--channel-nucleus |
3 | Nucleus channel (e.g. DAPI) |
--channel-pattern |
4 | Pattern channel (e.g. fibronectin) |
--ball-radius-fraction |
0.25 | Rolling-ball radius as fraction of cell's MIC |
--no-align |
off | Skip NCC alignment (use when no pattern channel) |
Run fungiform --help for the full option list.
Output
For each input image MAX_<title>.tif, Fungiform writes into the output
directory:
_allResults.csv # one row per detected cell
MAX_<title>_Cell_mask.jpg # labeled segmentation mask
MAX_<title>_mask_overlay.jpg # cell channel + segmentation overlay
MAX_<title>_image_qc.png # 3-panel per-image overview
qc_cells/<Label>_qc.png # 6-panel per-cell QC
protrusions/<Label>_protrusions.png # per-cell protrusion detail
protrusions/MAX_<title>_protrusions.png # rolling-ball multi-cell detail
protrusions/MAX_<title>_protrusions_overview.png
See docs/Results_interpretations.md for
a column-by-column description of _allResults.csv and a panel-by-panel guide
to every visualisation.
Pattern templates
Fungiform ships with default mushroom-pattern templates (perfect / head /
stem) under src/fungiform/templates/. To use your own pattern shape, supply
--pattern-template, --head-template, and --stem-template pointing at
TIFF masks.
Citation
If you use Fungiform in your research, please cite this repository:
@software{fungiform,
author = {Lin, Xufeng},
title = {Fungiform: Napari plugin for micropattern cell quantification},
url = {https://github.com/lxfhfut/Fungiform},
year = {2026}
}
License
BSD 3-Clause — see LICENSE.
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 napari_fungiform-0.1.1.tar.gz.
File metadata
- Download URL: napari_fungiform-0.1.1.tar.gz
- Upload date:
- Size: 69.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e7e9a75686252e7f3c6bd4fa7ff5ade36b44935fa6f38f989b5f72adf82e60a
|
|
| MD5 |
8a5f23ed63c6763f98b3950b7ee72c23
|
|
| BLAKE2b-256 |
094f93f9c22f6d4bc5d8b9ee701799dbd9da9413b2d98b5a7b7ae0ebf6d25685
|
File details
Details for the file napari_fungiform-0.1.1-py3-none-any.whl.
File metadata
- Download URL: napari_fungiform-0.1.1-py3-none-any.whl
- Upload date:
- Size: 66.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c0a496e22d1a9e9beb7307439101a36d68bb1df10d23e0b73e4d29dd35b91b6f
|
|
| MD5 |
f57e22c9cfe3ccf4a09bf6615e1be177
|
|
| BLAKE2b-256 |
f99c451dc0324aa0ea5f21d20f31556f1beece6358d6717c79e8ab8a9137b63d
|