Skip to main content

An automatic deep learning algorithm for spot detection in fluorescence microscopy images.

Project description

Piscis

Piscis

piscis is an automatic deep learning algorithm for spot detection, written in Python using the PyTorch framework. It is named after the Latin word for fish, as it was designed specifically for microscopy images generated by RNA fluorescence in situ hybridization (FISH). However, we have found it to be useful for other imaging methods, such as immunofluorescence (IF) and FISH-based spatial transcriptomics. To learn more about piscis, please read our Cell Systems paper or bioRxiv preprint.

This Python package allows users to apply pre-trained models from Hugging Face to both single plane images and z-stacks or to train new models using custom datasets. It provides a simple API for both training and inference that can be used in traditional Python scripts or Jupyter notebook environments such as on Google Colab. It also provides a command line interface for those who prefer the terminal. For a user-friendly graphical user interface, we have implemented piscis as a Docker image for NimbusImage, a cloud platform for biological image analysis enabling researchers to interactively visualize their data while leveraging state-of-the-art machine learning algorithms.

For more information, please refer to the comprehensive documentation available at https://piscis.netlify.app.

Examples

Examples

Installation

Install piscis from PyPI with pip.

pip install piscis

Usage

If you want to use piscis with its Python API, check out the inference example and training example notebooks.

If you want to use piscis with its command line interface, run the following commands.

# Run Piscis.
piscis predict INPUT_PATH OUTPUT_PATH [OPTIONS]

# Train Piscis.
piscis train MODEL_NAME DATASET_PATH [OPTIONS]

To see the full list of options, run piscis predict --help or piscis train --help.

Citation

If you use piscis in your research, please cite our paper.

Niu, Z., O’Farrell, A., Li, J., Reffsin, S., Jain, N., Dardani, I., Goyal, Y., & Raj, A. (2025). Piscis: A loss estimator of the F1 score enables accurate spot detection in fluorescence microscopy images via deep learning. Cell Systems. https://doi.org/10.1016/j.cels.2025.101448

@article{Niu2025-Piscis,
    title={Piscis: A loss estimator of the F1 score enables accurate spot detection in fluorescence microscopy images via deep learning},
    author={Niu, Zijian and O’Farrell, Aoife and Li, Jingxin and Reffsin, Sam and Jain, Naveen and Dardani, Ian and Goyal, Yogesh and Raj, Arjun},
    year=2025,
    journal="Cell Systems",
    DOI={10.1016/j.cels.2025.101448}
}

License

piscis is licensed under the MIT License. The copyright and permission notices found in the LICENSE file shall be included in all copies or substantial portions of the Software.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

piscis-1.1.0.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

piscis-1.1.0-py3-none-any.whl (47.5 kB view details)

Uploaded Python 3

File details

Details for the file piscis-1.1.0.tar.gz.

File metadata

  • Download URL: piscis-1.1.0.tar.gz
  • Upload date:
  • Size: 40.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for piscis-1.1.0.tar.gz
Algorithm Hash digest
SHA256 e1cff1db121965d6263ecceffd502c29481912a18532870f652d4f67e5794559
MD5 1e62df2815aedcf46037a19f1662d372
BLAKE2b-256 fb95edc535e1aa7efb8c0cedc15d984aacca451ef53f25a3d63b8228b88f4243

See more details on using hashes here.

File details

Details for the file piscis-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: piscis-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 47.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for piscis-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5cdf2ae5c406826ea5d84d7d3f98b336ab0d570f150d12be7a9198999ade120d
MD5 a4f453ca1c81f68b667be6eaa37f4604
BLAKE2b-256 c56eb649a86a3b5f98348dacdb748b705fee511ff6f8fc49083926917ee28c93

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page