Skip to main content

Unified Fluorescence Lifetime Imaging (FLI) data processing platform using analytical and deep learning methods.

Project description

PyFLI Logo

pyfli: A Unified Platform for FLI Data Processing

License: CC BY-NC-ND 4.0 Python 3.11+ PyPI version

pyfli is a comprehensive library designed for Fluorescence Lifetime Imaging (FLI) data processing. It streamlines the workflow for handling diverse file formats from various hardware manufacturers and provides a standardized pipeline for both traditional analytical and deep-learning-based inference.


Key Features

  • Universal Processing Pipeline: Simplifies the handling of multiple FLI file types (ICCD, SPAD, TCSPC).
  • Enhanced FLI Simulator: A robust simulation engine adaptable to specific camera hardware parameters and noise models.
  • Standardized Inference: Unified interface for time-resolved microscopy and macroscopic FLI data (MFLI).

Supported Data Acquisition Methods

The platform provides native support for several high-end imaging systems:

  1. ICCD: Intensified Charge-Coupled Device cameras for fast-gated, wide-field imaging.
  2. SwissSPAD2 & SwissSPAD3: High-speed SPAD (Single-Photon Avalanche Diode) architectures for high-resolution photon counting.
  3. SPCImage/TCSPC: Standardized processing for Time-Correlated Single Photon Counting microscopy data.

Data Processing & Analysis

pyfli implements industry-standard analytical methods to extract lifetime information:

  • Non-linear Least Squares Fitting (NLSF): Robust mathematical approach for exponential decay modeling.
  • Phasor Plot Analysis: Graphical, model-free transformation of fluorescence decay into a 2D polar plot for easy species separation.
  • Maximum Likelihood Estimation (MLE): Statistical estimator optimized for low-photon regimes.
  • Rapid Lifetime Determination (RLD): Computationally efficient method for real-time applications and high-frame-rate data.
  • Laguerre Method (LET): Laguerre Expansion Technique for model-free IRF deconvolution followed by multi-exponential lifetime extraction on a per-pixel basis.

Installation

Install the stable version directly from PyPI:

pip install pyfli-lib

For users requiring GPU-based processing, install the optional tensor/AI dependencies:

pip install "pyfli-lib[gpu]"

Quick Start

Even though the package is installed as pyfli-lib, you import it as pyfli in your scripts:

from pyfli import DataOperations

loader = DataOperations(    
    data_path = "experimental_data.sdt",
    irf_path = "instrument_data.txt", 
    bg_path = "background_data.tif",   
    mask_path="background_data.png",
    )
decay_data = loader.load_data()
irf_data = loader.load_irf()

Citation

If you use pyfli in your research, please cite this package:

Pandey V. pyfli: A Unified Platform for Fluorescence Lifetime Imaging Data Processing. https://github.com/vkp217/pyfli-pkg/tree/joss-submission

@article{pandey2025pyfli,
  author  = {Pandey, Vikas},
  title   = {{pyfli}: A Unified Platform for Fluorescence Lifetime Imaging Data Processing},
  journal = {},
  year    = {2025},
  note    = {},
  url     = {https://github.com/vkp217/pyfli-pkg/tree/joss-submission}
}

If you use the phasor SEPL analysis functionality specifically, please also cite the following paper on which the phasor module is based:

Michalet X. "Continuous and discrete phasor analysis of binned or time-gated periodic decays." AIP Advances 11, 035331 (2021). https://doi.org/10.1063/5.0027834


Repository & Issues

The source code is hosted on GitHub. Please report any bugs or feature requests via the issues tracker.

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

pyfli_lib-0.1.18.tar.gz (385.6 kB view details)

Uploaded Source

Built Distribution

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

pyfli_lib-0.1.18-py3-none-any.whl (415.5 kB view details)

Uploaded Python 3

File details

Details for the file pyfli_lib-0.1.18.tar.gz.

File metadata

  • Download URL: pyfli_lib-0.1.18.tar.gz
  • Upload date:
  • Size: 385.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for pyfli_lib-0.1.18.tar.gz
Algorithm Hash digest
SHA256 0d908cb6b2526aae7543fd58a30a8ae947ab6be74992b4bfd2cf6e6bdb9d2e37
MD5 eed1a58dea61bf4c7f46a7272b6ec1eb
BLAKE2b-256 384bbb987f2d768b57d98454ad65be2630bed3f913327cb84ab7cf063f5f9a11

See more details on using hashes here.

File details

Details for the file pyfli_lib-0.1.18-py3-none-any.whl.

File metadata

  • Download URL: pyfli_lib-0.1.18-py3-none-any.whl
  • Upload date:
  • Size: 415.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for pyfli_lib-0.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 2a7fa775023fe173aa9b8ae11e19cb905ab613f7e47646874b5eda0cfc9b7fb1
MD5 5aa1dc4fa3161f773f0ce2597f50ae8d
BLAKE2b-256 75f30c4356b7f91dac330ed027dd56176185b72d9a1421df3b7e0f2584fd1ecf

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