Skip to content

Latest commit

 

History

History
139 lines (93 loc) · 6.36 KB

README.md

File metadata and controls

139 lines (93 loc) · 6.36 KB
Raw
icon_filimpa

Project background

FLIMPA is an open-source software designed for the phasor plot analysis of raw Time-Correlated Single Photon Counting (TCSPC) Fluorescence Lifetime Imaging Microscopy (FLIM) data. Developed in Python, it offers an intuitive graphical user interface (GUI) for the analysis and visualisation of FLIM data.

To run the software, please download the executable (.exe) file. Currently, the .exe file runs only on Windows computers.

FLIMPA: An accessible software for Fluorescence Lifetime Imaging Microscopy Phasor Analysis
Sofia Kapsiani, Nino F Läubli, Edward N. Ward, Mona Shehata, Clemens F. Kaminski, Gabriele S. Kaminski Schierle
Molecular Neuroscience Group and Laser Analytics Group (University of Cambridge)

[FLIMPA (1.1)] [user manual] [bioRxiv] [bibtex]

Features

  • Phasor plot generation and analysis

  • Table of mean fluorescence lifetime values per image

  • ROI selection

  • Gallery plotting of fluorescence lifetime and intensity maps

  • Violin plot visualisation

    overview

Installation

FLIMPA can be easily run on Windows using the .exe file. Alternatively, you can clone the GitHub repository and run the software following these steps:

  1. Download the repository

    git clone https://github.com/SofiaKapsiani/FLIMPA.git
cd FLIMPA

  2. Create and activate a virtual environment

    conda create --name flimpa_env python=3.11 -y
conda activate flimpa_env

  3. Install the required packages

    pip install -r requirements.txt

  4. Run the software

    python main.py

Usage

For detailed information please refer to our online user manual.

Importing Data

FLIMPA currently accepts .sdt, .ptu, and .tif file formats for phasor plot analysis. To ensure accurate results, a reference file with a known lifetime (such as a sample of Rhodamine 6G or Erythrosin B) is required to correct for instrumental errors.

Importing .tif files

Please ensure that your .tif data is in the format (time, x, y). When loading your data, you will be prompted to enter the bin width (in nanoseconds), which is essential for accurate analysis.

If the exact bin width is unknown, FLIMPA provides an estimate option, calculated as:
(1 / (Instrument Frequency (in Hz) * Number of Bins)) * 10^9
However, this estimate may be inaccurate depending on your data acquisition settings.

The software can be tested using the .sdt files provided in the sample_data folder. These sample data were used in our publication and involve COS-7 cells stained with SiR-tubulin, treated with 40 µM of Nocodazole. Control data are also included, consisting of images of untreated cells.

There are three different options for importing the data:

  • Import raw data
  • Import raw data and assign experimental conditions (e.g treated vs untreated)
  • Import raw data with manually created masks (currently masks should be created using different software for example FLIMFit)

Example: Importing Raw Data and Assigning Experimental Conditions

import

Please note that FLIMPA currently only accepts single files and does not support the analysis of time-lapse data.

Running Phasor Plot Analysis

To run the phasor plot analysis, the following parameters need to be specified:

  • Laser Frequency (in MHz)
  • Upload a Reference File
  • Reference File Lifetime (in ns)
  • Number of Time Bins (default: 3x3)
  • Minimum Photon Count Threshold (optional, at least 100 p.c. per pixel recommended)
  • Maximum Photon Count Threshold (optional)

Example: Importing Reference file, setting minimum photon counts threshold and running the analysis

preprocessing

Phasor Plot Visualisation

FLIMPA enables to visualisation of phasor plots from single images and combined plots from multiple samples. Additionally three different phasor visualisation options: scatter plots, histograms and contour maps.

scatter

Saving Data

FLIMPA also allows users to export all generated data. This includes:

  • Lifetime and Intensity Maps: Exported as .png and raw .tif files.
  • Gallery Visualisations: Lifetime and intensity galleries exported as .png files.
  • Phasor Plots and Violin Plots: Saved with a transparent background.
  • Statistical Data: A .csv file containing the mean fluorescence lifetime per image can be exported for further statistical analysis.

save-73

Citation

If you found FLIMPA helpful for your data analysis, please consider citing our work! 😊 

@article{Kapsiani2024.09.13.612802,
	author = {Kapsiani, Sofia and L{\"a}ubli, Nino F and Ward, Edward N and Shehata, Mona and Kaminski, Clemens F and Kaminski Schierle, Gabriele S},
	title = {FLIMPA: A versatile software for Fluorescence Lifetime Imaging Microscopy Phasor Analysis},
	elocation-id = {2024.09.13.612802},
	year = {2024},
	doi = {10.1101/2024.09.13.612802},
	URL = {https://www.biorxiv.org/content/early/2024/09/19/2024.09.13.612802},
	eprint = {https://www.biorxiv.org/content/early/2024/09/19/2024.09.13.612802.full.pdf},
	journal = {bioRxiv}
}