Skip to main content

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

Project description

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. 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.16.tar.gz (169.8 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.16-py3-none-any.whl (198.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyfli_lib-0.1.16.tar.gz
  • Upload date:
  • Size: 169.8 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.16.tar.gz
Algorithm Hash digest
SHA256 23649f072b1d91c5ce3444ff0703c605c78096d50cbb57af05de1be424b230af
MD5 b2a3f3c44369a9103e5bd53750f3b5fd
BLAKE2b-256 8fc4e5763c75b385f007f85877cb9953aac4083fc2f7dca17af0cfa566ece451

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyfli_lib-0.1.16-py3-none-any.whl
  • Upload date:
  • Size: 198.4 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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 c0a979148a1e53f5677a97dda17726d0a38e67406745cc00cd43b12bf54b30fb
MD5 a0e640fa2d5a62de0d9a00d76f675d78
BLAKE2b-256 9725be30b5344fcebd44bc95c81cf3a45b88c3efca5a288028e501a756afe144

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