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.17.tar.gz (170.5 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.17-py3-none-any.whl (199.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyfli_lib-0.1.17.tar.gz
  • Upload date:
  • Size: 170.5 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.17.tar.gz
Algorithm Hash digest
SHA256 40b7c28dde8f4caca92b473f8c3ec4154c2480a87334c1ab1d3d84eba56a479d
MD5 f4fc0c38b19b0d47943d79e9b45cac59
BLAKE2b-256 0cd436c04752c2be34e060afcc671ff8782f9a794d17345fa1ccced1177eb882

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyfli_lib-0.1.17-py3-none-any.whl
  • Upload date:
  • Size: 199.6 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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 1b56a490e81ba1f55df74545e802a29c81544fdb85667cd446de1f66b1298530
MD5 645ac3256f8b9d8e31dff69b6c293074
BLAKE2b-256 9af839773e2ac42de677f8b035343d9d26d164697bbc19ddfbdd323c96af052f

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